Input Reference - core HEM

• This is the schema for input files to the core HEM engine.

• The text below has been automatically generated from core-input.json.

• The root object is the first JSON object below named “Input”.

Input

<JSON object>

• Named name/value pairs:

  • ApplianceGains: ApplianceGains collection

  • ColdWaterSource (required): ColdWaterSource collection

  • Control (required): Control collection

  • EnergySupply (required): EnergySupply collection

  • Events (required): WaterHeatingEvents

  • ExternalConditions (required): ExternalConditionsInput

  • HeatSourceWet: HeatSourceWet collection

  • HotWaterDemand (required): HotWaterDemand

  • HotWaterSource (required): HotWaterSource

  • InfiltrationVentilation (required): InfiltrationVentilation

  • InternalGains (required): InternalGains

  • OnSiteGeneration: OnSiteGeneration collection

  • PreHeatedWaterSource: PreHeatedWaterSource collection

  • SimulationTime (required): SimulationTime

  • SmartApplianceControls: SmartApplianceControls collection

  • SpaceCoolSystem: SpaceCoolSystem collection

  • SpaceHeatSystem: SpaceHeatSystem collection

  • WWHRS: WWHRS collection

  • Zone (required): Zone collection

  • temp_internal_air_static_calcs (required): Temp Internal Air Static Calcs

• User-named name/value pairs: NONE_ALLOWED

ApplianceGains collection

<JSON value>

• Parent: Input

• Default: <JSON null>

• AnyOf:

  • <JSON object>

    • User-named name/value pairs: {ANY_NAME: ApplianceGains}

  • <JSON null>

ColdWaterSource collection

<JSON object>

• Parent: Input

• User-named name/value pairs: {ANY_NAME: ColdWaterSource}

Control collection

<JSON value>

• Parent: Input

• AnyOf:

  • <JSON object>

    • User-named name/value pairs: {ANY_NAME: Control choice}

  • <JSON null>

Control choice

<JSON value>

• Parent: Control collection

• OneOf:

  • ControlOnOffTimer

  • ControlOnOffCostMinimising

  • ControlSetpointTimer

  • ControlChargeTarget

  • ControlCombinationTime

