Skip to content

Refactor sensors #2189

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
shorowit wants to merge 17 commits into
base: address-crankcase-defrost-pan-warning
Choose a base branch
from
Draft

Refactor sensors #2189

Show file tree
Hide file tree
Changes from 8 commits
Commits
Show all changes
17 commits
Select commit Hold shift + click to select a range
22e0d23
Add site & conditioned zone sensors upfront and reuse them throughout…
shorowit Apr 7, 2026
e21cad3
Merge branch 'address-crankcase-defrost-pan-warning' of https://githu…
shorowit Apr 7, 2026
00b0769
Need to revert this change. Setpoints need to be defined before we cr…
shorowit Apr 7, 2026
27df67b
Some more reuse of sensors.
shorowit Apr 7, 2026
e28c791
Latest results.
Apr 7, 2026
79088ab
Bugfix to address difference between setpoint 'schedule value' and zo…
shorowit Apr 8, 2026
dcb5f83
Latest results.
Apr 8, 2026
668be07
Another bugfix.
shorowit Apr 8, 2026
6d269bf
Latest results.
Apr 8, 2026
d4132dc
A bit more cleanup.
shorowit Apr 8, 2026
fe90374
Latest results.
Apr 8, 2026
5577137
More bugfixes.
shorowit Apr 9, 2026
a1b4d5e
Latest results.
Apr 9, 2026
b1fd092
Bugfix.
shorowit Apr 13, 2026
f95da7d
Latest results.
Apr 13, 2026
ff80104
Fix timeseries heating/cooling setpoints reported when using on-off t…
shorowit Apr 13, 2026
a5321e3
Switch to using thermostat setpoint schedule values everywhere.
shorowit Apr 14, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
117 changes: 114 additions & 3 deletions HPXMLtoOpenStudio/measure.rb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -331,10 +331,11 @@ def create_unit_model(hpxml, hpxml_bldg, runner, model, weather, schedules_file)
SimControls.apply(model, hpxml.header)
Location.apply(model, weather, hpxml_bldg, hpxml.header)

# Conditioned space & setpoints
# Conditioned space and setpoints
spaces = {} # Map of HPXML locations => OpenStudio Space objects
Geometry.create_or_get_space(model, spaces, HPXML::LocationConditionedSpace, hpxml_bldg)
hvac_days = HVAC.apply_setpoints(runner, model, weather, spaces, hpxml_bldg, hpxml.header, schedules_file)
hvac_season_days = HVAC.apply_setpoints(runner, model, weather, spaces, hpxml_bldg, hpxml.header, schedules_file)
create_global_ems_sensors(model, spaces)

# Geometry & Enclosure
Geometry.apply_foundation_and_walls_top(hpxml_bldg, hpxml.header)
Expand All @@ -352,7 +353,7 @@ def create_unit_model(hpxml, hpxml_bldg, runner, model, weather, schedules_file)
Geometry.explode_surfaces(model, hpxml_bldg)

# HVAC
airloop_map = HVAC.apply_hvac_systems(runner, model, weather, spaces, hpxml_bldg, hpxml.header, schedules_file, hvac_days)
airloop_map = HVAC.apply_hvac_systems(runner, model, weather, spaces, hpxml_bldg, hpxml.header, schedules_file, hvac_season_days)
HVAC.apply_dehumidifiers(runner, model, spaces, hpxml_bldg, hpxml.header)
HVAC.apply_ceiling_fans(runner, model, spaces, weather, hpxml_bldg, hpxml.header, schedules_file)

Expand Down Expand Up @@ -420,6 +421,116 @@ def init(model, hpxml_bldg, hpxml_header)
hpxml_header.apply_ashrae140_assumptions = false
end
end

# Creates a variety of global EMS sensors used throughout the code. Prevents creating
# duplicate sensors for different EMS programs.
#
# @param model [OpenStudio::Model::Model] OpenStudio Model object
# @param spaces [Hash] Map of HPXML locations => OpenStudio Space objects
# @return [nil]
def create_global_ems_sensors(model, spaces)
# Create site sensors

s = Model.add_ems_sensor(
model,
name: 'out_db_s',
output_var_or_meter_name: 'Site Outdoor Air Drybulb Temperature',
key_name: 'Environment'
)
s.additionalProperties.setFeature('ObjectType', Constants::ObjectTypeSensorSiteOutdoorAirDBTemp)

s = Model.add_ems_sensor(
model,
name: 'out_rh_s',
output_var_or_meter_name: 'Site Outdoor Air Relative Humidity',
key_name: 'Environment'
)
s.additionalProperties.setFeature('ObjectType', Constants::ObjectTypeSensorSiteOutdoorAirRH)

s = Model.add_ems_sensor(
model,
name: 'out_hr_s',
output_var_or_meter_name: 'Site Outdoor Air Humidity Ratio',
key_name: 'Environment'
)
s.additionalProperties.setFeature('ObjectType', Constants::ObjectTypeSensorSiteOutdoorAirHR)

s = Model.add_ems_sensor(
model,
name: 'out_pb_s',
output_var_or_meter_name: 'Site Outdoor Air Barometric Pressure',
key_name: 'Environment'
)
s.additionalProperties.setFeature('ObjectType', Constants::ObjectTypeSensorSiteOutdoorAirBarPressure)

s = Model.add_ems_sensor(
model,
name: 'out_vw_s',
output_var_or_meter_name: 'Site Wind Speed',
key_name: 'Environment'
)
s.additionalProperties.setFeature('ObjectType', Constants::ObjectTypeSensorSiteWindSpeed)

