v4.1-rc1

What's Changed

• Adds UnitHeightAboveGrade element by @shorowit in #406
• Adds a Slab/ExteriorHorizontalInsulation element by @shorowit in #411
• More window shading options by @shorowit in #418
• Allow UnitHeightAboveGrade to be negative by @shorowit in #423
• Allow 2024 for IECC climate zone year by @shorowit in #424
• Makes Window/ExteriorShading and InteriorShading more consistent by @shorowit in #427
• Window insect screens, part 2 by @shorowit in #425

Full Changelog: v4.0...v4.1

HPXML v4.0

This is the final release and includes all the changes in the release candidates. It is identical to Release Candidate 5. This change log shows everything that has changed since v3.1.

What's Changed

Breaking Changes

Moving, renaming, or deleting elements or enumerations.

• Require HVAC & water heater setpoints to be greater than zero by @shorowit in #410
• Require > 0 for some R-value elements by @shorowit in #414
• Fix WaterHeaterImprovement/PipeInsulated element by @shorowit in #401
• Various additional value constraints by @shorowit in #402
• Updating HPXML namespace and versions to v4.0 by @shorowit in #392
• Appliance minimum values by @shorowit in #398
• Portable Electric Spa Fixes by @nmerket in #395
• Support commercial water heaters by @shorowit in #334
• Battery Capacity in kWh by @shorowit in #296
• Move some FoundationWall/Slab insulation properties into their Layer elements by @yzhou601 in #215
• Remove deprecated Dehumidifier/Efficiency field by @shorowit in #345
• Remove "Loop" from Recirculation/BranchPipingLoopLength name by @shorowit in #342
• Allow additional floor types by @bpark1327 in #332
• Adds a SystemIdentifier element for Ducts by @shorowit in #350
• Standardize on Count by @shorowit in #346
• Standalone Inverter by @shorowit in #352
• Disallow zero for some elements by @shorowit in #368
• Geothermal loop by @shorowit in #367
• Fix idref attribute by @shorowit in #378
• Move MaxAmbientCOinLivingSpaceDuringAudit element by @shorowit in #377
• Generalize space heater element by @shorowit in #231
• Fix case of CEE enumeration by @shorowit in #387
• Replace Operable with FractionOperable for Windows/Skylights by @shorowit in #221
• Add PermanentSpa and PortableSpa by @joseph-robertson in #229
• Allow radiant barriers for (attic) walls/floors by @prsh5175 in #393

Non-breaking Changes

Adding elements or enumerations.

• Electric Panels by @nmerket in #420
• Allow negative Elevation values by @shorowit in #413
• Add Energy Star Cold Climate Heat Pump by @nmerket in #417
• Additional CeilingFan elements by @shorowit in #400
• Elevation field by @shorowit in #405
• Shared batteries by @shorowit in #397
• Fix RemoteReference documentation by @shorowit in #394
• Add new Battery fields by @shorowit in #344
• Add WaterHeatingSystem/MeasuredTankVolume element by @shorowit in #343
• Additional GlassType low-e enumerations by @shorowit in #331
• Update Slab/PerimeterInsulationDepth documentation. by @shorowit in #341
• New CFISControls by @shorowit in #348
• Adds FrameFloor/FloorOrCeiling element by @shorowit in #351
• Appliance DHW connections by @shorowit in #357
• Additional HPWH inputs by @shorowit in #361
• Heat pump detailed performance inputs by @shorowit in #359
• Skylight/AttachedToFloor element by @shorowit in #364
• Clarify Insulation/AssemblyEffectiveRValue for surfaces adjacent to ground by @shorowit in #365
• Soil properties by @shorowit in #373
• Add LightingGroup/Load element by @shorowit in #366
• Infiltration for multifamily buildings by @shorowit in #379
• Add elements for shared systems/appliances by @shorowit in #382
• Buried ducts by @shorowit in #376
• HPWH ducting elements by @shorowit in #383
• Add Walkout basement element by @shorowit in #384
• Add BellyAndWing foundation type and ManufacturedHomeSections by @nmerket in #360
• Additional enumerations for SFA/MF by @shorowit in #217
• Add PlugLoad/Location and FuelLoad/Location choices by @shorowit in #389
• SFA/MF Systems by @shorowit in #240
• New DuctShape element by @shorowit in #391