• Non-JSON Schema keywords:

  • discriminator: {‘mapping’: {‘ChargeControl’: ‘#/$defs/ControlChargeTarget’, ‘CombinationTimeControl’: ‘#/$defs/ControlCombinationTime’, ‘OnOffCostMinimisingTimeControl’: ‘#/$defs/ControlOnOffCostMinimising’, ‘OnOffTimeControl’: ‘#/$defs/ControlOnOffTimer’, ‘SetpointTimeControl’: ‘#/$defs/ControlSetpointTimer’}, ‘propertyName’: ‘type’}

EnergySupply collection

<JSON object>

• Parent: Input

• User-named name/value pairs: {ANY_NAME: EnergySupply}

HeatSourceWet collection

<JSON value>

• Parent: Input

• Default: <JSON null>

• AnyOf:

  • <JSON object>

    • User-named name/value pairs: {ANY_NAME: HeatSourceWet choice}

  • <JSON null>

HeatSourceWet choice

<JSON value>

• Parent: HeatSourceWet collection

• OneOf:

  • HeatSourceWetHeatPump

  • HeatSourceWetBoiler

  • HeatSourceWetHeatBattery

  • HeatSourceWetHIU

• Non-JSON Schema keywords:

  • discriminator: {‘mapping’: {‘Boiler’: ‘#/$defs/HeatSourceWetBoiler’, ‘HIU’: ‘#/$defs/HeatSourceWetHIU’, ‘HeatBattery’: ‘#/$defs/HeatSourceWetHeatBattery’, ‘HeatPump’: ‘#/$defs/HeatSourceWetHeatPump’}, ‘propertyName’: ‘type’}

OnSiteGeneration collection

<JSON value>

• Parent: Input

• Default: <JSON null>

• AnyOf:

  • <JSON object>

    • User-named name/value pairs: {ANY_NAME: OnSiteGeneration choice}

  • <JSON null>

OnSiteGeneration choice

<JSON value>

• Parent: OnSiteGeneration collection

• OneOf:

  • PhotovoltaicSystem

• Non-JSON Schema keywords:

  • discriminator: {‘mapping’: {‘PhotovoltaicSystem’: ‘#/$defs/PhotovoltaicSystem’}, ‘propertyName’: ‘type’}

PreHeatedWaterSource collection

<JSON value>

• Parent: Input

• Default: <JSON null>

• AnyOf:

  • <JSON object>

    • User-named name/value pairs: {ANY_NAME: StorageTank}

  • <JSON null>

SmartApplianceControls collection

<JSON value>

• Parent: Input

• Default: <JSON null>

• AnyOf:

  • <JSON object>

    • User-named name/value pairs: {ANY_NAME: SmartApplianceControl}

  • <JSON null>

SpaceCoolSystem collection

<JSON value>

• Parent: Input

• Default: <JSON null>

• AnyOf:

  • <JSON object>

    • User-named name/value pairs: {ANY_NAME: SpaceCoolSystem choice}

  • <JSON null>

SpaceCoolSystem choice

<JSON value>

• Parent: SpaceCoolSystem collection

• OneOf:

  • SpaceCoolSystemAirConditioning

• Non-JSON Schema keywords:

  • discriminator: {‘mapping’: {‘AirConditioning’: ‘#/$defs/SpaceCoolSystemAirConditioning’}, ‘propertyName’: ‘type’}

SpaceHeatSystem collection

<JSON value>

• Parent: Input

• Default: <JSON null>

• AnyOf:

  • <JSON object>

    • User-named name/value pairs: {ANY_NAME: SpaceHeatSystem choice}

  • <JSON null>

SpaceHeatSystem choice

<JSON value>

• Parent: SpaceHeatSystem collection

• OneOf:

  • SpaceHeatSystemInstantElectricHeater

  • SpaceHeatSystemElectricStorageHeater

  • SpaceHeatSystemWetDistribution

  • SpaceHeatSystemWarmAir

• Non-JSON Schema keywords:

  • discriminator: {‘mapping’: {‘ElecStorageHeater’: ‘#/$defs/SpaceHeatSystemElectricStorageHeater’, ‘InstantElecHeater’: ‘#/$defs/SpaceHeatSystemInstantElectricHeater’, ‘WarmAir’: ‘#/$defs/SpaceHeatSystemWarmAir’, ‘WetDistribution’: ‘#/$defs/SpaceHeatSystemWetDistribution’}, ‘propertyName’: ‘type’}

WWHRS collection

<JSON value>

• Parent: Input

• Default: <JSON null>

• AnyOf:

  • <JSON object>

    • User-named name/value pairs: {ANY_NAME: WasteWaterHeatRecoverySystem}

  • <JSON null>

Zone collection

<JSON object>

• Parent: Input

• User-named name/value pairs: {ANY_NAME: Zone}

Temp Internal Air Static Calcs

<JSON number>

• Parent: Input

AirFlowType

<JSON string>

• Parent(s): SpaceHeatSystemElectricStorageHeater

• Enum: [‘fan-assisted’, ‘damper-only’]

ApplianceGains

<JSON object>

• Parent(s): ApplianceGains collection

• Named name/value pairs:

  • Events: Events

  • Standby: Standby

  • EnergySupply (required): Energysupply

  • gains_fraction (required): Gains Fraction

  • loadshifting:

    • <JSON value>

      • Default: <JSON null>

      • AnyOf:

        • ApplianceLoadShifting

        • <JSON null>

  • priority: Priority

  • schedule:

    • <JSON value>

      • Default: <JSON null>

      • AnyOf:

        • ScheduleForDouble

        • <JSON null>

  • start_day (required): Start Day

  • time_series_step (required): Time Series Step

• User-named name/value pairs: NONE_ALLOWED

Events

<JSON value>

• Parent: ApplianceGains

• Description: List of appliance usage events

• Default: <JSON null>

• AnyOf:

  • <JSON array>

    • Items: ApplianceGainsEvent

  • <JSON null>

Standby

<JSON value>

• Parent: ApplianceGains

• Description: Appliance power consumption when not in use (unit: W)

• Default: <JSON null>

• AnyOf:

  • <JSON number>

  • <JSON null>

Energysupply

<JSON string>

• Parent: ApplianceGains

Gains Fraction

<JSON number>

• Parent: ApplianceGains

• Description: Proportion of appliance demand turned into heat gains (no unit)

Priority

<JSON value>

• Parent: ApplianceGains

• Default: <JSON null>

• AnyOf:

  • <JSON integer>

  • <JSON null>

Start Day

<JSON integer>

• Parent: ApplianceGains

• Maximum: 365

• Minimum: 0

• Description: First day of the time series, day of the year, 0 to 365

Time Series Step

<JSON number>

• Parent: ApplianceGains

• Description: Timestep of the time series data (unit: hours)

ApplianceGainsEvent

<JSON object>

• Parent(s): Events

• Named name/value pairs:

  • demand_W (required): Demand W

  • duration (required): Duration

  • start (required): Start

• User-named name/value pairs: NONE_ALLOWED

Demand W

<JSON number>

• Parent: ApplianceGainsEvent

Duration

<JSON number>

• Parent: ApplianceGainsEvent

Start

<JSON number>

• Parent: ApplianceGainsEvent

ApplianceLoadShifting

<JSON object>

• Parent(s): ApplianceGains

• Named name/value pairs:

  • Control: Control

  • demand_limit_weighted (required): Demand Limit Weighted

  • max_shift_hrs (required): Max Shift Hrs

  • priority: Priority

  • weight_timeseries (required): Weight Timeseries

• User-named name/value pairs: NONE_ALLOWED

Control

<JSON value>

• Parent: ApplianceLoadShifting

• Default: <JSON null>

• AnyOf:

  • <JSON string>

  • <JSON null>

Demand Limit Weighted

<JSON number>

• Parent: ApplianceLoadShifting

Max Shift Hrs

<JSON number>

• Parent: ApplianceLoadShifting

Priority

<JSON value>

• Parent: ApplianceLoadShifting

• Default: <JSON null>

• AnyOf:

  • <JSON integer>

  • <JSON null>

Weight Timeseries

<JSON array>

• Parent: ApplianceLoadShifting

• Items: <JSON number>

Bath

<JSON object>

• Parent(s): Bath

• Named name/value pairs:

  • ColdWaterSource (required): Coldwatersource

  • flowrate (required): Flowrate

  • size (required): Size

• User-named name/value pairs: NONE_ALLOWED

Coldwatersource

<JSON string>

• Parent: Bath

Flowrate

<JSON number>

• Parent: Bath

• Description: Tap/outlet flow rate (unit: litre/minute)

Size

<JSON number>

• Parent: Bath

• Description: Volume held by bath (unit: litre)

BatteryLocation

<JSON string>

• Parent(s): ElectricBattery

• Enum: [‘inside’, ‘outside’]

BoilerCostScheduleHybrid

<JSON object>

• Parent(s): HeatPumpBoiler

• Named name/value pairs:

  • cost_schedule_boiler (required): ScheduleForDouble

  • cost_schedule_hp (required): ScheduleForDouble

  • cost_schedule_start_day (required): Cost Schedule Start Day

  • cost_schedule_time_series_step (required): Cost Schedule Time Series Step

• User-named name/value pairs: NONE_ALLOWED

Cost Schedule Start Day

<JSON integer>

• Parent: BoilerCostScheduleHybrid

• Maximum: 365

• Minimum: 0

Cost Schedule Time Series Step

<JSON number>

• Parent: BoilerCostScheduleHybrid

BoilerHotWaterTest

<JSON string>

• Parent(s): HotWaterSourceCombiBoiler

• Enum: [‘M&L’, ‘M&S’, ‘M_only’, ‘No_additional_tests’]

BuildingElementAdjacentConditionedSpace

<JSON object>

• Parent(s): Buildingelement

• Named name/value pairs:

  • type (required): Type

  • area (required): Area

  • areal_heat_capacity (required): Areal Heat Capacity

  • mass_distribution_class (required): MassDistributionClass

  • pitch (required): Pitch

  • thermal_resistance_construction: Thermal Resistance Construction

  • u_value: U Value

• User-named name/value pairs: NONE_ALLOWED

Type

<JSON string>

• Parent: BuildingElementAdjacentConditionedSpace

• Const: ‘BuildingElementAdjacentConditionedSpace’

Area

<JSON number>

• Parent: BuildingElementAdjacentConditionedSpace

Areal Heat Capacity

<JSON number>

• Parent: BuildingElementAdjacentConditionedSpace

• Description: Areal heat capacity (unit: J/m².K)

Pitch

<JSON number>

• Parent: BuildingElementAdjacentConditionedSpace

• Description: Tilt angle of the surface from horizontal, between 0 and 180, where 0 means the external surface is facing up, 90 means the external surface is vertical and 180 means the external surface is facing down (unit: ˚)

Thermal Resistance Construction

<JSON value>

• Parent: BuildingElementAdjacentConditionedSpace

• Description: Thermal resistance (unit: m².K/W)

• Default: <JSON null>

• AnyOf:

  • <JSON number>

  • <JSON null>

U Value

<JSON value>

• Parent: BuildingElementAdjacentConditionedSpace

• Default: <JSON null>

• AnyOf:

  • <JSON number>

  • <JSON null>

BuildingElementAdjacentUnconditionedSpace_Simple

<JSON object>

• Parent(s): Buildingelement

• Named name/value pairs:

  • type (required): Type

  • area (required): Area

  • areal_heat_capacity (required): Areal Heat Capacity

  • mass_distribution_class (required): MassDistributionClass

  • pitch (required): Pitch

  • thermal_resistance_construction: Thermal Resistance Construction

  • thermal_resistance_unconditioned_space (required): Thermal Resistance Unconditioned Space

  • u_value: U Value

• User-named name/value pairs: NONE_ALLOWED

Type

<JSON string>

• Parent: BuildingElementAdjacentUnconditionedSpace_Simple

• Const: ‘BuildingElementAdjacentUnconditionedSpace_Simple’

Area

<JSON number>

• Parent: BuildingElementAdjacentUnconditionedSpace_Simple

• Description: Area of this building element (unit: m²)

Areal Heat Capacity

<JSON number>

• Parent: BuildingElementAdjacentUnconditionedSpace_Simple

• Description: Areal heat capacity (unit: J/m2.K)

Pitch

<JSON number>

• Parent: BuildingElementAdjacentUnconditionedSpace_Simple

• Description: Tilt angle of the surface from horizontal, between 0 and 180, where 0 means the external surface is facing up, 90 means the external surface is vertical and 180 means the external surface is facing down (unit: ˚)

Thermal Resistance Construction

<JSON value>

• Parent: BuildingElementAdjacentUnconditionedSpace_Simple

• Description: Thermal resistance (unit: m2.K/W)

• Default: <JSON null>

• AnyOf:

  • <JSON number>

  • <JSON null>

Thermal Resistance Unconditioned Space

<JSON number>

• Parent: BuildingElementAdjacentUnconditionedSpace_Simple

• Description: Effective thermal resistance of unheated space (unit: m².K/W)

U Value

<JSON value>

• Parent: BuildingElementAdjacentUnconditionedSpace_Simple

• Default: <JSON null>

• AnyOf:

  • <JSON number>

  • <JSON null>

BuildingElementGroundHeatedBasement

<JSON object>

• Parent(s): Buildingelement

• Description: Heated basement - uses init_heated_basement()

• Named name/value pairs:

  • type (required): Type

  • area (required): Area

  • total_area (required): Total Area

  • perimeter (required): Perimeter

  • areal_heat_capacity (required): Areal Heat Capacity

  • thermal_resistance_floor_construction (required): Thermal Resistance Floor Construction

  • u_value (required): U Value

  • psi_wall_floor_junc (required): Psi Wall Floor Junc

  • mass_distribution_class (required): MassDistributionClass

  • pitch (required): Pitch

  • thickness_walls (required): Thickness Walls

  • height_upper_surface: Height Upper Surface

  • shield_fact_location:

    • <JSON value>

      • Description: Wind shielding factor

      • Default: <JSON null>

      • AnyOf:

        • WindShieldLocation

        • <JSON null>

  • floor_type (required): Floor Type

  • depth_basement_floor (required): Depth Basement Floor

  • thermal_resist_walls_base (required): Thermal Resist Walls Base

  • height_basement_walls: Height Basement Walls

  • thermal_transm_envi_base: Thermal Transm Envi Base

  • thermal_transm_walls: Thermal Transm Walls

  • edge_insulation: Edge Insulation

• User-named name/value pairs: NONE_ALLOWED

Type

<JSON string>

• Parent: BuildingElementGroundHeatedBasement

• Const: ‘BuildingElementGround’

Area

<JSON number>

• Parent: BuildingElementGroundHeatedBasement

• Description: Area of this building element within the zone (unit: m²)

Total Area

<JSON number>

• Parent: BuildingElementGroundHeatedBasement

• Description: Total area of the building element across entire dwelling; if the Floor is divided among several zones, this is the total area across all zones (unit: m²)

Perimeter

<JSON number>

• Parent: BuildingElementGroundHeatedBasement

• Description: Perimeter of the floor; calculated for the entire ground floor, even if it is distributed among several zones (unit: m)

Areal Heat Capacity

<JSON number>

• Parent: BuildingElementGroundHeatedBasement

• Description: Areal heat capacity of the ground floor element (unit: J/m2.K)

Thermal Resistance Floor Construction

<JSON number>

• Parent: BuildingElementGroundHeatedBasement

• Description: Total thermal resistance of all layers in the floor construction (unit: m².K/W)

U Value

<JSON number>

• Parent: BuildingElementGroundHeatedBasement

• Description: Steady-state thermal transmittance of floor, including the effect of the ground (calculated for the entire ground floor, even if it is distributed among several zones) (unit: W/m2.K)

Psi Wall Floor Junc

<JSON number>

• Parent: BuildingElementGroundHeatedBasement

• Description: Linear thermal transmittance of the junction between the floor and the walls (unit: W/m.K)

Pitch

<JSON number>

• Parent: BuildingElementGroundHeatedBasement

• Description: Tilt angle of the surface from horizontal, between 0 and 180, where 0 means the external surface is facing up, 90 means the external surface is vertical and 180 means the external surface is facing down (unit: ˚)

Thickness Walls

<JSON number>

• Parent: BuildingElementGroundHeatedBasement

• Description: Thickness of the walls (unit: m)

Height Upper Surface

<JSON value>

• Parent: BuildingElementGroundHeatedBasement

• Default: <JSON null>

• AnyOf:

  • <JSON number>

  • <JSON null>

Floor Type

<JSON string>

• Parent: BuildingElementGroundHeatedBasement

• Const: ‘Heated_basement’

Depth Basement Floor

<JSON number>

• Parent: BuildingElementGroundHeatedBasement

• Description: Depth of basement floor below ground level (unit: m)

Thermal Resist Walls Base

<JSON number>

• Parent: BuildingElementGroundHeatedBasement

• Description: Thermal resistance of walls of the basement (unit: m².K/W)

Height Basement Walls

<JSON value>

• Parent: BuildingElementGroundHeatedBasement

• Description: Height of the basement walls above ground level (unit: m)

• Default: <JSON null>

• AnyOf:

  • <JSON number>

  • <JSON null>

Thermal Transm Envi Base

<JSON value>

• Parent: BuildingElementGroundHeatedBasement

• Description: Thermal transmittance of floor above basement (unit: W/m².K)

• Default: <JSON null>

• AnyOf:

  • <JSON number>

  • <JSON null>

Thermal Transm Walls

<JSON value>

• Parent: BuildingElementGroundHeatedBasement

• Description: Thermal transmittance of walls above ground (unit: W/m².K)

• Default: <JSON null>

• AnyOf:

  • <JSON number>

  • <JSON null>

Edge Insulation

<JSON value>

• Parent: BuildingElementGroundHeatedBasement

• Default: <JSON null>

• AnyOf:

  • <JSON array>

    • Items: <JSON value>

    • OneOf:

      • EdgeInsulationHorizontal

      • EdgeInsulationVertical

    • Non-JSON Schema keywords:

      • discriminator: {‘mapping’: {‘horizontal’: ‘#/$defs/EdgeInsulationHorizontal’, ‘vertical’: ‘#/$defs/EdgeInsulationVertical’}, ‘propertyName’: ‘type’}

  • <JSON null>

BuildingElementGroundSlabEdgeInsulation

<JSON object>

• Parent(s): Buildingelement

• Description: Slab floor with edge insulation - uses init_slab_on_ground_floor_edge_insulated()

• Named name/value pairs:

  • type (required): Type

  • area (required): Area

  • total_area (required): Total Area

  • perimeter (required): Perimeter

  • areal_heat_capacity (required): Areal Heat Capacity

  • thermal_resistance_floor_construction (required): Thermal Resistance Floor Construction

  • u_value (required): U Value

  • psi_wall_floor_junc (required): Psi Wall Floor Junc

  • mass_distribution_class (required): MassDistributionClass

  • pitch (required): Pitch

  • thickness_walls (required): Thickness Walls

  • height_upper_surface: Height Upper Surface

  • shield_fact_location:

    • <JSON value>

      • Description: Wind shielding factor

      • Default: <JSON null>

      • AnyOf:

        • WindShieldLocation

        • <JSON null>

  • floor_type (required): Floor Type

  • edge_insulation: Edge Insulation

• User-named name/value pairs: NONE_ALLOWED

Type

<JSON string>

• Parent: BuildingElementGroundSlabEdgeInsulation

• Const: ‘BuildingElementGround’

Area

<JSON number>

• Parent: BuildingElementGroundSlabEdgeInsulation

• Description: Area of this building element within the zone (unit: m²)

Total Area

<JSON number>

• Parent: BuildingElementGroundSlabEdgeInsulation

• Description: Total area of the building element across entire dwelling; if the Floor is divided among several zones, this is the total area across all zones (unit: m²)

Perimeter

<JSON number>

• Parent: BuildingElementGroundSlabEdgeInsulation

• Description: Perimeter of the floor; calculated for the entire ground floor, even if it is distributed among several zones (unit: m)

Areal Heat Capacity

<JSON number>

• Parent: BuildingElementGroundSlabEdgeInsulation

• Description: Areal heat capacity of the ground floor element (unit: J/m2.K)

Thermal Resistance Floor Construction

<JSON number>

• Parent: BuildingElementGroundSlabEdgeInsulation

• Description: Total thermal resistance of all layers in the floor construction (unit: m².K/W)

U Value

<JSON number>

• Parent: BuildingElementGroundSlabEdgeInsulation

• Description: Steady-state thermal transmittance of floor, including the effect of the ground (calculated for the entire ground floor, even if it is distributed among several zones) (unit: W/m2.K)

Psi Wall Floor Junc

<JSON number>

• Parent: BuildingElementGroundSlabEdgeInsulation

• Description: Linear thermal transmittance of the junction between the floor and the walls (unit: W/m.K)

Pitch

<JSON number>

• Parent: BuildingElementGroundSlabEdgeInsulation

• Description: Tilt angle of the surface from horizontal, between 0 and 180, where 0 means the external surface is facing up, 90 means the external surface is vertical and 180 means the external surface is facing down (unit: ˚)

Thickness Walls

<JSON number>

• Parent: BuildingElementGroundSlabEdgeInsulation

• Description: Thickness of the walls (unit: m)

Height Upper Surface

<JSON value>

• Parent: BuildingElementGroundSlabEdgeInsulation

• Default: <JSON null>

• AnyOf:

  • <JSON number>

  • <JSON null>

Floor Type

<JSON string>

• Parent: BuildingElementGroundSlabEdgeInsulation

• Const: ‘Slab_edge_insulation’

Edge Insulation

<JSON value>

• Parent: BuildingElementGroundSlabEdgeInsulation

• Default: <JSON null>

• AnyOf:

  • <JSON array>

    • Items: <JSON value>

    • OneOf:

      • EdgeInsulationHorizontal

      • EdgeInsulationVertical

    • Non-JSON Schema keywords:

      • discriminator: {‘mapping’: {‘horizontal’: ‘#/$defs/EdgeInsulationHorizontal’, ‘vertical’: ‘#/$defs/EdgeInsulationVertical’}, ‘propertyName’: ‘type’}

  • <JSON null>

BuildingElementGroundSlabNoEdgeInsulation

<JSON object>

• Parent(s): Buildingelement

• Description: Slab floor with no edge insulation - uses init_slab_on_ground_floor_uninsulated_or_all_insulation()

• Named name/value pairs:

  • type (required): Type

  • area (required): Area

  • total_area (required): Total Area

  • perimeter (required): Perimeter

  • areal_heat_capacity (required): Areal Heat Capacity

  • thermal_resistance_floor_construction (required): Thermal Resistance Floor Construction

  • u_value (required): U Value

  • psi_wall_floor_junc (required): Psi Wall Floor Junc

  • mass_distribution_class (required): MassDistributionClass

  • pitch (required): Pitch

  • thickness_walls (required): Thickness Walls

  • height_upper_surface: Height Upper Surface

  • shield_fact_location:

    • <JSON value>

      • Description: Wind shielding factor

      • Default: <JSON null>

      • AnyOf:

        • WindShieldLocation

        • <JSON null>

  • floor_type (required): Floor Type

  • edge_insulation: Edge Insulation

• User-named name/value pairs: NONE_ALLOWED

Type

<JSON string>

• Parent: BuildingElementGroundSlabNoEdgeInsulation

• Const: ‘BuildingElementGround’

Area

<JSON number>

• Parent: BuildingElementGroundSlabNoEdgeInsulation

• Description: Area of this building element within the zone (unit: m²)

Total Area

<JSON number>

• Parent: BuildingElementGroundSlabNoEdgeInsulation

• Description: Total area of the building element across entire dwelling; if the Floor is divided among several zones, this is the total area across all zones (unit: m²)

Perimeter

<JSON number>

• Parent: BuildingElementGroundSlabNoEdgeInsulation

• Description: Perimeter of the floor; calculated for the entire ground floor, even if it is distributed among several zones (unit: m)

Areal Heat Capacity

<JSON number>

• Parent: BuildingElementGroundSlabNoEdgeInsulation

• Description: Areal heat capacity of the ground floor element (unit: J/m2.K)

Thermal Resistance Floor Construction

<JSON number>

• Parent: BuildingElementGroundSlabNoEdgeInsulation

• Description: Total thermal resistance of all layers in the floor construction (unit: m².K/W)

U Value

<JSON number>

• Parent: BuildingElementGroundSlabNoEdgeInsulation

• Description: Steady-state thermal transmittance of floor, including the effect of the ground (calculated for the entire ground floor, even if it is distributed among several zones) (unit: W/m2.K)

Psi Wall Floor Junc

<JSON number>

• Parent: BuildingElementGroundSlabNoEdgeInsulation

• Description: Linear thermal transmittance of the junction between the floor and the walls (unit: W/m.K)

Pitch

<JSON number>

• Parent: BuildingElementGroundSlabNoEdgeInsulation

• Description: Tilt angle of the surface from horizontal, between 0 and 180, where 0 means the external surface is facing up, 90 means the external surface is vertical and 180 means the external surface is facing down (unit: ˚)

Thickness Walls

<JSON number>

• Parent: BuildingElementGroundSlabNoEdgeInsulation

• Description: Thickness of the walls (unit: m)

Height Upper Surface

<JSON value>

• Parent: BuildingElementGroundSlabNoEdgeInsulation

• Default: <JSON null>

• AnyOf:

  • <JSON number>

  • <JSON null>

Floor Type

<JSON string>

• Parent: BuildingElementGroundSlabNoEdgeInsulation

• Const: ‘Slab_no_edge_insulation’

Edge Insulation

<JSON value>

• Parent: BuildingElementGroundSlabNoEdgeInsulation

• Default: <JSON null>

• AnyOf:

  • <JSON array>

    • Items: <JSON value>

    • OneOf:

      • EdgeInsulationHorizontal

      • EdgeInsulationVertical

    • Non-JSON Schema keywords:

      • discriminator: {‘mapping’: {‘horizontal’: ‘#/$defs/EdgeInsulationHorizontal’, ‘vertical’: ‘#/$defs/EdgeInsulationVertical’}, ‘propertyName’: ‘type’}

  • <JSON null>

BuildingElementGroundSuspendedFloor

<JSON object>

• Parent(s): Buildingelement

• Description: Suspended floor - uses init_suspended_floor()

• Named name/value pairs:

  • type (required): Type

  • area (required): Area

  • total_area (required): Total Area

  • perimeter (required): Perimeter

  • areal_heat_capacity (required): Areal Heat Capacity

  • thermal_resistance_floor_construction (required): Thermal Resistance Floor Construction

  • u_value (required): U Value

  • psi_wall_floor_junc (required): Psi Wall Floor Junc

  • mass_distribution_class (required): MassDistributionClass

  • pitch (required): Pitch

  • thickness_walls (required): Thickness Walls

  • height_upper_surface: Height Upper Surface

  • shield_fact_location:

    • <JSON value>

      • Description: Wind shielding factor

      • Default: <JSON null>

      • AnyOf:

        • WindShieldLocation

        • <JSON null>

  • floor_type (required): Floor Type

  • area_per_perimeter_vent: Area Per Perimeter Vent

  • thermal_resist_insul: Thermal Resist Insul

  • thermal_transm_walls: Thermal Transm Walls

  • edge_insulation: Edge Insulation

• User-named name/value pairs: NONE_ALLOWED

Type

<JSON string>

• Parent: BuildingElementGroundSuspendedFloor

• Const: ‘BuildingElementGround’

Area

<JSON number>

• Parent: BuildingElementGroundSuspendedFloor

• Description: Area of this building element within the zone (unit: m²)

Total Area

<JSON number>

• Parent: BuildingElementGroundSuspendedFloor

• Description: Total area of the building element across entire dwelling; if the Floor is divided among several zones, this is the total area across all zones (unit: m²)

Perimeter

<JSON number>

• Parent: BuildingElementGroundSuspendedFloor

• Description: Perimeter of the floor; calculated for the entire ground floor, even if it is distributed among several zones (unit: m)

Areal Heat Capacity

<JSON number>

• Parent: BuildingElementGroundSuspendedFloor

• Description: Areal heat capacity of the ground floor element (unit: J/m2.K)

Thermal Resistance Floor Construction

<JSON number>

• Parent: BuildingElementGroundSuspendedFloor

• Description: Total thermal resistance of all layers in the floor construction (unit: m².K/W)

U Value

<JSON number>

• Parent: BuildingElementGroundSuspendedFloor

• Description: Steady-state thermal transmittance of floor, including the effect of the ground (calculated for the entire ground floor, even if it is distributed among several zones) (unit: W/m2.K)

Psi Wall Floor Junc

<JSON number>

• Parent: BuildingElementGroundSuspendedFloor

• Description: Linear thermal transmittance of the junction between the floor and the walls (unit: W/m.K)

Pitch

<JSON number>

• Parent: BuildingElementGroundSuspendedFloor

• Description: Tilt angle of the surface from horizontal, between 0 and 180, where 0 means the external surface is facing up, 90 means the external surface is vertical and 180 means the external surface is facing down (unit: ˚)

Thickness Walls

<JSON number>

• Parent: BuildingElementGroundSuspendedFloor

• Description: Thickness of the walls (unit: m)

Height Upper Surface

<JSON value>

• Parent: BuildingElementGroundSuspendedFloor

• Default: <JSON null>

• AnyOf:

  • <JSON number>

  • <JSON null>

Floor Type

<JSON string>

• Parent: BuildingElementGroundSuspendedFloor

• Const: ‘Suspended_floor’

Area Per Perimeter Vent

<JSON value>

• Parent: BuildingElementGroundSuspendedFloor

• Description: Area of ventilation openings per perimeter (unit: m²/m)

• Default: <JSON null>

• AnyOf:

  • <JSON number>

  • <JSON null>

Thermal Resist Insul

<JSON value>

• Parent: BuildingElementGroundSuspendedFloor

• Description: Thermal resistance of insulation on base of underfloor space (unit: m².K/W)

• Default: <JSON null>

• AnyOf:

  • <JSON number>

  • <JSON null>

Thermal Transm Walls

<JSON value>

• Parent: BuildingElementGroundSuspendedFloor

• Description: Thermal transmittance of walls above ground (unit: W/m².K)

• Default: <JSON null>

• AnyOf:

  • <JSON number>

  • <JSON null>

Edge Insulation

<JSON value>

• Parent: BuildingElementGroundSuspendedFloor

• Default: <JSON null>

• AnyOf:

  • <JSON array>

    • Items: <JSON value>

    • OneOf:

      • EdgeInsulationHorizontal

      • EdgeInsulationVertical

    • Non-JSON Schema keywords:

      • discriminator: {‘mapping’: {‘horizontal’: ‘#/$defs/EdgeInsulationHorizontal’, ‘vertical’: ‘#/$defs/EdgeInsulationVertical’}, ‘propertyName’: ‘type’}

  • <JSON null>

BuildingElementGroundUnheatedBasement

<JSON object>

• Parent(s): Buildingelement

• Description: Unheated basement - uses init_unheated_basement()

• Named name/value pairs:

  • type (required): Type

  • area (required): Area

  • total_area (required): Total Area

  • perimeter (required): Perimeter

  • areal_heat_capacity (required): Areal Heat Capacity

  • thermal_resistance_floor_construction (required): Thermal Resistance Floor Construction

  • u_value (required): U Value

  • psi_wall_floor_junc (required): Psi Wall Floor Junc

  • mass_distribution_class (required): MassDistributionClass

  • pitch (required): Pitch

  • thickness_walls (required): Thickness Walls

  • height_upper_surface: Height Upper Surface

  • shield_fact_location:

    • <JSON value>

      • Description: Wind shielding factor

      • Default: <JSON null>

      • AnyOf:

        • WindShieldLocation

        • <JSON null>

  • floor_type (required): Floor Type

  • depth_basement_floor (required): Depth Basement Floor

  • height_basement_walls (required): Height Basement Walls

  • thermal_resist_walls_base (required): Thermal Resist Walls Base

  • thermal_transm_envi_base (required): Thermal Transm Envi Base

  • thermal_transm_walls (required): Thermal Transm Walls

  • edge_insulation: Edge Insulation

• User-named name/value pairs: NONE_ALLOWED

Type

<JSON string>

• Parent: BuildingElementGroundUnheatedBasement

• Const: ‘BuildingElementGround’

Area

<JSON number>

• Parent: BuildingElementGroundUnheatedBasement

• Description: Area of this building element within the zone (unit: m²)

Total Area

<JSON number>

• Parent: BuildingElementGroundUnheatedBasement

• Description: Total area of the building element across entire dwelling; if the Floor is divided among several zones, this is the total area across all zones (unit: m²)

Perimeter

<JSON number>

• Parent: BuildingElementGroundUnheatedBasement

• Description: Perimeter of the floor; calculated for the entire ground floor, even if it is distributed among several zones (unit: m)

Areal Heat Capacity

<JSON number>

• Parent: BuildingElementGroundUnheatedBasement

• Description: Areal heat capacity of the ground floor element (unit: J/m2.K)

Thermal Resistance Floor Construction

<JSON number>

• Parent: BuildingElementGroundUnheatedBasement

• Description: Total thermal resistance of all layers in the floor construction (unit: m².K/W)

U Value

<JSON number>

• Parent: BuildingElementGroundUnheatedBasement

• Description: Steady-state thermal transmittance of floor, including the effect of the ground (calculated for the entire ground floor, even if it is distributed among several zones) (unit: W/m2.K)

Psi Wall Floor Junc

<JSON number>

• Parent: BuildingElementGroundUnheatedBasement

• Description: Linear thermal transmittance of the junction between the floor and the walls (unit: W/m.K)

Pitch

<JSON number>

• Parent: BuildingElementGroundUnheatedBasement

• Description: Tilt angle of the surface from horizontal, between 0 and 180, where 0 means the external surface is facing up, 90 means the external surface is vertical and 180 means the external surface is facing down (unit: ˚)

Thickness Walls

<JSON number>

• Parent: BuildingElementGroundUnheatedBasement

• Description: Thickness of the walls (unit: m)

Height Upper Surface

<JSON value>

• Parent: BuildingElementGroundUnheatedBasement

• Default: <JSON null>

• AnyOf:

  • <JSON number>

  • <JSON null>

Floor Type

<JSON string>

• Parent: BuildingElementGroundUnheatedBasement

• Const: ‘Unheated_basement’

Depth Basement Floor

<JSON number>

• Parent: BuildingElementGroundUnheatedBasement

• Description: Depth of basement floor below ground level (unit: m)

Height Basement Walls

<JSON number>

• Parent: BuildingElementGroundUnheatedBasement

• Description: Height of the basement walls above ground level (unit: m)

Thermal Resist Walls Base

<JSON number>

• Parent: BuildingElementGroundUnheatedBasement

• Description: Thermal resistance of walls of the basement (unit: m².K/W)

Thermal Transm Envi Base

<JSON number>

• Parent: BuildingElementGroundUnheatedBasement

• Description: Thermal transmittance of floor above basement (unit: W/m².K)

Thermal Transm Walls

<JSON number>

• Parent: BuildingElementGroundUnheatedBasement

• Description: Thermal transmittance of walls above ground (unit: W/m².K)

Edge Insulation

<JSON value>

• Parent: BuildingElementGroundUnheatedBasement

• Default: <JSON null>

• AnyOf:

  • <JSON array>

    • Items: <JSON value>

    • OneOf:

      • EdgeInsulationHorizontal

      • EdgeInsulationVertical

    • Non-JSON Schema keywords:

      • discriminator: {‘mapping’: {‘horizontal’: ‘#/$defs/EdgeInsulationHorizontal’, ‘vertical’: ‘#/$defs/EdgeInsulationVertical’}, ‘propertyName’: ‘type’}

  • <JSON null>

BuildingElementOpaque

<JSON object>

• Parent(s): Buildingelement

• Named name/value pairs:

  • type (required): Type

  • area (required): Area

  • areal_heat_capacity (required): Areal Heat Capacity

  • base_height (required): Base Height

  • height (required): Height

  • is_unheated_pitched_roof: Is Unheated Pitched Roof

  • mass_distribution_class (required): MassDistributionClass

  • orientation360 (required): Orientation360

  • pitch (required): Pitch

  • solar_absorption_coeff (required): Solar Absorption Coeff

  • thermal_resistance_construction: Thermal Resistance Construction

  • u_value: U Value

  • width (required): Width

• User-named name/value pairs: NONE_ALLOWED

Type

<JSON string>

• Parent: BuildingElementOpaque

• Const: ‘BuildingElementOpaque’

Area

<JSON number>

• Parent: BuildingElementOpaque

• Description: Net area of the opaque building element (i.e. minus any windows / doors / etc.) (unit: m²)

Areal Heat Capacity

<JSON number>

• Parent: BuildingElementOpaque

• Description: Areal heat capacity (unit: J/m².K)

Base Height

<JSON number>

• Parent: BuildingElementOpaque

• Description: The distance between the ground and the lowest edge of the element (unit: m)

Height

<JSON number>

• Parent: BuildingElementOpaque

• Description: The height of the building element (unit: m)

Is Unheated Pitched Roof

<JSON value>

• Parent: BuildingElementOpaque

• Default: <JSON null>

• AnyOf:

  • <JSON boolean>

  • <JSON null>

Orientation360

<JSON number>

• Parent: BuildingElementOpaque

• Description: The orientation angle of the inclined surface, expressed as the geographical azimuth angle of the horizontal projection of the inclined surface normal, 0 to 360 (unit: ˚)

Pitch

<JSON number>

• Parent: BuildingElementOpaque

• Description: Tilt angle of the surface from horizontal, between 0 and 180, where 0 means the external surface is facing up, 90 means the external surface is vertical and 180 means the external surface is facing down (unit: ˚)

Solar Absorption Coeff

<JSON number>

• Parent: BuildingElementOpaque

• Description: Solar absorption coefficient at the external surface (dimensionless)

Thermal Resistance Construction

<JSON value>

• Parent: BuildingElementOpaque

• Description: Thermal resistance (unit: m².K/W)

• Default: <JSON null>

• AnyOf:

  • <JSON number>

  • <JSON null>

U Value

<JSON value>

• Parent: BuildingElementOpaque

• Default: <JSON null>

• AnyOf:

  • <JSON number>

  • <JSON null>

Width

<JSON number>

• Parent: BuildingElementOpaque

• Description: The width of the building element (unit: m)

BuildingElementTransparent

<JSON object>

• Parent(s): Buildingelement

• Named name/value pairs:

  • type (required): Type

  • Control_WindowOpenable: Control Windowopenable

  • base_height (required): Base Height

  • frame_area_fraction (required): Frame Area Fraction

  • free_area_height (required): Free Area Height

  • g_value (required): G Value

  • height (required): Height

  • max_window_open_area (required): Max Window Open Area

  • mid_height (required): Mid Height

  • orientation360 (required): Orientation360

  • pitch (required): Pitch

  • shading (required): Shading

  • thermal_resistance_construction: Thermal Resistance Construction

  • treatment: Treatment

  • u_value: U Value

  • width (required): Width

  • window_part_list (required): Window Part List

• User-named name/value pairs: NONE_ALLOWED

Type

<JSON string>

• Parent: BuildingElementTransparent

• Const: ‘BuildingElementTransparent’

Control Windowopenable

<JSON value>

• Parent: BuildingElementTransparent

• Default: <JSON null>

• AnyOf:

  • <JSON string>

  • <JSON null>

Base Height

<JSON number>

• Parent: BuildingElementTransparent

• Description: The distance between the ground and the lowest edge of the element (unit: m)

Frame Area Fraction

<JSON number>

• Parent: BuildingElementTransparent

• Description: The frame area fraction of window, ratio of the projected frame area to the overall projected area of the glazed element of the window

Free Area Height

<JSON number>

• Parent: BuildingElementTransparent

G Value

<JSON number>

• Parent: BuildingElementTransparent

• Description: Total solar energy transmittance of the transparent part of the window

Height

<JSON number>

• Parent: BuildingElementTransparent

• Description: The height of the building element (unit: m)

Max Window Open Area

<JSON number>

• Parent: BuildingElementTransparent

Mid Height

<JSON number>

• Parent: BuildingElementTransparent

Orientation360

<JSON number>

• Parent: BuildingElementTransparent

• Description: The orientation angle of the inclined surface, expressed as the geographical azimuth angle of the horizontal projection of the inclined surface normal, 0 to 360 (unit: ˚)

Pitch

<JSON number>

• Parent: BuildingElementTransparent

• Description: Tilt angle of the surface from horizontal, between 0 and 180, where 0 means the external surface is facing up, 90 means the external surface is vertical and 180 means the external surface is facing down (unit: ˚)

Shading

<JSON array>

• Parent: BuildingElementTransparent

• Items: <JSON value>

• AnyOf:

  • WindowShadingObject

  • WindowShadingObstacle

Thermal Resistance Construction

<JSON value>

• Parent: BuildingElementTransparent

• Description: Thermal resistance (unit: m².K/W)

• Default: <JSON null>

• AnyOf:

  • <JSON number>

  • <JSON null>

Treatment

<JSON value>

• Parent: BuildingElementTransparent

• Default: <JSON null>

• AnyOf:

  • <JSON array>

    • Items: WindowTreatment

  • <JSON null>

U Value

<JSON value>

• Parent: BuildingElementTransparent

• Default: <JSON null>

• AnyOf:

  • <JSON number>

  • <JSON null>

Width

<JSON number>

• Parent: BuildingElementTransparent

• Description: The width of the building element (unit: m)

Window Part List

<JSON array>

• Parent: BuildingElementTransparent

• Items: WindowPart

ChargeLevel

<JSON value>

• Parent(s): ControlChargeTarget

• AnyOf:

  • <JSON number>

  • <JSON array>

    • Items: <JSON number>

  • ScheduleForDouble

ColdWaterSource

<JSON object>

• Parent(s): ColdWaterSource collection

• Named name/value pairs:

  • start_day (required): Start Day

  • temperatures (required): Temperatures

  • time_series_step (required): Time Series Step

• User-named name/value pairs: NONE_ALLOWED

Start Day

<JSON integer>

• Parent: ColdWaterSource

• Maximum: 365

• Minimum: 0

• Description: First day of the time series, day of the year, 0 to 365

Temperatures

<JSON array>

• Parent: ColdWaterSource

• Description: List of cold water temperatures, one entry per hour (unit: ˚C)

• Items: <JSON number>

Time Series Step

<JSON number>

• Parent: ColdWaterSource

• Description: Timestep of the time series data (unit: hours)

ControlChargeTarget

<JSON object>

• Parent(s): Control choice

• Named name/value pairs:

  • type (required): Type

  • charge_level:

    • <JSON value>

      • Description: Proportion of the charge targeted for each day

      • Default: <JSON null>

      • AnyOf:

        • ChargeLevel

        • <JSON null>

  • external_sensor:

    • <JSON value>

      • Default: <JSON null>

      • AnyOf:

        • ExternalSensor

        • <JSON null>

  • logic_type:

    • <JSON value>

      • Default: <JSON null>

      • AnyOf:

        • ControlLogicType

        • <JSON null>

  • schedule (required): ScheduleForBoolean

  • start_day (required): Start Day

  • temp_charge_cut: Temp Charge Cut

  • temp_charge_cut_delta:

    • <JSON value>

      • Default: <JSON null>

      • AnyOf:

        • ScheduleForDouble

        • <JSON null>

  • time_series_step (required): Time Series Step

• User-named name/value pairs: NONE_ALLOWED

Type

<JSON string>

• Parent: ControlChargeTarget

• Const: ‘ChargeControl’

Start Day

<JSON integer>

• Parent: ControlChargeTarget

• Maximum: 365

• Minimum: 0

• Description: First day of the time series, day of the year, 0 to 365

Temp Charge Cut

<JSON value>

• Parent: ControlChargeTarget

• Default: <JSON null>

• AnyOf:

  • <JSON number>

  • <JSON null>

Time Series Step

<JSON number>

• Parent: ControlChargeTarget

• Description: Timestep of the time series data (unit: hours)

ControlCombination

<JSON object>

• Parent(s): ControlCombinations

• Named name/value pairs:

  • controls (required): Controls

  • operation (required): ControlCombinationOperation

• User-named name/value pairs: NONE_ALLOWED

Controls

<JSON array>

• Parent: ControlCombination

• MinItems: 1

• Items: <JSON string>

ControlCombinationOperation

<JSON string>

• Parent(s): ControlCombination

• Enum: [‘AND’, ‘OR’, ‘XOR’, ‘NOT’, ‘MAX’, ‘MIN’, ‘MEAN’]

ControlCombinationTime

<JSON object>

• Parent(s): Control choice

• Named name/value pairs:

  • type (required): Type

  • combination (required): ControlCombinations

• User-named name/value pairs: NONE_ALLOWED

Type

<JSON string>

• Parent: ControlCombinationTime

• Const: ‘CombinationTimeControl’

ControlCombinations

<JSON object>

• Parent(s): ControlCombinationTime

• Description: A dictionary of control combinations where: - Keys are user-defined names (e.g., “main”, “week”, “weekday”, “weekend”) - Values conform to the ControlCombination schema - The “main” entry is required

• User-named name/value pairs: {ANY_NAME: ControlCombination}

ControlLogicType

<JSON string>

• Parent(s): ControlChargeTarget

• Enum: [‘celect’, ‘heat_battery’, ‘hhrsh’, ‘automatic’, ‘manual’]

ControlOnOffCostMinimising

<JSON object>

• Parent(s): Control choice

• Named name/value pairs:

  • type (required): Type

  • schedule (required): ScheduleForDouble

  • start_day (required): Start Day

  • time_on_daily (required): Time On Daily

  • time_series_step (required): Time Series Step

• User-named name/value pairs: NONE_ALLOWED

Type

<JSON string>

• Parent: ControlOnOffCostMinimising

• Const: ‘OnOffCostMinimisingTimeControl’

Start Day

<JSON integer>

• Parent: ControlOnOffCostMinimising

• Maximum: 365

• Minimum: 0

• Description: First day of the time series, day of the year, 0 to 365

Time On Daily

<JSON number>

• Parent: ControlOnOffCostMinimising

• Description: Number of ‘on’ hours to be set per day

Time Series Step

<JSON number>

• Parent: ControlOnOffCostMinimising

• Description: Timestep of the time series data (unit: hours)

ControlOnOffTimer

<JSON object>

• Parent(s): Control choice

• Named name/value pairs:

  • type (required): Type

  • allow_null: Allow Null

  • schedule (required): ScheduleForBoolean

  • start_day (required): Start Day

  • time_series_step (required): Time Series Step

• User-named name/value pairs: NONE_ALLOWED

Type

<JSON string>

• Parent: ControlOnOffTimer

• Const: ‘OnOffTimeControl’

Allow Null

<JSON value>

• Parent: ControlOnOffTimer

• Default: <JSON null>

• AnyOf:

  • <JSON boolean>

  • <JSON null>

Start Day

<JSON integer>

• Parent: ControlOnOffTimer

• Maximum: 365

• Minimum: 0

• Description: First day of the time series, day of the year, 0 to 365

Time Series Step

<JSON number>

• Parent: ControlOnOffTimer

• Description: Timestep of the time series data (unit: hours)

ControlSetpointTimer

<JSON object>

• Parent(s): Control choice

• Named name/value pairs:

  • type (required): Type

  • advanced_start: Advanced Start

  • default_to_max: Default To Max

  • schedule (required): ScheduleForDouble

  • setpoint_max: Setpoint Max

  • setpoint_min: Setpoint Min

  • start_day (required): Start Day

  • time_series_step (required): Time Series Step

• User-named name/value pairs: NONE_ALLOWED

Type

<JSON string>

• Parent: ControlSetpointTimer

• Const: ‘SetpointTimeControl’

Advanced Start

<JSON value>

• Parent: ControlSetpointTimer

• Description: How long before heating period the system should switch on (unit: hours)

• Default: <JSON null>

• AnyOf:

  • <JSON number>

  • <JSON null>

Default To Max

<JSON value>

• Parent: ControlSetpointTimer

• Description: If both min and max limits are set but setpoint is not, whether to default to min (false) or max (true)

• Default: <JSON null>

• AnyOf:

  • <JSON boolean>

  • <JSON null>

Setpoint Max

<JSON value>

• Parent: ControlSetpointTimer

• Description: Maximum setpoint allowed

• Default: <JSON null>

• AnyOf:

  • <JSON number>

  • <JSON null>

Setpoint Min

<JSON value>

• Parent: ControlSetpointTimer

• Description: Minimum setpoint allowed

• Default: <JSON null>

• AnyOf:

  • <JSON number>

  • <JSON null>

Start Day

<JSON integer>

• Parent: ControlSetpointTimer

• Maximum: 365

• Minimum: 0

• Description: First day of the time series, day of the year, 0 to 365

Time Series Step

<JSON number>

• Parent: ControlSetpointTimer

• Description: Timestep of the time series data (unit: hours)

CustomEnergySourceFactor

<JSON object>

• Parent(s): EnergySupply

• Named name/value pairs:

  • Emissions Factor kgCO2e/kWh (required): Emissions Factor Kgco2E/Kwh

  • Emissions Factor kgCO2e/kWh including out-of-scope emissions (required): Emissions Factor Kgco2E/Kwh Including Out-Of-Scope Emissions

  • Primary Energy Factor kWh/kWh delivered (required): Primary Energy Factor Kwh/Kwh Delivered

• User-named name/value pairs: NONE_ALLOWED

Emissions Factor Kgco2E/Kwh

<JSON number>

• Parent: CustomEnergySourceFactor

Emissions Factor Kgco2E/Kwh Including Out-Of-Scope Emissions

<JSON number>

• Parent: CustomEnergySourceFactor

Primary Energy Factor Kwh/Kwh Delivered

<JSON number>

• Parent: CustomEnergySourceFactor

DuctShape

<JSON string>

• Parent(s): MechanicalVentilationDuctwork

• Enum: [‘circular’, ‘rectangular’]

DuctType

<JSON string>

• Parent(s): MechanicalVentilationDuctwork

• Enum: [‘intake’, ‘supply’, ‘extract’, ‘exhaust’]

EcoDesignController

<JSON object>

• Parent(s): SpaceHeatSystemWetDistribution

• Named name/value pairs:

  • ecodesign_control_class (required): EcoDesignControllerClass

  • max_outdoor_temp: Max Outdoor Temp

  • min_flow_temp: Min Flow Temp

  • min_outdoor_temp: Min Outdoor Temp

• User-named name/value pairs: NONE_ALLOWED

Max Outdoor Temp

<JSON value>

• Parent: EcoDesignController

• Default: <JSON null>

• AnyOf:

  • <JSON number>

  • <JSON null>

Min Flow Temp

<JSON value>

• Parent: EcoDesignController

• Default: <JSON null>

• AnyOf:

  • <JSON number>

  • <JSON null>

Min Outdoor Temp

<JSON value>

• Parent: EcoDesignController

• Default: <JSON null>

• AnyOf:

  • <JSON number>

  • <JSON null>

EcoDesignControllerClass

<JSON integer>

• Parent(s): EcoDesignController

• Enum: [1, 2, 3, 4, 5, 6, 7, 8]

EdgeInsulationHorizontal

<JSON object>

• Parent(s): Edge Insulation, Edge Insulation, Edge Insulation, Edge Insulation, Edge Insulation

• Named name/value pairs:

  • type (required): Type

  • edge_thermal_resistance (required): Edge Thermal Resistance

  • width (required): Width

• User-named name/value pairs: NONE_ALLOWED

Type

<JSON string>

• Parent: EdgeInsulationHorizontal

• Const: ‘horizontal’

Edge Thermal Resistance

<JSON number>

• Parent: EdgeInsulationHorizontal

Width

<JSON number>

• Parent: EdgeInsulationHorizontal

EdgeInsulationVertical

<JSON object>

• Parent(s): Edge Insulation, Edge Insulation, Edge Insulation, Edge Insulation, Edge Insulation

• Named name/value pairs:

  • type (required): Type

  • edge_thermal_resistance (required): Edge Thermal Resistance

  • depth (required): Depth

• User-named name/value pairs: NONE_ALLOWED

Type

<JSON string>

• Parent: EdgeInsulationVertical

• Const: ‘vertical’

Edge Thermal Resistance

<JSON number>

• Parent: EdgeInsulationVertical

Depth

<JSON number>

• Parent: EdgeInsulationVertical

ElectricBattery

<JSON object>

• Parent(s): EnergySupply

• Named name/value pairs:

  • battery_age (required): Battery Age

  • battery_location (required): BatteryLocation

  • capacity (required): Capacity

  • charge_discharge_efficiency_round_trip (required): Charge Discharge Efficiency Round Trip

  • grid_charging_possible (required): Grid Charging Possible

  • maximum_charge_rate_one_way_trip (required): Maximum Charge Rate One Way Trip

  • maximum_discharge_rate_one_way_trip (required): Maximum Discharge Rate One Way Trip

  • minimum_charge_rate_one_way_trip (required): Minimum Charge Rate One Way Trip

• User-named name/value pairs: NONE_ALLOWED

Battery Age

<JSON number>

• Parent: ElectricBattery

Capacity

<JSON number>

• Parent: ElectricBattery

Charge Discharge Efficiency Round Trip

<JSON number>

• Parent: ElectricBattery

Grid Charging Possible

<JSON boolean>

• Parent: ElectricBattery

Maximum Charge Rate One Way Trip

<JSON number>

• Parent: ElectricBattery

Maximum Discharge Rate One Way Trip

<JSON number>

• Parent: ElectricBattery

Minimum Charge Rate One Way Trip

<JSON number>

• Parent: ElectricBattery

EnergyDiverter

<JSON object>

• Parent(s): EnergySupply

• Named name/value pairs:

  • Controlmax (required): Controlmax

  • HeatSource (required): Heatsource

• User-named name/value pairs: NONE_ALLOWED

Controlmax

<JSON string>

• Parent: EnergyDiverter

Heatsource

<JSON string>

• Parent: EnergyDiverter

EnergySupply

<JSON object>

• Parent(s): EnergySupply collection

• Named name/value pairs:

  • ElectricBattery:

    • <JSON value>

      • Default: <JSON null>

      • AnyOf:

        • ElectricBattery

        • <JSON null>

  • diverter:

    • <JSON value>

      • Default: <JSON null>

      • AnyOf:

        • EnergyDiverter

        • <JSON null>

  • factor:

    • <JSON value>

      • Default: <JSON null>

      • AnyOf:

        • CustomEnergySourceFactor

        • <JSON null>

  • fuel (required): FuelType

  • is_export_capable (required): Is Export Capable

  • priority: Priority

  • tariff: Tariff

  • threshold_charges: Threshold Charges

  • threshold_prices: Threshold Prices

• User-named name/value pairs: NONE_ALLOWED

Is Export Capable

<JSON boolean>

• Parent: EnergySupply

• Description: Denotes that this energy supply can export its surplus supply

Priority

<JSON value>

• Parent: EnergySupply

• Default: <JSON null>

• AnyOf:

  • <JSON array>

    • Items: EnergySupplyPriorityEntry

  • <JSON null>

Tariff

<JSON value>

• Parent: EnergySupply

• Default: <JSON null>

• AnyOf:

  • <JSON string>

  • <JSON null>

Threshold Charges

<JSON value>

• Parent: EnergySupply

• Default: <JSON null>

• AnyOf:

  • <JSON array>

    • MaxItems: 12

    • MinItems: 12

    • Items: <JSON number>

  • <JSON null>

Threshold Prices

<JSON value>

• Parent: EnergySupply

• Default: <JSON null>

• AnyOf:

  • <JSON array>

    • MaxItems: 12

    • MinItems: 12

    • Items: <JSON number>

  • <JSON null>

EnergySupplyPriorityEntry

<JSON string>

• Parent(s): Priority

• Enum: [‘ElectricBattery’, ‘diverter’]

ExternalConditionsInput

<JSON object>

• Parent(s): Input

• Named name/value pairs:

  • air_temperatures: Air Temperatures

  • diffuse_horizontal_radiation: Diffuse Horizontal Radiation

  • direct_beam_conversion_needed: Direct Beam Conversion Needed

  • direct_beam_radiation: Direct Beam Radiation

  • latitude: Latitude

  • longitude: Longitude

  • shading_segments: Shading Segments

  • solar_reflectivity_of_ground: Solar Reflectivity Of Ground

  • wind_directions: Wind Directions

  • wind_speeds: Wind Speeds

• User-named name/value pairs: NONE_ALLOWED

Air Temperatures

<JSON value>

• Parent: ExternalConditionsInput

• Description: List of external air temperatures, one entry per hour (unit: ˚C)

• Default: <JSON null>

• AnyOf:

  • <JSON array>

    • Items: <JSON number>

  • <JSON null>

Diffuse Horizontal Radiation

<JSON value>

• Parent: ExternalConditionsInput

• Description: List of diffuse horizontal radiation values, one entry per hour (unit: W/m²)

• Default: <JSON null>

• AnyOf:

  • <JSON array>

    • Items: <JSON number>

  • <JSON null>

Direct Beam Conversion Needed

<JSON value>

• Parent: ExternalConditionsInput

• Description: A flag to indicate whether direct beam radiation from climate data needs to be converted from horizontal to normal incidence; if normal direct beam radiation values are provided then no conversion is needed

• Default: <JSON null>

• AnyOf:

  • <JSON boolean>

  • <JSON null>

Direct Beam Radiation

<JSON value>

• Parent: ExternalConditionsInput

• Description: List of direct beam radiation values, one entry per hour (unit: W/m²)

• Default: <JSON null>

• AnyOf:

  • <JSON array>

    • Items: <JSON number>

  • <JSON null>

Latitude

<JSON value>

• Parent: ExternalConditionsInput

• Description: Latitude of weather station, angle from south (unit: ˚)

• Default: <JSON null>

• AnyOf:

  • <JSON number>

  • <JSON null>

Longitude

<JSON value>

• Parent: ExternalConditionsInput

• Description: Longitude of weather station, easterly +ve westerly -ve (unit: ˚)

• Default: <JSON null>

• AnyOf:

  • <JSON number>

  • <JSON null>

Shading Segments

<JSON value>

• Parent: ExternalConditionsInput

• Description: Data splitting the ground plane into segments (8-36) and giving height and distance to shading objects surrounding the building

• Default: <JSON null>

• AnyOf:

  • <JSON array>

    • Items: ShadingSegment

  • <JSON null>

Solar Reflectivity Of Ground

<JSON value>

• Parent: ExternalConditionsInput

• Description: List of ground reflectivity values, 0 to 1, one entry per hour

• Default: <JSON null>

• AnyOf:

  • <JSON array>

    • Items: <JSON number>

  • <JSON null>

Wind Directions

<JSON value>

• Parent: ExternalConditionsInput

• Description: List of wind directions in degrees where North=0, East=90, South=180, West=270. Values range: 0 to 360. Wind direction is reported by the direction from which it originates, e.g. a southerly (180 degree) wind blows from the south to the north. (unit: ˚)

• Default: <JSON null>

• AnyOf:

  • <JSON array>

    • Items: <JSON number>

  • <JSON null>

Wind Speeds

<JSON value>

• Parent: ExternalConditionsInput

• Description: List of wind speeds, one entry per hour (unit: m/s)

• Default: <JSON null>

• AnyOf:

  • <JSON array>

    • Items: <JSON number>

  • <JSON null>

ExternalSensor

<JSON object>

• Parent(s): ControlChargeTarget

• Named name/value pairs:

  • correlation (required): Correlation

• User-named name/value pairs: NONE_ALLOWED

Correlation

<JSON array>

• Parent: ExternalSensor

• Items: ExternalSensorCorrelation

ExternalSensorCorrelation

<JSON object>

• Parent(s): Correlation

• Named name/value pairs:

  • temperature (required): Temperature

  • max_charge (required): Max Charge

• User-named name/value pairs: NONE_ALLOWED

Temperature

<JSON number>

• Parent: ExternalSensorCorrelation

Max Charge

<JSON number>

• Parent: ExternalSensorCorrelation

FanSpeedData

<JSON object>

• Parent(s): Fan Speed Data

• Named name/value pairs:

  • power_output (required): Power Output

  • temperature_diff (required): Temperature Diff

• User-named name/value pairs: NONE_ALLOWED

Power Output

<JSON array>

• Parent: FanSpeedData

• Items: <JSON number>

Temperature Diff

<JSON number>

• Parent: FanSpeedData

FancoilTestData

<JSON object>

• Parent(s): WetEmitterFanCoil

• Named name/value pairs:

  • fan_power_W (required): Fan Power W

  • fan_speed_data (required): Fan Speed Data

• User-named name/value pairs: NONE_ALLOWED

Fan Power W

<JSON array>

• Parent: FancoilTestData

• Items: <JSON number>

Fan Speed Data

<JSON array>

• Parent: FancoilTestData

• Items: FanSpeedData

FuelType

<JSON string>

• Parent(s): EnergySupply

• Enum: [‘LPG_bottled’, ‘LPG_bulk’, ‘LPG_condition_11F’, ‘custom’, ‘electricity’, ‘energy_from_environment’, ‘mains_gas’, ‘unmet_demand’]

HeatPumpBackupControlType

<JSON string>

• Parent(s): HeatSourceWetHeatPump

• Enum: [‘None’, ‘TopUp’, ‘Substitute’]

HeatPumpBoiler

<JSON object>

• Parent(s): HeatSourceWetHeatPump

• Description: Boiler used as backup for heat pump systems

• Named name/value pairs:

  • EnergySupply (required): Energysupply

  • EnergySupply_aux (required): Energysupply Aux

  • boiler_location (required): HeatSourceLocation

  • efficiency_full_load (required): Efficiency Full Load

  • efficiency_part_load (required): Efficiency Part Load

  • electricity_circ_pump (required): Electricity Circ Pump

  • electricity_full_load (required): Electricity Full Load

  • electricity_part_load (required): Electricity Part Load

  • electricity_standby (required): Electricity Standby

  • modulation_load (required): Modulation Load

  • rated_power (required): Rated Power

  • cost_schedule_hybrid:

    • <JSON value>

      • Default: <JSON null>

      • AnyOf:

        • BoilerCostScheduleHybrid

        • <JSON null>

• User-named name/value pairs: NONE_ALLOWED

Energysupply

<JSON string>

• Parent: HeatPumpBoiler

Energysupply Aux

<JSON string>

• Parent: HeatPumpBoiler

Efficiency Full Load

<JSON number>

• Parent: HeatPumpBoiler

Efficiency Part Load

<JSON number>

• Parent: HeatPumpBoiler

Electricity Circ Pump

<JSON number>

• Parent: HeatPumpBoiler

Electricity Full Load

<JSON number>

• Parent: HeatPumpBoiler

Electricity Part Load

<JSON number>

• Parent: HeatPumpBoiler

Electricity Standby

<JSON number>

• Parent: HeatPumpBoiler

Modulation Load

<JSON number>

• Parent: HeatPumpBoiler

Rated Power

<JSON number>

• Parent: HeatPumpBoiler

HeatPumpBufferTank

<JSON object>

• Parent(s): HeatSourceWetHeatPump

• Named name/value pairs:

  • daily_losses (required): Daily Losses

  • pump_fixed_flow_rate (required): Pump Fixed Flow Rate

  • pump_power_at_flow_rate (required): Pump Power At Flow Rate

  • volume (required): Volume

• User-named name/value pairs: NONE_ALLOWED

Daily Losses

<JSON number>

• Parent: HeatPumpBufferTank

Pump Fixed Flow Rate

<JSON number>

• Parent: HeatPumpBufferTank

Pump Power At Flow Rate

<JSON number>

• Parent: HeatPumpBufferTank

Volume

<JSON number>

• Parent: HeatPumpBufferTank

HeatPumpHotWaterOnly

<JSON object>

• Parent(s): Heatsource, Heatsource

• Named name/value pairs:

  • type (required): Type

  • Controlmax (required): Controlmax

  • Controlmin (required): Controlmin

  • EnergySupply (required): Energysupply

  • daily_losses_declared (required): Daily Losses Declared

  • heat_exchanger_surface_area_declared (required): Heat Exchanger Surface Area Declared

  • heater_position (required): Heater Position

  • in_use_factor_mismatch (required): In Use Factor Mismatch

  • power_max (required): Power Max

  • tank_volume_declared (required): Tank Volume Declared

  • test_data (required): HeatPumpHotWaterTestData

  • thermostat_position: Thermostat Position

  • vol_hw_daily_average (required): Vol Hw Daily Average

• User-named name/value pairs: NONE_ALLOWED

Type

<JSON string>

• Parent: HeatPumpHotWaterOnly

• Const: ‘HeatPump_HWOnly’

Controlmax

<JSON string>

• Parent: HeatPumpHotWaterOnly

• Description: Reference to a control schedule of maximum temperature setpoints

Controlmin

<JSON string>

• Parent: HeatPumpHotWaterOnly

• Description: Reference to a control schedule of minimum temperature setpoints

Energysupply

<JSON string>

• Parent: HeatPumpHotWaterOnly

Daily Losses Declared

<JSON number>

• Parent: HeatPumpHotWaterOnly

Heat Exchanger Surface Area Declared

<JSON number>

• Parent: HeatPumpHotWaterOnly

Heater Position

<JSON number>

• Parent: HeatPumpHotWaterOnly

In Use Factor Mismatch

<JSON number>

• Parent: HeatPumpHotWaterOnly

Power Max

<JSON number>

• Parent: HeatPumpHotWaterOnly

Tank Volume Declared

<JSON number>

• Parent: HeatPumpHotWaterOnly

Thermostat Position

<JSON value>

• Parent: HeatPumpHotWaterOnly

• Description: Required for StorageTank but not for SmartHotWaterTank

• Default: <JSON null>

• AnyOf:

  • <JSON number>

  • <JSON null>

Vol Hw Daily Average

<JSON number>

• Parent: HeatPumpHotWaterOnly

HeatPumpHotWaterOnlyTestDatum

<JSON object>

• Parent(s): HeatPumpHotWaterTestData, HeatPumpHotWaterTestData

• Named name/value pairs:

  • cop_dhw (required): Cop Dhw

  • energy_input_measured (required): Energy Input Measured

  • hw_tapping_prof_daily_total (required): Hw Tapping Prof Daily Total

  • hw_vessel_loss_daily (required): Hw Vessel Loss Daily

  • power_standby (required): Power Standby

• User-named name/value pairs: NONE_ALLOWED

Cop Dhw

<JSON number>

• Parent: HeatPumpHotWaterOnlyTestDatum

Energy Input Measured

<JSON number>

• Parent: HeatPumpHotWaterOnlyTestDatum

Hw Tapping Prof Daily Total

<JSON number>

• Parent: HeatPumpHotWaterOnlyTestDatum

Hw Vessel Loss Daily

<JSON number>

• Parent: HeatPumpHotWaterOnlyTestDatum

Power Standby

<JSON number>

• Parent: HeatPumpHotWaterOnlyTestDatum

HeatPumpHotWaterTestData

<JSON object>

• Parent(s): HeatPumpHotWaterOnly

• Named name/value pairs:

  • L:

    • <JSON value>

      • Default: <JSON null>

      • AnyOf:

        • HeatPumpHotWaterOnlyTestDatum

        • <JSON null>

  • M (required): HeatPumpHotWaterOnlyTestDatum

• User-named name/value pairs: NONE_ALLOWED

HeatPumpSinkType

<JSON string>

• Parent(s): HeatSourceWetHeatPump

• Enum: [‘Water’, ‘Air’, ‘Glycol25’]

HeatPumpSourceType

<JSON string>

• Parent(s): HeatSourceWetHeatPump

• Enum: [‘Ground’, ‘OutsideAir’, ‘ExhaustAirMEV’, ‘ExhaustAirMVHR’, ‘ExhaustAirMixed’, ‘WaterGround’, ‘WaterSurface’, ‘HeatNetwork’]

HeatPumpTestDatum

<JSON object>

• Parent(s): Test Data En14825

• Named name/value pairs:

  • air_flow_rate: Air Flow Rate

  • capacity (required): Capacity

  • cop (required): Cop

  • degradation_coeff (required): Degradation Coeff

  • design_flow_temp (required): Design Flow Temp

  • eahp_mixed_ext_air_ratio: Eahp Mixed Ext Air Ratio

  • temp_outlet (required): Temp Outlet

  • temp_source (required): Temp Source

  • temp_test (required): Temp Test

  • test_letter (required): TestLetter

• User-named name/value pairs: NONE_ALLOWED

Air Flow Rate

<JSON value>

• Parent: HeatPumpTestDatum

• Default: <JSON null>

• AnyOf:

  • <JSON number>

  • <JSON null>

Capacity

<JSON number>

• Parent: HeatPumpTestDatum

Cop

<JSON number>

• Parent: HeatPumpTestDatum

Degradation Coeff

<JSON number>

• Parent: HeatPumpTestDatum

Design Flow Temp

<JSON number>

• Parent: HeatPumpTestDatum

Eahp Mixed Ext Air Ratio

<JSON value>

• Parent: HeatPumpTestDatum

• Default: <JSON null>

• AnyOf:

  • <JSON number>

  • <JSON null>

Temp Outlet

<JSON number>

• Parent: HeatPumpTestDatum

Temp Source

<JSON number>

• Parent: HeatPumpTestDatum

Temp Test

<JSON number>

• Parent: HeatPumpTestDatum

HeatSourceLocation

<JSON string>

• Parent(s): HeatPumpBoiler, HeatSourceWetBoiler

• Enum: [‘internal’, ‘external’]

HeatSourceWetBoiler

<JSON object>

• Parent(s): HeatSourceWet choice

• Description: Standalone boiler heat source

• Named name/value pairs:

  • EnergySupply (required): Energysupply

  • EnergySupply_aux (required): Energysupply Aux

  • boiler_location (required): HeatSourceLocation

  • efficiency_full_load (required): Efficiency Full Load

  • efficiency_part_load (required): Efficiency Part Load

  • electricity_circ_pump (required): Electricity Circ Pump

  • electricity_full_load (required): Electricity Full Load

  • electricity_part_load (required): Electricity Part Load

  • electricity_standby (required): Electricity Standby

  • modulation_load (required): Modulation Load

  • rated_power (required): Rated Power

  • type (required): Type

• User-named name/value pairs: NONE_ALLOWED

Energysupply

<JSON string>

• Parent: HeatSourceWetBoiler

Energysupply Aux

<JSON string>

• Parent: HeatSourceWetBoiler

Efficiency Full Load

<JSON number>

• Parent: HeatSourceWetBoiler

Efficiency Part Load

<JSON number>

• Parent: HeatSourceWetBoiler

Electricity Circ Pump

<JSON number>

• Parent: HeatSourceWetBoiler

Electricity Full Load

<JSON number>

• Parent: HeatSourceWetBoiler

Electricity Part Load

<JSON number>

• Parent: HeatSourceWetBoiler

Electricity Standby

<JSON number>

• Parent: HeatSourceWetBoiler

Modulation Load

<JSON number>

• Parent: HeatSourceWetBoiler

Rated Power

<JSON number>

• Parent: HeatSourceWetBoiler

Type

<JSON string>

• Parent: HeatSourceWetBoiler

• Const: ‘Boiler’

HeatSourceWetHIU

<JSON object>

• Parent(s): HeatSourceWet choice

• Named name/value pairs:

  • type (required): Type

  • EnergySupply (required): Energysupply

  • HIU_daily_loss (required): Hiu Daily Loss

  • building_level_distribution_losses (required): Building Level Distribution Losses

  • power_max (required): Power Max

• User-named name/value pairs: NONE_ALLOWED

Type

<JSON string>

• Parent: HeatSourceWetHIU

• Const: ‘HIU’

Energysupply

<JSON string>

• Parent: HeatSourceWetHIU

Hiu Daily Loss

<JSON number>

• Parent: HeatSourceWetHIU

Building Level Distribution Losses

<JSON number>

• Parent: HeatSourceWetHIU

Power Max

<JSON number>

• Parent: HeatSourceWetHIU

HeatSourceWetHeatBattery

<JSON object>

• Parent(s): HeatSourceWet choice

• Named name/value pairs:

  • type (required): Type

  • A (required): A

  • B (required): B

  • ControlCharge (required): Controlcharge

  • EnergySupply (required): Energysupply

  • capillary_diameter_m (required): Capillary Diameter M

  • electricity_circ_pump (required): Electricity Circ Pump

  • electricity_standby (required): Electricity Standby

  • flow_rate_l_per_min (required): Flow Rate L Per Min

  • heat_exchanger_surface_area_m2 (required): Heat Exchanger Surface Area M2

  • heat_storage_zone_material_kJ_per_K_above_Phase_transition (required): Heat Storage Zone Material Kj Per K Above Phase Transition

  • heat_storage_zone_material_kJ_per_K_below_Phase_transition (required): Heat Storage Zone Material Kj Per K Below Phase Transition

  • heat_storage_zone_material_kJ_per_K_during_Phase_transition (required): Heat Storage Zone Material Kj Per K During Phase Transition

  • max_rated_losses (required): Max Rated Losses

  • max_temperature (required): Max Temperature

  • number_of_units (required): Number Of Units

  • phase_transition_temperature_upper (required): Phase Transition Temperature Upper

  • phase_transition_temperature_lower (required): Phase Transition Temperature Lower

  • rated_charge_power (required): Rated Charge Power

  • simultaneous_charging_and_discharging (required): Simultaneous Charging And Discharging

  • velocity_in_HEX_tube_at_1_l_per_min_m_per_s (required): Velocity In Hex Tube At 1 L Per Min M Per S

• User-named name/value pairs: NONE_ALLOWED

Type

<JSON string>

• Parent: HeatSourceWetHeatBattery

• Const: ‘HeatBattery’

A

<JSON number>

• Parent: HeatSourceWetHeatBattery

B

<JSON number>

• Parent: HeatSourceWetHeatBattery

Controlcharge

<JSON string>

• Parent: HeatSourceWetHeatBattery

Energysupply

<JSON string>

• Parent: HeatSourceWetHeatBattery

Capillary Diameter M

<JSON number>

• Parent: HeatSourceWetHeatBattery

Electricity Circ Pump

<JSON number>

• Parent: HeatSourceWetHeatBattery

Electricity Standby

<JSON number>

• Parent: HeatSourceWetHeatBattery

Flow Rate L Per Min

<JSON number>

• Parent: HeatSourceWetHeatBattery

Heat Exchanger Surface Area M2

<JSON number>

• Parent: HeatSourceWetHeatBattery

Heat Storage Zone Material Kj Per K Above Phase Transition

<JSON number>

• Parent: HeatSourceWetHeatBattery

Heat Storage Zone Material Kj Per K Below Phase Transition

<JSON number>

• Parent: HeatSourceWetHeatBattery

Heat Storage Zone Material Kj Per K During Phase Transition

<JSON number>

• Parent: HeatSourceWetHeatBattery

Max Rated Losses

<JSON number>

• Parent: HeatSourceWetHeatBattery

Max Temperature

<JSON number>

• Parent: HeatSourceWetHeatBattery

Number Of Units

<JSON integer>

• Parent: HeatSourceWetHeatBattery

• Minimum: 0

Phase Transition Temperature Upper

<JSON number>

• Parent: HeatSourceWetHeatBattery

Phase Transition Temperature Lower

<JSON number>

• Parent: HeatSourceWetHeatBattery

Rated Charge Power

<JSON number>

• Parent: HeatSourceWetHeatBattery

Simultaneous Charging And Discharging

<JSON boolean>

• Parent: HeatSourceWetHeatBattery

Velocity In Hex Tube At 1 L Per Min M Per S

<JSON number>

• Parent: HeatSourceWetHeatBattery

HeatSourceWetHeatPump

<JSON object>

• Parent(s): HeatSourceWet choice

• Named name/value pairs:

  • type (required): Type

  • BufferTank:

    • <JSON value>

      • Default: <JSON null>

      • AnyOf:

        • HeatPumpBufferTank

        • <JSON null>

  • EnergySupply (required): Energysupply

  • EnergySupply_heat_network: Energysupply Heat Network

  • MechanicalVentilation: Mechanicalventilation

  • backup_ctrl_type (required): HeatPumpBackupControlType

  • boiler:

    • <JSON value>

      • Default: <JSON null>

      • AnyOf:

        • HeatPumpBoiler

        • <JSON null>

  • eahp_mixed_max_temp: Eahp Mixed Max Temp

  • eahp_mixed_min_temp: Eahp Mixed Min Temp

  • min_modulation_rate_20: Min Modulation Rate 20

  • min_modulation_rate_35: Min Modulation Rate 35

  • min_modulation_rate_55: Min Modulation Rate 55

  • min_temp_diff_flow_return_for_hp_to_operate (required): Min Temp Diff Flow Return For Hp To Operate

  • modulating_control (required): Modulating Control

  • power_crankcase_heater (required): Power Crankcase Heater

  • power_heating_circ_pump: Power Heating Circ Pump

  • power_heating_warm_air_fan: Power Heating Warm Air Fan

  • power_max_backup: Power Max Backup

  • power_off (required): Power Off

  • power_source_circ_pump (required): Power Source Circ Pump

  • power_standby (required): Power Standby

  • sink_type (required): HeatPumpSinkType

  • source_type (required): HeatPumpSourceType

  • temp_distribution_heat_network: Temp Distribution Heat Network

  • temp_lower_operating_limit (required): Temp Lower Operating Limit

  • temp_return_feed_max: Temp Return Feed Max

  • test_data_EN14825 (required): Test Data En14825

  • time_constant_onoff_operation (required): Time Constant Onoff Operation

  • time_delay_backup: Time Delay Backup

  • var_flow_temp_ctrl_during_test (required): Var Flow Temp Ctrl During Test

• User-named name/value pairs: NONE_ALLOWED

Type

<JSON string>

• Parent: HeatSourceWetHeatPump

• Const: ‘HeatPump’

Energysupply

<JSON string>

• Parent: HeatSourceWetHeatPump

Energysupply Heat Network

<JSON value>

• Parent: HeatSourceWetHeatPump

• Default: <JSON null>

• AnyOf:

  • <JSON string>

  • <JSON null>

Mechanicalventilation

<JSON value>

• Parent: HeatSourceWetHeatPump

• Default: <JSON null>

• AnyOf:

  • <JSON string>

  • <JSON null>

Eahp Mixed Max Temp

<JSON value>

• Parent: HeatSourceWetHeatPump

• Default: <JSON null>

• AnyOf:

  • <JSON number>

  • <JSON null>

Eahp Mixed Min Temp

<JSON value>

• Parent: HeatSourceWetHeatPump

• Default: <JSON null>

• AnyOf:

  • <JSON number>

  • <JSON null>

Min Modulation Rate 20

<JSON value>

• Parent: HeatSourceWetHeatPump

• Default: <JSON null>

• AnyOf:

  • <JSON number>

  • <JSON null>

Min Modulation Rate 35

<JSON value>

• Parent: HeatSourceWetHeatPump

• Default: <JSON null>

• AnyOf:

  • <JSON number>

  • <JSON null>

Min Modulation Rate 55

<JSON value>

• Parent: HeatSourceWetHeatPump

• Default: <JSON null>

• AnyOf:

  • <JSON number>

  • <JSON null>

Min Temp Diff Flow Return For Hp To Operate

<JSON number>

• Parent: HeatSourceWetHeatPump

Modulating Control

<JSON boolean>

• Parent: HeatSourceWetHeatPump

Power Crankcase Heater

<JSON number>

• Parent: HeatSourceWetHeatPump

Power Heating Circ Pump

<JSON value>

• Parent: HeatSourceWetHeatPump

• Default: <JSON null>

• AnyOf:

  • <JSON number>

  • <JSON null>

Power Heating Warm Air Fan

<JSON value>

• Parent: HeatSourceWetHeatPump

• Default: <JSON null>

• AnyOf:

  • <JSON number>

  • <JSON null>

Power Max Backup

<JSON value>

• Parent: HeatSourceWetHeatPump

• Default: <JSON null>

• AnyOf:

  • <JSON number>

  • <JSON null>

Power Off

<JSON number>

• Parent: HeatSourceWetHeatPump

Power Source Circ Pump

<JSON number>

• Parent: HeatSourceWetHeatPump

Power Standby

<JSON number>

• Parent: HeatSourceWetHeatPump

Temp Distribution Heat Network

<JSON value>

• Parent: HeatSourceWetHeatPump

• Default: <JSON null>

• AnyOf:

  • <JSON number>

  • <JSON null>

Temp Lower Operating Limit

<JSON number>

• Parent: HeatSourceWetHeatPump

Temp Return Feed Max

<JSON value>

• Parent: HeatSourceWetHeatPump

• Default: <JSON null>

• AnyOf:

  • <JSON number>

  • <JSON null>

Test Data En14825

<JSON array>

• Parent: HeatSourceWetHeatPump

• Items: HeatPumpTestDatum

Time Constant Onoff Operation

<JSON number>

• Parent: HeatSourceWetHeatPump

Time Delay Backup

<JSON value>

• Parent: HeatSourceWetHeatPump

• Default: <JSON null>

• AnyOf:

  • <JSON number>

  • <JSON null>

Var Flow Temp Ctrl During Test

<JSON boolean>

• Parent: HeatSourceWetHeatPump

HeatSourceWetServiceWaterRegular

<JSON object>

• Parent(s): Heatsource, Heatsource

• Named name/value pairs:

  • type (required): Type

  • Controlmax (required): Controlmax

  • Controlmin (required): Controlmin

  • EnergySupply (required): Energysupply

  • heater_position (required): Heater Position

  • name (required): Name

  • temp_flow_limit_upper: Temp Flow Limit Upper

  • thermostat_position: Thermostat Position

• User-named name/value pairs: NONE_ALLOWED

Type

<JSON string>

• Parent: HeatSourceWetServiceWaterRegular

• Const: ‘HeatSourceWet’

Controlmax

<JSON string>

• Parent: HeatSourceWetServiceWaterRegular

• Description: Reference to a control schedule of maximum temperature setpoints

Controlmin

<JSON string>

• Parent: HeatSourceWetServiceWaterRegular

• Description: Reference to a control schedule of minimum temperature setpoints

Energysupply

<JSON string>

• Parent: HeatSourceWetServiceWaterRegular

Heater Position

<JSON number>

• Parent: HeatSourceWetServiceWaterRegular

Name

<JSON string>

• Parent: HeatSourceWetServiceWaterRegular

Temp Flow Limit Upper

<JSON value>

• Parent: HeatSourceWetServiceWaterRegular

• Default: <JSON null>

• AnyOf:

  • <JSON number>

  • <JSON null>

Thermostat Position

<JSON value>

• Parent: HeatSourceWetServiceWaterRegular

• Description: Required for StorageTank but not for SmartHotWaterTank

• Default: <JSON null>

• AnyOf:

  • <JSON number>

  • <JSON null>

HotWaterDemand

<JSON object>

• Parent(s): Input

• Named name/value pairs:

  • Bath: Bath

  • Distribution: Distribution

  • Other: Other

  • Shower: Shower

• User-named name/value pairs: NONE_ALLOWED

Bath

<JSON value>

• Parent: HotWaterDemand

• Default: <JSON null>

• AnyOf:

  • <JSON object>

    • User-named name/value pairs: {ANY_NAME: Bath}

  • <JSON null>

Distribution

<JSON value>

• Parent: HotWaterDemand

• Default: <JSON null>

• AnyOf:

  • <JSON array>

    • Items: WaterPipeworkSimple

  • <JSON null>

Other

<JSON value>

• Parent: HotWaterDemand

• Default: <JSON null>

• AnyOf:

  • <JSON object>

    • User-named name/value pairs: {ANY_NAME: OtherWaterUse}

  • <JSON null>

Shower

<JSON value>

• Parent: HotWaterDemand

• Default: <JSON null>

• AnyOf:

  • <JSON object>

    • User-named name/value pairs:

      • {ANY_NAME:

        • <JSON value>

        • OneOf:

          • ShowerMixer

          • ShowerInstantElectric

        • Non-JSON Schema keywords:

          • discriminator: {‘mapping’: {‘InstantElecShower’: ‘#/$defs/ShowerInstantElectric’, ‘MixerShower’: ‘#/$defs/ShowerMixer’}, ‘propertyName’: ‘type’}

        }

  • <JSON null>

HotWaterSource

<JSON object>

• Parent(s): Input

• Named name/value pairs:

  • hw cylinder (required): Hw Cylinder

• User-named name/value pairs: NONE_ALLOWED

Hw Cylinder

<JSON value>

• Parent: HotWaterSource

• OneOf:

  • StorageTank

  • HotWaterSourceCombiBoiler

  • HotWaterSourceHUI

  • HotWaterSourcePointOfUse

  • HotWaterSourceSmartHotWaterTank

  • HotWaterSourceHeatBattery

• Non-JSON Schema keywords:

  • discriminator: {‘mapping’: {‘CombiBoiler’: ‘#/$defs/HotWaterSourceCombiBoiler’, ‘HIU’: ‘#/$defs/HotWaterSourceHUI’, ‘HeatBattery’: ‘#/$defs/HotWaterSourceHeatBattery’, ‘PointOfUse’: ‘#/$defs/HotWaterSourcePointOfUse’, ‘SmartHotWaterTank’: ‘#/$defs/HotWaterSourceSmartHotWaterTank’, ‘StorageTank’: ‘#/$defs/StorageTank’}, ‘propertyName’: ‘type’}

HotWaterSourceCombiBoiler

<JSON object>

• Parent(s): Hw Cylinder

• Named name/value pairs:

  • type (required): Type

  • ColdWaterSource (required): Coldwatersource

  • HeatSourceWet (required): Heatsourcewet

  • daily_HW_usage (required): Daily Hw Usage

  • rejected_energy_1: Rejected Energy 1

  • rejected_factor_3: Rejected Factor 3

  • separate_DHW_tests (required): BoilerHotWaterTest

  • setpoint_temp (required): Setpoint Temp

  • storage_loss_factor_2: Storage Loss Factor 2

• User-named name/value pairs: NONE_ALLOWED

Type

<JSON string>

• Parent: HotWaterSourceCombiBoiler

• Const: ‘CombiBoiler’

Coldwatersource

<JSON string>

• Parent: HotWaterSourceCombiBoiler

Heatsourcewet

<JSON string>

• Parent: HotWaterSourceCombiBoiler

Daily Hw Usage

<JSON number>

• Parent: HotWaterSourceCombiBoiler

Rejected Energy 1

<JSON value>

• Parent: HotWaterSourceCombiBoiler

• Default: <JSON null>

• AnyOf:

  • <JSON number>

  • <JSON null>

Rejected Factor 3

<JSON value>

• Parent: HotWaterSourceCombiBoiler

• Default: <JSON null>

• AnyOf:

  • <JSON number>

  • <JSON null>

Setpoint Temp

<JSON number>

• Parent: HotWaterSourceCombiBoiler

Storage Loss Factor 2

<JSON value>

• Parent: HotWaterSourceCombiBoiler

• Default: <JSON null>

• AnyOf:

  • <JSON number>

  • <JSON null>

HotWaterSourceHUI

<JSON object>

• Parent(s): Hw Cylinder

• Named name/value pairs:

  • type (required): Type

  • ColdWaterSource (required): Coldwatersource

  • HeatSourceWet (required): Heatsourcewet

  • setpoint_temp: Setpoint Temp

• User-named name/value pairs: NONE_ALLOWED

Type

<JSON string>

• Parent: HotWaterSourceHUI

• Const: ‘HIU’

Coldwatersource

<JSON string>

• Parent: HotWaterSourceHUI

Heatsourcewet

<JSON string>

• Parent: HotWaterSourceHUI

Setpoint Temp

<JSON value>

• Parent: HotWaterSourceHUI

• Default: <JSON null>

• AnyOf:

  • <JSON number>

  • <JSON null>

HotWaterSourceHeatBattery

<JSON object>

• Parent(s): Hw Cylinder

• Named name/value pairs:

  • type (required): Type

  • ColdWaterSource (required): Coldwatersource

  • HeatSourceWet (required): Heatsourcewet

• User-named name/value pairs: NONE_ALLOWED

Type

<JSON string>

• Parent: HotWaterSourceHeatBattery

• Const: ‘HeatBattery’

Coldwatersource

<JSON string>

• Parent: HotWaterSourceHeatBattery

Heatsourcewet

<JSON string>

• Parent: HotWaterSourceHeatBattery

HotWaterSourcePointOfUse

<JSON object>

• Parent(s): Hw Cylinder

• Named name/value pairs:

  • type (required): Type

  • ColdWaterSource (required): Coldwatersource

  • EnergySupply (required): Energysupply

  • efficiency (required): Efficiency

  • setpoint_temp (required): Setpoint Temp

• User-named name/value pairs: NONE_ALLOWED

Type

<JSON string>

• Parent: HotWaterSourcePointOfUse

• Const: ‘PointOfUse’

Coldwatersource

<JSON string>

• Parent: HotWaterSourcePointOfUse

Energysupply

<JSON string>

• Parent: HotWaterSourcePointOfUse

Efficiency

<JSON number>

• Parent: HotWaterSourcePointOfUse

Setpoint Temp

<JSON number>

• Parent: HotWaterSourcePointOfUse

HotWaterSourceSmartHotWaterTank

<JSON object>

• Parent(s): Hw Cylinder

• Named name/value pairs:

  • type (required): Type

  • ColdWaterSource (required): Coldwatersource

  • EnergySupply_pump (required): Energysupply Pump

  • HeatSource (required): Heatsource

  • daily_losses (required): Daily Losses

  • init_temp (required): Init Temp

  • max_flow_rate_pump_l_per_min (required): Max Flow Rate Pump L Per Min

  • power_pump_kW (required): Power Pump Kw

  • primary_pipework: Primary Pipework

  • temp_setpnt_max (required): Temp Setpnt Max

  • temp_usable (required): Temp Usable

  • volume (required): Volume

• User-named name/value pairs: NONE_ALLOWED

Type

<JSON string>

• Parent: HotWaterSourceSmartHotWaterTank

• Const: ‘SmartHotWaterTank’

Coldwatersource

<JSON string>

• Parent: HotWaterSourceSmartHotWaterTank

Energysupply Pump

<JSON string>

• Parent: HotWaterSourceSmartHotWaterTank

Heatsource

<JSON object>

• Parent: HotWaterSourceSmartHotWaterTank

• User-named name/value pairs:

  • {ANY_NAME:

    • <JSON value>

    • OneOf:

      • ImmersionHeater

      • SolarThermalSystem

      • HeatSourceWetServiceWaterRegular

      • HeatPumpHotWaterOnly

    • Non-JSON Schema keywords:

      • discriminator: {‘mapping’: {‘HeatPump_HWOnly’: ‘#/$defs/HeatPumpHotWaterOnly’, ‘HeatSourceWet’: ‘#/$defs/HeatSourceWetServiceWaterRegular’, ‘ImmersionHeater’: ‘#/$defs/ImmersionHeater’, ‘SolarThermalSystem’: ‘#/$defs/SolarThermalSystem’}, ‘propertyName’: ‘type’}

    }

Daily Losses

<JSON number>

• Parent: HotWaterSourceSmartHotWaterTank

Init Temp

<JSON number>

• Parent: HotWaterSourceSmartHotWaterTank

Max Flow Rate Pump L Per Min

<JSON number>

• Parent: HotWaterSourceSmartHotWaterTank

Power Pump Kw

<JSON number>

• Parent: HotWaterSourceSmartHotWaterTank

Primary Pipework

<JSON value>

• Parent: HotWaterSourceSmartHotWaterTank

• Default: <JSON null>

• AnyOf:

  • <JSON array>

    • Items: WaterPipework

  • <JSON null>

Temp Setpnt Max

<JSON string>

• Parent: HotWaterSourceSmartHotWaterTank

• Description: Reference to a control schedule of maximum state of charge values

Temp Usable

<JSON number>

• Parent: HotWaterSourceSmartHotWaterTank

Volume

<JSON number>

• Parent: HotWaterSourceSmartHotWaterTank

ImmersionHeater

<JSON object>

• Parent(s): Heatsource, Heatsource

• Named name/value pairs:

  • type (required): Type

  • Controlmax (required): Controlmax

  • Controlmin (required): Controlmin

  • EnergySupply (required): Energysupply

  • heater_position (required): Heater Position

  • power (required): Power

  • thermostat_position: Thermostat Position

• User-named name/value pairs: NONE_ALLOWED

Type

<JSON string>

• Parent: ImmersionHeater

• Const: ‘ImmersionHeater’

Controlmax

<JSON string>

• Parent: ImmersionHeater

• Description: Reference to a control schedule of maximum temperature setpoints

Controlmin

<JSON string>

• Parent: ImmersionHeater

• Description: Reference to a control schedule of minimum temperature setpoints

Energysupply

<JSON string>

• Parent: ImmersionHeater

Heater Position

<JSON number>

• Parent: ImmersionHeater

Power

<JSON number>

• Parent: ImmersionHeater

Thermostat Position

<JSON value>

• Parent: ImmersionHeater

• Default: <JSON null>

• AnyOf:

  • <JSON number>

  • <JSON null>

InfiltrationVentilation

<JSON object>

• Parent(s): Input

• Named name/value pairs:

  • Control_VentAdjustMax: Control Ventadjustmax

  • Control_VentAdjustMin: Control Ventadjustmin

  • Control_WindowAdjust: Control Windowadjust

  • Leaks (required): VentilationLeaks

  • MechanicalVentilation: Mechanicalventilation

  • Vents (required): Vents

  • ach_max_static_calcs: Ach Max Static Calcs

  • ach_min_static_calcs: Ach Min Static Calcs

  • altitude (required): Altitude

  • cross_vent_possible (required): Cross Vent Possible

  • shield_class (required): VentilationShieldClass

  • terrain_class (required): TerrainClass

  • ventilation_zone_base_height (required): Ventilation Zone Base Height

  • vent_opening_ratio_init: Vent Opening Ratio Init

• User-named name/value pairs: NONE_ALLOWED

Control Ventadjustmax

<JSON value>

• Parent: InfiltrationVentilation

• Default: <JSON null>

• AnyOf:

  • <JSON string>

  • <JSON null>

Control Ventadjustmin

<JSON value>

• Parent: InfiltrationVentilation

• Default: <JSON null>

• AnyOf:

  • <JSON string>

  • <JSON null>

Control Windowadjust

<JSON value>

• Parent: InfiltrationVentilation

• Default: <JSON null>

• AnyOf:

  • <JSON string>

  • <JSON null>

Mechanicalventilation

<JSON value>

• Parent: InfiltrationVentilation

• Default: <JSON null>

• AnyOf:

  • <JSON object>

    • User-named name/value pairs: {ANY_NAME: MechanicalVentilation}

  • <JSON null>

Vents

<JSON object>

• Parent: InfiltrationVentilation

• User-named name/value pairs: {ANY_NAME: Vent}

Ach Max Static Calcs

<JSON value>

• Parent: InfiltrationVentilation

• Default: <JSON null>

• AnyOf:

  • <JSON number>

  • <JSON null>

Ach Min Static Calcs

<JSON value>

• Parent: InfiltrationVentilation

• Default: <JSON null>

• AnyOf:

  • <JSON number>

  • <JSON null>

Altitude

<JSON number>

• Parent: InfiltrationVentilation

Cross Vent Possible

<JSON boolean>

• Parent: InfiltrationVentilation

Ventilation Zone Base Height

<JSON number>

• Parent: InfiltrationVentilation

• Description: Base height of the ventilation zone relative to ground (m)

Vent Opening Ratio Init

<JSON value>

• Parent: InfiltrationVentilation

• Default: <JSON null>

• AnyOf:

  • <JSON number>

  • <JSON null>

InternalGains

<JSON object>

• Parent(s): Input

• Description: A dictionary of internal gains entries where: - Keys are user-defined names (e.g., “ColdWaterLosses”, “EvaporativeLosses”, “metabolic gains”, etc.) - Values conform to the InternalGainsDetails schema - No specific entries are required - all entries are optional and user-defined

• User-named name/value pairs: {ANY_NAME: InternalGainsDetails}

InternalGainsDetails

<JSON object>

• Parent(s): InternalGains

• Named name/value pairs:

  • schedule (required): ScheduleForDouble

  • start_day (required): Start Day

  • time_series_step (required): Time Series Step

• User-named name/value pairs: NONE_ALLOWED

Start Day

<JSON integer>

• Parent: InternalGainsDetails

• Maximum: 365

• Minimum: 0

Time Series Step

<JSON number>

• Parent: InternalGainsDetails

InverterType

<JSON string>

• Parent(s): PhotovoltaicSystem

• Enum: [‘optimised_inverter’, ‘string_inverter’]

MVHRLocation

<JSON string>

• Parent(s): MechanicalVentilation

• Enum: [‘inside’, ‘outside’]

MassDistributionClass

<JSON string>

• Parent(s): BuildingElementAdjacentConditionedSpace, BuildingElementAdjacentUnconditionedSpace_Simple, BuildingElementGroundHeatedBasement, BuildingElementGroundSlabEdgeInsulation, BuildingElementGroundSlabNoEdgeInsulation, BuildingElementGroundSuspendedFloor, BuildingElementGroundUnheatedBasement, BuildingElementOpaque

• Enum: [‘D’, ‘E’, ‘I’, ‘IE’, ‘M’]

MechVentType

<JSON string>

• Parent(s): MechanicalVentilation

• Enum: [‘Intermittent MEV’, ‘Centralised continuous MEV’, ‘Decentralised continuous MEV’, ‘MVHR’]

MechanicalVentilation

<JSON object>

• Parent(s): Mechanicalventilation

• Named name/value pairs:

  • Control: Control

  • EnergySupply (required): Energysupply

  • SFP (required): Sfp

  • design_outdoor_air_flow_rate (required): Design Outdoor Air Flow Rate

  • ductwork: Ductwork

  • mvhr_eff: Mvhr Eff

  • mvhr_location:

    • <JSON value>

      • Default: <JSON null>

      • AnyOf:

        • MVHRLocation

        • <JSON null>

  • sup_air_flw_ctrl (required): SupplyAirFlowRateControlType

  • sup_air_temp_ctrl (required): SupplyAirTemperatureControlType

  • vent_type (required): MechVentType

• User-named name/value pairs: NONE_ALLOWED

Control

<JSON value>

• Parent: MechanicalVentilation

• Default: <JSON null>

• AnyOf:

  • <JSON string>

  • <JSON null>

Energysupply

<JSON string>

• Parent: MechanicalVentilation

Sfp

<JSON number>

• Parent: MechanicalVentilation

• Description: Specific fan power, inclusive of any in use factors (unit: W/l/s)

Design Outdoor Air Flow Rate

<JSON number>

• Parent: MechanicalVentilation

• Description: (unit: m³/hour)

Ductwork

<JSON value>

• Parent: MechanicalVentilation

• Default: <JSON null>

• AnyOf:

  • <JSON array>

    • Items: MechanicalVentilationDuctwork

  • <JSON null>

Mvhr Eff

<JSON value>

• Parent: MechanicalVentilation

• Description: MVHR efficiency

• Default: <JSON null>

• AnyOf:

  • <JSON number>

  • <JSON null>

MechanicalVentilationDuctwork

<JSON object>

• Parent(s): Ductwork

• Named name/value pairs:

  • cross_section_shape (required): DuctShape

  • duct_perimeter_mm: Duct Perimeter Mm

  • duct_type (required): DuctType

  • external_diameter_mm: External Diameter Mm

  • insulation_thermal_conductivity (required): Insulation Thermal Conductivity

  • insulation_thickness_mm (required): Insulation Thickness Mm

  • internal_diameter_mm: Internal Diameter Mm

  • length (required): Length

  • reflective (required): Reflective

• User-named name/value pairs: NONE_ALLOWED

Duct Perimeter Mm

<JSON value>

• Parent: MechanicalVentilationDuctwork

• Default: <JSON null>

• AnyOf:

  • <JSON number>

  • <JSON null>

External Diameter Mm

<JSON value>

• Parent: MechanicalVentilationDuctwork

• Default: <JSON null>

• AnyOf:

  • <JSON number>

  • <JSON null>

Insulation Thermal Conductivity

<JSON number>

• Parent: MechanicalVentilationDuctwork

Insulation Thickness Mm

<JSON number>

• Parent: MechanicalVentilationDuctwork

Internal Diameter Mm

<JSON value>

• Parent: MechanicalVentilationDuctwork

• Default: <JSON null>

• AnyOf:

  • <JSON number>

  • <JSON null>

Length

<JSON number>

• Parent: MechanicalVentilationDuctwork

Reflective

<JSON boolean>

• Parent: MechanicalVentilationDuctwork

OtherWaterUse

<JSON object>

• Parent(s): Other

• Named name/value pairs:

  • ColdWaterSource (required): Coldwatersource

  • flowrate (required): Flowrate

• User-named name/value pairs: NONE_ALLOWED

Coldwatersource

<JSON string>

• Parent: OtherWaterUse

Flowrate

<JSON number>

• Parent: OtherWaterUse

• Description: Tap/outlet flow rate (unit: litre/minute)

PhotovoltaicSystem

<JSON object>

• Parent(s): OnSiteGeneration choice

• Named name/value pairs:

  • type (required): Type

  • EnergySupply (required): Energysupply

  • base_height (required): Base Height

  • height (required): Height

  • inverter_is_inside (required): Inverter Is Inside

  • inverter_peak_power_ac (required): Inverter Peak Power Ac

  • inverter_peak_power_dc (required): Inverter Peak Power Dc

  • inverter_type (required): InverterType

  • orientation360 (required): Orientation360

  • peak_power (required): Peak Power

  • pitch (required): Pitch

  • shading (required): Shading

  • ventilation_strategy (required): PhotovoltaicVentilationStrategy

  • width (required): Width

• User-named name/value pairs: NONE_ALLOWED

Type

<JSON string>

• Parent: PhotovoltaicSystem

• Const: ‘PhotovoltaicSystem’

Energysupply

<JSON string>

• Parent: PhotovoltaicSystem

Base Height

<JSON number>

• Parent: PhotovoltaicSystem

• Description: The distance between the ground and the lowest edge of the PV array (unit: m)

Height

<JSON number>

• Parent: PhotovoltaicSystem

• Description: Height of the PV array (unit: m)

Inverter Is Inside

<JSON boolean>

• Parent: PhotovoltaicSystem

• Description: Whether the inverter is considered inside the building

Inverter Peak Power Ac

<JSON number>

• Parent: PhotovoltaicSystem

Inverter Peak Power Dc

<JSON number>

• Parent: PhotovoltaicSystem

Orientation360

<JSON number>

• Parent: PhotovoltaicSystem

• Description: The orientation angle of the inclined surface, expressed as the geographical azimuth angle of the horizontal projection of the inclined surface normal, 0 to 360 (unit: ˚)

Peak Power

<JSON number>

• Parent: PhotovoltaicSystem

• Description: Peak power; represents the electrical power of a photovoltaic system with a given area for a solar irradiance of 1 kW/m² on this surface (at 25 degrees) (unit: kW)

Pitch

<JSON number>

• Parent: PhotovoltaicSystem

• Description: The tilt angle (inclination) of the PV panel from horizontal, measured upwards facing, 0 to 90 (unit: ˚)

Shading

<JSON array>

• Parent: PhotovoltaicSystem

• Items: <JSON value>

• AnyOf:

  • WindowShadingObject

  • WindowShadingObstacle

Width

<JSON number>

• Parent: PhotovoltaicSystem

• Description: Width of the PV panel (unit: m)

PhotovoltaicVentilationStrategy

<JSON string>

• Parent(s): PhotovoltaicSystem

• Enum: [‘unventilated’, ‘moderately_ventilated’, ‘strongly_or_forced_ventilated’, ‘rear_surface_free’]

ScheduleEntryForBoolean

<JSON value>

• Parent(s): ScheduleForBoolean

• AnyOf:

  • <JSON boolean>

  • ScheduleRepeaterForBoolean

  • <JSON string>

  • <JSON null>

ScheduleEntryForDouble

<JSON value>

• Parent(s): ScheduleForDouble

• AnyOf:

  • <JSON number>

  • ScheduleRepeaterForDouble

  • <JSON string>

  • <JSON null>

ScheduleForBoolean

<JSON object>

• Parent(s): ControlChargeTarget, ControlOnOffTimer

• Description: A dictionary of schedule entries where: - Keys are user-defined names (e.g., “main”, “week”, “weekday”, “weekend”) - Values are lists of ScheduleEntryForBoolean - The “main” entry is required

• User-named name/value pairs:

  • {ANY_NAME:

    • <JSON array>

    • Items: ScheduleEntryForBoolean

    }

ScheduleForDouble

<JSON object>

• Parent(s): ApplianceGains, BoilerCostScheduleHybrid, BoilerCostScheduleHybrid, ChargeLevel, ControlChargeTarget, ControlOnOffCostMinimising, ControlSetpointTimer, InternalGainsDetails

• Description: A dictionary of schedule entries where: - Keys are user-defined names (e.g., “main”, “week”, “weekday”, “weekend”) - Values are lists of ScheduleEntryForDouble - The “main” entry is required

• User-named name/value pairs:

  • {ANY_NAME:

    • <JSON array>

    • Items: ScheduleEntryForDouble

    }

ScheduleRepeaterEntryForBoolean

<JSON value>

• Parent(s): ScheduleRepeaterValueForBoolean

• AnyOf:

  • <JSON boolean>

  • <JSON null>

ScheduleRepeaterEntryForDouble

<JSON value>

• Parent(s): ScheduleRepeaterValueForDouble

• AnyOf:

  • <JSON number>

  • <JSON null>

ScheduleRepeaterForBoolean

<JSON object>

• Parent(s): ScheduleEntryForBoolean

• Named name/value pairs:

  • repeat (required): Repeat

  • value (required): ScheduleRepeaterValueForBoolean

• User-named name/value pairs: NONE_ALLOWED

Repeat

<JSON integer>

• Parent: ScheduleRepeaterForBoolean

• Minimum: 0

ScheduleRepeaterForDouble

<JSON object>

• Parent(s): ScheduleEntryForDouble

• Named name/value pairs:

  • repeat (required): Repeat

  • value (required): ScheduleRepeaterValueForDouble

• User-named name/value pairs: NONE_ALLOWED

Repeat

<JSON integer>

• Parent: ScheduleRepeaterForDouble

• Minimum: 0

ScheduleRepeaterValueForBoolean

<JSON value>

• Parent(s): ScheduleRepeaterForBoolean

• AnyOf:

  • <JSON string>

  • ScheduleRepeaterEntryForBoolean

ScheduleRepeaterValueForDouble

<JSON value>

• Parent(s): ScheduleRepeaterForDouble

• AnyOf:

  • <JSON string>

  • ScheduleRepeaterEntryForDouble

ShadingObject

<JSON object>

• Parent(s): Shading

• Named name/value pairs:

  • distance (required): Distance

  • height (required): Height

  • type (required): ShadingObjectType

• User-named name/value pairs: NONE_ALLOWED

Distance

<JSON number>

• Parent: ShadingObject

Height

<JSON number>

• Parent: ShadingObject

ShadingObjectType

<JSON string>

• Parent(s): ShadingObject

• Enum: [‘obstacle’, ‘overhang’]

ShadingSegment

<JSON object>

• Parent(s): Shading Segments

• Named name/value pairs:

  • end360 (required): End360

  • shading: Shading

  • start360 (required): Start360

• User-named name/value pairs: NONE_ALLOWED

End360

<JSON number>

• Parent: ShadingSegment

Shading

<JSON value>

• Parent: ShadingSegment

• Default: <JSON null>

• AnyOf:

  • <JSON array>

    • Items: ShadingObject

  • <JSON null>

Start360

<JSON number>

• Parent: ShadingSegment

ShowerInstantElectric

<JSON object>

• Parent(s): Shower

• Named name/value pairs:

  • type (required): Type

  • ColdWaterSource (required): Coldwatersource

  • EnergySupply (required): Energysupply

  • rated_power (required): Rated Power

• User-named name/value pairs: NONE_ALLOWED

Type

<JSON string>

• Parent: ShowerInstantElectric

• Const: ‘InstantElecShower’

Coldwatersource

<JSON string>

• Parent: ShowerInstantElectric

Energysupply

<JSON string>

• Parent: ShowerInstantElectric

Rated Power

<JSON number>

• Parent: ShowerInstantElectric

ShowerMixer

<JSON object>

• Parent(s): Shower

• Named name/value pairs:

  • type (required): Type

  • ColdWaterSource (required): Coldwatersource

  • WWHRS: Wwhrs

  • flowrate (required): Flowrate

• User-named name/value pairs: NONE_ALLOWED

Type

<JSON string>

• Parent: ShowerMixer

• Const: ‘MixerShower’

Coldwatersource

<JSON string>

• Parent: ShowerMixer

Wwhrs

<JSON value>

• Parent: ShowerMixer

• Description: Reference to a key in Input.WWHRS

• Default: <JSON null>

• AnyOf:

  • <JSON string>

  • <JSON null>

Flowrate

<JSON number>

• Parent: ShowerMixer

• Description: Shower flow rate (unit: litre/minute)

SimulationTime

<JSON object>

• Parent(s): Input

• Named name/value pairs:

  • end (required): End

  • start (required): Start

  • step (required): Step

• User-named name/value pairs: NONE_ALLOWED

End

<JSON number>

• Parent: SimulationTime

Start

<JSON number>

• Parent: SimulationTime

Step

<JSON number>

• Parent: SimulationTime

SmartApplianceBattery

<JSON object>

• Parent(s): SmartApplianceControl

• Named name/value pairs:

  • battery_state_of_charge (required): Battery State Of Charge

  • energy_into_battery_from_generation (required): Energy Into Battery From Generation

  • energy_into_battery_from_grid (required): Energy Into Battery From Grid

  • energy_out_of_battery (required): Energy Out Of Battery

• User-named name/value pairs: NONE_ALLOWED

Battery State Of Charge

<JSON object>

• Parent: SmartApplianceBattery

• User-named name/value pairs:

  • {ANY_NAME:

    • <JSON array>

    • Items: <JSON number>

    }

Energy Into Battery From Generation

<JSON object>

• Parent: SmartApplianceBattery

• User-named name/value pairs:

  • {ANY_NAME:

    • <JSON array>

    • Items: <JSON number>

    }

Energy Into Battery From Grid

<JSON object>

• Parent: SmartApplianceBattery

• User-named name/value pairs:

  • {ANY_NAME:

    • <JSON array>

    • Items: <JSON number>

    }

Energy Out Of Battery

<JSON object>

• Parent: SmartApplianceBattery

• User-named name/value pairs:

  • {ANY_NAME:

    • <JSON array>

    • Items: <JSON number>

    }

SmartApplianceControl

<JSON object>

• Parent(s): SmartApplianceControls collection

• Named name/value pairs:

  • Appliances (required): Appliances

  • battery24hr (required): SmartApplianceBattery

  • non_appliance_demand_24hr (required): Non Appliance Demand 24Hr

  • power_timeseries (required): Power Timeseries

  • time_series_step (required): Time Series Step

• User-named name/value pairs: NONE_ALLOWED

Appliances

<JSON array>

• Parent: SmartApplianceControl

• Items: <JSON string>

Non Appliance Demand 24Hr

<JSON object>

• Parent: SmartApplianceControl

• User-named name/value pairs:

  • {ANY_NAME:

    • <JSON array>

    • Items: <JSON number>

    }

Power Timeseries

<JSON object>

• Parent: SmartApplianceControl

• User-named name/value pairs:

  • {ANY_NAME:

    • <JSON array>

    • Items: <JSON number>

    }

Time Series Step

<JSON number>

• Parent: SmartApplianceControl

SolarCollectorLoopLocation

<JSON string>

• Parent(s): SolarThermalSystem

• Enum: [‘OUT’, ‘HS’, ‘NHS’]

• Description: Location of the main part of the solar thermal collector loop piping. This affects the ambient temperature used for heat loss calculations in the collector loop piping.

SolarThermalSystem

<JSON object>

• Parent(s): Heatsource, Heatsource

• Named name/value pairs:

  • type (required): Type

  • Controlmax (required): Controlmax

  • EnergySupply (required): Energysupply

  • area_module (required): Area Module

  • collector_mass_flow_rate (required): Collector Mass Flow Rate

  • first_order_hlc (required): First Order Hlc

  • heater_position (required): Heater Position

  • incidence_angle_modifier (required): Incidence Angle Modifier

  • modules (required): Modules

  • orientation360 (required): Orientation360

  • peak_collector_efficiency (required): Peak Collector Efficiency

  • power_pump (required): Power Pump

  • power_pump_control (required): Power Pump Control

  • second_order_hlc (required): Second Order Hlc

  • sol_loc (required): SolarCollectorLoopLocation

  • solar_loop_piping_hlc (required): Solar Loop Piping Hlc

  • thermostat_position: Thermostat Position

  • tilt (required): Tilt

• User-named name/value pairs: NONE_ALLOWED

Type

<JSON string>

• Parent: SolarThermalSystem

• Const: ‘SolarThermalSystem’

Controlmax

<JSON string>

• Parent: SolarThermalSystem

• Description: Reference to a control schedule of maximum temperature setpoints

Energysupply

<JSON string>

• Parent: SolarThermalSystem

Area Module

<JSON number>

• Parent: SolarThermalSystem

Collector Mass Flow Rate

<JSON number>

• Parent: SolarThermalSystem

First Order Hlc

<JSON number>

• Parent: SolarThermalSystem

Heater Position

<JSON number>

• Parent: SolarThermalSystem

Incidence Angle Modifier

<JSON number>

• Parent: SolarThermalSystem

Modules

<JSON integer>

• Parent: SolarThermalSystem

• Minimum: 1

Orientation360

<JSON number>

• Parent: SolarThermalSystem

• Description: The orientation angle of the inclined surface, expressed as the geographical azimuth angle of the horizontal projection of the inclined surface normal, 0 to 360 (unit: ˚)

Peak Collector Efficiency

<JSON number>

• Parent: SolarThermalSystem

Power Pump

<JSON number>

• Parent: SolarThermalSystem

Power Pump Control

<JSON number>

• Parent: SolarThermalSystem

Second Order Hlc

<JSON number>

• Parent: SolarThermalSystem

Solar Loop Piping Hlc

<JSON number>

• Parent: SolarThermalSystem

Thermostat Position

<JSON value>

• Parent: SolarThermalSystem

• Description: Required for StorageTank but not for SmartHotWaterTank

• Default: <JSON null>

• AnyOf:

  • <JSON number>

  • <JSON null>

Tilt

<JSON number>

• Parent: SolarThermalSystem

SpaceCoolSystemAirConditioning

<JSON object>

• Parent(s): SpaceCoolSystem choice

• Named name/value pairs:

  • type (required): Type

  • Control (required): Control

  • EnergySupply (required): Energysupply

  • cooling_capacity (required): Cooling Capacity

  • efficiency (required): Efficiency

  • frac_convective (required): Frac Convective

• User-named name/value pairs: NONE_ALLOWED

Type

<JSON string>

• Parent: SpaceCoolSystemAirConditioning

• Const: ‘AirConditioning’

Control

<JSON string>

• Parent: SpaceCoolSystemAirConditioning

Energysupply

<JSON string>

• Parent: SpaceCoolSystemAirConditioning

Cooling Capacity

<JSON number>

• Parent: SpaceCoolSystemAirConditioning

• Description: Maximum cooling capacity of the system (unit: kW)

Efficiency

<JSON number>

• Parent: SpaceCoolSystemAirConditioning

Frac Convective

<JSON number>

• Parent: SpaceCoolSystemAirConditioning

• Description: Convective fraction for cooling

SpaceHeatSystemElectricStorageHeater

<JSON object>

• Parent(s): SpaceHeatSystem choice

• Named name/value pairs:

  • type (required): Type

  • ControlCharger (required): Controlcharger

  • ESH_max_output (required): Esh Max Output

  • ESH_min_output (required): Esh Min Output

  • EnergySupply (required): Energysupply

  • air_flow_type (required): AirFlowType

  • Control (required): Control

  • fan_pwr (required): Fan Pwr

  • frac_convective (required): Frac Convective

  • n_units (required): N Units

  • pwr_in (required): Pwr In

  • rated_power_instant (required): Rated Power Instant

  • storage_capacity (required): Storage Capacity

  • Zone (required): Zone

  • temp_setback: Temp Setback

  • advanced_start: Advanced Start

• User-named name/value pairs: NONE_ALLOWED

Type

<JSON string>

• Parent: SpaceHeatSystemElectricStorageHeater

• Const: ‘ElecStorageHeater’

Controlcharger

<JSON string>

• Parent: SpaceHeatSystemElectricStorageHeater

Esh Max Output

<JSON array>

• Parent: SpaceHeatSystemElectricStorageHeater

• Items: <JSON array>

• MaxItems: 2

• MinItems: 2

• Items: <JSON number>

Esh Min Output

<JSON array>

• Parent: SpaceHeatSystemElectricStorageHeater

• Items: <JSON array>

• MaxItems: 2

• MinItems: 2

• Items: <JSON number>

Energysupply

<JSON string>

• Parent: SpaceHeatSystemElectricStorageHeater

Control

<JSON string>

• Parent: SpaceHeatSystemElectricStorageHeater

Fan Pwr

<JSON number>

• Parent: SpaceHeatSystemElectricStorageHeater

• Description: Fan power (unit: W)

Frac Convective

<JSON number>

• Parent: SpaceHeatSystemElectricStorageHeater

• Description: Convective fraction for heating

N Units

<JSON integer>

• Parent: SpaceHeatSystemElectricStorageHeater

• Minimum: 0

Pwr In

<JSON number>

• Parent: SpaceHeatSystemElectricStorageHeater

Rated Power Instant

<JSON number>

• Parent: SpaceHeatSystemElectricStorageHeater

• Description: (instant backup) (unit: kW)

Storage Capacity

<JSON number>

• Parent: SpaceHeatSystemElectricStorageHeater

Zone

<JSON string>

• Parent: SpaceHeatSystemElectricStorageHeater

• Description: The zone where the unit(s) is/are installed

Temp Setback

<JSON value>

• Parent: SpaceHeatSystemElectricStorageHeater

• Default: <JSON null>

• AnyOf:

  • <JSON number>

  • <JSON null>

Advanced Start

<JSON value>

• Parent: SpaceHeatSystemElectricStorageHeater

• Default: <JSON null>

• AnyOf:

  • <JSON number>

  • <JSON null>

SpaceHeatSystemHeatSource

<JSON object>

• Parent(s): SpaceHeatSystemWarmAir, SpaceHeatSystemWetDistribution

• Named name/value pairs:

  • name (required): Name

  • temp_flow_limit_upper: Temp Flow Limit Upper

• User-named name/value pairs: NONE_ALLOWED

Name

<JSON string>

• Parent: SpaceHeatSystemHeatSource

Temp Flow Limit Upper

<JSON value>

• Parent: SpaceHeatSystemHeatSource

• Default: <JSON null>

• AnyOf:

  • <JSON number>

  • <JSON null>

SpaceHeatSystemInstantElectricHeater

<JSON object>

• Parent(s): SpaceHeatSystem choice

• Named name/value pairs:

  • type (required): Type

  • EnergySupply (required): Energysupply

  • Control (required): Control

  • frac_convective (required): Frac Convective

  • rated_power (required): Rated Power

• User-named name/value pairs: NONE_ALLOWED

Type

<JSON string>

• Parent: SpaceHeatSystemInstantElectricHeater

• Const: ‘InstantElecHeater’

Energysupply

<JSON string>

• Parent: SpaceHeatSystemInstantElectricHeater

Control

<JSON string>

• Parent: SpaceHeatSystemInstantElectricHeater

Frac Convective

<JSON number>

• Parent: SpaceHeatSystemInstantElectricHeater

• Description: Convective fraction for heating

Rated Power

<JSON number>

• Parent: SpaceHeatSystemInstantElectricHeater

• Description: (unit: kW)

SpaceHeatSystemWarmAir

<JSON object>

• Parent(s): SpaceHeatSystem choice

• Named name/value pairs:

  • type (required): Type

  • HeatSource (required): SpaceHeatSystemHeatSource

  • Control (required): Control

  • frac_convective (required): Frac Convective

• User-named name/value pairs: NONE_ALLOWED

Type

<JSON string>

• Parent: SpaceHeatSystemWarmAir

• Const: ‘WarmAir’

Control

<JSON string>

• Parent: SpaceHeatSystemWarmAir

Frac Convective

<JSON number>

• Parent: SpaceHeatSystemWarmAir

SpaceHeatSystemWetDistribution

<JSON object>

• Parent(s): SpaceHeatSystem choice

• Named name/value pairs:

  • type (required): Type

  • HeatSource (required): SpaceHeatSystemHeatSource

  • bypass_percentage_recirculated: Bypass Percentage Recirculated

  • design_flow_rate: Design Flow Rate

  • design_flow_temp (required): Design Flow Temp

  • emitters (required): Emitters

  • ecodesign_controller (required): EcoDesignController

  • max_flow_rate: Max Flow Rate

  • min_flow_rate: Min Flow Rate

  • temp_diff_emit_dsgn (required): Temp Diff Emit Dsgn

  • thermal_mass: Thermal Mass

  • variable_flow (required): Variable Flow

  • Control (required): Control

  • EnergySupply: Energysupply

  • Zone (required): Zone

• User-named name/value pairs: NONE_ALLOWED

Type

<JSON string>

• Parent: SpaceHeatSystemWetDistribution

• Const: ‘WetDistribution’

Bypass Percentage Recirculated

<JSON value>

• Parent: SpaceHeatSystemWetDistribution

• Default: <JSON null>

• AnyOf:

  • <JSON number>

  • <JSON null>

Design Flow Rate

<JSON value>

• Parent: SpaceHeatSystemWetDistribution

• Default: <JSON null>

• AnyOf:

  • <JSON number>

  • <JSON null>

Design Flow Temp

<JSON integer>

• Parent: SpaceHeatSystemWetDistribution

Emitters

<JSON array>

• Parent: SpaceHeatSystemWetDistribution

• MinItems: 1

• Items: <JSON value>

• OneOf:

  • WetEmitterRadiator

  • WetEmitterUFH

  • WetEmitterFanCoil

• Non-JSON Schema keywords:

  • discriminator: {‘mapping’: {‘fancoil’: ‘#/$defs/WetEmitterFanCoil’, ‘radiator’: ‘#/$defs/WetEmitterRadiator’, ‘ufh’: ‘#/$defs/WetEmitterUFH’}, ‘propertyName’: ‘wet_emitter_type’}

Max Flow Rate

<JSON value>

• Parent: SpaceHeatSystemWetDistribution

• Default: <JSON null>

• AnyOf:

  • <JSON number>

  • <JSON null>

Min Flow Rate

<JSON value>

• Parent: SpaceHeatSystemWetDistribution

• Default: <JSON null>

• AnyOf:

  • <JSON number>

  • <JSON null>

Temp Diff Emit Dsgn

<JSON number>

• Parent: SpaceHeatSystemWetDistribution

Thermal Mass

<JSON value>

• Parent: SpaceHeatSystemWetDistribution

• Default: <JSON null>

• AnyOf:

  • <JSON number>

  • <JSON null>

Variable Flow

<JSON boolean>

• Parent: SpaceHeatSystemWetDistribution

Control

<JSON string>

• Parent: SpaceHeatSystemWetDistribution

Energysupply

<JSON value>

• Parent: SpaceHeatSystemWetDistribution

• Default: <JSON null>

• AnyOf:

  • <JSON string>

  • <JSON null>

Zone

<JSON string>

• Parent: SpaceHeatSystemWetDistribution

StorageTank

<JSON object>

• Parent(s): PreHeatedWaterSource collection, Hw Cylinder

• Named name/value pairs:

  • type (required): Type

  • ColdWaterSource (required): Coldwatersource

  • HeatSource (required): Heatsource

  • daily_losses (required): Daily Losses

  • heat_exchanger_surface_area: Heat Exchanger Surface Area

  • init_temp (required): Init Temp

  • primary_pipework: Primary Pipework

  • volume (required): Volume

• User-named name/value pairs: NONE_ALLOWED

Type

<JSON string>

• Parent: StorageTank

• Const: ‘StorageTank’

Coldwatersource

<JSON string>

• Parent: StorageTank

Heatsource

<JSON object>

• Parent: StorageTank

• User-named name/value pairs:

  • {ANY_NAME:

    • <JSON value>

    • OneOf:

      • ImmersionHeater

      • SolarThermalSystem

      • HeatSourceWetServiceWaterRegular

      • HeatPumpHotWaterOnly

    • Non-JSON Schema keywords:

      • discriminator: {‘mapping’: {‘HeatPump_HWOnly’: ‘#/$defs/HeatPumpHotWaterOnly’, ‘HeatSourceWet’: ‘#/$defs/HeatSourceWetServiceWaterRegular’, ‘ImmersionHeater’: ‘#/$defs/ImmersionHeater’, ‘SolarThermalSystem’: ‘#/$defs/SolarThermalSystem’}, ‘propertyName’: ‘type’}

    }

Daily Losses

<JSON number>

• Parent: StorageTank

• Description: Measured standby losses due to cylinder insulation at standardised conditions (unit: kWh/24h)

Heat Exchanger Surface Area

<JSON value>

• Parent: StorageTank

• Default: <JSON null>

• AnyOf:

  • <JSON number>

  • <JSON null>

Init Temp

<JSON number>

• Parent: StorageTank

Primary Pipework

<JSON value>

• Parent: StorageTank

• Default: <JSON null>

• AnyOf:

  • <JSON array>

    • Items: WaterPipework

  • <JSON null>

Volume

<JSON number>

• Parent: StorageTank

• Description: Total volume of tank (unit: litre)

SupplyAirFlowRateControlType

<JSON string>

• Parent(s): MechanicalVentilation

• Enum: [‘ODA’]

SupplyAirTemperatureControlType

<JSON string>

• Parent(s): MechanicalVentilation

• Enum: [‘CONST’, ‘NO_CTRL’, ‘LOAD_COM’]

TerrainClass

<JSON string>

• Parent(s): InfiltrationVentilation

• Enum: [‘OpenWater’, ‘OpenField’, ‘Suburban’, ‘Urban’]

TestLetter

<JSON string>

• Parent(s): HeatPumpTestDatum

• Enum: [‘A’, ‘B’, ‘C’, ‘D’, ‘F’]

ThermalBridgingLinear

<JSON object>

• Parent(s): Thermalbridging

• Named name/value pairs:

  • type (required): Type

  • length (required): Length

  • linear_thermal_transmittance (required): Linear Thermal Transmittance

• User-named name/value pairs: NONE_ALLOWED

Type

<JSON string>

• Parent: ThermalBridgingLinear

• Const: ‘ThermalBridgeLinear’

Length

<JSON number>

• Parent: ThermalBridgingLinear

Linear Thermal Transmittance

<JSON number>

• Parent: ThermalBridgingLinear

ThermalBridgingPoint

<JSON object>

• Parent(s): Thermalbridging

• Named name/value pairs:

  • type (required): Type

  • heat_transfer_coeff (required): Heat Transfer Coeff

• User-named name/value pairs: NONE_ALLOWED

Type

<JSON string>

• Parent: ThermalBridgingPoint

• Const: ‘ThermalBridgePoint’

Heat Transfer Coeff

<JSON number>

• Parent: ThermalBridgingPoint

Vent

<JSON object>

• Parent(s): Vents

• Named name/value pairs:

  • area_cm2 (required): Area Cm2

  • mid_height_air_flow_path (required): Mid Height Air Flow Path

  • orientation360 (required): Orientation360

  • pitch (required): Pitch

  • pressure_difference_ref (required): Pressure Difference Ref

• User-named name/value pairs: NONE_ALLOWED

Area Cm2

<JSON number>

• Parent: Vent

Mid Height Air Flow Path

<JSON number>

• Parent: Vent

Orientation360

<JSON number>

• Parent: Vent

• Description: The orientation angle of the inclined surface, expressed as the geographical azimuth angle of the horizontal projection of the inclined surface normal, 0 to 360 (unit: ˚)

Pitch

<JSON number>

• Parent: Vent

• Description: Tilt angle of the surface from horizontal, between 0 and 180, where 0 means the external surface is facing up, 90 means the external surface is vertical and 180 means the external surface is facing down (unit: ˚)

Pressure Difference Ref

<JSON number>

• Parent: Vent

• Description: Reference pressure difference for an air terminal device (unit: Pa)

VentilationLeaks

<JSON object>

• Parent(s): InfiltrationVentilation

• Named name/value pairs:

  • env_area (required): Env Area

  • test_pressure (required): Test Pressure

  • test_result (required): Test Result

  • ventilation_zone_height (required): Ventilation Zone Height

• User-named name/value pairs: NONE_ALLOWED

Env Area

<JSON number>

• Parent: VentilationLeaks

• Description: Reference area of the envelope airtightness index

Test Pressure

<JSON number>

• Parent: VentilationLeaks

• Description: Reference pressure difference (unit: Pa)

Test Result

<JSON number>

• Parent: VentilationLeaks

• Description: Flow rate through

Ventilation Zone Height

<JSON number>

• Parent: VentilationLeaks

VentilationShieldClass

<JSON string>

• Parent(s): InfiltrationVentilation

• Enum: [‘Open’, ‘Normal’, ‘Shielded’]

WasteWaterHeatRecoverySystem

<JSON object>

• Parent(s): WWHRS collection

• Named name/value pairs:

  • ColdWaterSource (required): Coldwatersource

  • efficiencies (required): Efficiencies

  • flow_rates (required): Flow Rates

  • type (required): WasteWaterHeatRecoverySystemType

  • utilisation_factor (required): Utilisation Factor

• User-named name/value pairs: NONE_ALLOWED

Coldwatersource

<JSON string>

• Parent: WasteWaterHeatRecoverySystem

Efficiencies

<JSON array>

• Parent: WasteWaterHeatRecoverySystem

• Items: <JSON number>

Flow Rates

<JSON array>

• Parent: WasteWaterHeatRecoverySystem

• Items: <JSON number>

Utilisation Factor

<JSON number>

• Parent: WasteWaterHeatRecoverySystem

WasteWaterHeatRecoverySystemType

<JSON string>

• Parent(s): WasteWaterHeatRecoverySystem

• Enum: [‘WWHRS_InstantaneousSystemA’, ‘WWHRS_InstantaneousSystemB’, ‘WWHRS_InstantaneousSystemC’]

WaterHeatingEvent

<JSON object>

• Parent(s): Shower, Bath, Other

• Named name/value pairs:

  • duration: Duration

  • start (required): Start

  • temperature (required): Temperature

  • volume: Volume

• User-named name/value pairs: NONE_ALLOWED

Duration

<JSON value>

• Parent: WaterHeatingEvent

• Default: <JSON null>

• AnyOf:

  • <JSON number>

  • <JSON null>

Start

<JSON number>

• Parent: WaterHeatingEvent

Temperature

<JSON number>

• Parent: WaterHeatingEvent

Volume

<JSON value>

• Parent: WaterHeatingEvent

• Default: <JSON null>

• AnyOf:

  • <JSON number>

  • <JSON null>

WaterHeatingEvents

<JSON object>

• Parent(s): Input

• Named name/value pairs:

  • Shower: Shower

  • Bath: Bath

  • Other: Other

• User-named name/value pairs: NONE_ALLOWED

Shower

<JSON value>

• Parent: WaterHeatingEvents

• Default: <JSON null>

• AnyOf:

  • <JSON object>

    • User-named name/value pairs:

      • {ANY_NAME:

        • <JSON array>

        • Items: WaterHeatingEvent

        }

  • <JSON null>

Bath

<JSON value>

• Parent: WaterHeatingEvents

• Default: <JSON null>

• AnyOf:

  • <JSON object>

    • User-named name/value pairs:

      • {ANY_NAME:

        • <JSON array>

        • Items: WaterHeatingEvent

        }

  • <JSON null>

Other

<JSON value>

• Parent: WaterHeatingEvents

• Default: <JSON null>

• AnyOf:

  • <JSON object>

    • User-named name/value pairs:

      • {ANY_NAME:

        • <JSON array>

        • Items: WaterHeatingEvent

        }

  • <JSON null>

WaterPipeContentsType

<JSON string>

• Parent(s): WaterPipework

• Enum: [‘water’, ‘glycol25’]

WaterPipework

<JSON object>

• Parent(s): Primary Pipework, Primary Pipework

• Named name/value pairs:

  • external_diameter_mm (required): External Diameter Mm

  • insulation_thermal_conductivity (required): Insulation Thermal Conductivity

  • insulation_thickness_mm (required): Insulation Thickness Mm

  • internal_diameter_mm (required): Internal Diameter Mm

  • length (required): Length

  • location (required): WaterPipeworkLocation

  • pipe_contents (required): WaterPipeContentsType

  • surface_reflectivity (required): Surface Reflectivity

• User-named name/value pairs: NONE_ALLOWED

External Diameter Mm

<JSON number>

• Parent: WaterPipework

Insulation Thermal Conductivity

<JSON number>

• Parent: WaterPipework

Insulation Thickness Mm

<JSON number>

• Parent: WaterPipework

Internal Diameter Mm

<JSON number>

• Parent: WaterPipework

Length

<JSON number>

• Parent: WaterPipework

Surface Reflectivity

<JSON boolean>

• Parent: WaterPipework

WaterPipeworkLocation

<JSON string>

• Parent(s): WaterPipework, WaterPipeworkSimple

• Enum: [‘internal’, ‘external’]

WaterPipeworkSimple

<JSON object>

• Parent(s): Distribution

• Named name/value pairs:

  • internal_diameter_mm (required): Internal Diameter Mm

  • length (required): Length

  • location (required): WaterPipeworkLocation

• User-named name/value pairs: NONE_ALLOWED

Internal Diameter Mm

<JSON number>

• Parent: WaterPipeworkSimple

Length

<JSON number>

• Parent: WaterPipeworkSimple

WetEmitterFanCoil

<JSON object>

• Parent(s): Emitters

• Named name/value pairs:

  • wet_emitter_type (required): Wet Emitter Type

  • fancoil_test_data (required): FancoilTestData

  • frac_convective (required): Frac Convective

  • n_units: N Units

• User-named name/value pairs: NONE_ALLOWED

Wet Emitter Type

<JSON string>

• Parent: WetEmitterFanCoil

• Const: ‘fancoil’

Frac Convective

<JSON number>

• Parent: WetEmitterFanCoil

N Units

<JSON value>

• Parent: WetEmitterFanCoil

• Default: 1

• AnyOf:

  • <JSON integer>

    • ExclusiveMinimum: 0

  • <JSON null>

WetEmitterRadiator

<JSON object>

• Parent(s): Emitters

• Named name/value pairs:

  • wet_emitter_type (required): Wet Emitter Type

  • c (required): C

  • frac_convective (required): Frac Convective

  • n (required): N

• User-named name/value pairs: NONE_ALLOWED

Wet Emitter Type

<JSON string>

• Parent: WetEmitterRadiator

• Const: ‘radiator’

C

<JSON number>

• Parent: WetEmitterRadiator

Frac Convective

<JSON number>

• Parent: WetEmitterRadiator

N

<JSON number>

• Parent: WetEmitterRadiator

WetEmitterUFH

<JSON object>

• Parent(s): Emitters

• Named name/value pairs:

  • wet_emitter_type (required): Wet Emitter Type

  • emitter_floor_area (required): Emitter Floor Area

  • equivalent_specific_thermal_mass (required): Equivalent Specific Thermal Mass

  • frac_convective (required): Frac Convective

  • system_performance_factor (required): System Performance Factor

• User-named name/value pairs: NONE_ALLOWED

Wet Emitter Type

<JSON string>

• Parent: WetEmitterUFH

• Const: ‘ufh’

Emitter Floor Area

<JSON number>

• Parent: WetEmitterUFH

Equivalent Specific Thermal Mass

<JSON number>

• Parent: WetEmitterUFH

Frac Convective

<JSON number>

• Parent: WetEmitterUFH

System Performance Factor

<JSON number>

• Parent: WetEmitterUFH

WindShieldLocation

<JSON string>

• Parent(s): BuildingElementGroundHeatedBasement, BuildingElementGroundSlabEdgeInsulation, BuildingElementGroundSlabNoEdgeInsulation, BuildingElementGroundSuspendedFloor, BuildingElementGroundUnheatedBasement

• Enum: [‘Sheltered’, ‘Average’, ‘Exposed’]

WindowPart

<JSON object>

• Parent(s): Window Part List

• Named name/value pairs:

  • mid_height_air_flow_path (required): Mid Height Air Flow Path

• User-named name/value pairs: NONE_ALLOWED

Mid Height Air Flow Path

<JSON number>

• Parent: WindowPart

WindowShadingObject

<JSON object>

• Parent(s): Shading, Shading

• Named name/value pairs:

  • type (required): WindowShadingType

  • depth (required): Depth

  • distance (required): Distance

• User-named name/value pairs: NONE_ALLOWED

Depth

<JSON number>

• Parent: WindowShadingObject

Distance

<JSON number>

• Parent: WindowShadingObject

WindowShadingObstacle

<JSON object>

• Parent(s): Shading, Shading

• Named name/value pairs:

  • type (required): Type

  • height (required): Height

  • distance (required): Distance

  • transparency (required): Transparency

• User-named name/value pairs: NONE_ALLOWED

Type

<JSON string>

• Parent: WindowShadingObstacle

• Const: ‘obstacle’

Height

<JSON number>

• Parent: WindowShadingObstacle

Distance

<JSON number>

• Parent: WindowShadingObstacle

Transparency

<JSON number>

• Parent: WindowShadingObstacle

WindowShadingType

<JSON string>

• Parent(s): WindowShadingObject

• Enum: [‘overhang’, ‘sidefinright’, ‘sidefinleft’, ‘reveal’]

WindowTreatment

<JSON object>

• Parent(s): Treatment

• Named name/value pairs:

  • Control_closing_irrad: Control Closing Irrad

  • Control_open: Control Open

  • Control_opening_irrad: Control Opening Irrad

  • controls (required): WindowTreatmentControl

  • delta_r (required): Delta R

  • is_open: Is Open

  • opening_delay_hrs: Opening Delay Hrs

  • trans_red (required): Trans Red

  • type (required): WindowTreatmentType

• User-named name/value pairs: NONE_ALLOWED

Control Closing Irrad

<JSON value>

• Parent: WindowTreatment

• Default: <JSON null>

• AnyOf:

  • <JSON string>

  • <JSON null>

Control Open

<JSON value>

• Parent: WindowTreatment

• Default: <JSON null>

• AnyOf:

  • <JSON string>

  • <JSON null>

Control Opening Irrad

<JSON value>

• Parent: WindowTreatment

• Default: <JSON null>

• AnyOf:

  • <JSON string>

  • <JSON null>

Delta R

<JSON number>

• Parent: WindowTreatment

Is Open

<JSON value>

• Parent: WindowTreatment

• Description: This field should be a boolean - any string provided will be ignored and treated as a null.

• Default: <JSON null>

• AnyOf:

  • <JSON boolean>

  • <JSON null>

Opening Delay Hrs

<JSON value>

• Parent: WindowTreatment

• Default: <JSON null>

• AnyOf:

  • <JSON number>

  • <JSON null>

Trans Red

<JSON number>

• Parent: WindowTreatment

WindowTreatmentControl

<JSON string>

• Parent(s): WindowTreatment

• Enum: [‘auto_motorised’, ‘combined_light_blind_HVAC’, ‘manual’, ‘manual_motorised’]

WindowTreatmentType

<JSON string>

• Parent(s): WindowTreatment

• Enum: [‘blinds’, ‘curtains’]

Zone

<JSON object>

• Parent(s): Zone collection

• Named name/value pairs:

  • BuildingElement (required): Buildingelement

  • SpaceCoolSystem: Spacecoolsystem

  • SpaceHeatSystem: Spaceheatsystem

  • ThermalBridging (required): Thermalbridging

  • area (required): Area

  • temp_setpnt_basis:

    • <JSON value>

      • Default: <JSON null>

      • AnyOf:

        • ZoneTemperatureControlBasis

        • <JSON null>

  • temp_setpnt_init (required): Temp Setpnt Init

  • volume (required): Volume

• User-named name/value pairs: NONE_ALLOWED

Buildingelement

<JSON object>

• Parent: Zone

• User-named name/value pairs:

  • {ANY_NAME:

    • <JSON value>

    • OneOf:

      • BuildingElementOpaque

      • BuildingElementTransparent

      • <JSON value>

        • OneOf:

          • BuildingElementGroundSlabNoEdgeInsulation

          • BuildingElementGroundSlabEdgeInsulation

          • BuildingElementGroundSuspendedFloor

          • BuildingElementGroundHeatedBasement

          • BuildingElementGroundUnheatedBasement

        • Non-JSON Schema keywords:

          • discriminator: {‘mapping’: {‘Heated_basement’: ‘#/$defs/BuildingElementGroundHeatedBasement’, ‘Slab_edge_insulation’: ‘#/$defs/BuildingElementGroundSlabEdgeInsulation’, ‘Slab_no_edge_insulation’: ‘#/$defs/BuildingElementGroundSlabNoEdgeInsulation’, ‘Suspended_floor’: ‘#/$defs/BuildingElementGroundSuspendedFloor’, ‘Unheated_basement’: ‘#/$defs/BuildingElementGroundUnheatedBasement’}, ‘propertyName’: ‘floor_type’}

      • BuildingElementAdjacentConditionedSpace

      • BuildingElementAdjacentUnconditionedSpace_Simple

    • Non-JSON Schema keywords:

      • discriminator: {‘mapping’: {‘BuildingElementAdjacentConditionedSpace’: ‘#/$defs/BuildingElementAdjacentConditionedSpace’, ‘BuildingElementAdjacentUnconditionedSpace_Simple’: ‘#/$defs/BuildingElementAdjacentUnconditionedSpace_Simple’, ‘BuildingElementGround’: {‘discriminator’: {‘mapping’: {‘Heated_basement’: ‘#/$defs/BuildingElementGroundHeatedBasement’, ‘Slab_edge_insulation’: ‘#/$defs/BuildingElementGroundSlabEdgeInsulation’, ‘Slab_no_edge_insulation’: ‘#/$defs/BuildingElementGroundSlabNoEdgeInsulation’, ‘Suspended_floor’: ‘#/$defs/BuildingElementGroundSuspendedFloor’, ‘Unheated_basement’: ‘#/$defs/BuildingElementGroundUnheatedBasement’}, ‘propertyName’: ‘floor_type’}, ‘oneOf’: [{‘$ref’: ‘#/$defs/BuildingElementGroundSlabNoEdgeInsulation’}, {‘$ref’: ‘#/$defs/BuildingElementGroundSlabEdgeInsulation’}, {‘$ref’: ‘#/$defs/BuildingElementGroundSuspendedFloor’}, {‘$ref’: ‘#/$defs/BuildingElementGroundHeatedBasement’}, {‘$ref’: ‘#/$defs/BuildingElementGroundUnheatedBasement’}]}, ‘BuildingElementOpaque’: ‘#/$defs/BuildingElementOpaque’, ‘BuildingElementTransparent’: ‘#/$defs/BuildingElementTransparent’}, ‘propertyName’: ‘type’}

    }

Spacecoolsystem

<JSON value>

• Parent: Zone

• Default: <JSON null>

• AnyOf:

  • <JSON string>

  • <JSON array>

    • UniqueItems: True

    • Items: <JSON string>

  • <JSON null>

Spaceheatsystem

<JSON value>

• Parent: Zone

• Default: <JSON null>

• AnyOf:

  • <JSON string>

  • <JSON array>

    • UniqueItems: True

    • Items: <JSON string>

  • <JSON null>

Thermalbridging

<JSON value>

• Parent: Zone

• AnyOf:

  • <JSON number>

  • <JSON object>

    • User-named name/value pairs:

      • {ANY_NAME:

        • <JSON value>

        • OneOf:

          • ThermalBridgingLinear

          • ThermalBridgingPoint

        • Non-JSON Schema keywords:

          • discriminator: {‘mapping’: {‘ThermalBridgeLinear’: ‘#/$defs/ThermalBridgingLinear’, ‘ThermalBridgePoint’: ‘#/$defs/ThermalBridgingPoint’}, ‘propertyName’: ‘type’}

        }

Area

<JSON number>

• Parent: Zone

• Description: Useful floor area of the zone (unit: m²)

Temp Setpnt Init

<JSON number>

• Parent: Zone

• Description: Setpoint temperature to use during initialisation (unit: ˚C)

Volume

<JSON number>

• Parent: Zone

ZoneTemperatureControlBasis

<JSON string>

• Parent(s): Zone

• Enum: [‘air’, ‘operative’]