Skip to content

v5.0

Latest

Choose a tag to compare

@nmerket nmerket released this 28 Aug 13:09
· 34 commits to master since this release

HPXML v5.0 is a breaking release. Every document must move to the new namespace http://hpxmlonline.com/2025/12 and declare SchemaVersion 5.0; the 4.x versions are no longer valid values.

No changes since v5.0-rc2. Here are the total changes since v4.2.

🛠️ Breaking changes

Namespace and schema version. http://hpxmlonline.com/2023/09http://hpxmlonline.com/2025/12. schemaVersionType now accepts only 5.0 (4.0, 4.1, and 4.2 were removed).

"none" is now "not present" (#451). Absence of a component is now expressed consistently, and most typed components also gained unknown and other. The none choice was removed from Wall/Siding, Wall/InteriorFinish/Type, Floor/FloorCovering, Window/InteriorShading/Type, Window/ExteriorShading/Type, BellyAndWing/BellyWrapCondition, Pool/Type, Pool/FilterType, Pool/Pumps/Pump/Type, Pool/Cleaner/Type, and Pool/Heater/Type. Also in the same change:

  • Insulation/None element → Insulation/NotPresent
  • Refrigerator/Type: uncategorizedother
  • Skylight/SolarTube boolean → Skylight/Type (fixed, venting, tubular, dome, ...)

Cool roofs are no longer a roofing material (#462, #479). cool roof was removed from Roof/RoofType. Use the new Roof/CoolRoof boolean so the actual roofing material can still be described.

Units/Value are required when their parent is present (#467), affecting AirInfiltrationMeasurement/BuildingAirLeakage, DuctLeakageMeasurement/DuctLeakage, Attic/VentilationRate, Foundation/VentilationRate, and Vehicle/FuelEconomyCombined, /FuelEconomyCity, /FuelEconomyHighway.

New elements

  • Roof/CoolRoof (#462)
  • WaterFixture/Location (#463): bathroom, kitchen, garage, basement, laundry room, outside, other
  • AirInfiltrationMeasurement/SpecificLeakageArea (#455)
  • Type on components that previously had none (#451): Freezer, CookingRange, Oven, Window/WindowFilm, Window/InsectScreen, Window/StormWindow, Skylight, PVSystem, ElectricVehicleCharger, WindTurbine, CeilingFan, PortableElectricSpa

New and corrected choices

  • WallAndRoofColor: white (#465) and medium light (#457)
  • Siding: stone veneer (#458)
  • WaterFixtureType: toilet (#480)
  • GreenBuildingVerification/Type: DOE Efficient New Home (#452)
  • Heat pump water heater OperatingMode and Voltage enumerations fixed (#466)
  • ElectricPanel/HeadroomSpaces may now be negative (#456)

What's Changed

🛠️ = breaking change

Full Changelog: v4.2...v5.0