Maintenance Changes

Changes that shouldn't affect anything.

• Add HPXML version translator link to the README by @shorowit in #409
• Bump versions of GitHub Actions to prevent CI warnings by @shorowit in #419
• Remove unused datatypes. by @shorowit in #338
• Add combined XSD via automatic commit by @shorowit in #369
• Run CI on master branch too by @shorowit in #375
• Fix broken link in README by @nelsonauner in #381

HPXML v4.0 - Release Candidate 5

What's Changed

Breaking Changes

• Require HVAC & water heater setpoints to be greater than zero by @shorowit in #410
• Require > 0 for some R-value elements by @shorowit in #414

Non-breaking Changes

• Electric Panels by @nmerket in #420
• Allow negative Elevation values by @shorowit in #413
• Add Energy Star Cold Climate Heat Pump by @nmerket in #417

Maintenance Changes

• Add HPXML version translator link to the README by @shorowit in #409
• Bump versions of GitHub Actions to prevent CI warnings by @shorowit in #419

Full Changelog: v4.0-rc4...v4.0-rc5

HPXML v4.0 - Release Candidate 4

What's Changed

Breaking Changes

Moving, renaming, or deleting elements or enumerations.

• Fix WaterHeaterImprovement/PipeInsulated element by @shorowit in #401
• Various additional value constraints by @shorowit in #402
• Updating HPXML namespace and versions to v4.0 by @shorowit in #392

Non-breaking Changes

Adding elements or enumerations.

• Additional CeilingFan elements by @shorowit in #400
• Elevation field by @shorowit in #405

Full Changelog: v4.0-rc3...v4.0-rc4

HPXML v4.0 - Release Candidate 3

What's Changed

Breaking Changes

Moving, renaming, or deleting elements or enumerations.

• Appliance minimum values by @shorowit in #398

Non-breaking Changes

Adding elements or enumerations.

• Shared batteries by @shorowit in #397

Full Changelog: v4.0-rc2...v4.0-rc3

HPXML v4.0 - Release Candidate 2

A few minor fixes we found since v4.0-rc1:

What's Changed

Breaking Changes

• Portable Electric Spa Fixes by @nmerket in #395

Non-breaking Changes

• Fix RemoteReference documentation by @shorowit in #394

Full Changelog: v4.0-rc1...v4.0-rc2

HPXML v4.0 - Release Candidate 1

Changelog

Breaking Changes

Moving, renaming, or deleting elements or enumerations.

• Support commercial water heaters by @shorowit in #334
• Battery Capacity in kWh by @shorowit in #296
• Move some FoundationWall/Slab insulation properties into their Layer elements by @yzhou601 in #215
• Remove deprecated Dehumidifier/Efficiency field by @shorowit in #345
• Remove "Loop" from Recirculation/BranchPipingLoopLength name by @shorowit in #342
• Allow additional floor types by @bpark1327 in #332
• Adds a SystemIdentifier element for Ducts by @shorowit in #350
• Standardize on Count by @shorowit in #346
• Standalone Inverter by @shorowit in #352
• Disallow zero for some elements by @shorowit in #368
• Geothermal loop by @shorowit in #367
• Fix idref attribute by @shorowit in #378
• Move MaxAmbientCOinLivingSpaceDuringAudit element by @shorowit in #377
• Generalize space heater element by @shorowit in #231
• Fix case of CEE enumeration by @shorowit in #387
• Replace Operable with FractionOperable for Windows/Skylights by @shorowit in #221
• Add PermanentSpa and PortableSpa by @joseph-robertson in #229
• Allow radiant barriers for (attic) walls/floors by @prsh5175 in #393

Non-breaking Changes

Adding elements or enumerations.

