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