Skip to content

Home Energy Score JSON Schema

Defined in: hescore_json.schema.json.schema.json
Type: object
Additional Properties Allowed: False

Property Type Required Format Title
version string ✅
address address ✅ Address
hpwes home_performance_with_energy_star Home Performance With Energy Star
about about ✅ About
zone zone ✅ Zone
systems systems ✅ Systems

allOf Requirement

Conditional Validation

if true validate
about.dwelling_unit_type is apartment_unit address2 is present in address
about.manufactured_home_sections is one of [double-wide, triple-wide] zone.zone_roof does not contain zone_roof_with_bowstring_roof
about.dwelling_unit_type is manufactured_home zone.zone_wall does not contain zone_wall_assembly_code_for_manufactured_homes
zone.zone_roof does not contain zone_roof_with_vented_or_conditioned_attic systems.hvac contain hvac_distribution_duct_validation_object
about.dwelling_unit_type is one of [single_family_detached, manufactured_home] zone.zone_wall does not contain zone_wall_adjacent_to_other_space
about.dwelling_unit_type is one of [apartment_unit, single_family_attached] systems.generation.solar_electric.system_capacity is minimum value of 0.05, maximum value of 200 AND num_panels is minimum value of 1, maximum value of 1000
about.dwelling_unit_type is not one of [apartment_unit, single_family_attached] systems.generation.solar_electric.number_units_sharing_system existssystem_capacity is minimum value of 0.05, maximum value of 20 AND num_panels is minimum value of 1, maximum value of 100
zone.zone_roof contain zone_roof_with_bowstring_roof about.dwelling_unit_type is manufactured_home
zone.zone_roof contain zone_roof_with_below_other_unit_roof

OR

zone.zone_floor contain zone_floor_with_above_other_unit_foundation
about.dwelling_unit_type is one of [single_family_attached, apartment_unit]
zone.zone_floor contain zone_floor_with_slab_on_grade_foundation about has no key/smanufactured_home_dwelling_type_object
zone.zone_floor does not contain zone_floor_with_vented_crawlspace_foundation systems.hvac contain hvac_without_vented_crawlspace_duct
zone.zone_floor does not contain zone_floor_with_unvented_crawlspace_foundation systems.hvac contain hvac_without_unvented_crawlspace_duct
zone.zone_floor does not contain zone_floor_with_unconditioned_basement_foundation systems.hvac contain hvac_without_unconditioned_basement_duct
zone.zone_floor does not contain zone_floor_with_belly_and_wing_foundation systems.hvac contain hvac_without_belly_and_wing_duct
zone.zone_floor contain zone_floor_with_belly_and_wing_foundation about.dwelling_unit_type is manufactured_home
systems.hvac contain hvac_with_manufactured_home_belly_duct about.dwelling_unit_type is manufactured_home

version

The version of the building unit schema. Use semantic versioning.

  • is required
  • Type: string

Constant: 4.0

address

hpwes

about

  • is required
  • Type: about

zone

  • is required
  • Type: zone

systems