Rename and restructure temperature setpoints #506
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
Certainly no objection to guiding us more towards consistent names, especially where we're using the same set of words just perhaps in a different order. Jason, Klaus, and I briefly talked about this and one thing that we'd want to dig into is using something like 223 to describe some aspects of the class - I don't mind if the names of the classes are constructed sensibly but we never want any developer to try to 'parse' the classnames to extract any meaning from them (we never want to see something like I think the occupied/unoccupied/standby are sufficiently common that we should have those as prepackaged classes. Of the non-deprecated classes on your list, which ones are new? |
|
I was curious how well the proposed new convention would fit with the other Setpoint classes, so here's my attempt at parsing the class names: (Click to expand)Of the 237 class names, 159 fit the convention. Here are the 78 that don't: (Click to expand)Overall I think this PR is going in a very good direction and would like to see the other setpoint classes adjusted in the same way. Small observation: The |
I agree, I don't see a need to parse by classname. This proposal is mainly to establish a naming convention
For more details, you can see the newly added definitions inside |
|
Thank you @ektrah. I appreciate your feedback.
I propose that we use exclusively elemental terms, such as "air", "water", etc., to represent substances. The term "where" indicates the context in which the substance is being utilized, be it Discharge, Return, or Zone. Thanks for identifying the remaining class names! This initial PR was primarily focused on occupancy and zone air temperature. Perhaps we could arrange a meeting to discuss possible solutions with the committee. By the way, I noticed several class names are included in the PR, such as |
|
If there are no objections, I'm ok with using the Brick meeting this Friday to discuss the the remaining class names and how to handle them. (@jbkoh can send you the invite info, @connorjcantrell) This is great work to have going into Brick -- thanks @connorjcantrell! |
|
Another option would be to use one of the working groups: https://brickschema.org/blog/working-groups/ Feel free to show up to any of them @connorjcantrell ! |
|
Here is the script that I used to generate the above lists: https://gist.github.com/ektrah/956c5c811797ab482bb6c3bb9169d7d7 |
|
https://clockworksanalytics.com/temperature-setpoints-clockworks-approach/ is another resource we might refer folks to in the documentation for how to model setpoints |
|
I have revised the remaining classes that are incompatible with our newly defined convention, as seen in this commit (bd56ba1). Their alternatives can be viewed within deprecations.py. Based on our discussion in our last meeting a couple weeks ago, we have chosen to focus our attention on temperature setpoint related with zones. I'd like to confirm - do we all agree that this branch effectively addresses all zone-related concepts? |
|
It looks good to me, but it would be great to re-run @ektrah's script to see what is changed. Do you have cycles for that @connorjcantrell? I'm ok with merging this w/ the scope of air temp setpoints, but we should eventually carry this structure over to non-air and non-temperature setpoints too (does not have to be this PR) |
|
I'm also looking into why the test are failing and will let you know if I find anything |
|
Parsed class names: (Click to expand)Of the 231 class names, 157 fit the convention. Here are the 74 that don't: (Click to expand) |
|
Diff from main branch: (Click to expand) Current_Ratio_(class:Setpoint)
(quantity:Voltage)_Ratio_(class:Setpoint)
(quantity:Frequency)_(class:Setpoint)
(quantity:Illuminance)_(class:Setpoint)
(quantity:Enthalpy)_(class:Setpoint)
(quantity:Dewpoint)_(class:Setpoint)
(class:Demand_Setpoint)
(effect:Cooling)_(class:Demand_Setpoint)
(effect:Heating)_(class:Demand_Setpoint)
Preheat_(class:Demand_Setpoint)
(substance:Air)_(quantity:Flow)_(class:Demand_Setpoint)
+ (substance:Discharge_Air)_(quantity:Flow)_(class:Demand_Setpoint)
(substance:Supply_Air)_(quantity:Flow)_(class:Demand_Setpoint)
Damper_(quantity:Position)_(class:Setpoint)
(class:Deadband_Setpoint)
(quantity:Humidity)_(class:Deadband_Setpoint)
(quantity:Temperature)_(class:Deadband_Setpoint)
(when:Occupied)_(effect:Cooling)_(quantity:Temperature)_(class:Deadband_Setpoint)
(when:Occupied)_(effect:Heating)_(quantity:Temperature)_(class:Deadband_Setpoint)
(when:Unoccupied)_(effect:Cooling)_(quantity:Temperature)_(class:Deadband_Setpoint)
(when:Unoccupied)_(effect:Heating)_(quantity:Temperature)_(class:Deadband_Setpoint)
+ (substance:Discharge_Air)_(quantity:Temperature)_(class:Deadband_Setpoint)
+ (effect:Heating)_(substance:Discharge_Air)_(quantity:Temperature)_(class:Deadband_Setpoint)
+ (effect:Cooling)_(substance:Discharge_Air)_(quantity:Temperature)_(class:Deadband_Setpoint)
(substance:Supply_Air)_(quantity:Temperature)_(class:Deadband_Setpoint)
(effect:Heating)_(substance:Supply_Air)_(quantity:Temperature)_(class:Deadband_Setpoint)
(effect:Cooling)_(substance:Supply_Air)_(quantity:Temperature)_(class:Deadband_Setpoint)
(substance:Entering_Water)_(quantity:Temperature)_(class:Deadband_Setpoint)
(substance:Leaving_Water)_(quantity:Temperature)_(class:Deadband_Setpoint)
(substance:Air)_(quantity:Flow)_(class:Deadband_Setpoint)
(substance:Exhaust_Air)_Stack_(quantity:Flow)_(class:Deadband_Setpoint)
(quantity:Static_Pressure)_(class:Deadband_Setpoint)
+ (substance:Discharge_Air)_(quantity:Static_Pressure)_(class:Deadband_Setpoint)
(substance:Supply_Air)_(quantity:Static_Pressure)_(class:Deadband_Setpoint)
(quantity:Flow)_(class:Setpoint)
(substance:Air)_(quantity:Flow)_(class:Setpoint)
(substance:Air)_(quantity:Flow)_(class:Demand_Setpoint)
+ (substance:Discharge_Air)_(quantity:Flow)_(class:Setpoint)
+ (substance:Discharge_Air)_(quantity:Flow)_(class:Demand_Setpoint)
+ (when:Occupied)_(substance:Discharge_Air)_(quantity:Flow)_(class:Setpoint)
+ (when:Occupied)_(effect:Cooling)_(substance:Discharge_Air)_(quantity:Flow)_(class:Setpoint)
+ (when:Occupied)_(effect:Heating)_(substance:Discharge_Air)_(quantity:Flow)_(class:Setpoint)
+ (when:Unoccupied)_(substance:Discharge_Air)_(quantity:Flow)_(class:Setpoint)
+ (when:Unoccupied)_(effect:Cooling)_(substance:Discharge_Air)_(quantity:Flow)_(class:Setpoint)
+ (when:Unoccupied)_(effect:Heating)_(substance:Discharge_Air)_(quantity:Flow)_(class:Setpoint)
+ (effect:Cooling)_(substance:Discharge_Air)_(quantity:Flow)_(class:Setpoint)
+ (effect:Heating)_(substance:Discharge_Air)_(quantity:Flow)_(class:Setpoint)
(substance:Exhaust_Air)_(quantity:Flow)_(class:Setpoint)
(substance:Exhaust_Air)_Stack_(quantity:Flow)_(class:Setpoint)
(substance:Outside_Air)_(quantity:Flow)_(class:Setpoint)
(substance:Supply_Air)_(quantity:Flow)_(class:Setpoint)
(substance:Supply_Air)_(quantity:Flow)_(class:Demand_Setpoint)
(when:Occupied)_(substance:Supply_Air)_(quantity:Flow)_(class:Setpoint)
(when:Occupied)_(effect:Cooling)_(substance:Supply_Air)_(quantity:Flow)_(class:Setpoint)
(when:Occupied)_(effect:Heating)_(substance:Supply_Air)_(quantity:Flow)_(class:Setpoint)
(when:Unoccupied)_(substance:Supply_Air)_(quantity:Flow)_(class:Setpoint)
(when:Unoccupied)_(effect:Cooling)_(substance:Supply_Air)_(quantity:Flow)_(class:Setpoint)
(when:Unoccupied)_(effect:Heating)_(substance:Supply_Air)_(quantity:Flow)_(class:Setpoint)
(effect:Cooling)_(substance:Supply_Air)_(quantity:Flow)_(class:Setpoint)
(effect:Heating)_(substance:Supply_Air)_(quantity:Flow)_(class:Setpoint)
(substance:Water)_(quantity:Flow)_(class:Setpoint)
(substance:Condenser_Water)_(quantity:Flow)_(class:Setpoint)
(substance:Entering_Water)_(quantity:Flow)_(class:Setpoint)
(substance:Entering_Chilled_Water)_(quantity:Flow)_(class:Setpoint)
(substance:Entering_Hot_Water)_(quantity:Flow)_(class:Setpoint)
(substance:Leaving_Water)_(quantity:Flow)_(class:Setpoint)
(substance:Leaving_Chilled_Water)_(quantity:Flow)_(class:Setpoint)
(substance:Leaving_Hot_Water)_(quantity:Flow)_(class:Setpoint)
(substance:Hot_Water)_(quantity:Flow)_(class:Setpoint)
(substance:Chilled_Water)_(quantity:Flow)_(class:Setpoint)
(substance:Bypass_Water)_(quantity:Flow)_(class:Setpoint)
(quantity:Humidity)_(class:Setpoint)
(when:Unoccupied)_(quantity:Humidity)_(class:Setpoint)
(when:Occupied)_(quantity:Humidity)_(class:Setpoint)
(substance:Bypass_Air)_(quantity:Humidity)_(class:Setpoint)
(substance:Outside_Air)_(quantity:Humidity)_(class:Setpoint)
(substance:Zone_Air)_(quantity:Humidity)_(class:Setpoint)
(substance:Building_Air)_(quantity:Humidity)_(class:Setpoint)
+ (substance:Discharge_Air)_(quantity:Humidity)_(class:Setpoint)
(substance:Mixed_Air)_(quantity:Humidity)_(class:Setpoint)
(substance:Return_Air)_(quantity:Humidity)_(class:Setpoint)
(substance:Exhaust_Air)_(quantity:Humidity)_(class:Setpoint)
(substance:Supply_Air)_(quantity:Humidity)_(class:Setpoint)
(class:Load_Setpoint)
(class:Load_Shed_Setpoint)
Leaving_Medium_(quantity:Temperature)_(substance:Hot_Water)_(quantity:Temperature)_(class:Load_Shed_Setpoint)
Entering_Medium_(quantity:Temperature)_(substance:Hot_Water)_(quantity:Temperature)_(class:Load_Shed_Setpoint)
(quantity:Luminance)_(class:Setpoint)
(quantity:Pressure)_(class:Setpoint)
(quantity:Static_Pressure)_(class:Setpoint)
(substance:Building_Air)_(quantity:Static_Pressure)_(class:Setpoint)
(substance:Chilled_Water)_(quantity:Static_Pressure)_(class:Setpoint)
+ (substance:Discharge_Air)_(quantity:Static_Pressure)_(class:Setpoint)
(substance:Exhaust_Air)_(quantity:Static_Pressure)_(class:Setpoint)
(substance:Hot_Water)_(quantity:Static_Pressure)_(class:Setpoint)
(substance:Supply_Air)_(quantity:Static_Pressure)_(class:Setpoint)
Underfloor_(substance:Air)_Plenum_(quantity:Static_Pressure)_(class:Setpoint)
(quantity:Velocity_Pressure)_(class:Setpoint)
(class:Reset_Setpoint)
(substance:Supply_Air)_(quantity:Flow)_(class:Reset_Setpoint)
(substance:Supply_Air)_(quantity:Flow)_High_(class:Reset_Setpoint)
(substance:Supply_Air)_(quantity:Flow)_Low_(class:Reset_Setpoint)
+ (substance:Discharge_Air)_(quantity:Flow)_(class:Reset_Setpoint)
+ (substance:Discharge_Air)_(quantity:Flow)_High_(class:Reset_Setpoint)
+ (substance:Discharge_Air)_(quantity:Flow)_Low_(class:Reset_Setpoint)
(quantity:Temperature)_High_(class:Reset_Setpoint)
(substance:Leaving_Hot_Water)_(quantity:Temperature)_High_(class:Reset_Setpoint)
Leaving_Medium_(quantity:Temperature)_(substance:Hot_Water)_(quantity:Temperature)_High_(class:Reset_Setpoint)
(substance:Entering_Hot_Water)_(quantity:Temperature)_High_(class:Reset_Setpoint)
Entering_Medium_(quantity:Temperature)_(substance:Hot_Water)_(quantity:Temperature)_High_(class:Reset_Setpoint)
+ (substance:Supply_Air)_(quantity:Temperature)_High_(class:Reset_Setpoint)
(substance:Outside_Air)_(quantity:Temperature)_High_(class:Reset_Setpoint)
(substance:Return_Air)_(quantity:Temperature)_High_(class:Reset_Setpoint)
(quantity:Temperature)_Low_(class:Reset_Setpoint)
+ (substance:Supply_Air)_(quantity:Temperature)_Low_(class:Reset_Setpoint)
(substance:Leaving_Hot_Water)_(quantity:Temperature)_Low_(class:Reset_Setpoint)
Leaving_Medium_(quantity:Temperature)_(substance:Hot_Water)_(quantity:Temperature)_Low_(class:Reset_Setpoint)
(substance:Entering_Hot_Water)_(quantity:Temperature)_Low_(class:Reset_Setpoint)
Entering_Medium_(quantity:Temperature)_(substance:Hot_Water)_(quantity:Temperature)_Low_(class:Reset_Setpoint)
(substance:Outside_Air)_(quantity:Temperature)_Low_(class:Reset_Setpoint)
(substance:Return_Air)_(quantity:Temperature)_Low_(class:Reset_Setpoint)
(quantity:Speed)_(class:Setpoint)
Rated_(quantity:Speed)_(class:Setpoint)
(quantity:Temperature)_(class:Setpoint)
(substance:Air)_(quantity:Temperature)_(class:Setpoint)
+ (substance:Discharge_Air)_(quantity:Temperature)_(class:Setpoint)
+ Effective_(substance:Discharge_Air)_(quantity:Temperature)_(class:Setpoint)
+ (when:Occupied)_(substance:Discharge_Air)_(quantity:Temperature)_(class:Setpoint)
+ (when:Unoccupied)_(substance:Discharge_Air)_(quantity:Temperature)_(class:Setpoint)
+ (substance:Discharge_Air)_(quantity:Temperature)_(effect:Heating)_(class:Setpoint)
+ (substance:Discharge_Air)_(quantity:Temperature)_(effect:Cooling)_(class:Setpoint)
Effective_(substance:Air)_(quantity:Temperature)_(class:Setpoint)
- Effective_(substance:Air)_(quantity:Temperature)_(effect:Cooling)_(class:Setpoint)
- Effective_(substance:Air)_(quantity:Temperature)_(effect:Heating)_(class:Setpoint)
(substance:Mixed_Air)_(quantity:Temperature)_(class:Setpoint)
- (when:Occupied)_(substance:Air)_(quantity:Temperature)_(class:Setpoint)
- (when:Occupied)_(substance:Air)_(quantity:Temperature)_(effect:Cooling)_(class:Setpoint)
- (when:Occupied)_(substance:Air)_(quantity:Temperature)_(effect:Heating)_(class:Setpoint)
(substance:Return_Air)_(quantity:Temperature)_(class:Setpoint)
Effective_(substance:Return_Air)_(quantity:Temperature)_(class:Setpoint)
(when:Occupied)_(substance:Return_Air)_(quantity:Temperature)_(class:Setpoint)
(when:Unoccupied)_(substance:Return_Air)_(quantity:Temperature)_(class:Setpoint)
Room_(substance:Air)_(quantity:Temperature)_(class:Setpoint)
Effective_Room_(substance:Air)_(quantity:Temperature)_(class:Setpoint)
(when:Occupied)_Room_(substance:Air)_(quantity:Temperature)_(class:Setpoint)
(when:Unoccupied)_Room_(substance:Air)_(quantity:Temperature)_(class:Setpoint)
- (substance:Zone_Air)_(quantity:Temperature)_(class:Setpoint)
- Effective_(substance:Zone_Air)_(quantity:Temperature)_(class:Setpoint)
- (when:Occupied)_(substance:Zone_Air)_(quantity:Temperature)_(class:Setpoint)
- (when:Unoccupied)_(substance:Zone_Air)_(quantity:Temperature)_(class:Setpoint)
- (substance:Zone_Air)_(effect:Cooling)_(quantity:Temperature)_(class:Setpoint)
- (substance:Zone_Air)_(effect:Heating)_(quantity:Temperature)_(class:Setpoint)
+ (effect:Target)_(substance:Zone_Air)_(quantity:Temperature)_(class:Setpoint)
+ Effective_(effect:Target)_(substance:Zone_Air)_(quantity:Temperature)_(class:Setpoint)
+ (when:Occupied)_(effect:Target)_(substance:Zone_Air)_(quantity:Temperature)_(class:Setpoint)
+ (when:Unoccupied)_(effect:Target)_(substance:Zone_Air)_(quantity:Temperature)_(class:Setpoint)
+ (when:Standby)_(effect:Target)_(substance:Zone_Air)_(quantity:Temperature)_(class:Setpoint)
+ (effect:Cooling)_(substance:Zone_Air)_(quantity:Temperature)_(class:Setpoint)
+ Effective_(effect:Cooling)_(substance:Zone_Air)_(quantity:Temperature)_(class:Setpoint)
+ (when:Occupied)_(effect:Cooling)_(substance:Zone_Air)_(quantity:Temperature)_(class:Setpoint)
+ (when:Unoccupied)_(effect:Cooling)_(substance:Zone_Air)_(quantity:Temperature)_(class:Setpoint)
+ (when:Standby)_(effect:Cooling)_(substance:Zone_Air)_(quantity:Temperature)_(class:Setpoint)
+ (effect:Heating)_(substance:Zone_Air)_(quantity:Temperature)_(class:Setpoint)
+ Effective_(effect:Heating)_(substance:Zone_Air)_(quantity:Temperature)_(class:Setpoint)
+ (when:Occupied)_(effect:Heating)_(substance:Zone_Air)_(quantity:Temperature)_(class:Setpoint)
+ (when:Unoccupied)_(effect:Heating)_(substance:Zone_Air)_(quantity:Temperature)_(class:Setpoint)
+ (when:Standby)_(effect:Heating)_(substance:Zone_Air)_(quantity:Temperature)_(class:Setpoint)
(substance:Outside_Air)_(quantity:Temperature)_(class:Setpoint)
Low_(substance:Outside_Air)_(quantity:Temperature)_Enable_(class:Setpoint)
Disable_(substance:Hot_Water)_System_(substance:Outside_Air)_(quantity:Temperature)_(class:Setpoint)
Enable_(substance:Hot_Water)_System_(substance:Outside_Air)_(quantity:Temperature)_(class:Setpoint)
Open_(effect:Heating)_Valve_(substance:Outside_Air)_(quantity:Temperature)_(class:Setpoint)
(substance:Outside_Air)_Lockout_(quantity:Temperature)_(class:Setpoint)
- (when:Unoccupied)_(substance:Air)_(quantity:Temperature)_(class:Setpoint)
- (when:Unoccupied)_(substance:Air)_(quantity:Temperature)_(effect:Cooling)_(class:Setpoint)
- (when:Unoccupied)_(substance:Air)_(quantity:Temperature)_(effect:Heating)_(class:Setpoint)
(substance:Supply_Air)_(quantity:Temperature)_(class:Setpoint)
Effective_(substance:Supply_Air)_(quantity:Temperature)_(class:Setpoint)
(when:Occupied)_(substance:Supply_Air)_(quantity:Temperature)_(class:Setpoint)
(when:Unoccupied)_(substance:Supply_Air)_(quantity:Temperature)_(class:Setpoint)
(substance:Supply_Air)_(quantity:Temperature)_(effect:Heating)_(class:Setpoint)
(substance:Supply_Air)_(quantity:Temperature)_(effect:Cooling)_(class:Setpoint)
Min_(substance:Air)_(quantity:Temperature)_(class:Setpoint)
Max_(substance:Air)_(quantity:Temperature)_(class:Setpoint)
(effect:Cooling)_(quantity:Temperature)_(class:Setpoint)
(when:Occupied)_(effect:Cooling)_(quantity:Temperature)_(class:Setpoint)
(when:Unoccupied)_(effect:Cooling)_(quantity:Temperature)_(class:Setpoint)
(effect:Heating)_(quantity:Temperature)_(class:Setpoint)
(when:Occupied)_(effect:Heating)_(quantity:Temperature)_(class:Setpoint)
(when:Unoccupied)_(effect:Heating)_(quantity:Temperature)_(class:Setpoint)
Schedule_(quantity:Temperature)_(class:Setpoint)
Radiant_Panel_(quantity:Temperature)_(class:Setpoint)
Inside_Face_Surface_(quantity:Temperature)_(class:Setpoint)
Outside_Face_Surface_(quantity:Temperature)_(class:Setpoint)
Embedded_(quantity:Temperature)_(class:Setpoint)
Core_(quantity:Temperature)_(class:Setpoint)
(substance:Water)_(quantity:Temperature)_(class:Setpoint)
Domestic_(substance:Hot_Water)_(quantity:Temperature)_(class:Setpoint)
Entering_Domestic_(substance:Hot_Water)_(quantity:Temperature)_(class:Setpoint)
Leaving_Domestic_(substance:Hot_Water)_(quantity:Temperature)_(class:Setpoint)
(substance:Chilled_Water)_(quantity:Temperature)_(class:Setpoint)
(substance:Hot_Water)_(quantity:Temperature)_(class:Setpoint)
(substance:Leaving_Water)_(quantity:Temperature)_(class:Setpoint)
(substance:Leaving_Condenser_Water)_(quantity:Temperature)_(class:Setpoint)
(substance:Leaving_Hot_Water)_(quantity:Temperature)_(class:Setpoint)
(substance:Leaving_Chilled_Water)_(quantity:Temperature)_(class:Setpoint)
(substance:Entering_Condenser_Water)_(quantity:Temperature)_(class:Setpoint)
(substance:Entering_Water)_(quantity:Temperature)_(class:Setpoint)
(substance:Entering_Hot_Water)_(quantity:Temperature)_(class:Setpoint)
(substance:Entering_Chilled_Water)_(quantity:Temperature)_(class:Setpoint)
Min_(substance:Water)_(quantity:Temperature)_(class:Setpoint)
Max_(substance:Water)_(quantity:Temperature)_(class:Setpoint)
(substance:CO2)_(class:Setpoint)
(substance:Return_Air)_(substance:CO2)_(class:Setpoint)
(quantity:Time)_(class:Setpoint)
(quantity:Deceleration_Time)_(class:Setpoint)
(quantity:Acceleration_Time)_(class:Setpoint)
(class:Differential_Setpoint)
(quantity:Differential_Temperature)_(class:Setpoint)
(substance:Water)_(quantity:Differential_Temperature)_(class:Setpoint)
Differential_(substance:Air)_(quantity:Temperature)_(class:Setpoint)
Differential_(quantity:Speed)_(class:Setpoint)
(quantity:Temperature)_Differential_(class:Reset_Setpoint)
+ (substance:Discharge_Air)_(quantity:Temperature)_Reset_(class:Differential_Setpoint)
+ (substance:Discharge_Air)_(quantity:Temperature)_High_(class:Reset_Setpoint)
+ (substance:Discharge_Air)_(quantity:Temperature)_Low_(class:Reset_Setpoint)
(substance:Supply_Air)_(quantity:Temperature)_Reset_(class:Differential_Setpoint)
- (substance:Supply_Air)_(quantity:Temperature)_High_(class:Reset_Setpoint)
- (substance:Supply_Air)_(quantity:Temperature)_Low_(class:Reset_Setpoint)
(quantity:Differential_Pressure)_(class:Setpoint)
(substance:Air)_(quantity:Differential_Pressure)_(class:Setpoint)
(substance:Exhaust_Air)_(quantity:Differential_Pressure)_(class:Setpoint)
(substance:Return_Air)_(quantity:Differential_Pressure)_(class:Setpoint)
(substance:Supply_Air)_(quantity:Differential_Pressure)_(class:Setpoint)
+ (substance:Discharge_Air)_(quantity:Differential_Pressure)_(class:Setpoint)
(substance:Water)_(quantity:Differential_Pressure)_(class:Setpoint)
(substance:Chilled_Water)_(quantity:Differential_Pressure)_(class:Setpoint)
(substance:Hot_Water)_(quantity:Differential_Pressure)_(class:Setpoint)
Medium_(quantity:Temperature)_(substance:Hot_Water)_(quantity:Differential_Pressure)_(class:Setpoint)
Load_Shed_(quantity:Differential_Pressure)_(class:Setpoint)
(substance:Chilled_Water)_(quantity:Differential_Pressure)_(class:Load_Shed_Setpoint)
Medium_(quantity:Temperature)_(substance:Hot_Water)_(quantity:Differential_Pressure)_(class:Load_Shed_Setpoint)
(quantity:Differential_Pressure)_(class:Deadband_Setpoint)
(substance:Hot_Water)_(quantity:Differential_Pressure)_(class:Deadband_Setpoint)
(substance:Chilled_Water)_(quantity:Differential_Pressure)_(class:Deadband_Setpoint)
(substance:Leaving_Water)_(quantity:Differential_Pressure)_(class:Deadband_Setpoint)
(substance:Entering_Water)_(quantity:Differential_Pressure)_(class:Deadband_Setpoint)Class names that do not fit the convention: (Click to expand) (quantity:Temperature)_Differential_(class:Reset_Setpoint)
(quantity:Temperature)_High_(class:Reset_Setpoint)
(quantity:Temperature)_Low_(class:Reset_Setpoint)
(quantity:Voltage)_Ratio_(class:Setpoint)
+(substance:Discharge_Air)_(quantity:Flow)_High_(class:Reset_Setpoint)
+(substance:Discharge_Air)_(quantity:Flow)_Low_(class:Reset_Setpoint)
+(substance:Discharge_Air)_(quantity:Temperature)_(effect:Cooling)_(class:Setpoint)
+(substance:Discharge_Air)_(quantity:Temperature)_(effect:Heating)_(class:Setpoint)
+(substance:Discharge_Air)_(quantity:Temperature)_High_(class:Reset_Setpoint)
+(substance:Discharge_Air)_(quantity:Temperature)_Low_(class:Reset_Setpoint)
+(substance:Discharge_Air)_(quantity:Temperature)_Reset_(class:Differential_Setpoint)
(substance:Entering_Hot_Water)_(quantity:Temperature)_High_(class:Reset_Setpoint)
(substance:Entering_Hot_Water)_(quantity:Temperature)_Low_(class:Reset_Setpoint)
(substance:Exhaust_Air)_Stack_(quantity:Flow)_(class:Deadband_Setpoint)
(substance:Exhaust_Air)_Stack_(quantity:Flow)_(class:Setpoint)
(substance:Leaving_Hot_Water)_(quantity:Temperature)_High_(class:Reset_Setpoint)
(substance:Leaving_Hot_Water)_(quantity:Temperature)_Low_(class:Reset_Setpoint)
(substance:Outside_Air)_(quantity:Temperature)_High_(class:Reset_Setpoint)
(substance:Outside_Air)_(quantity:Temperature)_Low_(class:Reset_Setpoint)
(substance:Outside_Air)_Lockout_(quantity:Temperature)_(class:Setpoint)
(substance:Return_Air)_(quantity:Temperature)_High_(class:Reset_Setpoint)
(substance:Return_Air)_(quantity:Temperature)_Low_(class:Reset_Setpoint)
(substance:Return_Air)_(substance:CO2)_(class:Setpoint)
(substance:Supply_Air)_(quantity:Flow)_High_(class:Reset_Setpoint)
(substance:Supply_Air)_(quantity:Flow)_Low_(class:Reset_Setpoint)
(substance:Supply_Air)_(quantity:Temperature)_(effect:Cooling)_(class:Setpoint)
(substance:Supply_Air)_(quantity:Temperature)_(effect:Heating)_(class:Setpoint)
(substance:Supply_Air)_(quantity:Temperature)_High_(class:Reset_Setpoint)
(substance:Supply_Air)_(quantity:Temperature)_Low_(class:Reset_Setpoint)
(substance:Supply_Air)_(quantity:Temperature)_Reset_(class:Differential_Setpoint)
-(substance:Zone_Air)_(effect:Cooling)_(quantity:Temperature)_(class:Setpoint)
-(substance:Zone_Air)_(effect:Heating)_(quantity:Temperature)_(class:Setpoint)
-(when:Occupied)_(substance:Air)_(quantity:Temperature)_(effect:Cooling)_(class:Setpoint)
-(when:Occupied)_(substance:Air)_(quantity:Temperature)_(effect:Heating)_(class:Setpoint)
(when:Occupied)_Room_(substance:Air)_(quantity:Temperature)_(class:Setpoint)
-(when:Unoccupied)_(substance:Air)_(quantity:Temperature)_(effect:Cooling)_(class:Setpoint)
-(when:Unoccupied)_(substance:Air)_(quantity:Temperature)_(effect:Heating)_(class:Setpoint)
(when:Unoccupied)_Room_(substance:Air)_(quantity:Temperature)_(class:Setpoint)
Core_(quantity:Temperature)_(class:Setpoint)
Current_Ratio_(class:Setpoint)
Damper_(quantity:Position)_(class:Setpoint)
Differential_(quantity:Speed)_(class:Setpoint)
Differential_(substance:Air)_(quantity:Temperature)_(class:Setpoint)
Disable_(substance:Hot_Water)_System_(substance:Outside_Air)_(quantity:Temperature)_(class:Setpoint)
Domestic_(substance:Hot_Water)_(quantity:Temperature)_(class:Setpoint)
+Effective_(effect:Cooling)_(substance:Zone_Air)_(quantity:Temperature)_(class:Setpoint)
+Effective_(effect:Heating)_(substance:Zone_Air)_(quantity:Temperature)_(class:Setpoint)
+Effective_(effect:Target)_(substance:Zone_Air)_(quantity:Temperature)_(class:Setpoint)
Effective_(substance:Air)_(quantity:Temperature)_(class:Setpoint)
-Effective_(substance:Air)_(quantity:Temperature)_(effect:Cooling)_(class:Setpoint)
-Effective_(substance:Air)_(quantity:Temperature)_(effect:Heating)_(class:Setpoint)
+Effective_(substance:Discharge_Air)_(quantity:Temperature)_(class:Setpoint)
Effective_(substance:Return_Air)_(quantity:Temperature)_(class:Setpoint)
Effective_(substance:Supply_Air)_(quantity:Temperature)_(class:Setpoint)
-Effective_(substance:Zone_Air)_(quantity:Temperature)_(class:Setpoint)
Effective_Room_(substance:Air)_(quantity:Temperature)_(class:Setpoint)
Embedded_(quantity:Temperature)_(class:Setpoint)
Enable_(substance:Hot_Water)_System_(substance:Outside_Air)_(quantity:Temperature)_(class:Setpoint)
Entering_Domestic_(substance:Hot_Water)_(quantity:Temperature)_(class:Setpoint)
Entering_Medium_(quantity:Temperature)_(substance:Hot_Water)_(quantity:Temperature)_(class:Load_Shed_Setpoint)
Entering_Medium_(quantity:Temperature)_(substance:Hot_Water)_(quantity:Temperature)_High_(class:Reset_Setpoint)
Entering_Medium_(quantity:Temperature)_(substance:Hot_Water)_(quantity:Temperature)_Low_(class:Reset_Setpoint)
Inside_Face_Surface_(quantity:Temperature)_(class:Setpoint)
Leaving_Domestic_(substance:Hot_Water)_(quantity:Temperature)_(class:Setpoint)
Leaving_Medium_(quantity:Temperature)_(substance:Hot_Water)_(quantity:Temperature)_(class:Load_Shed_Setpoint)
Leaving_Medium_(quantity:Temperature)_(substance:Hot_Water)_(quantity:Temperature)_High_(class:Reset_Setpoint)
Leaving_Medium_(quantity:Temperature)_(substance:Hot_Water)_(quantity:Temperature)_Low_(class:Reset_Setpoint)
Load_Shed_(quantity:Differential_Pressure)_(class:Setpoint)
Low_(substance:Outside_Air)_(quantity:Temperature)_Enable_(class:Setpoint)
Max_(substance:Air)_(quantity:Temperature)_(class:Setpoint)
Max_(substance:Water)_(quantity:Temperature)_(class:Setpoint)
Medium_(quantity:Temperature)_(substance:Hot_Water)_(quantity:Differential_Pressure)_(class:Load_Shed_Setpoint)
Medium_(quantity:Temperature)_(substance:Hot_Water)_(quantity:Differential_Pressure)_(class:Setpoint)
Min_(substance:Air)_(quantity:Temperature)_(class:Setpoint)
Min_(substance:Water)_(quantity:Temperature)_(class:Setpoint)
Open_(effect:Heating)_Valve_(substance:Outside_Air)_(quantity:Temperature)_(class:Setpoint)
Outside_Face_Surface_(quantity:Temperature)_(class:Setpoint)
Preheat_(class:Demand_Setpoint)
Radiant_Panel_(quantity:Temperature)_(class:Setpoint)
Rated_(quantity:Speed)_(class:Setpoint)
Room_(substance:Air)_(quantity:Temperature)_(class:Setpoint)
Schedule_(quantity:Temperature)_(class:Setpoint)
Underfloor_(substance:Air)_Plenum_(quantity:Static_Pressure)_(class:Setpoint)
-128 OK; 72 not OK; 200 total
+157 OK; 74 not OK; 231 total |
|
After looking at these changes a bit more closely, I'm good with the changes as they're mostly just renamings and it doesn't really change anyone's queries. |
|
We can merge after occupied/unoccupied air temperature setpoint classes are added back to the hierarchy. Should be a quick fix! |
|
@gtfierro My apologies for the delay on this. I will have this completed by Monday EOD |
|
No worries! Thanks for handling it |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR addresses the issue discussed here: #502
The primary concern was the inconsistent naming conventions and ambiguities in our class hierarchy, particularly regarding temperature setpoints.
We have taken steps to resolve these issues by cleaning up conflicting names and defining a clear, systematic naming convention. Our new convention follows this structure:
{When}_{Effect}_{Where}_{Substance}_{Measurement}_{PointClass}As an example,
Occupied_Cooling_Zone_Air_Temperature_Setpointwould represent a cooling setpoint for the air temperature in an occupied zone.In addition to the naming convention, we're incorporating the term "Target" into our class hierarchy to enhance clarity and precision. In this context, "Target" setpoints serve as reference points for cooling and heating setpoints, which essentially act as the upper and lower bounds of a deadband (a range within which no action is taken).
Previously, we used the term "Zone_Air_Temperature_Setpoint" to represent the target temperature setpoint a zone is expected to maintain. This led to confusion due to the term's broad scope, causing difficulties in distinguishing between generic and specific temperature setpoints.
The introduction of "Target" will serve as a specific designation for the temperature setpoint a zone is intended to maintain, simplifying our queries and bolstering the overall cohesiveness of our class hierarchy.