• Add new Battery fields by @shorowit in #344
• Add WaterHeatingSystem/MeasuredTankVolume element by @shorowit in #343
• Additional GlassType low-e enumerations by @shorowit in #331
• Update Slab/PerimeterInsulationDepth documentation. by @shorowit in #341
• New CFISControls by @shorowit in #348
• Adds FrameFloor/FloorOrCeiling element by @shorowit in #351
• Appliance DHW connections by @shorowit in #357
• Additional HPWH inputs by @shorowit in #361
• Heat pump detailed performance inputs by @shorowit in #359
• Skylight/AttachedToFloor element by @shorowit in #364
• Clarify Insulation/AssemblyEffectiveRValue for surfaces adjacent to ground by @shorowit in #365
• Soil properties by @shorowit in #373
• Add LightingGroup/Load element by @shorowit in #366
• Infiltration for multifamily buildings by @shorowit in #379
• Add elements for shared systems/appliances by @shorowit in #382
• Buried ducts by @shorowit in #376
• HPWH ducting elements by @shorowit in #383
• Add Walkout basement element by @shorowit in #384
• Add BellyAndWing foundation type and ManufacturedHomeSections by @nmerket in #360
• Additional enumerations for SFA/MF by @shorowit in #217
• Add PlugLoad/Location and FuelLoad/Location choices by @shorowit in #389
• SFA/MF Systems by @shorowit in #240
• New DuctShape element by @shorowit in #391

Maintenance Changes

Changes that shouldn't affect anything.

• Remove unused datatypes. by @shorowit in #338
• Add combined XSD via automatic commit by @shorowit in #369
• Run CI on master branch too by @shorowit in #375
• Fix broken link in README by @nelsonauner in #381

New Contributors

• @bpark1327 made their first contribution in #332
• @nelsonauner made their first contribution in #381
• @prsh5175 made their first contribution in #393

Full Changelog: v3.1...v4.0

HPXML 3.1

v3.1 Changelog

• DataTypes cleanup by @shorowit in #265
• Adds wood stud wall framing type field by @shorowit in #261
• Adds storm window material field by @shorowit in #259
• Removes outdated reference to HPXML wiki by @shorowit in #258
• Requires AssemblyEffectiveRValue to be > 0 by @shorowit in #257
• Add CEER to cooling efficiency units by @yzhou601 in #254
• Adds PerformanceClass element for fenestration by @shorowit in #248
• DSE values as fractions by @shorowit in #246
• Radiant Barrier grade by @shorowit in #234
• Adobe wall type by @shorowit in #230
• RimJoist Siding/Color by @shorowit in #227
• PerformanceAdjustment clarification by @shorowit in #226
• Adds VentilationFan/Quantity by @shorowit in #225
• Adds an extension to the WaterHeating element by @shorowit in #224
• Adds Dishwasher/ClothesWasher label fields by @shorowit in #223
• Adds units to CollectorRatedOpticalEfficiency by @shorowit in #220
• Indirect water heater standby loss by @shorowit in #214
• Adds UsageBin element for water heaters by @shorowit in #276
• Adds InteriorFinish element for enclosure surfaces by @shorowit in #274
• Update IECC Year choices by @shorowit in #273
• Add Location for storm windows by @shorowit in #272
• Add Location for more appliances by @shorowit in #271
• Adds "none" as a siding type by @shorowit in #267
• HeatingSeason and CoolingSeason by @joseph-robertson in #262
• Adds clothes dryer venting fields by @shorowit in #255
• Address input vs output heating capacities by @shorowit in #249
• Continuous Integration Testing by @nmerket in #278
• Adds a window type field by @shorowit in #260
• Adds FuelLoads element (similar to PlugLoads) by @joseph-robertson in #228
• WithinInfiltrationVolume element for Attics/Foundations by @shorowit in #216
• Additional Dehumidifier properties by @shorowit in #208
• Renames BaseElements.xsd to HPXMLBaseElements.xsd. by @shorowit in #282
• Infiltration Height by @shorowit in #297
• Add FoundationWall/Type enumerations by @shorowit in #293
• AtticType/BelowApartment by @shorowit in #291
• Adds more window property choices by @shorowit in #288
• Compressor type for ACs/HPs by @shorowit in #219
• Number of units by @shorowit in #316
• [technically breaking change] Update Overhangs to use units of ft by @shorowit in #312
• Add HeatPump lockout temperature elements by @shorowit in #309
• Relax requirement for Building/Site/Address by @shorowit in #302
• MBtu units by @shorowit in #299
• Expand Building/Site by @shorowit in #301
• Clarify documentation for thickness elements by @shorowit in #314
• Adds "conditioned space" enumeration by @shorowit in #318
• [technically breaking change] Disallow zero for efficiencies by @shorowit in #319
• Adds SEER2, EER2, and HSPF2 by @shorowit in #326
• Example files and prep for v3.1 by @nmerket in #328

