diff --git a/ontology/yaml/resources/LIGHTING/entity_types/ABSTRACT.yaml b/ontology/yaml/resources/LIGHTING/entity_types/ABSTRACT.yaml index c21b1d275..b3d684fb7 100644 --- a/ontology/yaml/resources/LIGHTING/entity_types/ABSTRACT.yaml +++ b/ontology/yaml/resources/LIGHTING/entity_types/ABSTRACT.yaml @@ -12,23 +12,38 @@ # See the License for the specific language governing permissions and # limitations under the License. -### ABSTRACT TYPES +### ABSTRACT TYPES ### SS: guid: "71ad241a-b4d5-413a-b86a-6102117feb8e" description: "Basic combination of run command and status (start/stop); indicates the light is active or inactive." is_abstract: true implements: - - /SS + - /SS # inherits from GLOBAL namespace -DC: - guid: "f00c5ccb-1549-4620-9a2f-ba13a73a5aaf" - description: "Brightness dimming control." +SRC: + guid: "2483cfe4-4196-42a4-b18f-f67f258a0220" + description: "Basic run scheduling." is_abstract: true - opt_uses: - - brightness_percentage_sensor uses: - - brightness_percentage_command + - schedule_run_command + +RC: + guid: "4bd721fa-c80b-469f-ba59-4e201464b527" + description: "Relay or switch to switch a socket or power supply for lumiaires or other devices." + is_abstract: true + uses: + - switch_command + +# TODO: understand the difference between this and RC (combine functionality, if possible) +LSC: + guid: "e0fa76a9-1bd3-4844-914e-ed66eef7fcfb" + description: "Lighting switch control." + is_abstract: true + uses: + - lighting_switch_status + +### Zone monitoring types ### MS: guid: "d5244d01-e5e9-4592-8c76-bf3a7e196a28" @@ -37,6 +52,7 @@ MS: uses: - motion_status +# TODO: rename to ZOM (zone occupancy monitoring) OS: guid: "42e7e1d7-2da6-4be6-9d21-2d3e93e5af1c" is_abstract: true @@ -51,27 +67,35 @@ ROS: uses: - room_occupancy_status -SC: - guid: "84c2b591-fbd8-47e1-982b-45bef8211bdb" +### Illuminance types ### + +IM: + guid: "13d6cfcb-8aa0-487e-a8b3-9f0f02ad63c6" + description: "Individual illuminance sensor monitoring, not used for control" is_abstract: true - description: "Scene control for a device or group of devices." uses: - - scene_index_command + - illuminance_sensor -BM: - guid: "b2da7457-74d3-4ec3-95a5-6f272e67a48d" - description: " Battery power status monitoring." +# TODO: delete this type (duplicate of IM) +IS: + guid: "5c46b19e-f238-4299-baac-4bd6db5c1cc7" is_abstract: true + description: "Illuminance sensing." uses: - - battery_charge_status + - illuminance_sensor -IM: - guid: "13d6cfcb-8aa0-487e-a8b3-9f0f02ad63c6" - description: "Individual illuminance sensor monitoring, not used for control" +# TODO: rename to IC (illuminance control) to match precedent +LC: + guid: "fa06c1cc-0240-4e55-8956-300ec6f3e095" + description: "Luminance control." is_abstract: true uses: + - illuminance_setpoint - illuminance_sensor +### Dimmer and brightness types ### + +# TODO: justify use of this (modeling similar behavior as DC) DPC: guid: "af54bb0b-795c-4b3e-bb74-b3a77d61eae2" description: " Dimmer control." @@ -79,24 +103,45 @@ DPC: uses: - dimmer_percentage_command +DC: + guid: "f00c5ccb-1549-4620-9a2f-ba13a73a5aaf" + description: "Brightness dimming control." + is_abstract: true + opt_uses: + - brightness_percentage_sensor + uses: + - brightness_percentage_command + +# TODO: jutify this type, very similar control to DC (combine with DC, if possible) +DM: + guid: "0e3ab3d7-a378-4c72-91ca-32a1290c6d84" + description: "Brightness dimming monitoring." + is_abstract: true + opt_uses: + - dimmer_run_status # TODO: justify this field name, similar meaning as lighting_switch_status + - power_sensor # TODO: remove from this type, implement PWM on the canonical instead + uses: + - brightness_percentage_sensor + +### Scene types ### + +SC: + guid: "84c2b591-fbd8-47e1-982b-45bef8211bdb" + is_abstract: true + description: "Scene control for a device or group of devices." + uses: + - scene_index_command + SCZ: guid: "e61e393c-370e-4917-bdb4-2554e0d47f0b" is_abstract: true description: "Scene control for a device and zone." opt_uses: - - scene_command + - scene_command # TODO: justify the need for this (because zone_scene_command is also implemented) - scene_index_command uses: - zone_scene_command -IS: - guid: "5c46b19e-f238-4299-baac-4bd6db5c1cc7" - is_abstract: true - description: "Illuminance sensing." - uses: - - illuminance_sensor - - #Abstract types for CH ZRH EURD VADC: guid: "dd477164-19aa-4b48-ad31-115c086cfc1e" description: "Variable dimmer control for standard luminaires." @@ -109,7 +154,7 @@ VADC: VADCRGB: guid: "338fb60b-963b-4489-bf94-6796bb19d367" - description: "Variable dimmer control for RGB luminaires." + description: "Variable dimmer control for red-green-blue (RGB) luminaires." is_abstract: true uses: - scene_dimmer_percentage_command @@ -120,41 +165,43 @@ VADCRGB: - green_scene_dimmer_percentage_command - blue_scene_dimmer_percentage_command -RC: - guid: "4bd721fa-c80b-469f-ba59-4e201464b527" - description: "Relay or switch to switch a socket or power supply for lumiaires or other devices" - is_abstract: true - uses: - - switch_command +### Power and energy types ### -LSC: - guid: "e0fa76a9-1bd3-4844-914e-ed66eef7fcfb" - description: "Lighting switch control." +BM: + guid: "b2da7457-74d3-4ec3-95a5-6f272e67a48d" + description: " Battery power status monitoring." is_abstract: true uses: - - lighting_switch_status - -LC: - guid: "fa06c1cc-0240-4e55-8956-300ec6f3e095" - description: "Luminance control." + - battery_charge_status + +# TODO: deprecate and inherit from METERS (or promote PWM to global and inherit from there) +# TODO: combine with ENM +PWM: + guid: "fc70bbb6-5000-4f83-9e79-862f60ececfe" + description: "Basic power monitoring " is_abstract: true uses: - - illuminance_setpoint - - illuminance_sensor + - power_sensor -SRC: - guid: "2483cfe4-4196-42a4-b18f-f67f258a0220" - description: "Basic run scheduling " +# TODO: deprecate and combine with PWM +ENM: + guid: "2f548e52-a2b3-492c-acd8-747f0ce4f8a9" + description: "Basic energy monitoring " is_abstract: true uses: - - schedule_run_command + - energy_accumulator -PWM: - guid: "fc70bbb6-5000-4f83-9e79-862f60ececfe" - description: "Basic power monitoring " +# TODO: deprecate and replace with new, targeted abstract types +OM: + guid: "54221319-0bab-4aa9-aea0-d667419bee11" + description: "Operation monitoring for lighting fixtures" is_abstract: true uses: - - power_sensor + - energy_accumulator # TODO: covered by PWM + - run_time_accumulator # TODO: add as opt_uses to SS + - luminaire_alarm # TODO: understand this alarm's purpose (does it indicate failure? If so, add failed_alarm to general type) + +### Lighting color types ### CCIEM: guid: "d2755279-6ccd-4d9e-838a-371ab23c022d" @@ -172,37 +219,11 @@ CHSLM: - lighting_color_hsl_saturation_percentage_sensor - lighting_color_hsl_hue_angle_sensor -OM: - guid: "54221319-0bab-4aa9-aea0-d667419bee11" - description: "Operation monitoring for lighting fixtures" - is_abstract: true - uses: - - energy_accumulator - - run_time_accumulator - - luminaire_alarm - -DM: - guid: "0e3ab3d7-a378-4c72-91ca-32a1290c6d84" - description: "Brightness dimming monitoring." - is_abstract: true - opt_uses: - - dimmer_run_status - - power_sensor - uses: - - brightness_percentage_sensor - -ENM: - guid: "2f548e52-a2b3-492c-acd8-747f0ce4f8a9" - description: "Basic energy monitoring " - is_abstract: true - uses: - - energy_accumulator - CTC: guid: "30ed8ab4-8df7-493f-a3fc-b4da7f28c8fe" is_abstract: true description: "Scene control for a device and zone." opt_uses: - - lighting_color_temperature_sensor + - lighting_color_temperature_sensor # TODO: promote to uses uses: - lighting_color_temperature_setpoint diff --git a/ontology/yaml/resources/LIGHTING/entity_types/GENERALTYPES.yaml b/ontology/yaml/resources/LIGHTING/entity_types/GENERALTYPES.yaml index 3561a7c13..623e869a3 100644 --- a/ontology/yaml/resources/LIGHTING/entity_types/GENERALTYPES.yaml +++ b/ontology/yaml/resources/LIGHTING/entity_types/GENERALTYPES.yaml @@ -12,20 +12,14 @@ # See the License for the specific language governing permissions and # limitations under the License. -LT: - guid: "01154366-4062-43ff-b7eb-ffbe7216ea84" - description: "Luminaire, lighting fixture. The thing that produces light." - is_abstract: true - implements: - - EQUIPMENT - -LTGW: - guid: "30a5aaf1-a30d-41db-8ace-643ce84b170e" - description: "Lighting gateway." +ELT: + guid: "fb78a0b6-b1aa-4779-bde3-8ed76ea6b6ed" + description: "Lights intended to provide illumination and/or direction during an emergency." is_abstract: true implements: - EQUIPMENT +# TODO: justify the difference between LCM and LGRP LCM: guid: "8cdb21a1-2835-43ea-879c-1ca29105ec44" description: "Lighting control module, used for controlling one or more luminaires (LT)." @@ -33,6 +27,11 @@ LCM: implements: - EQUIPMENT +LGRP: + guid: "7b2723ef-361a-40ff-8399-4a907a52c357" + is_abstract: true + description: "A group containing one or more luminaires." + LKP: guid: "be286551-98a9-46be-82f0-9c83266cee22" description: "Lighting keypad." @@ -41,28 +40,30 @@ LKP: - EQUIPMENT - USER_INTERFACE -LTB: # TODO: inherit from common device when a concrete example emerges. - guid: "f1dcdb9b-6aab-4551-9f44-0385c95d0274" - description: "Battery that serves lighting devices. " +LS: + guid: "768b8a60-ae3f-445e-8169-3b001513e752" is_abstract: true + description: "Lighting system specific sensor." implements: - - EQUIPMENT + - SENSOR -LGRP: - guid: "7b2723ef-361a-40ff-8399-4a907a52c357" +LT: + guid: "01154366-4062-43ff-b7eb-ffbe7216ea84" + description: "Luminaire, lighting fixture. The thing that produces light." is_abstract: true - description: "A group containing one or more luminaires." + implements: + - EQUIPMENT -LS: - guid: "768b8a60-ae3f-445e-8169-3b001513e752" +LTB: # TODO: inherit from common device when a concrete example emerges. + guid: "f1dcdb9b-6aab-4551-9f44-0385c95d0274" + description: "Battery that serves lighting devices." is_abstract: true - description: "Lighting system specific sensor." implements: - - SENSOR + - EQUIPMENT -ELT: - guid: "fb78a0b6-b1aa-4779-bde3-8ed76ea6b6ed" - description: "Lights intended to provide illumination and/or direction during an emergency." +LTGW: + guid: "30a5aaf1-a30d-41db-8ace-643ce84b170e" + description: "Lighting gateway." is_abstract: true implements: - EQUIPMENT diff --git a/ontology/yaml/resources/LIGHTING/entity_types/LCM.yaml b/ontology/yaml/resources/LIGHTING/entity_types/LCM.yaml index 46555db9d..88ea5f9e8 100644 --- a/ontology/yaml/resources/LIGHTING/entity_types/LCM.yaml +++ b/ontology/yaml/resources/LIGHTING/entity_types/LCM.yaml @@ -12,6 +12,9 @@ # See the License for the specific language governing permissions and # limitations under the License. +######################## +### Canonical Types ### +######################## # Lighting group controllers. LCM_SS: diff --git a/ontology/yaml/resources/LIGHTING/entity_types/LGRP.yaml b/ontology/yaml/resources/LIGHTING/entity_types/LGRP.yaml index bbd422d23..db3cb2d18 100644 --- a/ontology/yaml/resources/LIGHTING/entity_types/LGRP.yaml +++ b/ontology/yaml/resources/LIGHTING/entity_types/LGRP.yaml @@ -12,6 +12,9 @@ # See the License for the specific language governing permissions and # limitations under the License. +######################## +### Canonical Types ### +######################## # Lighting device group LGRP_DC: @@ -19,8 +22,8 @@ LGRP_DC: description: "Lighting group control module with brightness control." is_canonical: true implements: - - LGRP - - DC + - LGRP + - DC LGRP_DC_OS_SC: guid: "96e4ec5a-6a0d-4460-9065-8efa3cdfbcb4" @@ -273,17 +276,6 @@ LGRP_SS_DC_MS: - DC - MS -#Noncanonical types -LGRP_DC_MS_IM: - guid: "5a1e9a7c-0b8d-4eb4-9e97-6abfc696e382" - description: "Non-canonical lighting groups with brightness, motion sensing and illuminance monitoring" - is_canonical: false - implements: - - LGRP - - DC - - MS - - IM - LGRP_OS_LC: guid: "c6296635-f9e9-4dc4-b963-0a3d517e7d44" description: "Standard lighting fixture group control with zone occupancy montoring and luminance control" @@ -308,3 +300,18 @@ LGRP_SS_OS_IM: uses: - group_mode +################################### +### Existing Non-standard Types ### +################################### + +LGRP_DC_MS_IM: + guid: "5a1e9a7c-0b8d-4eb4-9e97-6abfc696e382" + description: "Non-canonical lighting groups with brightness, motion sensing and illuminance monitoring" + is_canonical: false + implements: + - LGRP + - DC + - MS + - IM + + diff --git a/ontology/yaml/resources/LIGHTING/entity_types/LKP.yaml b/ontology/yaml/resources/LIGHTING/entity_types/LKP.yaml index 04a1d8730..94eb09d85 100644 --- a/ontology/yaml/resources/LIGHTING/entity_types/LKP.yaml +++ b/ontology/yaml/resources/LIGHTING/entity_types/LKP.yaml @@ -12,11 +12,14 @@ # See the License for the specific language governing permissions and # limitations under the License. +######################## +### Canonical Types ### +######################## # Canonical types for Lighting Keypads LKP_SCZ_DC: guid: "eee9591f-b34d-4ec7-8885-4fbf2a0047ce" - description: "Lighting to control brightness with scene command." + description: "Lighting keypad to control brightness with scene command." is_canonical: true implements: - LKP diff --git a/ontology/yaml/resources/LIGHTING/entity_types/LS.yaml b/ontology/yaml/resources/LIGHTING/entity_types/LS.yaml index d812ec8b2..6695654ab 100644 --- a/ontology/yaml/resources/LIGHTING/entity_types/LS.yaml +++ b/ontology/yaml/resources/LIGHTING/entity_types/LS.yaml @@ -20,14 +20,13 @@ # This document specific types for lighting system sensors (LS). These are used when sensors are not # tied directly to an individual luminaire and must be modeled as stand-alone devices. -LS_LPS: +LS_IM: guid: "8ad90cb4-3c19-4c41-81ab-22b192073539" description: "Lighting system photocell sensor." is_canonical: true implements: - LS - uses: - - illuminance_sensor + - IM LS_LMS: guid: "62961442-f3b8-47e1-9b53-ac658cd2cf61" @@ -37,24 +36,22 @@ LS_LMS: - LS - MS - -LS_MTS: +LS_IM_ZTM: guid: "8bc3943d-da3e-406b-b3d4-c1b0874e2052" description: "Lighting multi-sensor, for temperature and brightness." is_canonical: true implements: - LS - uses: - - illuminance_sensor - - zone_air_temperature_sensor + - IM + - HVAC/ZTM # inherits from HVAC namespace -LS_IS_OS: +LS_IM_OS: guid: "144f310a-7848-428a-ba09-24439d26d7d6" description: "Illuminance sensing and zone occupancy monitoring" is_canonical: true implements: - LS - - IS + - IM - OS LS_OS: @@ -65,32 +62,31 @@ LS_OS: - LS - OS +# TODO: deprecate type and use LS_OS (currently implemented by entities) LS_LOS: guid: "f9589a72-3122-4b44-b31c-c37a17751590" description: "Lighting system motion sensor." is_canonical: true implements: - - LS - - OS + - LS_OS -LS_MS_IS: +LS_MS_IM: guid: "caf4990c-fdb2-47cb-ab7c-a8743cf855b6" description: "lighting multi-sensor for motion and illuminance." is_canonical: true implements: - LS - MS - - IS + - IM -LS_OS_IS_MTS: +LS_OS_IM_ZTM_ZHM: guid: "a63a45d8-dbfc-4a48-b8ad-0879c15eb3b2" description: "Ceiling mounted multi sensor for zone occupancy monitoring, brightness- and temperature control" is_canonical: true implements: - LS - OS - - IS - uses: - - zone_air_temperature_sensor - - zone_air_relative_humidity_sensor + - IM + - HVAC/ZTM + - HVAC/ZHM diff --git a/ontology/yaml/resources/LIGHTING/entity_types/LT.yaml b/ontology/yaml/resources/LIGHTING/entity_types/LT.yaml index b7621b4a1..2759840ac 100644 --- a/ontology/yaml/resources/LIGHTING/entity_types/LT.yaml +++ b/ontology/yaml/resources/LIGHTING/entity_types/LT.yaml @@ -12,10 +12,13 @@ # See the License for the specific language governing permissions and # limitations under the License. +######################## +### Canonical Types ### +######################## LT_SS: guid: "75cb78f1-63d6-4442-9e05-2ee0d9b24360" - description: "Standard light." + description: "Standard light with start/stop." is_canonical: true implements: - LT @@ -23,7 +26,7 @@ LT_SS: LT_DC: guid: "5eee1cd9-5a5c-4daf-8211-4a413bcdff5d" - description: "Even more standaard light with dimming control." + description: "Standard light with dimming control." is_canonical: true implements: - LT @@ -31,7 +34,7 @@ LT_DC: LT_DC_SC: guid: "ec914daa-b767-4034-a072-cf33c6e4d60b" - description: "Standard light with dimming control and scene control." + description: "Light with dimming control and scene control." is_canonical: true implements: - LT @@ -46,13 +49,6 @@ LT_DPC: - LT - DPC -ELT_GENERIC: - guid: "93b0205f-5a69-45e9-8af8-7d2a862037af" - description: "Generic, non-canonical emergency light" - is_canonical: false - implements: - - ELT - LT_DM_CCIEM_OM: guid: "b0a36e56-d06d-4418-9636-cb1a3d9b5bab" description: "Standard light with dimming and CIE color control." @@ -82,3 +78,14 @@ LT_DC_CTC_OM: - DC - CTC - OM + +################################### +### Existing Non-standard Types ### +################################### + +ELT_GENERIC: + guid: "93b0205f-5a69-45e9-8af8-7d2a862037af" + description: "Generic, non-canonical emergency light" + is_canonical: false + implements: + - ELT \ No newline at end of file diff --git a/ontology/yaml/resources/LIGHTING/entity_types/LTB.yaml b/ontology/yaml/resources/LIGHTING/entity_types/LTB.yaml index 72bec3cca..9f8c7d7e1 100644 --- a/ontology/yaml/resources/LIGHTING/entity_types/LTB.yaml +++ b/ontology/yaml/resources/LIGHTING/entity_types/LTB.yaml @@ -21,12 +21,8 @@ LTB_SS: guid: "b162ff3b-1f5e-48bd-b68d-ec0349572241" - description: "Lighting battery with basic feedback. " + description: "Lighting battery with basic feedback." is_canonical: true implements: - ELECTRICAL/BATT - SS - - - - diff --git a/ontology/yaml/resources/LIGHTING/entity_types/LTGW.yaml b/ontology/yaml/resources/LIGHTING/entity_types/LTGW.yaml index 0966ab4fb..3e3d8e871 100644 --- a/ontology/yaml/resources/LIGHTING/entity_types/LTGW.yaml +++ b/ontology/yaml/resources/LIGHTING/entity_types/LTGW.yaml @@ -12,6 +12,9 @@ # See the License for the specific language governing permissions and # limitations under the License. +######################## +### Canonical Types ### +######################## # Canonical types for Lighting Gateways LTGW_BS: @@ -20,7 +23,9 @@ LTGW_BS: implements: - LTGW -# Non-Canonical types for Lighting Gateways +################################### +### Existing Non-standard Types ### +################################### LTGW_NONCANONICAL_1: guid: "fe48016c-e9cc-4599-9056-fa44d3b01df6"