From 0b2781ebb7559d4c4dd410fe46a79c1e9ea173f0 Mon Sep 17 00:00:00 2001 From: Claire Stirdivant <64609897+cstirdivant@users.noreply.github.com> Date: Mon, 29 Apr 2024 16:11:51 -0700 Subject: [PATCH 01/15] LIGHTING namespace cleanup --- ontology/yaml/resources/LIGHTING/entity_types/GENERALTYPES.yaml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/ontology/yaml/resources/LIGHTING/entity_types/GENERALTYPES.yaml b/ontology/yaml/resources/LIGHTING/entity_types/GENERALTYPES.yaml index 3561a7c13..a5fc793ae 100644 --- a/ontology/yaml/resources/LIGHTING/entity_types/GENERALTYPES.yaml +++ b/ontology/yaml/resources/LIGHTING/entity_types/GENERALTYPES.yaml @@ -43,7 +43,7 @@ LKP: LTB: # TODO: inherit from common device when a concrete example emerges. guid: "f1dcdb9b-6aab-4551-9f44-0385c95d0274" - description: "Battery that serves lighting devices. " + description: "Battery that serves lighting devices." is_abstract: true implements: - EQUIPMENT From 1273b985d4bcfd97dc063dc00d02789d464d3435 Mon Sep 17 00:00:00 2001 From: Claire Stirdivant <64609897+cstirdivant@users.noreply.github.com> Date: Mon, 29 Apr 2024 16:12:28 -0700 Subject: [PATCH 02/15] Update LGRP.yaml --- ontology/yaml/resources/LIGHTING/entity_types/LGRP.yaml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/ontology/yaml/resources/LIGHTING/entity_types/LGRP.yaml b/ontology/yaml/resources/LIGHTING/entity_types/LGRP.yaml index bbd422d23..4c2d33d4e 100644 --- a/ontology/yaml/resources/LIGHTING/entity_types/LGRP.yaml +++ b/ontology/yaml/resources/LIGHTING/entity_types/LGRP.yaml @@ -19,8 +19,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" From 27b8d07524cc9c63eb638dd73f0be046dc4f7561 Mon Sep 17 00:00:00 2001 From: Claire Stirdivant <64609897+cstirdivant@users.noreply.github.com> Date: Mon, 29 Apr 2024 16:12:46 -0700 Subject: [PATCH 03/15] Update LKP.yaml --- ontology/yaml/resources/LIGHTING/entity_types/LKP.yaml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/ontology/yaml/resources/LIGHTING/entity_types/LKP.yaml b/ontology/yaml/resources/LIGHTING/entity_types/LKP.yaml index 04a1d8730..79bfe11df 100644 --- a/ontology/yaml/resources/LIGHTING/entity_types/LKP.yaml +++ b/ontology/yaml/resources/LIGHTING/entity_types/LKP.yaml @@ -16,7 +16,7 @@ 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 From 9e3c2e574d4a38e97bb77e54d9b7bb7d980ea852 Mon Sep 17 00:00:00 2001 From: Claire Stirdivant <64609897+cstirdivant@users.noreply.github.com> Date: Mon, 29 Apr 2024 16:16:47 -0700 Subject: [PATCH 04/15] Update LS.yaml --- .../resources/LIGHTING/entity_types/LS.yaml | 34 ++++++++----------- 1 file changed, 15 insertions(+), 19 deletions(-) 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 From 5c6ed5e893fdf40e033f79992276c7d035c2a342 Mon Sep 17 00:00:00 2001 From: Claire Stirdivant <64609897+cstirdivant@users.noreply.github.com> Date: Mon, 29 Apr 2024 16:17:29 -0700 Subject: [PATCH 05/15] Update LT.yaml --- ontology/yaml/resources/LIGHTING/entity_types/LT.yaml | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/ontology/yaml/resources/LIGHTING/entity_types/LT.yaml b/ontology/yaml/resources/LIGHTING/entity_types/LT.yaml index b7621b4a1..acd76efbe 100644 --- a/ontology/yaml/resources/LIGHTING/entity_types/LT.yaml +++ b/ontology/yaml/resources/LIGHTING/entity_types/LT.yaml @@ -15,7 +15,7 @@ LT_SS: guid: "75cb78f1-63d6-4442-9e05-2ee0d9b24360" - description: "Standard light." + description: "Standard light with start/stop." is_canonical: true implements: - LT @@ -23,7 +23,7 @@ LT_SS: LT_DC: guid: "5eee1cd9-5a5c-4daf-8211-4a413bcdff5d" - description: "Even more standaard light with dimming control." + description: "Standaard light with dimming control." is_canonical: true implements: - LT @@ -31,7 +31,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 From c90aa3a4763eee6974cf50f39c00d96a7c33d2e1 Mon Sep 17 00:00:00 2001 From: Claire Stirdivant <64609897+cstirdivant@users.noreply.github.com> Date: Mon, 29 Apr 2024 16:29:40 -0700 Subject: [PATCH 06/15] Update ABSTRACT.yaml --- .../LIGHTING/entity_types/ABSTRACT.yaml | 26 ++++++++++++------- 1 file changed, 16 insertions(+), 10 deletions(-) diff --git a/ontology/yaml/resources/LIGHTING/entity_types/ABSTRACT.yaml b/ontology/yaml/resources/LIGHTING/entity_types/ABSTRACT.yaml index c21b1d275..9e6ddd588 100644 --- a/ontology/yaml/resources/LIGHTING/entity_types/ABSTRACT.yaml +++ b/ontology/yaml/resources/LIGHTING/entity_types/ABSTRACT.yaml @@ -19,7 +19,7 @@ SS: 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" @@ -37,6 +37,7 @@ MS: uses: - motion_status +# TODO: rename to ZOM (zone occupancy monitoring) OS: guid: "42e7e1d7-2da6-4be6-9d21-2d3e93e5af1c" is_abstract: true @@ -84,11 +85,12 @@ SCZ: is_abstract: true description: "Scene control for a device and zone." opt_uses: - - scene_command + - scene_command # TODO: justify the need for this - scene_index_command uses: - zone_scene_command +# TODO: delete this type (duplicate of IM) IS: guid: "5c46b19e-f238-4299-baac-4bd6db5c1cc7" is_abstract: true @@ -96,7 +98,6 @@ IS: 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 +110,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 @@ -127,6 +128,7 @@ RC: 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." @@ -149,6 +151,8 @@ SRC: uses: - schedule_run_command +# TODO: deprecate and inherit from METERS +# TODO: combine with ENM PWM: guid: "fc70bbb6-5000-4f83-9e79-862f60ececfe" description: "Basic power monitoring " @@ -172,25 +176,27 @@ CHSLM: - lighting_color_hsl_saturation_percentage_sensor - lighting_color_hsl_hue_angle_sensor +# 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: - - energy_accumulator - - run_time_accumulator - - luminaire_alarm + - 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) DM: guid: "0e3ab3d7-a378-4c72-91ca-32a1290c6d84" description: "Brightness dimming monitoring." is_abstract: true opt_uses: - - dimmer_run_status - - power_sensor + - dimmer_run_status # TODO: justify this field name + - power_sensor # TODO: remove from this type, implement PWM on the canonical instead uses: - brightness_percentage_sensor +# TODO: deprecate and combine with PWM ENM: guid: "2f548e52-a2b3-492c-acd8-747f0ce4f8a9" description: "Basic energy monitoring " @@ -203,6 +209,6 @@ CTC: 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 From c8dbc56904dac4b2b7b221ad8fdab2911a39bc1c Mon Sep 17 00:00:00 2001 From: Claire Stirdivant <64609897+cstirdivant@users.noreply.github.com> Date: Mon, 29 Apr 2024 16:30:17 -0700 Subject: [PATCH 07/15] Update LTB.yaml --- ontology/yaml/resources/LIGHTING/entity_types/LTB.yaml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/ontology/yaml/resources/LIGHTING/entity_types/LTB.yaml b/ontology/yaml/resources/LIGHTING/entity_types/LTB.yaml index 72bec3cca..18aa2c34b 100644 --- a/ontology/yaml/resources/LIGHTING/entity_types/LTB.yaml +++ b/ontology/yaml/resources/LIGHTING/entity_types/LTB.yaml @@ -21,7 +21,7 @@ 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 From 704579257f360e15115e2d15ef8155424ccde9fb Mon Sep 17 00:00:00 2001 From: Claire Stirdivant <64609897+cstirdivant@users.noreply.github.com> Date: Mon, 29 Apr 2024 16:31:47 -0700 Subject: [PATCH 08/15] Update LT.yaml --- ontology/yaml/resources/LIGHTING/entity_types/LT.yaml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/ontology/yaml/resources/LIGHTING/entity_types/LT.yaml b/ontology/yaml/resources/LIGHTING/entity_types/LT.yaml index acd76efbe..825d94cbe 100644 --- a/ontology/yaml/resources/LIGHTING/entity_types/LT.yaml +++ b/ontology/yaml/resources/LIGHTING/entity_types/LT.yaml @@ -23,7 +23,7 @@ LT_SS: LT_DC: guid: "5eee1cd9-5a5c-4daf-8211-4a413bcdff5d" - description: "Standaard light with dimming control." + description: "Standard light with dimming control." is_canonical: true implements: - LT From a4142c2d3b03cf262bb5beaf004eb110bb5062a9 Mon Sep 17 00:00:00 2001 From: Claire Stirdivant <64609897+cstirdivant@users.noreply.github.com> Date: Mon, 29 Apr 2024 16:32:33 -0700 Subject: [PATCH 09/15] Update ABSTRACT.yaml --- ontology/yaml/resources/LIGHTING/entity_types/ABSTRACT.yaml | 1 + 1 file changed, 1 insertion(+) diff --git a/ontology/yaml/resources/LIGHTING/entity_types/ABSTRACT.yaml b/ontology/yaml/resources/LIGHTING/entity_types/ABSTRACT.yaml index 9e6ddd588..25114a9b4 100644 --- a/ontology/yaml/resources/LIGHTING/entity_types/ABSTRACT.yaml +++ b/ontology/yaml/resources/LIGHTING/entity_types/ABSTRACT.yaml @@ -73,6 +73,7 @@ IM: uses: - illuminance_sensor +# TODO: justify use of this (identical usage as DC) DPC: guid: "af54bb0b-795c-4b3e-bb74-b3a77d61eae2" description: " Dimmer control." From bd267e8e09d9c2cab0e29608ea2c1545d0b031ef Mon Sep 17 00:00:00 2001 From: Claire Stirdivant <64609897+cstirdivant@users.noreply.github.com> Date: Mon, 29 Apr 2024 16:34:07 -0700 Subject: [PATCH 10/15] Update ABSTRACT.yaml --- ontology/yaml/resources/LIGHTING/entity_types/ABSTRACT.yaml | 1 + 1 file changed, 1 insertion(+) diff --git a/ontology/yaml/resources/LIGHTING/entity_types/ABSTRACT.yaml b/ontology/yaml/resources/LIGHTING/entity_types/ABSTRACT.yaml index 25114a9b4..49e45c562 100644 --- a/ontology/yaml/resources/LIGHTING/entity_types/ABSTRACT.yaml +++ b/ontology/yaml/resources/LIGHTING/entity_types/ABSTRACT.yaml @@ -187,6 +187,7 @@ OM: - 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) +# TODO: jutify this type, very similar control to DC DM: guid: "0e3ab3d7-a378-4c72-91ca-32a1290c6d84" description: "Brightness dimming monitoring." From b0e1f9ddd1603483a83e6a135f2b92bd25d4a273 Mon Sep 17 00:00:00 2001 From: Claire Stirdivant <64609897+cstirdivant@users.noreply.github.com> Date: Mon, 29 Apr 2024 17:01:43 -0700 Subject: [PATCH 11/15] Update GENERALTYPES.yaml --- .../LIGHTING/entity_types/GENERALTYPES.yaml | 48 +++++++++---------- 1 file changed, 24 insertions(+), 24 deletions(-) diff --git a/ontology/yaml/resources/LIGHTING/entity_types/GENERALTYPES.yaml b/ontology/yaml/resources/LIGHTING/entity_types/GENERALTYPES.yaml index a5fc793ae..bd8c0c415 100644 --- a/ontology/yaml/resources/LIGHTING/entity_types/GENERALTYPES.yaml +++ b/ontology/yaml/resources/LIGHTING/entity_types/GENERALTYPES.yaml @@ -12,16 +12,9 @@ # 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 @@ -33,6 +26,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 +39,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 From 68b7d58984d59bab61ea1709487685357daced23 Mon Sep 17 00:00:00 2001 From: Claire Stirdivant <64609897+cstirdivant@users.noreply.github.com> Date: Mon, 29 Apr 2024 17:08:05 -0700 Subject: [PATCH 12/15] Update ABSTRACT.yaml --- .../LIGHTING/entity_types/ABSTRACT.yaml | 173 ++++++++++-------- 1 file changed, 92 insertions(+), 81 deletions(-) diff --git a/ontology/yaml/resources/LIGHTING/entity_types/ABSTRACT.yaml b/ontology/yaml/resources/LIGHTING/entity_types/ABSTRACT.yaml index 49e45c562..05aef27dc 100644 --- a/ontology/yaml/resources/LIGHTING/entity_types/ABSTRACT.yaml +++ b/ontology/yaml/resources/LIGHTING/entity_types/ABSTRACT.yaml @@ -12,7 +12,7 @@ # 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" @@ -21,14 +21,29 @@ SS: implements: - /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" @@ -52,25 +67,29 @@ ROS: uses: - room_occupancy_status -SC: - guid: "84c2b591-fbd8-47e1-982b-45bef8211bdb" +### Brightness 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" +LC: + guid: "fa06c1cc-0240-4e55-8956-300ec6f3e095" + description: "Luminance control." is_abstract: true uses: + - illuminance_setpoint - illuminance_sensor # TODO: justify use of this (identical usage as DC) @@ -81,6 +100,35 @@ 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 +DM: + guid: "0e3ab3d7-a378-4c72-91ca-32a1290c6d84" + description: "Brightness dimming monitoring." + is_abstract: true + opt_uses: + - dimmer_run_status # TODO: justify this field name + - 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 @@ -91,14 +139,6 @@ SCZ: uses: - zone_scene_command -# TODO: delete this type (duplicate of IM) -IS: - guid: "5c46b19e-f238-4299-baac-4bd6db5c1cc7" - is_abstract: true - description: "Illuminance sensing." - uses: - - illuminance_sensor - VADC: guid: "dd477164-19aa-4b48-ad31-115c086cfc1e" description: "Variable dimmer control for standard luminaires." @@ -122,35 +162,15 @@ 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 ### -# 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 - -LC: - guid: "fa06c1cc-0240-4e55-8956-300ec6f3e095" - description: "Luminance control." - is_abstract: true - uses: - - illuminance_setpoint - - illuminance_sensor - -SRC: - guid: "2483cfe4-4196-42a4-b18f-f67f258a0220" - description: "Basic run scheduling " +BM: + guid: "b2da7457-74d3-4ec3-95a5-6f272e67a48d" + description: " Battery power status monitoring." is_abstract: true uses: - - schedule_run_command + - battery_charge_status + # TODO: deprecate and inherit from METERS # TODO: combine with ENM @@ -161,21 +181,13 @@ PWM: uses: - power_sensor -CCIEM: - guid: "d2755279-6ccd-4d9e-838a-371ab23c022d" - description: "CIE light color monitoring" - is_abstract: true - uses: - - lighting_color_cie_xvalue_sensor - - lighting_color_cie_yvalue_sensor - -CHSLM: - guid: "1ab195d7-4035-424c-b2d9-282ec0a9cc2a" - description: "HSL light color monitoring" +# TODO: deprecate and combine with PWM +ENM: + guid: "2f548e52-a2b3-492c-acd8-747f0ce4f8a9" + description: "Basic energy monitoring " is_abstract: true - uses: - - lighting_color_hsl_saturation_percentage_sensor - - lighting_color_hsl_hue_angle_sensor + uses: + - energy_accumulator # TODO: deprecate and replace with new, targeted abstract types OM: @@ -187,24 +199,23 @@ OM: - 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) -# TODO: jutify this type, very similar control to DC -DM: - guid: "0e3ab3d7-a378-4c72-91ca-32a1290c6d84" - description: "Brightness dimming monitoring." +### Lighting color types ### + +CCIEM: + guid: "d2755279-6ccd-4d9e-838a-371ab23c022d" + description: "CIE light color monitoring" is_abstract: true - opt_uses: - - dimmer_run_status # TODO: justify this field name - - power_sensor # TODO: remove from this type, implement PWM on the canonical instead - uses: - - brightness_percentage_sensor + uses: + - lighting_color_cie_xvalue_sensor + - lighting_color_cie_yvalue_sensor -# TODO: deprecate and combine with PWM -ENM: - guid: "2f548e52-a2b3-492c-acd8-747f0ce4f8a9" - description: "Basic energy monitoring " +CHSLM: + guid: "1ab195d7-4035-424c-b2d9-282ec0a9cc2a" + description: "HSL light color monitoring" is_abstract: true - uses: - - energy_accumulator + uses: + - lighting_color_hsl_saturation_percentage_sensor + - lighting_color_hsl_hue_angle_sensor CTC: guid: "30ed8ab4-8df7-493f-a3fc-b4da7f28c8fe" From f7466e7729abec2bcb0156522ff018d02f52dee3 Mon Sep 17 00:00:00 2001 From: Claire Stirdivant <64609897+cstirdivant@users.noreply.github.com> Date: Mon, 29 Apr 2024 17:18:43 -0700 Subject: [PATCH 13/15] Update ABSTRACT.yaml --- .../LIGHTING/entity_types/ABSTRACT.yaml | 20 ++++++++++--------- 1 file changed, 11 insertions(+), 9 deletions(-) diff --git a/ontology/yaml/resources/LIGHTING/entity_types/ABSTRACT.yaml b/ontology/yaml/resources/LIGHTING/entity_types/ABSTRACT.yaml index 05aef27dc..b3d684fb7 100644 --- a/ontology/yaml/resources/LIGHTING/entity_types/ABSTRACT.yaml +++ b/ontology/yaml/resources/LIGHTING/entity_types/ABSTRACT.yaml @@ -23,14 +23,14 @@ SS: SRC: guid: "2483cfe4-4196-42a4-b18f-f67f258a0220" - description: "Basic run scheduling " + description: "Basic run scheduling." is_abstract: true uses: - 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" + description: "Relay or switch to switch a socket or power supply for lumiaires or other devices." is_abstract: true uses: - switch_command @@ -67,7 +67,7 @@ ROS: uses: - room_occupancy_status -### Brightness types ### +### Illuminance types ### IM: guid: "13d6cfcb-8aa0-487e-a8b3-9f0f02ad63c6" @@ -84,6 +84,7 @@ IS: uses: - illuminance_sensor +# TODO: rename to IC (illuminance control) to match precedent LC: guid: "fa06c1cc-0240-4e55-8956-300ec6f3e095" description: "Luminance control." @@ -92,7 +93,9 @@ LC: - illuminance_setpoint - illuminance_sensor -# TODO: justify use of this (identical usage as DC) +### Dimmer and brightness types ### + +# TODO: justify use of this (modeling similar behavior as DC) DPC: guid: "af54bb0b-795c-4b3e-bb74-b3a77d61eae2" description: " Dimmer control." @@ -109,13 +112,13 @@ DC: uses: - brightness_percentage_command -# TODO: jutify this type, very similar control to DC +# 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 + - 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 @@ -134,7 +137,7 @@ SCZ: is_abstract: true description: "Scene control for a device and zone." opt_uses: - - scene_command # TODO: justify the need for this + - scene_command # TODO: justify the need for this (because zone_scene_command is also implemented) - scene_index_command uses: - zone_scene_command @@ -171,8 +174,7 @@ BM: uses: - battery_charge_status - -# TODO: deprecate and inherit from METERS +# 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" From d566c4d4c0092a37d967109aa0c09d1563a7b8ab Mon Sep 17 00:00:00 2001 From: Claire Stirdivant <64609897+cstirdivant@users.noreply.github.com> Date: Mon, 29 Apr 2024 17:19:21 -0700 Subject: [PATCH 14/15] Update GENERALTYPES.yaml --- ontology/yaml/resources/LIGHTING/entity_types/GENERALTYPES.yaml | 1 + 1 file changed, 1 insertion(+) diff --git a/ontology/yaml/resources/LIGHTING/entity_types/GENERALTYPES.yaml b/ontology/yaml/resources/LIGHTING/entity_types/GENERALTYPES.yaml index bd8c0c415..623e869a3 100644 --- a/ontology/yaml/resources/LIGHTING/entity_types/GENERALTYPES.yaml +++ b/ontology/yaml/resources/LIGHTING/entity_types/GENERALTYPES.yaml @@ -19,6 +19,7 @@ ELT: 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)." From 6813075a8520e16534ef1356241ac7ae7e5ee964 Mon Sep 17 00:00:00 2001 From: Claire Stirdivant Date: Thu, 2 May 2024 17:25:02 +0000 Subject: [PATCH 15/15] minor formatting updates --- .../resources/LIGHTING/entity_types/LCM.yaml | 3 ++ .../resources/LIGHTING/entity_types/LGRP.yaml | 29 ++++++++++++------- .../resources/LIGHTING/entity_types/LKP.yaml | 3 ++ .../resources/LIGHTING/entity_types/LT.yaml | 21 +++++++++----- .../resources/LIGHTING/entity_types/LTB.yaml | 4 --- .../resources/LIGHTING/entity_types/LTGW.yaml | 7 ++++- 6 files changed, 44 insertions(+), 23 deletions(-) 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 4c2d33d4e..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: @@ -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 79bfe11df..94eb09d85 100644 --- a/ontology/yaml/resources/LIGHTING/entity_types/LKP.yaml +++ b/ontology/yaml/resources/LIGHTING/entity_types/LKP.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 Keypads LKP_SCZ_DC: diff --git a/ontology/yaml/resources/LIGHTING/entity_types/LT.yaml b/ontology/yaml/resources/LIGHTING/entity_types/LT.yaml index 825d94cbe..2759840ac 100644 --- a/ontology/yaml/resources/LIGHTING/entity_types/LT.yaml +++ b/ontology/yaml/resources/LIGHTING/entity_types/LT.yaml @@ -12,6 +12,9 @@ # See the License for the specific language governing permissions and # limitations under the License. +######################## +### Canonical Types ### +######################## LT_SS: guid: "75cb78f1-63d6-4442-9e05-2ee0d9b24360" @@ -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 18aa2c34b..9f8c7d7e1 100644 --- a/ontology/yaml/resources/LIGHTING/entity_types/LTB.yaml +++ b/ontology/yaml/resources/LIGHTING/entity_types/LTB.yaml @@ -26,7 +26,3 @@ LTB_SS: 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"