New Contributors

• @yzhou601 made their first contribution in #254
• @joseph-robertson made their first contribution in #262

Full Changelog: v3.0...v3.1

HPXML 3.0

v3.0 Changelog

• [breaking change] Green Building Verification from RESO #66
• [breaking change] Multiple IECC climate zones #123
• [breaking change] Addresses inconsistencies #124
• HeatingSystem/ElectricAuxiliaryEnergy #140
• Additional WaterFixture fields #142
• Clothes Washer IMEF/IWF #144
• [breaking change] Clothes Dryer CEF (and EF bugfix) #145
• Additional PV fields #147
• Additional heat pump types #148
• Add rim joists perimeter field #150
• Adds extension element for CeilingFan #151
• Add Quantity field for CeilingFan/WaterFixture #152
• Clarifies UnderSlabInsulationWidth description #153
• Adds VentilationFan/AttachedToHVACDistributionSystem #154
• Add Azimuth/Orientation to RimJoists and FoundationWalls #155
• [breaking change] Standardize Locations #156
• Adds generic "coal" fuel type #157
• Fix typo in AttachedToWaterHeatingSystem description #158
• Adds fuel type element for heat pumps #159
• Adds PV element for number of panels #160
• Adds LeakinessDescription element to doors/windows/skylights #161
• Additional heating system properties #162
• Presence of Insulation #163
• Adds InfiltrationVolume element #164
• [breaking change] Lighting fraction improvements #165
• [breaking change] Deprecates items #167
• Adds WaterHeaterInsulation fields #171
• Adds Refrigerator Type choice #173
• Adds "other" enumeration for Occupancy #175
• [breaking change] Reworking HPXML's Enclosure #181
• Update HPXML version to 3.0 #182
• [breaking change] Adds desuperheater flexibility #184
• Adds SolarThermalSystem performance elements #185
• Adds ASRE/ATRE for mechanical ventilation #186
• New DuctLocation choices #187
• [breaking change] Allow insulation location to be layer-specific #188
• [breaking change] Window/Skylight Interior Shading Fraction #189
• EV Chargers #190
• Adding customer comments element #191
• Adding house batteries #192
• Adding pipe diameter and some other elements to hydronic systems #193
• Adding dataSource attribute #194
• Door area documentation #196
• [breaking change] Fixing project ids #197
• Home Automation #198
• DHW Controllers #200
• [breaking change] Window sub-components #202
• Additional AdjacentTo enumerations #203
• Percent duct leakage #206
• [breaking change] Clarify PV inverter efficiency value #207
• updating BPI-2101 enums in GreenBuildingVerification/Type #210

HPXML 2.3

HPXML 2.3 is a backwards compatible release that adds several new features to the standard. The deadline for adoption of this version is November 1, 2018. This will ensure that senders and receivers of data will be coordinated in their upgrade efforts.

Changelog

• Clarifying documentation for BPI2400Inputs/CalibrationQualification #138
• Adding the FloorFurnace heating system type #137
• Adding optional reference to a HeatingSystem from a HeatPump to indicate that it provides backup heat #136
• Adding ModeledUsage/ElectricityDemandKW #135
• Adding ExternalResource element #134
• Adding 2x3 stud size enumeration #133
• Adding 'medium dark' to WallAndRoofColor #131
• Adding solar absorptance and emittance for non-foundation walls and roofs #129
• Adding WMO Station Number #122
• Adding Slab/Thickness #121
• Adding UniformEnergyFactor for water heaters #120
• Additional vent fan types #114
• Adding drain water heat recovery extension element #112
• Clarify hot water distribution fields #109
• Adding appliance fields #108
• Adding FuelTypesAvailable #106