Rename and restructure temperature setpoints (#506)

* restructure zone air temperature setpoint class

* add occupied and unoccupied to common zone air temperature setpoint class

* fix elements inside parents list

* Deprecate zone air temperature setpoint classes

* Add standby mode for zone air temperature setpoints

* Rename 'Common' to 'Target'

* Deprecate effective cooling/heating air temperature setpoints

* Add definitions for air temperature setpoints

* Deprecate air temperature setpoints

* Remove `(Unocc/Occ)upied_Air_Temperature_Setpoint` and subclasses

* Add occupied/unoccupied air temperature setpoint

bricksrc/definitions.csv

@@ -190,6 +190,7 @@ https://brickschema.org/schema/Brick#Cooling_Temperature_Setpoint,Sets temperatu
 https://brickschema.org/schema/Brick#Cooling_Tower,"A cooling tower is a heat rejection device that rejects waste heat to the atmosphere through the cooling of a water stream to a lower temperature. Cooling towers may either use the evaporation of water to remove process heat and cool the working fluid to near the wet-bulb air temperature or, in the case of closed circuit dry cooling towers, rely solely on air to cool the working fluid to near the dry-bulb air temperature.",https://en.wikipedia.org/wiki/Cooling_tower
 https://brickschema.org/schema/Brick#Cooling_Tower_Fan,A fan that pulls air through a cooling tower and across the louvers where the water falls to aid in heat exchange by the process of evaporation,https://highperformancehvac.com/cooling-tower-fan/
 https://brickschema.org/schema/Brick#Cooling_Valve,A valve that controls air temperature by modulating the amount of cold water flowing through a cooling coil,
+https://brickschema.org/schema/Brick#Cooling_Zone_Air_Temperature_Setpoint,The cooling setpoint for a specific zone in a building.,
 https://brickschema.org/schema/Brick#Copy_Room,"A room set aside for common office equipment, including printers and copiers",
 https://brickschema.org/schema/Brick#Core_Temperature_Sensor,Measures the internal temperature of the radiant layer at the heat source or sink level of the radiant heating and cooling HVAC system.,
 https://brickschema.org/schema/Brick#Core_Temperature_Setpoint,"Sets temperature for the core, i.e. the temperature at the heat source or sink level, of the radiant panel.",
@@ -303,9 +304,10 @@ https://brickschema.org/schema/Brick#Duration_Sensor,Measures the duration of a
 https://brickschema.org/schema/Brick#ESS_Panel,See Embedded_Surface_System_Panel,
 https://brickschema.org/schema/Brick#Economizer,"Device that, on proper variable sensing, initiates control signals or actions to conserve energy. A control system that reduces the mechanical heating and cooling requirement.",
 https://brickschema.org/schema/Brick#Economizer_Damper,A damper that is part of an economizer that is used to module the flow of air,
-https://brickschema.org/schema/Brick#Effective_Air_Temperature_Cooling_Setpoint,,
-https://brickschema.org/schema/Brick#Effective_Air_Temperature_Heating_Setpoint,,
 https://brickschema.org/schema/Brick#Effective_Air_Temperature_Setpoint,,
+https://brickschema.org/schema/Brick#Effective_Cooling_Zone_Air_Temperature_Setpoint,"The effective cooling setpoint for a specific zone in a building.",
+https://brickschema.org/schema/Brick#Effective_Heating_Zone_Air_Temperature_Setpoint,"The effective heating setpoint for a specific zone in a building.",
+https://brickschema.org/schema/Brick#Effective_Target_Zone_Air_Temperature_Setpoint,"Target Setpoint (also known as Common Setpoint) is a reference point representing the desired air temperature in a specific zone of a building. This setpoint acts as a baseline from which the cooling and heating setpoints are established by adding or subtracting a deadband width",
 https://brickschema.org/schema/Brick#Electric_Baseboard_Radiator,Electric heating device located at or near the floor,
 https://brickschema.org/schema/Brick#Electric_Boiler,"A closed, pressure vessel that uses electricity for heating water or other fluids to supply steam or hot water for heating, humidification, or other applications.",
 https://brickschema.org/schema/Brick#Electric_Current,,
@@ -492,6 +494,7 @@ https://brickschema.org/schema/Brick#Heating_Temperature_Setpoint,Sets temperatu
 https://brickschema.org/schema/Brick#Heating_Thermal_Power_Sensor,,
 https://brickschema.org/schema/Brick#Heating_Valve,A valve that controls air temperature by modulating the amount of hot water flowing through a heating coil,
 https://brickschema.org/schema/Brick#Heating_Ventilation_Air_Conditioning_System,"The equipment, distribution systems and terminals that provide, either collectively or individually, the processes of heating, ventilating or air conditioning to a building or portion of a building",
+https://brickschema.org/schema/Brick#Heating_Zone_Air_Temperature_Setpoint,The heating setpoint for a specific zone in a building.,
 https://brickschema.org/schema/Brick#High_Air_Flow_Alarm,An alarm that indicates that the air flow is higher than normal.,
 https://brickschema.org/schema/Brick#High_CO2_Alarm,A device that indicates high concentration of carbon dioxide.,
 https://brickschema.org/schema/Brick#High_Discharge_Air_Temperature_Alarm,An alarm that indicates that discharge air temperature is too high,
@@ -727,14 +730,17 @@ https://brickschema.org/schema/Brick#Occupied_Cooling_Discharge_Air_Flow_Setpoin
 https://brickschema.org/schema/Brick#Occupied_Cooling_Supply_Air_Flow_Setpoint,Sets supply air flow rate for cooling when occupied,
 https://brickschema.org/schema/Brick#Occupied_Cooling_Temperature_Deadband_Setpoint,Sets the size of a deadband of temperature for cooling when occupied,
 https://brickschema.org/schema/Brick#Occupied_Cooling_Temperature_Setpoint,Sets temperature for cooling when occupied,
+https://brickschema.org/schema/Brick#Occupied_Cooling_Zone_Air_Temperature_Setpoint,Sets temperature for zone air cooling when occupied,
 https://brickschema.org/schema/Brick#Occupied_Discharge_Air_Flow_Setpoint,Sets discharge air flow when occupied,
 https://brickschema.org/schema/Brick#Occupied_Heating_Discharge_Air_Flow_Setpoint,Sets discharge air flow for heating when occupied,
 https://brickschema.org/schema/Brick#Occupied_Heating_Supply_Air_Flow_Setpoint,Sets supply air flow rate for heating when occupied,
 https://brickschema.org/schema/Brick#Occupied_Heating_Temperature_Deadband_Setpoint,Sets the size of a deadband of temperature for heating when occupied,
 https://brickschema.org/schema/Brick#Occupied_Heating_Temperature_Setpoint,Sets temperature for heating when occupied,
+https://brickschema.org/schema/Brick#Occupied_Heating_Zone_Air_Temperature_Setpoint,Sets temperature for zone air heating when occupied,
 https://brickschema.org/schema/Brick#Occupied_Humidity_Setpoint,Target humidity level when the location is occupied.,
 https://brickschema.org/schema/Brick#Occupied_Mode_Status,"Indicates if a system, device or control loop is in ""Occupied"" mode",
 https://brickschema.org/schema/Brick#Occupied_Supply_Air_Flow_Setpoint,Sets supply air flow rate when occupied,
+https://brickschema.org/schema/Brick#Occupied_Target_Zone_Air_Temperature_Setpoint,Target Setpoint (also known as Common Setpoint) is a reference point representing the desired occupied air temperature in a specific zone of a building. This setpoint acts as a baseline from which deadband setpoints are established by adding or subtracting a deadband width.,
 https://brickschema.org/schema/Brick#Off_Command,"An Off Command controls or reports the binary 'off' status of a control loop, relay or equipment activity. It can only be used to stop/deactivate an associated equipment or process, or determine that the related entity is 'off'",
 https://brickschema.org/schema/Brick#Off_Status,"Indicates if a control loop, relay or equipment is off",
 https://brickschema.org/schema/Brick#Office,A class of rooms dedicated for work or study,
@@ -1057,14 +1063,15 @@ https://brickschema.org/schema/Brick#Underfloor_Air_Plenum_Static_Pressure_Senso
 https://brickschema.org/schema/Brick#Underfloor_Air_Plenum_Static_Pressure_Setpoint,Sets the underfloor air plenum static pressure,
 https://brickschema.org/schema/Brick#Underfloor_Air_Temperature_Sensor,Measures the temperature of underfloor air,
 https://brickschema.org/schema/Brick#Unit_Failure_Alarm,An alarm that indicates the failure of an equipment or device,
-https://brickschema.org/schema/Brick#Unoccupied_Air_Temperature_Cooling_Setpoint,Sets temperature of air when unoccupied for cooling,
-https://brickschema.org/schema/Brick#Unoccupied_Air_Temperature_Heating_Setpoint,Sets temperature of air when unoccupied for heating,
 https://brickschema.org/schema/Brick#Unoccupied_Air_Temperature_Setpoint,Sets temperature of air when unoccupied,
 https://brickschema.org/schema/Brick#Unoccupied_Cooling_Discharge_Air_Flow_Setpoint,Sets discharge air flow for cooling when unoccupied,
 https://brickschema.org/schema/Brick#Unoccupied_Cooling_Mode_Status,"Indicates whether a system, device or control loop is in an unoccupied cooling mode",
+https://brickschema.org/schema/Brick#Unoccupied_Cooling_Zone_Air_Temperature_Setpoint,Sets temperature of air when unoccupied for cooling within a specific zone,
 https://brickschema.org/schema/Brick#Unoccupied_Heating_Mode_Status,"Indicates whether a system, device or control loop is in an unoccupied heating mode",
+https://brickschema.org/schema/Brick#Unoccupied_Heating_Zone_Air_Temperature_Setpoint,Sets temperature of air when unoccupied for heating within a specific zone,
 https://brickschema.org/schema/Brick#Unoccupied_Humidity_Setpoint,Target humidity level when the location is unoccupied.,
 https://brickschema.org/schema/Brick#Unoccupied_Load_Shed_Command,,
+https://brickschema.org/schema/Brick#Unoccupied_Target_Zone_Air_Temperature_Setpoint,Target Setpoint (also known as Common Setpoint) is a reference point representing the desired unoccupied air temperature in a specific zone of a building. This setpoint acts as a baseline from which deadband setpoints are established by adding or subtracting a deadband width.,
 https://brickschema.org/schema/Brick#Usage_Sensor,"Measures the amount of some substance that is consumed or used, over some period of time",
 https://brickschema.org/schema/Brick#VAV,See Variable_Air_Volume_Box,
 https://brickschema.org/schema/Brick#VFD,"Electronic device that varies its output frequency to vary the rotating speed of a motor, given a fixed input frequency. Used with fans or pumps to vary the flow in the system as a function of a maintained pressure.",https://xp20.ashrae.org/terminology/index.php?term=vfd&submit=Search

bricksrc/deprecations.py

@@ -1,6 +1,78 @@
 from .namespaces import BRICK, RDFS, SKOS, A
 
 deprecations = {
+    BRICK.Occupied_Air_Temperature_Cooling_Setpoint: {
+            "version": "1.3.0",
+            "mitigation_message": "'Occupied_Air_Temperature_Cooling_Setpoint' is deprecated in favor of further specifying that it is a zone air setpoint.",
+            "replace_with": BRICK.Occupied_Cooling_Zone_Air_Temperature_Setpoint,
+            RDFS.subClassOf: BRICK.Occupied_Air_Temperature_Setpoint,
+        },
+    BRICK.Occupied_Air_Temperature_Heating_Setpoint: {
+            "version": "1.3.0",
+            "mitigation_message": "'Occupied_Air_Temperature_Heating_Setpoint' is deprecated in favor of further specifying that it is a zone air setpoint.",
+            "replace_with": BRICK.Occupied_Heating_Zone_Air_Temperature_Setpoint,
+            RDFS.subClassOf: BRICK.Occupied_Air_Temperature_Setpoint,
+        },
+    BRICK.Unoccupied_Air_Temperature_Cooling_Setpoint: {
+            "version": "1.3.0",
+            "mitigation_message": "'Unoccupied_Air_Temperature_Cooling_Setpoint' is deprecated in favor of further specifying that it is a zone air setpoint.",
+            "replace_with": BRICK.Unoccupied_Cooling_Zone_Air_Temperature_Setpoint,
+            RDFS.subClassOf: BRICK.Unoccupied_Air_Temperature_Setpoint,
+        },
+    BRICK.Unoccupied_Air_Temperature_Heating_Setpoint: {
+            "version": "1.3.0",
+            "mitigation_message": "'Unoccupied_Air_Temperature_Heating_Setpoint' is deprecated in favor of further specifying that it is a zone air setpoint.",
+            "replace_with": BRICK.Unoccupied_Heating_Zone_Air_Temperature_Setpoint,
+            RDFS.subClassOf: BRICK.Unoccupied_Air_Temperature_Setpoint,
+        },
+    BRICK.Effective_Air_Temperature_Cooling_Setpoint: {
+        "version": "1.3.0",
+        "mitigation_message": "The class 'Effective_Air_Temperature_Cooling_Setpoint' is deprecated in favor of further specifying that it is a zone air setpoint.",
+        "replace_with": BRICK.Effective_Cooling_Zone_Air_Temperature_Setpoint,
+        RDFS.subClassOf: BRICK.Effective_Air_Temperature_Setpoint,
+    },
+    BRICK.Effective_Air_Temperature_Heating_Setpoint: {
+        "version": "1.3.0",
+        "mitigation_message": "The class 'Effective_Air_Temperature_Heating_Setpoint' is deprecated in favor of further specifying that it is a zone air setpoint.",
+        "replace_with": BRICK.Effective_Heating_Zone_Air_Temperature_Setpoint,
+        RDFS.subClassOf: BRICK.Effective_Air_Temperature_Setpoint,
+    },
+    BRICK.Zone_Air_Temperature_Setpoint: {
+        "version": "1.3.0",
+        "mitigation_message": "The class 'Zone_Air_Temperature_Setpoint' is deprecated in favor of more explicit class names to distinguish target and cooling/heating setpoints.",
+        "replace_with": BRICK.Target_Zone_Air_Temperature_Setpoint,
+        RDFS.subClassOf: BRICK.Air_Temperature_Setpoint,
+    },
+    BRICK.Effective_Zone_Air_Temperature_Setpoint: {
+        "version": "1.3.0",
+        "mitigation_message": "The class 'Effective_Zone_Air_Temperature_Setpoint' is deprecated and replaced to better represent its function as a target setpoint",
+        "replace_with": BRICK.Effective_Target_Zone_Air_Temperature_Setpoint,
+        RDFS.subClassOf: BRICK.Zone_Air_Temperature_Setpoint,
+    },
+    BRICK.Occupied_Zone_Air_Temperaure_Setpoint: {
+        "version": "1.3.0",
+        "mitigation_message": "'Occupied_Zone_Air_Temperature_Setpoint' is deprecated in favor of further specifying that it is a target setpoint",
+        "replace_with": BRICK.Occupied_Target_Zone_Air_Temperature_Setpoint,
+        RDFS.subClassOf: BRICK.Zone_Air_Temperature_Setpoint,
+    },
+    BRICK.Unoccupied_Zone_Air_Temperature_Setpoint: {
+        "version": "1.3.0",
+        "mitigation_message": "'Unoccupied_Zone_Air_Temperature_Setpoint' is deprecated in favor of further specifying that it is a target setpoint",
+        "replace_with": BRICK.Unoccupied_Target_Zone_Air_Temperature_Setpoint,
+        RDFS.subClassOf: BRICK.Zone_Air_Temperature_Setpoint,
+    },
+    BRICK.Zone_Air_Cooling_Temperature_Setpoint: {
+        "version": "1.3.0",
+        "mitigation_message": "'Zone_Air_Cooling_Temperature_Setpoint' is deprecated to support new naming convention, which reorders intended behaviour (cooling) before the substance (zone air).",
+        "replace_with": BRICK.Cooling_Zone_Air_Temperature_Setpoint,
+        RDFS.subClassOf: BRICK.Zone_Air_Temperature_Setpoint,
+    },
+    BRICK.Zone_Air_Heating_Temperature_Setpoint: {
+        "version": "1.3.0",
+        "mitigation_message": "'Zone_Air_Heating_Temperature_Setpoint' is deprecated to support new naming convention, whic reorders intended behaviour (heating) before the substance (zone air)",
+        "replace_with": BRICK.Heating_Zone_Air_Temperature_Setpoint,
+        RDFS.subClassOf: BRICK.Zone_Air_Temperature_Setpoint,
+    },
     BRICK.Fresh_Air_Fan: {
         "version": "1.3.0",
         "mitigation_message": "Fresh Air Fan is deprecated in favor of Outside Fan because the latter is a more accurate representation",