s = Model.add_ems_sensor(
model,
name: 'ground_temp_s',
output_var_or_meter_name: 'Site Surface Ground Temperature',
key_name: nil
)
s.additionalProperties.setFeature('ObjectType', Constants::ObjectTypeSensorSiteGroundTemp)

s = Model.add_ems_sensor(
model,
name: 'mains_temp_s',
output_var_or_meter_name: 'Site Mains Water Temperature',
key_name: 'Environment'
)
s.additionalProperties.setFeature('ObjectType', Constants::ObjectTypeSensorSiteMainsWaterTemp)

# Create conditioned zone temperatures

conditioned_zone = spaces[HPXML::LocationConditionedSpace].thermalZone.get

s = Model.add_ems_sensor(
model,
name: 'in_db_s',
output_var_or_meter_name: 'Zone Mean Air Temperature',
key_name: conditioned_zone.name
)
s.additionalProperties.setFeature('ObjectType', Constants::ObjectTypeSensorIndoorAirDBTemp)

s = Model.add_ems_sensor(
model,
name: 'in_rh_s',
output_var_or_meter_name: 'Zone Air Relative Humidity',
key_name: conditioned_zone.name
)
s.additionalProperties.setFeature('ObjectType', Constants::ObjectTypeSensorIndoorAirRH)

s = Model.add_ems_sensor(
model,
name: 'in_hr_s',
output_var_or_meter_name: 'Zone Mean Air Humidity Ratio',
key_name: conditioned_zone.name
)
s.additionalProperties.setFeature('ObjectType', Constants::ObjectTypeSensorIndoorAirHR)

s = Model.add_ems_sensor(
model,
name: 'in_clg_spt_s',
output_var_or_meter_name: 'Zone Thermostat Cooling Setpoint Temperature',
key_name: conditioned_zone.name
)
s.additionalProperties.setFeature('ObjectType', Constants::ObjectTypeSensorIndoorCoolingSetpointTemp)

s = Model.add_ems_sensor(
model,
name: 'in_htg_stp_s',
output_var_or_meter_name: 'Zone Thermostat Heating Setpoint Temperature',
key_name: conditioned_zone.name
)
s.additionalProperties.setFeature('ObjectType', Constants::ObjectTypeSensorIndoorHeatingSetpointTemp)
end
end

# register the measure to be used by the application
Expand Down
22 changes: 11 additions & 11 deletions HPXMLtoOpenStudio/measure.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,8 @@
<schema_version>3.1</schema_version>
<name>hpxm_lto_openstudio</name>
<uid>b1543b30-9465-45ff-ba04-1d1f85e763bc</uid>
<version_id>cd8e4618-ee2e-4311-99be-bd83d436432e</version_id>
<version_modified>2026-04-06T15:04:56Z</version_modified>
<version_id>39662630-5222-4788-b0a9-94925fa375a3</version_id>
<version_modified>2026-04-08T03:07:07Z</version_modified>
<xml_checksum>D8922A73</xml_checksum>
<class_name>HPXMLtoOpenStudio</class_name>
<display_name>HPXML to OpenStudio Translator</display_name>
Expand Down Expand Up @@ -211,13 +211,13 @@
<filename>measure.rb</filename>
<filetype>rb</filetype>
<usage_type>script</usage_type>
<checksum>B86AA9F1</checksum>
<checksum>0363165F</checksum>
</file>
<file>
<filename>airflow.rb</filename>
<filetype>rb</filetype>
<usage_type>resource</usage_type>
<checksum>2F17E22A</checksum>
<checksum>7660205D</checksum>
</file>
<file>
<filename>battery.rb</filename>
Expand All @@ -235,13 +235,13 @@
<filename>constants.rb</filename>
<filetype>rb</filetype>
<usage_type>resource</usage_type>
<checksum>F541060C</checksum>
<checksum>04716AF0</checksum>
</file>
<file>
<filename>constructions.rb</filename>
<filetype>rb</filetype>
<usage_type>resource</usage_type>
<checksum>207A61E6</checksum>
<checksum>62E206AC</checksum>
</file>
<file>
<filename>data/Xing_okstate_0664D_13659_Table_A-3.csv</filename>
Expand Down Expand Up @@ -391,7 +391,7 @@
<filename>geometry.rb</filename>
<filetype>rb</filetype>
<usage_type>resource</usage_type>
<checksum>CE6EE50A</checksum>
<checksum>7A2DE2D7</checksum>
</file>
<file>
<filename>hotwater_appliances.rb</filename>
Expand Down Expand Up @@ -433,7 +433,7 @@
<filename>hvac.rb</filename>
<filetype>rb</filetype>
<usage_type>resource</usage_type>
<checksum>D9826CC6</checksum>
<checksum>0F51B93D</checksum>
</file>
<file>
<filename>hvac_sizing.rb</filename>
Expand Down Expand Up @@ -499,7 +499,7 @@
<filename>output.rb</filename>
<filetype>rb</filetype>
<usage_type>resource</usage_type>
<checksum>B707C6E3</checksum>
<checksum>5C7B0C78</checksum>
</file>
<file>
<filename>psychrometrics.rb</filename>
Expand Down Expand Up @@ -703,7 +703,7 @@
<filename>vehicle.rb</filename>
<filetype>rb</filetype>
<usage_type>resource</usage_type>
<checksum>62131EE4</checksum>
<checksum>EE770A63</checksum>
</file>
<file>
<filename>version.rb</filename>
Expand All @@ -715,7 +715,7 @@
<filename>waterheater.rb</filename>
<filetype>rb</filetype>
<usage_type>resource</usage_type>
<checksum>096F8A5F</checksum>
<checksum>93E3D235</checksum>
</file>
<file>
<filename>weather.rb</filename>
Expand Down
Loading