HPXML Enclosure
The dwelling unit’s enclosure is entered in /HPXML/Building/BuildingDetails/Enclosure
.
All surfaces that bound different space types of the dwelling unit (i.e., not just thermal boundary surfaces) must be specified in the HPXML file.
For example, an attached garage would generally be defined by walls adjacent to conditioned space, walls adjacent to outdoors, a slab, and a roof or ceiling.
For software tools that do not collect sufficient inputs for every required surface, the software developers will need to make assumptions about these surfaces or collect additional input.
Interior partition surfaces (e.g., walls between rooms inside conditioned space, or the floor between two conditioned stories) can be excluded.
For single-family attached (SFA) or multifamily (MF) buildings, surfaces between unconditioned space and the neighboring unit’s same unconditioned space should set InteriorAdjacentTo
and ExteriorAdjacentTo
to the same value.
For example, a foundation wall between the unit’s vented crawlspace and the neighboring unit’s vented crawlspace would use InteriorAdjacentTo="crawlspace - vented"
and ExteriorAdjacentTo="crawlspace - vented"
.
Warning
It is the software tool’s responsibility to provide the appropriate building surfaces.
While some error-checking is in place, it is not possible to know whether some surfaces are incorrectly missing.
Also note that wall and roof surfaces do not require an azimuth to be specified.
Rather, only the windows/skylights themselves require an azimuth.
Thus, software tools can choose to use a single wall (or roof) surface to represent multiple wall (or roof) surfaces for the entire building if all their other properties (construction type, interior/exterior adjacency, etc.) are identical.
HPXML Air Infiltration
Building air leakage is entered in /HPXML/Building/BuildingDetails/Enclosure/AirInfiltration/AirInfiltrationMeasurement
.
Element |
Type |
Units |
Constraints |
Required |
Default |
Notes |
SystemIdentifier |
id |
|
|
Yes |
|
Unique identifier |
BuildingAirLeakage/UnitofMeasure |
string |
|
See |
Yes |
|
Units for air leakage |
HousePressure |
double |
Pa |
> 0 |
See |
|
House pressure with respect to outside |
BuildingAirLeakage/AirLeakage |
double |
|
> 0 |
Yes |
|
Value for air leakage |
InfiltrationVolume |
double |
ft3 |
> 0, >= ConditionedBuildingVolume |
Yes |
|
Volume associated with infiltration measurement |
HPXML Attics
If the dwelling unit has an unvented attic, whether it is within the infiltration volume is entered in /HPXML/Building/BuildingDetails/Enclosure/Attics/Attic[AtticType/Attic[Vented="false"]]
.
Element |
Type |
Units |
Constraints |
Required |
Default |
Notes |
WithinInfiltrationVolume |
boolean |
|
|
Yes |
|
In accordance with ANSI/RESNET/ICC Standard 380 |
If the dwelling unit has a vented attic, attic ventilation information can be optionally entered in /HPXML/Building/BuildingDetails/Enclosure/Attics/Attic[AtticType/Attic[Vented="true"]]/VentilationRate
.
Element |
Type |
Units |
Constraints |
Required |
Default |
Notes |
UnitofMeasure |
string |
|
See |
No |
SLA |
Units for ventilation rate |
Value |
double |
|
> 0 |
No |
1/300 |
Value for ventilation rate |
HPXML Foundations
If the dwelling unit has an unconditioned basement, whether it is within the infiltration volume is entered in Enclosure/Foundations/Foundation/FoundationType/Basement[Conditioned='false']
.
Element |
Type |
Units |
Constraints |
Required |
Default |
Notes |
WithinInfiltrationVolume |
boolean |
|
|
Yes |
|
In accordance with ANSI/RESNET/ICC Standard 380 |
If the dwelling unit has an unvented crawlspace, whether it is within the infiltration volume is entered in Enclosure/Foundations/Foundation/FoundationType/Crawlspace[Vented='false']
.
Element |
Type |
Units |
Constraints |
Required |
Default |
Notes |
WithinInfiltrationVolume |
boolean |
|
|
Yes |
|
In accordance with ANSI/RESNET/ICC Standard 380 |
If the dwelling unit has a vented crawlspace, crawlspace ventilation information can be optionally entered in /HPXML/Building/BuildingDetails/Enclosure/Foundations/Foundation[FoundationType/Crawlspace[Vented="true"]]/VentilationRate
.
Element |
Type |
Units |
Constraints |
Required |
Default |
Notes |
UnitofMeasure |
string |
|
See |
No |
SLA |
Units for ventilation rate |
Value |
double |
|
> 0 |
No |
1/150 |
Value for ventilation rate |
HPXML Roofs
Each pitched or flat roof surface that is exposed to ambient conditions is entered as an /HPXML/Building/BuildingDetails/Enclosure/Roofs/Roof
.
For a multifamily building where the dwelling unit has another dwelling unit above it, the surface between the two dwelling units should be considered a FrameFloor
and not a Roof
.
Element |
Type |
Units |
Constraints |
Required |
Default |
Notes |
SystemIdentifier |
id |
|
|
Yes |
|
Unique identifier |
InteriorAdjacentTo |
string |
|
See |
Yes |
|
Interior adjacent space type |
Area |
double |
ft2 |
> 0 |
Yes |
|
Gross area (including skylights) |
Azimuth |
integer |
deg |
0 - 359 |
No |
See |
Azimuth (clockwise from North) |
SolarAbsorptance |
double |
|
0 - 1 |
Yes |
|
Solar absorptance |
Emittance |
double |
|
0 - 1 |
Yes |
|
Emittance |
Pitch |
integer |
?:12 |
>= 0 |
Yes |
|
Pitch |
RadiantBarrier |
boolean |
|
|
Yes |
|
Presence of radiant barrier |
RadiantBarrierGrade |
integer |
|
1 - 3 |
See |
|
Radiant barrier installation grade |
Insulation/SystemIdentifier |
id |
|
|
Yes |
|
Unique identifier |
Insulation/AssemblyEffectiveRValue |
double |
F-ft2-hr/Btu |
> 0 |
Yes |
|
Assembly R-value |
HPXML Rim Joists
Each rim joist surface (i.e., the perimeter of floor joists typically found between stories of a building or on top of a foundation wall) is entered as an /HPXML/Building/BuildingDetails/Enclosure/RimJoists/RimJoist
.
Element |
Type |
Units |
Constraints |
Required |
Default |
Notes |
SystemIdentifier |
id |
|
|
Yes |
|
Unique identifier |
ExteriorAdjacentTo |
string |
|
See |
Yes |
|
Exterior adjacent space type |
InteriorAdjacentTo |
string |
|
See |
Yes |
|
Interior adjacent space type |
Area |
double |
ft2 |
> 0 |
Yes |
|
Gross area |
Azimuth |
integer |
deg |
0 - 359 |
No |
See |
Azimuth (clockwise from North) |
SolarAbsorptance |
double |
|
0 - 1 |
Yes |
|
Solar absorptance |
Emittance |
double |
|
0 - 1 |
Yes |
|
Emittance |
Insulation/SystemIdentifier |
id |
|
|
Yes |
|
Unique identifier |
Insulation/AssemblyEffectiveRValue |
double |
F-ft2-hr/Btu |
> 0 |
Yes |
|
Assembly R-value |
HPXML Walls
Each wall that has no contact with the ground and bounds a space type is entered as an /HPXML/Building/BuildingDetails/Enclosure/Walls/Wall
.
Element |
Type |
Units |
Constraints |
Required |
Default |
Notes |
SystemIdentifier |
id |
|
|
Yes |
|
Unique identifier |
ExteriorAdjacentTo |
string |
|
See |
Yes |
|
Exterior adjacent space type |
InteriorAdjacentTo |
string |
|
See |
Yes |
|
Interior adjacent space type |
WallType |
element |
|
1 |
Yes |
|
Wall type (for thermal mass) |
Area |
double |
ft2 |
> 0 |
Yes |
|
Gross area (including doors/windows) |
Azimuth |
integer |
deg |
0 - 359 |
No |
See |
Azimuth (clockwise from North) |
SolarAbsorptance |
double |
|
0 - 1 |
Yes |
|
Solar absorptance |
Emittance |
double |
|
0 - 1 |
Yes |
|
Emittance |
Insulation/SystemIdentifier |
id |
|
|
Yes |
|
Unique identifier |
Insulation/AssemblyEffectiveRValue |
double |
F-ft2-hr/Btu |
> 0 |
Yes |
|
Assembly R-value |
HPXML Foundation Walls
Each wall that is in contact with the ground should be specified as an /HPXML/Building/BuildingDetails/Enclosure/FoundationWalls/FoundationWall
.
Other walls (e.g., wood framed walls) that are connected to a below-grade space but have no contact with the ground should be specified as a Wall
and not a FoundationWall
.
Element |
Type |
Units |
Constraints |
Required |
Default |
Notes |
SystemIdentifier |
id |
|
|
Yes |
|
Unique identifier |
ExteriorAdjacentTo |
string |
|
See |
Yes |
|
Exterior adjacent space type |
InteriorAdjacentTo |
string |
|
See |
Yes |
|
Interior adjacent space type |
Height |
double |
ft |
> 0 |
Yes |
|
Total height |
Area |
double |
ft2 |
> 0 |
Yes |
|
Gross area (including doors/windows) |
Azimuth |
integer |
deg |
0 - 359 |
No |
See |
Azimuth (clockwise from North) |
Thickness |
double |
inches |
> 0 |
Yes |
|
Thickness excluding interior framing |
DepthBelowGrade |
double |
ft |
0 - Height |
Yes |
|
Depth below grade |
Insulation/SystemIdentifier |
id |
|
|
Yes |
|
Unique identifier |
Insulation/Layer[InstallationType="continuous - interior"] |
element |
|
0 - 1 |
See |
|
Interior insulation layer |
Insulation/Layer[InstallationType="continuous - exterior"] |
element |
|
0 - 1 |
See |
|
Exterior insulation layer |
Insulation/AssemblyEffectiveRValue |
double |
F-ft2-hr/Btu |
> 0 |
See |
|
Assembly R-value |
If insulation layers are provided, additional information is entered in each FoundationWall/Insulation/Layer
.
Element |
Type |
Units |
Constraints |
Required |
Default |
Notes |
NominalRValue |
double |
F-ft2-hr/Btu |
>= 0 |
Yes |
|
R-value of the foundation wall insulation; use zero if no insulation |
extension/DistanceToTopOfInsulation |
double |
ft |
>= 0 |
Yes |
|
Vertical distance from top of foundation wall to top of insulation |
extension/DistanceToBottomOfInsulation |
double |
ft |
DistanceToTopOfInsulation - Height |
Yes |
|
Vertical distance from top of foundation wall to bottom of insulation |
HPXML Frame Floors
Each horizontal floor/ceiling surface that is not in contact with the ground (Slab) nor adjacent to ambient conditions above (Roof) is entered as an /HPXML/Building/BuildingDetails/Enclosure/FrameFloors/FrameFloor
.
Element |
Type |
Units |
Constraints |
Required |
Default |
Notes |
SystemIdentifier |
id |
|
|
Yes |
|
Unique identifier |
ExteriorAdjacentTo |
string |
|
See |
Yes |
|
Exterior adjacent space type |
InteriorAdjacentTo |
string |
|
See |
Yes |
|
Interior adjacent space type |
Area |
double |
ft2 |
> 0 |
Yes |
|
Gross area |
Insulation/SystemIdentifier |
id |
|
|
Yes |
|
Unique identifier |
Insulation/AssemblyEffectiveRValue |
double |
F-ft2-hr/Btu |
> 0 |
Yes |
|
Assembly R-value |
For frame floors adjacent to “other housing unit”, “other heated space”, “other multifamily buffer space”, or “other non-freezing space”, additional information is entered in FrameFloor
.
Element |
Type |
Units |
Constraints |
Required |
Default |
Notes |
extension/OtherSpaceAboveOrBelow |
string |
|
See |
Yes |
|
Specifies if above/below the MF space type |
HPXML Slabs
Each space type that borders the ground (i.e., basements, crawlspaces, garages, and slab-on-grade foundations) should have a slab entered as an /HPXML/Building/BuildingDetails/Enclosure/Slabs/Slab
.
Element |
Type |
Units |
Constraints |
Required |
Default |
Notes |
SystemIdentifier |
id |
|
|
Yes |
|
Unique identifier |
InteriorAdjacentTo |
string |
|
See |
Yes |
|
Interior adjacent space type |
Area |
double |
ft2 |
> 0 |
Yes |
|
Gross area |
Thickness |
double |
inches |
>= 0 |
Yes |
|
Thickness |
ExposedPerimeter |
double |
ft |
>= 0 |
Yes |
|
Perimeter exposed to ambient conditions |
PerimeterInsulationDepth |
double |
ft |
>= 0 |
Yes |
|
Depth from grade to bottom of vertical insulation |
UnderSlabInsulationWidth |
double |
ft |
>= 0 |
See |
|
Width from slab edge inward of horizontal insulation |
UnderSlabInsulationSpansEntireSlab |
boolean |
|
|
See |
|
Whether horizontal insulation spans entire slab |
DepthBelowGrade |
double |
ft |
>= 0 |
See |
|
Depth from the top of the slab surface to grade |
PerimeterInsulation/SystemIdentifier |
id |
|
|
Yes |
|
Unique identifier |
PerimeterInsulation/Layer/NominalRValue |
double |
F-ft2-hr/Btu |
>= 0 |
Yes |
|
R-value of vertical insulation |
UnderSlabInsulation/SystemIdentifier |
id |
|
|
Yes |
|
Unique identifier |
UnderSlabInsulation/Layer/NominalRValue |
double |
F-ft2-hr/Btu |
>= 0 |
Yes |
|
R-value of horizontal insulation |
extension/CarpetFraction |
double |
frac |
0 - 1 |
Yes |
|
Fraction of slab covered by carpet |
extension/CarpetRValue |
double |
F-ft2-hr/Btu |
>= 0 |
Yes |
|
Carpet R-value |
HPXML Windows
Each window or glass door area is entered as an /HPXML/Building/BuildingDetails/Enclosure/Windows/Window
.
Element |
Type |
Units |
Constraints |
Required |
Default |
Notes |
SystemIdentifier |
id |
|
|
Yes |
|
Unique identifier |
Area |
double |
ft2 |
> 0 |
Yes |
|
Total area |
Azimuth |
integer |
deg |
0 - 359 |
Yes |
|
Azimuth (clockwise from North) |
UFactor |
double |
Btu/F-ft2-hr |
> 0 |
Yes |
|
Full-assembly NFRC U-factor |
SHGC |
double |
|
0 - 1 |
Yes |
|
Full-assembly NFRC solar heat gain coefficient |
Overhangs |
element |
|
0 - 1 |
No |
<none> |
Presence of overhangs (including roof eaves) |
FractionOperable |
double |
frac |
0 - 1 |
Yes |
|
Operable fraction |
PerformanceClass |
string |
|
See |
Yes |
|
Performance class |
AttachedToWall |
idref |
|
See |
Yes |
|
ID of attached wall |
If overhangs are specified, additional information is entered in Overhangs
.
Element |
Type |
Units |
Constraints |
Required |
Default |
Notes |
Depth |
double |
inches |
>= 0 |
Yes |
|
Depth of overhang |
DistanceToTopOfWindow |
double |
ft |
>= 0 |
Yes |
|
Vertical distance from overhang to top of window |
DistanceToBottomOfWindow |
double |
ft |
> DistanceToTopOfWindow |
Yes |
|
Vertical distance from overhang to bottom of window |
HPXML Skylights
Each skylight is entered as an /HPXML/Building/BuildingDetails/Enclosure/Skylights/Skylight
.
Element |
Type |
Units |
Constraints |
Required |
Default |
Notes |
SystemIdentifier |
id |
|
|
Yes |
|
Unique identifier |
Area |
double |
ft2 |
> 0 |
Yes |
|
Total area |
Azimuth |
integer |
deg |
0 - 359 |
Yes |
|
Azimuth (clockwise from North) |
UFactor |
double |
Btu/F-ft2-hr |
> 0 |
Yes |
|
Full-assembly NFRC U-factor |
SHGC |
double |
|
0 - 1 |
Yes |
|
Full-assembly NFRC solar heat gain coefficient |
AttachedToRoof |
idref |
|
See |
Yes |
|
ID of attached roof |
HPXML Doors
Each opaque door is entered as an /HPXML/Building/BuildingDetails/Enclosure/Doors/Door
.
Element |
Type |
Units |
Constraints |
Required |
Default |
Notes |
SystemIdentifier |
id |
|
|
Yes |
|
Unique identifier |
AttachedToWall |
idref |
|
See |
Yes |
|
ID of attached wall |
Area |
double |
ft2 |
> 0 |
Yes |
|
Total area |
Azimuth |
integer |
deg |
0 - 359 |
Yes |
|
Azimuth (clockwise from North) |
RValue |
double |
F-ft2-hr/Btu |
> 0 |
Yes |
|
R-value |
HPXML Systems
The dwelling unit’s systems are entered in /HPXML/Building/BuildingDetails/Systems
.
HPXML Heating Systems
Each heating system (other than a heat pump) is entered as an /HPXML/Building/BuildingDetails/Systems/HVAC/HVACPlant/HeatingSystem
.
Element |
Type |
Units |
Constraints |
Required |
Default |
Notes |
SystemIdentifier |
id |
|
|
Yes |
|
Unique identifier |
HeatingSystemType |
element |
|
1 |
Yes |
|
Type of heating system |
HeatingSystemFuel |
string |
|
See |
Yes |
|
Fuel type |
HeatingCapacity |
double |
Btu/hr |
>= 0 |
Yes |
|
Input heating capacity |
FractionHeatLoadServed |
double |
frac |
0 - 1 |
Yes |
|
Fraction of heating load served |
Electric Resistance
If electric resistance heating is specified, additional information is entered in HeatingSystem
.
Element |
Type |
Units |
Constraints |
Required |
Default |
Notes |
AnnualHeatingEfficiency[Units="Percent"]/Value |
double |
frac |
0 - 1 |
Yes |
|
Efficiency |
Furnace
If a furnace is specified, additional information is entered in HeatingSystem
.
Element |
Type |
Units |
Constraints |
Required |
Default |
Notes |
DistributionSystem |
idref |
|
See |
Yes |
|
ID of attached distribution system |
AnnualHeatingEfficiency[Units="AFUE"]/Value |
double |
frac |
0 - 1 |
Yes |
|
Rated efficiency |
extension/FanPowerWattsPerCFM or extension/FanPowerNotTested=true |
double or boolean |
W/cfm |
>= 0 |
Yes |
|
In accordance with ANSI/RESNET/ACCA 310 |
extension/AirflowDefectRatio or extension/AirflowNotTested=true |
double or boolean |
frac |
> -1 |
Yes |
|
In accordance with ANSI/RESNET/ACCA 310 |
Warning
HVAC installation quality should be provided per the conditions specified in ANSI/RESNET/ACCA 310.
OS-ERI does not check that, for example, the total duct leakage requirement has been met or that a Grade I/II input is appropriate per the ANSI 310 process flow; that is currently the responsibility of the software developer.
Wall/Floor Furnace
If a wall furnace or floor furnace is specified, additional information is entered in HeatingSystem
.
Element |
Type |
Units |
Constraints |
Required |
Default |
Notes |
AnnualHeatingEfficiency[Units="AFUE"]/Value |
double |
frac |
0 - 1 |
Yes |
|
Rated efficiency |
extension/FanPowerWatts |
double |
W |
>= 0 |
No |
0 |
Fan power |
Boiler
If a boiler is specified, additional information is entered in HeatingSystem
.
Element |
Type |
Units |
Constraints |
Required |
Default |
Notes |
IsSharedSystem |
boolean |
|
|
Yes |
|
Whether it serves multiple dwelling units |
DistributionSystem |
idref |
|
See |
Yes |
|
ID of attached distribution system |
AnnualHeatingEfficiency[Units="AFUE"]/Value |
double |
frac |
0 - 1 |
Yes |
|
Rated efficiency |
If an in-unit boiler if specified, additional information is entered in HeatingSystem
.
Element |
Type |
Units |
Constraints |
Required |
Default |
Notes |
ElectricAuxiliaryEnergy |
double |
kWh/yr |
>= 0 |
No |
See |
Electric auxiliary energy |
If instead a shared boiler is specified, additional information is entered in HeatingSystem
.
Element |
Type |
Units |
Constraints |
Required |
Default |
Notes |
NumberofUnitsServed |
integer |
|
> 1 |
Yes |
|
Number of dwelling units served |
extension/SharedLoopWatts |
double |
W |
>= 0 |
Yes |
|
Shared loop power |
extension/SharedLoopMotorEfficiency |
double |
frac |
0 - 1 |
No |
0.85 |
Shared loop motor efficiency |
extension/FanCoilWatts |
double |
W |
>= 0 |
See |
|
Fan coil power |
Stove
If a stove is specified, additional information is entered in HeatingSystem
.
Element |
Type |
Units |
Constraints |
Required |
Default |
Notes |
AnnualHeatingEfficiency[Units="Percent"]/Value |
double |
frac |
0 - 1 |
Yes |
|
Efficiency |
extension/FanPowerWatts |
double |
W |
>= 0 |
No |
40 |
Fan power |
Portable/Fixed Heater
If a portable heater or fixed heater is specified, additional information is entered in HeatingSystem
.
Element |
Type |
Units |
Constraints |
Required |
Default |
Notes |
AnnualHeatingEfficiency[Units="Percent"]/Value |
double |
frac |
0 - 1 |
Yes |
|
Efficiency |
extension/FanPowerWatts |
double |
W |
>= 0 |
No |
0 |
Fan power |
Fireplace
If a fireplace is specified, additional information is entered in HeatingSystem
.
Element |
Type |
Units |
Constraints |
Required |
Default |
Notes |
AnnualHeatingEfficiency[Units="Percent"]/Value |
double |
frac |
0 - 1 |
Yes |
|
Efficiency |
extension/FanPowerWatts |
double |
W |
>= 0 |
No |
0 |
Fan power |
HPXML Cooling Systems
Each cooling system (other than a heat pump) is entered as an /HPXML/Building/BuildingDetails/Systems/HVAC/HVACPlant/CoolingSystem
.
Element |
Type |
Units |
Constraints |
Required |
Default |
Notes |
SystemIdentifier |
id |
|
|
Yes |
|
Unique identifier |
CoolingSystemType |
string |
|
See |
Yes |
|
Type of cooling system |
CoolingSystemFuel |
string |
|
See |
Yes |
|
Fuel type |
FractionCoolLoadServed |
double |
frac |
0 - 1 |
Yes |
|
Fraction of cooling load served |
Central Air Conditioner
If a central air conditioner is specified, additional information is entered in CoolingSystem
.
Element |
Type |
Units |
Constraints |
Required |
Default |
Notes |
DistributionSystem |
idref |
|
See |
Yes |
|
ID of attached distribution system |
AnnualCoolingEfficiency[Units="SEER"]/Value |
double |
Btu/Wh |
> 0 |
Yes |
|
Rated efficiency |
CoolingCapacity |
double |
Btu/hr |
>= 0 |
Yes |
|
Cooling capacity |
SensibleHeatFraction |
double |
frac |
0 - 1 |
No |
|
Sensible heat fraction |
CompressorType |
string |
|
See |
No |
See |
Type of compressor |
extension/FanPowerWattsPerCFM or extension/FanPowerNotTested=true |
double or boolean |
W/cfm |
>= 0 |
Yes |
|
In accordance with ANSI/RESNET/ACCA 310 |
extension/AirflowDefectRatio or extension/AirflowNotTested=true |
double or boolean |
frac |
> -1 |
Yes |
|
In accordance with ANSI/RESNET/ACCA 310 |
extension/ChargeDefectRatio or extension/ChargeNotTested=true |
double or boolean |
frac |
-0.25, 0, 0.25 |
Yes |
|
In accordance with ANSI/RESNET/ACCA 310 |
Warning
HVAC installation quality should be provided per the conditions specified in ANSI/RESNET/ACCA 310.
OS-ERI does not check that, for example, the total duct leakage requirement has been met or that a Grade I/II input is appropriate per the ANSI 310 process flow; that is currently the responsibility of the software developer.
Room Air Conditioner
If a room air conditioner is specified, additional information is entered in CoolingSystem
.
Element |
Type |
Units |
Constraints |
Required |
Default |
Notes |
AnnualCoolingEfficiency[Units="EER"]/Value |
double |
Btu/Wh |
> 0 |
Yes |
|
Rated efficiency |
CoolingCapacity |
double |
Btu/hr |
>= 0 |
Yes |
|
Cooling capacity |
SensibleHeatFraction |
double |
frac |
0 - 1 |
No |
|
Sensible heat fraction |
Evaporative Cooler
If an evaporative cooler is specified, additional information is entered in CoolingSystem
.
Element |
Type |
Units |
Constraints |
Required |
Default |
Notes |
DistributionSystem |
idref |
|
See |
No |
|
ID of attached distribution system |
CoolingCapacity |
double |
Btu/hr |
>= 0 |
No |
autosized |
Cooling capacity |
Mini-Split
If a mini-split is specified, additional information is entered in CoolingSystem
.
Element |
Type |
Units |
Constraints |
Required |
Default |
Notes |
DistributionSystem |
idref |
|
See |
No |
|
ID of attached distribution system |
AnnualCoolingEfficiency[Units="SEER"]/Value |
double |
Btu/Wh |
> 0 |
Yes |
|
Rated cooling efficiency |
CoolingCapacity |
double |
Btu/hr |
>= 0 |
Yes |
|
Cooling capacity |
SensibleHeatFraction |
double |
frac |
0 - 1 |
No |
|
Sensible heat fraction |
extension/ChargeDefectRatio or extension/ChargeNotTested=true |
double or boolean |
frac |
-0.25, 0, 0.25 |
Yes |
|
In accordance with ANSI/RESNET/ACCA 310 |
If a ducted mini-split is specified (i.e., a DistributionSystem
has been entered), additional information is entered in CoolingSystem
.
Element |
Type |
Units |
Constraints |
Required |
Default |
Notes |
extension/FanPowerWattsPerCFM or extension/FanPowerNotTested=true |
double or boolean |
W/cfm |
>= 0 |
Yes |
|
In accordance with ANSI/RESNET/ACCA 310 |
extension/AirflowDefectRatio or extension/AirflowNotTested=true |
double or boolean |
frac |
> -1 |
Yes |
|
In accordance with ANSI/RESNET/ACCA 310 |
Warning
HVAC installation quality should be provided per the conditions specified in ANSI/RESNET/ACCA 310.
OS-ERI does not check that, for example, the total duct leakage requirement has been met or that a Grade I/II input is appropriate per the ANSI 310 process flow; that is currently the responsibility of the software developer.
Chiller
If a chiller is specified, additional information is entered in CoolingSystem
.
Element |
Type |
Units |
Constraints |
Required |
Default |
Notes |
IsSharedSystem |
boolean |
|
true |
Yes |
|
Whether it serves multiple dwelling units |
DistributionSystem |
idref |
|
See |
Yes |
|
ID of attached distribution system |
NumberofUnitsServed |
integer |
|
> 1 |
Yes |
|
Number of dwelling units served |
CoolingCapacity |
double |
Btu/hr |
>= 0 |
Yes |
|
Total cooling capacity |
AnnualCoolingEfficiency[Units="kW/ton"]/Value |
double |
kW/ton |
> 0 |
Yes |
|
Rated efficiency |
extension/SharedLoopWatts |
double |
W |
>= 0 |
Yes |
|
Pumping and fan power serving the system |
extension/SharedLoopMotorEfficiency |
double |
frac |
0 - 1 |
No |
0.85 |
Shared loop motor efficiency |
extension/FanCoilWatts |
double |
W |
>= 0 |
See |
|
Fan coil power |
Cooling Tower
If a cooling tower is specified, additional information is entered in CoolingSystem
.
Element |
Type |
Units |
Constraints |
Required |
Default |
Notes |
IsSharedSystem |
boolean |
|
true |
Yes |
|
Whether it serves multiple dwelling units |
DistributionSystem |
idref |
|
See |
Yes |
|
ID of attached distribution system |
NumberofUnitsServed |
integer |
|
> 1 |
Yes |
|
Number of dwelling units served |
extension/SharedLoopWatts |
double |
W |
>= 0 |
Yes |
|
Pumping and fan power serving the system |
extension/SharedLoopMotorEfficiency |
double |
frac |
0 - 1 |
No |
0.85 |
Shared loop motor efficiency |
HPXML Heat Pumps
Each heat pump is entered as an /HPXML/Building/BuildingDetails/Systems/HVAC/HVACPlant/HeatPump
.
Element |
Type |
Units |
Constraints |
Required |
Default |
Notes |
SystemIdentifier |
id |
|
|
Yes |
|
Unique identifier |
HeatPumpType |
string |
|
See |
Yes |
|
Type of heat pump |
HeatPumpFuel |
string |
|
See |
Yes |
|
Fuel type |
BackupSystemFuel |
string |
|
See |
No |
|
Fuel type of backup heating, if present |
If a backup system fuel is provided, additional information is entered in HeatPump
.
Element |
Type |
Units |
Constraints |
Required |
Default |
Notes |
BackupAnnualHeatingEfficiency[Units="Percent" or Units="AFUE"]/Value |
double |
frac |
0 - 1 |
Yes |
|
Backup heating efficiency |
BackupHeatingCapacity |
double |
Btu/hr |
>= 0 |
Yes |
|
Backup heating capacity |
BackupHeatingSwitchoverTemperature |
double |
F |
|
No |
<none> |
Backup heating switchover temperature |
Air-to-Air Heat Pump
If an air-to-air heat pump is specified, additional information is entered in HeatPump
.
Element |
Type |
Units |
Constraints |
Required |
Default |
Notes |
DistributionSystem |
idref |
|
See |
Yes |
|
ID of attached distribution system |
CompressorType |
string |
|
See |
No |
See |
Type of compressor |
HeatingCapacity |
double |
Btu/hr |
>= 0 |
Yes |
|
Heating capacity (excluding any backup heating) |
HeatingCapacity17F |
double |
Btu/hr |
>= 0 |
No |
|
Heating capacity at 17F, if available |
CoolingCapacity |
double |
Btu/hr |
>= 0 |
Yes |
|
Cooling capacity |
CoolingSensibleHeatFraction |
double |
frac |
0 - 1 |
No |
|
Sensible heat fraction |
FractionHeatLoadServed |
double |
frac |
0 - 1 |
Yes |
|
Fraction of heating load served |
FractionCoolLoadServed |
double |
frac |
0 - 1 |
Yes |
|
Fraction of cooling load served |
AnnualCoolingEfficiency[Units="SEER"]/Value |
double |
Btu/Wh |
> 0 |
Yes |
|
Rated cooling efficiency |
AnnualHeatingEfficiency[Units="HSPF"]/Value |
double |
Btu/Wh |
> 0 |
Yes |
|
Rated heating efficiency |
extension/FanPowerWattsPerCFM or extension/FanPowerNotTested=true |
double or boolean |
W/cfm |
>= 0 |
Yes |
|
In accordance with ANSI/RESNET/ACCA 310 |
extension/AirflowDefectRatio or extension/AirflowNotTested=true |
double or boolean |
frac |
> -1 |
Yes |
|
In accordance with ANSI/RESNET/ACCA 310 |
extension/ChargeDefectRatio or extension/ChargeNotTested=true |
double or boolean |
frac |
-0.25, 0, 0.25 |
Yes |
|
In accordance with ANSI/RESNET/ACCA 310 |
Warning
HVAC installation quality should be provided per the conditions specified in ANSI/RESNET/ACCA 310.
OS-ERI does not check that, for example, the total duct leakage requirement has been met or that a Grade I/II input is appropriate per the ANSI 310 process flow; that is currently the responsibility of the software developer.
Mini-Split Heat Pump
If a mini-split heat pump is specified, additional information is entered in HeatPump
.
Element |
Type |
Units |
Constraints |
Required |
Default |
Notes |
DistributionSystem |
idref |
|
See |
No |
|
ID of attached distribution system, if present |
HeatingCapacity |
double |
Btu/hr |
>= 0 |
Yes |
|
Heating capacity (excluding any backup heating) |
HeatingCapacity17F |
double |
Btu/hr |
>= 0 |
No |
|
Heating capacity at 17F, if available |
CoolingCapacity |
double |
Btu/hr |
>= 0 |
Yes |
|
Cooling capacity |
CoolingSensibleHeatFraction |
double |
frac |
0 - 1 |
No |
|
Sensible heat fraction |
FractionHeatLoadServed |
double |
frac |
0 - 1 |
Yes |
|
Fraction of heating load served |
FractionCoolLoadServed |
double |
frac |
0 - 1 |
Yes |
|
Fraction of cooling load served |
AnnualCoolingEfficiency[Units="SEER"]/Value |
double |
Btu/Wh |
> 0 |
Yes |
|
Rated cooling efficiency |
AnnualHeatingEfficiency[Units="HSPF"]/Value |
double |
Btu/Wh |
> 0 |
Yes |
|
Rated heating efficiency |
extension/ChargeDefectRatio or extension/ChargeNotTested=true |
double or boolean |
frac |
-0.25, 0, 0.25 |
Yes |
|
In accordance with ANSI/RESNET/ACCA 310 |
If a ducted mini-split is specified (i.e., a DistributionSystem
has been entered), additional information is entered in HeatPump
.
Element |
Type |
Units |
Constraints |
Required |
Default |
Notes |
extension/FanPowerWattsPerCFM or extension/FanPowerNotTested=true |
double or boolean |
W/cfm |
>= 0 |
Yes |
|
In accordance with ANSI/RESNET/ACCA 310 |
extension/AirflowDefectRatio or extension/AirflowNotTested=true |
double or boolean |
frac |
> -1 |
Yes |
|
In accordance with ANSI/RESNET/ACCA 310 |
Warning
HVAC installation quality should be provided per the conditions specified in ANSI/RESNET/ACCA 310.
OS-ERI does not check that, for example, the total duct leakage requirement has been met or that a Grade I/II input is appropriate per the ANSI 310 process flow; that is currently the responsibility of the software developer.
Ground-to-Air Heat Pump
If a ground-to-air heat pump is specified, additional information is entered in HeatPump
.
Element |
Type |
Units |
Constraints |
Required |
Default |
Notes |
IsSharedSystem |
boolean |
|
|
Yes |
|
Whether it has a shared hydronic circulation loop |
DistributionSystem |
idref |
|
See |
Yes |
|
ID of attached distribution system |
HeatingCapacity |
double |
Btu/hr |
>= 0 |
Yes |
|
Heating capacity (excluding any backup heating) |
CoolingCapacity |
double |
Btu/hr |
>= 0 |
Yes |
|
Cooling capacity |
CoolingSensibleHeatFraction |
double |
frac |
0 - 1 |
No |
|
Sensible heat fraction |
FractionHeatLoadServed |
double |
frac |
0 - 1 |
Yes |
|
Fraction of heating load served |
FractionCoolLoadServed |
double |
frac |
0 - 1 |
Yes |
|
Fraction of cooling load served |
AnnualCoolingEfficiency[Units="EER"]/Value |
double |
Btu/Wh |
> 0 |
Yes |
|
Rated cooling efficiency |
AnnualHeatingEfficiency[Units="COP"]/Value |
double |
W/W |
> 0 |
Yes |
|
Rated heating efficiency |
NumberofUnitsServed |
integer |
|
> 0 |
See |
|
Number of dwelling units served |
extension/PumpPowerWattsPerTon |
double |
W/ton |
>= 0 |
Yes |
|
Pump power |
extension/SharedLoopWatts |
double |
W |
>= 0 |
See |
|
Shared pump power |
extension/SharedLoopMotorEfficiency |
double |
frac |
0 - 1 |
No |
0.85 |
Shared loop motor efficiency |
extension/FanPowerWattsPerCFM or extension/FanPowerNotTested=true |
double or boolean |
W/cfm |
>= 0 |
Yes |
|
In accordance with ANSI/RESNET/ACCA 310 |
extension/AirflowDefectRatio or extension/AirflowNotTested=true |
double or boolean |
frac |
> -1 |
Yes |
|
In accordance with ANSI/RESNET/ACCA 310 |
extension/ChargeDefectRatio |
double or boolean |
frac |
0 |
Yes |
|
In accordance with ANSI/RESNET/ACCA 310 |
Warning
HVAC installation quality should be provided per the conditions specified in ANSI/RESNET/ACCA 310.
OS-ERI does not check that, for example, the total duct leakage requirement has been met or that a Grade I/II input is appropriate per the ANSI 310 process flow; that is currently the responsibility of the software developer.
Water-Loop-to-Air Heat Pump
If a water-loop-to-air heat pump is specified, additional information is entered in HeatPump
.
Element |
Type |
Units |
Constraints |
Required |
Default |
Notes |
DistributionSystem |
idref |
|
See |
Yes |
|
ID of attached distribution system |
HeatingCapacity |
double |
Btu/hr |
> 0 |
See |
|
Heating capacity |
CoolingCapacity |
double |
Btu/hr |
> 0 |
See |
|
Cooling capacity |
AnnualCoolingEfficiency[Units="EER"]/Value |
double |
Btu/Wh |
> 0 |
See |
|
Rated cooling efficiency |
AnnualHeatingEfficiency[Units="COP"]/Value |
double |
W/W |
> 0 |
See |
|
Rated heating efficiency |
Note
If a water loop heat pump is specified, there must be at least one shared heating system (i.e., Boiler) and/or one shared cooling system (i.e., Chiller or Cooling Tower) specified with water loop distribution.
HPXML HVAC Control
If any HVAC systems are specified, a single thermostat is entered as a /HPXML/Building/BuildingDetails/Systems/HVAC/HVACControl
.
Element |
Type |
Units |
Constraints |
Required |
Default |
Notes |
SystemIdentifier |
id |
|
|
Yes |
|
Unique identifier |
ControlType |
string |
|
See |
Yes |
|
Type of thermostat |
HPXML HVAC Distribution
Each separate HVAC distribution system is entered as a /HPXML/Building/BuildingDetails/Systems/HVAC/HVACDistribution
.
Element |
Type |
Units |
Constraints |
Required |
Default |
Notes |
SystemIdentifier |
id |
|
|
Yes |
|
Unique identifier |
DistributionSystemType |
element |
|
1 |
Yes |
|
Type of distribution system |
ConditionedFloorAreaServed |
double |
ft2 |
> 0 |
See |
|
Conditioned floor area served |
Note
There should be at most one heating system and one cooling system attached to a distribution system.
See HPXML Heating Systems, HPXML Cooling Systems, and HPXML Heat Pumps for information on which DistributionSystemType is allowed for which HVAC system.
Also note that some HVAC systems (e.g., room air conditioners) are not allowed to be attached to a distribution system.
Air Distribution
To define an air distribution system, additional information is entered in HVACDistribution/DistributionSystemType/AirDistribution
.
Element |
Type |
Units |
Constraints |
Required |
Default |
Notes |
AirDistributionType |
string |
|
See |
Yes |
|
Type of air distribution |
NumberofReturnRegisters |
integer |
|
>= 0 |
See |
|
Number of return registers |
For the air distribution system, duct leakage inputs are required if AirDistributionType is “regular velocity” or “gravity” and optional if AirDistributionType is “fan coil”.
When provided, duct leakage must be entered in one of three ways:
- Leakage to the Outside
Supply and return leakage to the outside are each entered as a HVACDistribution/DistributionSystemType/AirDistribution/DuctLeakageMeasurement
:
Element |
Type |
Units |
Constraints |
Required |
Default |
Notes |
DuctType |
string |
|
See |
Yes |
|
Supply or return ducts |
DuctLeakage/Units |
string |
|
CFM25 |
Yes |
|
Duct leakage units |
DuctLeakage/Value |
double |
|
>= 0 |
Yes |
|
Duct leakage value |
DuctLeakage/TotalOrToOutside |
string |
|
to outside |
Yes |
|
Type of duct leakage (outside conditioned space vs total) |
- Total Leakage (Version 2014ADEGL or newer)
Total leakage is entered as a HVACDistribution/DistributionSystemType/AirDistribution/DuctLeakageMeasurement
:
Element |
Type |
Units |
Constraints |
Required |
Default |
Notes |
DuctLeakage/Units |
string |
|
CFM25 |
Yes |
|
Duct leakage units |
DuctLeakage/Value |
double |
|
>= 0 |
Yes |
|
Duct leakage value |
DuctLeakage/TotalOrToOutside |
string |
|
total |
Yes |
|
Type of duct leakage (outside conditioned space vs total) |
If the ResidentialFacilityType is “apartment unit”, OS-ERI will calculate leakage to outside for the given distribution system as half the total leakage.
If the ResidentialFacilityType is anything else, OS-ERI will calculate leakage to outside for the given distribution system based on total leakage, the fraction of duct surface area outside conditioned space, and HVAC capacities.
OS-ERI currently assumes the air handler is located outside conditioned space; future inputs will be available to describe when the air handler is within conditioned space.
Warning
Total leakage should only be used if the conditions specified in ANSI/RESNET/ICC 301 have been appropriately met.
OS-ERI does not check that, for example, the total duct leakage or infiltration requirements for dwellings and townhouses have been met per ANSI 301; that is currently the responsibility of the software developer.
Leakage to Outside Testing Exemption (Version 2014AD or newer)
A duct leakage to outside testing exemption is entered in HVACDistribution/DistributionSystemType/AirDistribution
:
Element |
Type |
Units |
Constraints |
Required |
Default |
Notes |
extension/DuctLeakageToOutsideTestingExemption=true |
boolean |
|
true |
Yes |
|
Leakage to outside exemption? |
OS-ERI will use a DSE of 0.88 for the given distribution system.
Warning
The duct leakage to outside testing exemption should only be used if the conditions specified in ANSI/RESNET/ICC 301 have been appropriately met.
Additionally, each supply/return duct present is entered in a HVACDistribution/DistributionSystemType/AirDistribution/Ducts
.
Element |
Type |
Units |
Constraints |
Required |
Default |
Notes |
DuctType |
string |
|
See |
Yes |
|
Supply or return ducts |
DuctInsulationRValue |
double |
F-ft2-hr/Btu |
>= 0 |
Yes |
|
R-value of duct insulation |
DuctSurfaceArea |
double |
ft2 |
>= 0 |
Yes |
|
Duct surface area |
DuctLocation |
string |
|
See |
Yes |
|
Duct location |
Hydronic Distribution
To define a hydronic distribution system, additional information is entered in HVACDistribution/DistributionSystemType/HydronicDistribution
.
Element |
Type |
Units |
Constraints |
Required |
Default |
Notes |
HydronicDistributionType |
string |
|
See |
Yes |
|
Type of hydronic distribution system |
Distribution System Efficiency (DSE)
Warning
A simplified DSE model is provided for flexibility, but it is strongly recommended to use one of the other detailed distribution system types for better accuracy.
To define a DSE system, additional information is entered in HVACDistribution
.
Element |
Type |
Units |
Constraints |
Required |
Default |
Notes |
AnnualHeatingDistributionSystemEfficiency |
double |
frac |
0 - 1 |
Yes |
|
Seasonal distribution system efficiency for heating |
AnnualCoolingDistributionSystemEfficiency |
double |
frac |
0 - 1 |
Yes |
|
Seasonal distribution system efficiency for cooling |
DSE values can be calculated from ASHRAE Standard 152.
HPXML Ventilation Fan
Each mechanical ventilation system that provides ventilation to the whole dwelling unit is entered as a /HPXML/Building/BuildingDetails/Systems/MechanicalVentilation/VentilationFans/VentilationFan
.
Element |
Type |
Units |
Constraints |
Required |
Default |
Notes |
SystemIdentifier |
id |
|
|
Yes |
|
Unique identifier |
UsedForWholeBuildingVentilation |
boolean |
|
true |
Yes |
|
Must be set to true |
IsSharedSystem |
boolean |
|
See |
Yes |
|
Whether it serves multiple dwelling units |
FanType |
string |
|
See |
Yes |
|
Type of ventilation system |
HoursInOperation |
double |
hrs/day |
0 - 24 |
Yes |
|
Hours per day of operation |
FanPower or extension/FanPowerDefaulted=true |
double or boolean |
W |
>= 0 or true |
Yes |
|
Fan power or whether fan power is unknown |
Exhaust/Supply Only
If a supply only or exhaust only system is specified, no additional information is entered.
Balanced
If a balanced system is specified, no additional information is entered.
Heat Recovery Ventilator
If a heat recovery ventilator system is specified, additional information is entered in VentilationFan
.
Element |
Type |
Units |
Constraints |
Required |
Default |
Notes |
SensibleRecoveryEfficiency or AdjustedSensibleRecoveryEfficiency |
double |
frac |
0 - 1 |
Yes |
|
(Adjusted) Sensible recovery efficiency |
Energy Recovery Ventilator
If an energy recovery ventilator system is specified, additional information is entered in VentilationFan
.
Element |
Type |
Units |
Constraints |
Required |
Default |
Notes |
TotalRecoveryEfficiency or AdjustedTotalRecoveryEfficiency |
double |
frac |
0 - 1 |
Yes |
|
(Adjusted) Total recovery efficiency |
SensibleRecoveryEfficiency or AdjustedSensibleRecoveryEfficiency |
double |
frac |
0 - 1 |
Yes |
|
(Adjusted) Sensible recovery efficiency |
Central Fan Integrated Supply
If a central fan integrated supply system is specified, additional information is entered in VentilationFan
.
Element |
Type |
Units |
Constraints |
Required |
Default |
Notes |
AttachedToHVACDistributionSystem |
idref |
|
See |
Yes |
|
ID of attached distribution system |
In-Unit System
If the specified system is not a shared system (i.e., not serving multiple dwelling units), additional information is entered in VentilationFan
.
Element |
Type |
Units |
Constraints |
Required |
Default |
Notes |
TestedFlowRate or extension/FlowRateNotTested=true |
double or boolean |
cfm |
>= 0 or true |
Yes |
|
Flow rate or whether flow rate unmeasured |
Shared System
If the specified system is a shared system (i.e., serving multiple dwelling units), additional information is entered in VentilationFan
.
Element |
Type |
Units |
Constraints |
Required |
Default |
Notes |
RatedFlowRate |
double |
cfm |
>= 0 |
Yes |
|
Total flow rate of shared system |
FractionRecirculation |
double |
frac |
0 - 1 |
Yes |
|
Fraction of supply air that is recirculated |
extension/InUnitFlowRate or extension/FlowRateNotTested=true |
double or boolean |
cfm |
>= 0 or true |
Yes |
|
Flow rate delivered to the dwelling unit or whether flow rate unmeasured |
extension/PreHeating |
element |
|
0 - 1 |
No |
<none> |
Supply air preconditioned by heating equipment? |
extension/PreCooling |
element |
|
0 - 1 |
No |
<none> |
Supply air preconditioned by cooling equipment? |
If pre-heating is specified, additional information is entered in extension/PreHeating
.
Element |
Type |
Units |
Constraints |
Required |
Default |
Notes |
Fuel |
string |
|
See |
Yes |
|
Pre-heating equipment fuel type |
AnnualHeatingEfficiency[Units="COP"]/Value |
double |
W/W |
> 0 |
Yes |
|
Pre-heating equipment annual COP |
FractionVentilationHeatLoadServed |
double |
frac |
0 - 1 |
Yes |
|
Fraction of ventilation heating load served by pre-heating equipment |
If pre-cooling is specified, additional information is entered in extension/PreCooling
.
Element |
Type |
Units |
Constraints |
Required |
Default |
Notes |
Fuel |
string |
|
See |
Yes |
|
Pre-cooling equipment fuel type |
AnnualCoolingEfficiency[Units="COP"]/Value |
double |
W/W |
> 0 |
Yes |
|
Pre-cooling equipment annual COP |
FractionVentilationCoolLoadServed |
double |
frac |
0 - 1 |
Yes |
|
Fraction of ventilation cooling load served by pre-cooling equipment |
HPXML Whole House Fan
Each whole house fan that provides cooling load reduction is entered as a /HPXML/Building/BuildingDetails/Systems/MechanicalVentilation/VentilationFans/VentilationFan
.
Element |
Type |
Units |
Constraints |
Required |
Default |
Notes |
SystemIdentifier |
id |
|
|
Yes |
|
Unique identifier |
UsedForSeasonalCoolingLoadReduction |
boolean |
|
true |
Yes |
|
Must be set to true |
RatedFlowRate |
double |
cfm |
>= 0 |
Yes |
|
Flow rate |
FanPower |
double |
W |
>= 0 |
Yes |
|
Fan power |
Note
The whole house fan is assumed to operate during hours of favorable outdoor conditions and will take priority over operable windows (natural ventilation).
HPXML Water Heating Systems
Each water heater is entered as a /HPXML/Building/BuildingDetails/Systems/WaterHeating/WaterHeatingSystem
.
Element |
Type |
Units |
Constraints |
Required |
Default |
Notes |
SystemIdentifier |
id |
|
|
Yes |
|
Unique identifier |
IsSharedSystem |
boolean |
|
|
Yes |
|
Whether it serves multiple dwelling units or shared laundry room |
WaterHeaterType |
string |
|
See |
Yes |
|
Type of water heater |
Location |
string |
|
See |
Yes |
|
Water heater location |
FractionDHWLoadServed |
double |
frac |
0 - 1 |
Yes |
|
Fraction of hot water load served |
UsesDesuperheater |
boolean |
|
|
No |
false |
Presence of desuperheater? |
NumberofUnitsServed |
integer |
|
> 0 |
See |
|
Number of dwelling units served directly or indirectly |
Conventional Storage
If a conventional storage water heater is specified, additional information is entered in WaterHeatingSystem
.
Element |
Type |
Units |
Constraints |
Required |
Default |
Notes |
FuelType |
string |
|
See |
Yes |
|
Fuel type |
TankVolume |
double |
gal |
> 0 |
Yes |
|
Tank volume |
HeatingCapacity |
double |
Btuh |
> 0 |
No |
See |
Heating capacity |
UniformEnergyFactor or EnergyFactor |
double |
frac |
< 1 |
Yes |
|
EnergyGuide label rated efficiency |
FirstHourRating |
double |
gal/hr |
> 0 |
See |
|
EnergyGuide label first hour rating |
RecoveryEfficiency |
double |
frac |
0 - 1 |
See |
|
Recovery efficiency |
WaterHeaterInsulation/Jacket/JacketRValue |
double |
F-ft2-hr/Btu |
>= 0 |
No |
0 |
R-value of additional tank insulation wrap |
Tankless
If an instantaneous tankless water heater is specified, additional information is entered in WaterHeatingSystem
.
Element |
Type |
Units |
Constraints |
Required |
Default |
Notes |
FuelType |
string |
|
See |
Yes |
|
Fuel type |
UniformEnergyFactor or EnergyFactor |
double |
frac |
< 1 |
Yes |
|
EnergyGuide label rated efficiency |
Heat Pump
If a heat pump water heater is specified, additional information is entered in WaterHeatingSystem
.
Element |
Type |
Units |
Constraints |
Required |
Default |
Notes |
FuelType |
string |
|
See |
Yes |
|
Fuel type |
TankVolume |
double |
gal |
> 0 |
Yes |
|
Tank volume |
UniformEnergyFactor or EnergyFactor |
double |
frac |
> 1 |
Yes |
|
EnergyGuide label rated efficiency |
FirstHourRating |
double |
gal/hr |
> 0 |
See |
|
EnergyGuide label first hour rating |
WaterHeaterInsulation/Jacket/JacketRValue |
double |
F-ft2-hr/Btu |
>= 0 |
No |
0 |
R-value of additional tank insulation wrap |
Combi Boiler w/ Storage
If a combination boiler w/ storage tank (sometimes referred to as an indirect water heater) is specified, additional information is entered in WaterHeatingSystem
.
Element |
Type |
Units |
Constraints |
Required |
Default |
Notes |
RelatedHVACSystem |
idref |
|
See |
Yes |
|
ID of boiler |
TankVolume |
double |
gal |
> 0 |
Yes |
|
Volume of the storage tank |
WaterHeaterInsulation/Jacket/JacketRValue |
double |
F-ft2-hr/Btu |
>= 0 |
No |
0 |
R-value of additional storage tank insulation wrap |
StandbyLoss |
double |
F/hr |
> 0 |
No |
See |
Storage tank standby losses |
Combi Boiler w/ Tankless Coil
If a combination boiler w/ tankless coil is specified, additional information is entered in WaterHeatingSystem
.
Element |
Type |
Units |
Constraints |
Required |
Default |
Notes |
RelatedHVACSystem |
idref |
|
See |
Yes |
|
ID of boiler |
Desuperheater
If the water heater uses a desuperheater, additional information is entered in WaterHeatingSystem
.
Element |
Type |
Units |
Constraints |
Required |
Default |
Notes |
RelatedHVACSystem |
idref |
|
See |
Yes |
|
ID of heat pump or air conditioner |
HPXML Hot Water Distribution
If any water heating systems are provided, a single hot water distribution system is entered as a /HPXML/Building/BuildingDetails/Systems/WaterHeating/HotWaterDistribution
.
Element |
Type |
Units |
Constraints |
Required |
Default |
Notes |
SystemIdentifier |
id |
|
|
Yes |
|
Unique identifier |
SystemType |
element |
|
1 |
Yes |
|
Type of in-unit distribution system serving the dwelling unit |
PipeInsulation/PipeRValue |
double |
F-ft2-hr/Btu |
>= 0 |
Yes |
|
Pipe insulation R-value |
DrainWaterHeatRecovery |
element |
|
0 - 1 |
No |
<none> |
Presence of drain water heat recovery device |
extension/SharedRecirculation |
element |
|
0 - 1 |
No |
<none> |
Presence of shared recirculation system serving multiple dwelling units |
Note
In attached/multifamily buildings, only the hot water distribution system serving the dwelling unit should be defined.
The hot water distribution associated with, e.g., a shared laundry room should not be defined.
Standard
If the in-unit distribution system is specified as standard, additional information is entered in SystemType/Standard
.
Element |
Type |
Units |
Constraints |
Required |
Default |
Notes |
PipingLength |
double |
ft |
> 0 |
Yes |
|
Length of piping |
Recirculation
If the in-unit distribution system is specified as recirculation, additional information is entered in SystemType/Recirculation
.
Element |
Type |
Units |
Constraints |
Required |
Default |
Notes |
ControlType |
string |
|
See |
Yes |
|
Recirculation control type |
RecirculationPipingLoopLength |
double |
ft |
> 0 |
Yes |
|
Recirculation piping loop length |
BranchPipingLoopLength |
double |
ft |
> 0 |
Yes |
|
Branch piping loop length |
PumpPower |
double |
W |
>= 0 |
Yes |
|
Recirculation pump power |
Shared Recirculation
If a shared recirculation system is specified, additional information is entered in extension/SharedRecirculation
.
Element |
Type |
Units |
Constraints |
Required |
Default |
Notes |
NumberofUnitsServed |
integer |
|
> 1 |
Yes |
|
Number of dwelling units served |
PumpPower |
double |
W |
>= 0 |
Yes |
|
Shared recirculation pump power |
MotorEfficiency |
double |
frac |
0 - 1 |
No |
0.85 |
Shared recirculation motor efficiency |
ControlType |
string |
|
See |
Yes |
|
Shared recirculation control type |
Drain Water Heat Recovery
If a drain water heat recovery (DWHR) device is specified, additional information is entered in DrainWaterHeatRecovery
.
Element |
Type |
Units |
Constraints |
Required |
Default |
Notes |
FacilitiesConnected |
string |
|
See |
Yes |
|
Specifies which facilities are connected |
EqualFlow |
boolean |
|
|
Yes |
|
Specifies how the DHWR is configured |
Efficiency |
double |
frac |
0 - 1 |
Yes |
|
Efficiency according to CSA 55.1 |
HPXML Water Fixtures
Each water fixture is entered as a /HPXML/Building/BuildingDetails/Systems/WaterHeating/WaterFixture
.
Element |
Type |
Units |
Constraints |
Required |
Default |
Notes |
SystemIdentifier |
id |
|
|
Yes |
|
Unique identifier |
WaterFixtureType |
string |
|
See |
Yes |
|
Type of water fixture |
LowFlow |
boolean |
|
|
Yes |
|
Whether the fixture is considered low-flow |
HPXML Solar Thermal
A single solar hot water system can be entered as a /HPXML/Building/BuildingDetails/Systems/SolarThermal/SolarThermalSystem
.
Element |
Type |
Units |
Constraints |
Required |
Default |
Notes |
SystemIdentifier |
id |
|
|
Yes |
|
Unique identifier |
SystemType |
string |
|
See |
Yes |
|
Type of solar thermal system |
Solar hot water systems can be described with either simple or detailed inputs.
HPXML Photovoltaics
Each solar electric photovoltaic (PV) system is entered as a /HPXML/Building/BuildingDetails/Systems/Photovoltaics/PVSystem
.
Many of the inputs are adopted from the PVWatts model.
Element |
Type |
Units |
Constraints |
Required |
Default |
Notes |
SystemIdentifier |
id |
|
|
Yes |
|
Unique identifier |
IsSharedSystem |
boolean |
|
|
Yes |
|
Whether it serves multiple dwelling units |
Location |
string |
|
See |
Yes |
|
Mounting location |
ModuleType |
string |
|
See |
Yes |
|
Type of module |
Tracking |
string |
|
See |
Yes |
|
Type of tracking |
ArrayAzimuth |
integer |
deg |
0 - 359 |
Yes |
|
Direction panels face (clockwise from North) |
ArrayTilt |
double |
deg |
0 - 90 |
Yes |
|
Tilt relative to horizontal |
MaxPowerOutput |
double |
W |
>= 0 |
Yes |
|
Peak power |
InverterEfficiency |
double |
frac |
0 - 1 |
Yes |
|
Inverter efficiency |
SystemLossesFraction |
double |
frac |
0 - 1 |
Yes |
|
System losses |
extension/NumberofBedroomsServed |
integer |
|
> 1 |
See |
|
Number of bedrooms served |
HPXML Generators
Each generator that provides on-site power is entered as a /HPXML/Building/BuildingDetails/Systems/extension/Generators/Generator
.
Element |
Type |
Units |
Constraints |
Required |
Default |
Notes |
SystemIdentifier |
id |
|
|
Yes |
|
Unique identifier |
IsSharedSystem |
boolean |
|
|
Yes |
|
Whether it serves multiple dwelling units |
FuelType |
string |
|
See |
Yes |
|
Fuel type |
AnnualConsumptionkBtu |
double |
kBtu/yr |
> 0 |
Yes |
|
Annual fuel consumed |
AnnualOutputkWh |
double |
kWh/yr |
> 0 |
Yes |
|
Annual electricity produced |
NumberofBedroomsServed |
integer |
|
> 1 |
See |
|
Number of bedrooms served |
Note
Generators will be modeled as operating continuously (24/7).
HPXML Appliances
Appliances entered in /HPXML/Building/BuildingDetails/Appliances
.
HPXML Clothes Washer
A single clothes washer can be entered as a /HPXML/Building/BuildingDetails/Appliances/ClothesWasher
.
Element |
Type |
Units |
Constraints |
Required |
Default |
Notes |
SystemIdentifier |
id |
|
|
Yes |
|
Unique identifier |
IsSharedAppliance |
boolean |
|
|
Yes |
|
Whether it serves multiple dwelling units |
Location |
string |
|
See |
Yes |
|
Location |
IntegratedModifiedEnergyFactor or ModifiedEnergyFactor |
double |
ft3/kWh/cyc |
> 0 |
Yes |
|
EnergyGuide label efficiency |
RatedAnnualkWh |
double |
kWh/yr |
> 0 |
Yes |
|
EnergyGuide label annual consumption |
LabelElectricRate |
double |
$/kWh |
> 0 |
Yes |
|
EnergyGuide label electricity rate |
LabelGasRate |
double |
$/therm |
> 0 |
Yes |
|
EnergyGuide label natural gas rate |
LabelAnnualGasCost |
double |
$ |
> 0 |
Yes |
|
EnergyGuide label annual gas cost |
LabelUsage |
double |
cyc/wk |
> 0 |
Yes |
|
EnergyGuide label number of cycles (not used if 301 version < 2019A) |
Capacity |
double |
ft3 |
> 0 |
Yes |
|
Clothes dryer volume |
If the clothes washer is shared, additional information is entered in /HPXML/Building/BuildingDetails/Appliances/ClothesWasher
.
Element |
Type |
Units |
Constraints |
Required |
Default |
Notes |
AttachedToWaterHeatingSystem |
idref |
|
See |
Yes |
|
ID of attached water heater |
NumberofUnits |
integer |
|
|
Yes |
|
Number of clothes washers in the shared laundry room |
NumberofUnitsServed |
integer |
|
|
Yes |
|
Number of dwelling units served by the shared laundry room |
Note
If no clothes washer is located within the Rated Home, a clothes washer in the nearest shared laundry room on the project site shall be used if available for daily use by the occupants of the Rated Home.
If there are multiple clothes washers, the clothes washer with the highest Label Energy Rating (kWh/yr) shall be used.
HPXML Clothes Dryer
A single clothes dryer can be entered as a /HPXML/Building/BuildingDetails/Appliances/ClothesDryer
.
Element |
Type |
Units |
Constraints |
Required |
Default |
Notes |
SystemIdentifier |
id |
|
|
Yes |
|
Unique identifier |
IsSharedAppliance |
boolean |
|
|
Yes |
|
Whether it serves multiple dwelling units |
Location |
string |
|
See |
Yes |
|
Location |
FuelType |
string |
|
See |
Yes |
|
Fuel type |
CombinedEnergyFactor or EnergyFactor |
double |
lb/kWh |
> 0 |
Yes |
|
EnergyGuide label efficiency |
ControlType |
string |
|
See |
See |
|
Type of controls |
If the clothes dryer is shared, additional information is entered in /HPXML/Building/BuildingDetails/Appliances/ClothesDryer
.
Element |
Type |
Units |
Constraints |
Required |
Default |
Notes |
NumberofUnits |
integer |
|
|
Yes |
|
Number of clothes dryers in the shared laundry room |
NumberofUnitsServed integer |
|
|
Yes |
|
Number of dwelling units served by the shared laundry room |
Note
If no clothes dryer is located within the Rated Home, a clothes dryer in the nearest shared laundry room on the project site shall be used if available for daily use by the occupants of the Rated Home.
If there are multiple clothes dryers, the clothes dryer with the lowest Energy Factor or Combined Energy Factor shall be used.
HPXML Dishwasher
A single dishwasher can be entered as a /HPXML/Building/BuildingDetails/Appliances/Dishwasher
.
Element |
Type |
Units |
Constraints |
Required |
Default |
Notes |
SystemIdentifier |
id |
|
|
Yes |
|
Unique identifier |
IsSharedAppliance |
boolean |
|
|
Yes |
|
Whether it serves multiple dwelling units |
Location |
string |
|
See |
Yes |
|
Location |
RatedAnnualkWh or EnergyFactor |
double |
kWh/yr or # |
> 0 |
Yes |
|
EnergyGuide label consumption/efficiency |
LabelElectricRate |
double |
$/kWh |
> 0 |
Yes |
|
EnergyGuide label electricity rate (not used if 301 version < 2019A) |
LabelGasRate |
double |
$/therm |
> 0 |
Yes |
|
EnergyGuide label natural gas rate (not used if 301 version < 2019A) |
LabelAnnualGasCost |
double |
$ |
> 0 |
Yes |
|
EnergyGuide label annual gas cost (not used if 301 version < 2019A) |
LabelUsage |
double |
cyc/wk |
> 0 |
Yes |
|
EnergyGuide label number of cycles (not used if 301 version < 2019A) |
PlaceSettingCapacity |
integer |
# |
> 0 |
Yes |
|
Number of place settings |
If the dishwasher is shared, additional information is entered in /HPXML/Building/BuildingDetails/Appliances/Dishwasher
.
Element |
Type |
Units |
Constraints |
Required |
Default |
Notes |
AttachedToWaterHeatingSystem |
idref |
|
See |
Yes |
|
ID of attached water heater |
Note
If no dishwasher is located within the Rated Home, a dishwasher in the nearest shared kitchen in the building shall be used only if available for daily use by the occupants of the Rated Home.
If there are multiple dishwashers, the dishwasher with the lowest Energy Factor (highest kWh/yr) shall be used.
HPXML Refrigerators
A single refrigerator can be entered as a /HPXML/Building/BuildingDetails/Appliances/Refrigerator
.
Element |
Type |
Units |
Constraints |
Required |
Default |
Notes |
SystemIdentifier |
id |
|
|
Yes |
|
Unique identifier |
Location |
string |
|
See |
Yes |
|
Location |
RatedAnnualkWh |
double |
kWh/yr |
> 0 |
Yes |
|
Annual consumption |
Note
If there are multiple refrigerators, the total energy consumption of all refrigerators/freezers shall be used along with the location that represents the majority of power consumption.
HPXML Dehumidifier
Each dehumidifier can be entered as a /HPXML/Building/BuildingDetails/Appliances/Dehumidifier
.
Element |
Type |
Units |
Constraints |
Required |
Default |
Notes |
SystemIdentifier |
id |
|
|
Yes |
|
Unique identifier |
Type |
string |
|
See |
Yes |
|
Type of dehumidifier |
Location |
string |
|
See |
Yes |
|
Location of dehumidifier |
Capacity |
double |
pints/day |
> 0 |
Yes |
|
Dehumidification capacity |
IntegratedEnergyFactor or EnergyFactor |
double |
liters/kWh |
> 0 |
Yes |
|
Rated efficiency |
FractionDehumidificationLoadServed |
double |
frac |
0 - 1 |
Yes |
|
Fraction of dehumidification load served |
Note
Dehumidifiers only affect ERI scores if Version 2019AB or newer is used, as dehumidifiers were incorporated into the ERI calculation as of 301-2019 Addendum B.
Note
Dehumidifiers are currently modeled as located within conditioned space; the model is not suited for a dehumidifier in, e.g., a wet unconditioned basement or crawlspace.
Therefore the dehumidifier Location is currently restricted to “living space”.
HPXML Cooking Range/Oven
A single cooking range can be entered as a /HPXML/Building/BuildingDetails/Appliances/CookingRange
.
Element |
Type |
Units |
Constraints |
Required |
Default |
Notes |
SystemIdentifier |
id |
|
|
Yes |
|
Unique identifier |
Location |
string |
|
See |
Yes |
|
Location |
FuelType |
string |
|
See |
Yes |
|
Fuel type |
IsInduction |
boolean |
|
|
Yes |
|
Induction range? |
If a cooking range is specified, a single oven is also entered as a /HPXML/Building/BuildingDetails/Appliances/Oven
.
Element |
Type |
Units |
Constraints |
Required |
Default |
Notes |
SystemIdentifier |
id |
|
|
Yes |
|
Unique identifier |
IsConvection |
boolean |
|
|
Yes |
|
Convection oven? |
Validating & Debugging Errors
When running HPXML files, errors may occur because:
- An HPXML file provided is invalid (either relative to the HPXML schema or the ERI Use Case).
- An unexpected error occurred in the workflow (e.g., applying the ERI 301 ruleset).
- An unexpected EnergyPlus simulation error occurred.
If, for example, the Rated Home is unsuccessful, first look in the ERIRatedHome/run.log for details.
If there are no errors in that log file, then the error may be in the EnergyPlus simulation – see ERIRatedHome/eplusout.err.
Contact us if you can’t figure out the cause of an error.