Skip to content

HVAC models

Detailed HVAC: the network, loops and connections, and the component models. Every model in the dsbxml.hvac modules, generated from the code.

Network and loops

HVACNetwork

Bases: BaseModel

Source code in dsbxml\hvac\network.py
19
20
21
22
23
24
25
class HVACNetwork(BaseModel):
    ObjectHandle: int | None = element(tag="ObjectHandle", default=None)
    object_ids: Annotated[ObjectIDs, Field(default_factory=ObjectIDs)] = element(
        tag="ObjectIDs"
    )
    hvac_loops: HVACLoops | None = element(tag="HVACLoops", default=None)
    hvac_zone_groups: HVACZoneGroups | None = element(tag="HVACZoneGroups", default=None)

ObjectHandle = element(tag='ObjectHandle', default=None) class-attribute instance-attribute

object_ids = element(tag='ObjectIDs') class-attribute instance-attribute

hvac_loops = element(tag='HVACLoops', default=None) class-attribute instance-attribute

hvac_zone_groups = element(tag='HVACZoneGroups', default=None) class-attribute instance-attribute

HVACLoops

Bases: BaseModel

Source code in dsbxml\hvac\network.py
28
29
30
class HVACLoops(BaseModel):
    hvac_loop: list[HVACLoop] = element(tag="HVACLoop", default_factory=list)
    hvac_vrf_loop: list[HVACVRFLoop] = element(tag="HVACVRFLoop", default_factory=list)

hvac_loop = element(tag='HVACLoop', default_factory=list) class-attribute instance-attribute

hvac_vrf_loop = element(tag='HVACVRFLoop', default_factory=list) class-attribute instance-attribute

HVACZoneGroups

Bases: BaseModel

Source code in dsbxml\hvac\network.py
33
34
class HVACZoneGroups(BaseModel):
    hvac_zone_group: list[HVACZoneGroup] = element(tag="HVACZoneGroup", default_factory=list)

hvac_zone_group = element(tag='HVACZoneGroup', default_factory=list) class-attribute instance-attribute

HVACLoop

Bases: BaseModel

Source code in dsbxml\hvac\network.py
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
class HVACLoop(BaseModel):
    currentSubLoopIndex: int = attr()
    loopType: int = attr()
    plantLoopType: int = attr()
    numberOfFlowNodes: int = attr()
    object_ids: Annotated[ObjectIDs, Field(default_factory=ObjectIDs)] = element(
        tag="ObjectIDs"
    )
    origin: WrappedPoint3D = element(tag="Origin")
    plant_operation_schemes: PlantOperationSchemes | None = element(
        tag="PlantOperationSchemes", default=None
    )
    demand_sub_loop: DemandSubLoop = element(tag="DemandSubLoop")
    supply_sub_loop: SupplySubLoop = element(tag="SupplySubLoop")
    attributes: NameAttributes = element(tag="Attributes")

currentSubLoopIndex = attr() class-attribute instance-attribute

loopType = attr() class-attribute instance-attribute

plantLoopType = attr() class-attribute instance-attribute

numberOfFlowNodes = attr() class-attribute instance-attribute

object_ids = element(tag='ObjectIDs') class-attribute instance-attribute

origin = element(tag='Origin') class-attribute instance-attribute

plant_operation_schemes = element(tag='PlantOperationSchemes', default=None) class-attribute instance-attribute

demand_sub_loop = element(tag='DemandSubLoop') class-attribute instance-attribute

supply_sub_loop = element(tag='SupplySubLoop') class-attribute instance-attribute

attributes = element(tag='Attributes') class-attribute instance-attribute

HVACVRFLoop

Bases: BaseModel

Source code in dsbxml\hvac\network.py
54
55
56
57
58
59
60
61
class HVACVRFLoop(BaseModel):
    object_ids: Annotated[ObjectIDs, Field(default_factory=ObjectIDs)] = element(
        tag="ObjectIDs"
    )
    origin: WrappedPoint3D = element(tag="Origin")
    vrf_air_conditioner_unit: VRFAirConditionerUnit = element(tag="VRFAirConditionerUnit")
    hvac_connections: HVACConnections = element(tag="HVACConnections")
    attributes: NameAttributes = element(tag="Attributes")

object_ids = element(tag='ObjectIDs') class-attribute instance-attribute

origin = element(tag='Origin') class-attribute instance-attribute

vrf_air_conditioner_unit = element(tag='VRFAirConditionerUnit') class-attribute instance-attribute

hvac_connections = element(tag='HVACConnections') class-attribute instance-attribute

attributes = element(tag='Attributes') class-attribute instance-attribute

PlantOperationSchemes

Bases: BaseModel

Source code in dsbxml\hvac\network.py
64
65
66
67
class PlantOperationSchemes(BaseModel):
    plant_operation_scheme: list[PlantOperationScheme] = element(
        tag="PlantOperationScheme", default_factory=list
    )

plant_operation_scheme = element(tag='PlantOperationScheme', default_factory=list) class-attribute instance-attribute

PlantOperationScheme

Bases: BaseModel

Source code in dsbxml\hvac\network.py
70
71
72
class PlantOperationScheme(BaseModel):
    plant_operation_ranges: list[PlantOperationRanges] = element(tag="PlantOperationRanges")
    attributes: NameAttributes = element(tag="Attributes")

plant_operation_ranges = element(tag='PlantOperationRanges') class-attribute instance-attribute

attributes = element(tag='Attributes') class-attribute instance-attribute

PlantOperationRanges

Bases: BaseModel

Source code in dsbxml\hvac\network.py
75
76
77
78
79
class PlantOperationRanges(BaseModel):
    # The XSD allows several ranges per scheme (one per load band).
    plant_operation_range: list[PlantOperationRange] = element(
        tag="PlantOperationRange", default_factory=list
    )

plant_operation_range = element(tag='PlantOperationRange', default_factory=list) class-attribute instance-attribute

PlantOperationRange

Bases: BaseModel

Source code in dsbxml\hvac\network.py
82
83
class PlantOperationRange(BaseModel):
    attributes: NameAttributes = element(tag="Attributes")

attributes = element(tag='Attributes') class-attribute instance-attribute

DemandSubLoop

Bases: BaseModel

Source code in dsbxml\hvac\network.py
86
87
88
89
90
91
92
93
94
95
class DemandSubLoop(BaseModel):
    loopType: int = element(tag="LoopType")
    plantLoopType: int = element(tag="PlantLoopType")
    subLoopType: int = element(tag="SubLoopType")
    object_ids: Annotated[ObjectIDs, Field(default_factory=ObjectIDs)] = element(
        tag="ObjectIDs"
    )
    hvac_components: HVACComponents = element(tag="HVACComponents")
    hvac_connections: HVACConnections = element(tag="HVACConnections")
    attributes: NameAttributes = element(tag="Attributes")

loopType = element(tag='LoopType') class-attribute instance-attribute

plantLoopType = element(tag='PlantLoopType') class-attribute instance-attribute

subLoopType = element(tag='SubLoopType') class-attribute instance-attribute

object_ids = element(tag='ObjectIDs') class-attribute instance-attribute

hvac_components = element(tag='HVACComponents') class-attribute instance-attribute

hvac_connections = element(tag='HVACConnections') class-attribute instance-attribute

attributes = element(tag='Attributes') class-attribute instance-attribute

SupplySubLoop

Bases: BaseModel

Source code in dsbxml\hvac\network.py
 98
 99
100
101
102
103
104
105
106
107
class SupplySubLoop(BaseModel):
    loopType: int = element(tag="LoopType")
    plantLoopType: int = element(tag="PlantLoopType")
    subLoopType: int = element(tag="SubLoopType")
    object_ids: Annotated[ObjectIDs, Field(default_factory=ObjectIDs)] = element(
        tag="ObjectIDs"
    )
    hvac_components: HVACComponents = element(tag="HVACComponents")
    hvac_connections: HVACConnections = element(tag="HVACConnections")
    attributes: NameAttributes = element(tag="Attributes")

loopType = element(tag='LoopType') class-attribute instance-attribute

plantLoopType = element(tag='PlantLoopType') class-attribute instance-attribute

subLoopType = element(tag='SubLoopType') class-attribute instance-attribute

object_ids = element(tag='ObjectIDs') class-attribute instance-attribute

hvac_components = element(tag='HVACComponents') class-attribute instance-attribute

hvac_connections = element(tag='HVACConnections') class-attribute instance-attribute

attributes = element(tag='Attributes') class-attribute instance-attribute

HVACZoneGroup

Bases: NoTypeHVACComponent

Source code in dsbxml\hvac\network.py
110
111
112
113
114
class HVACZoneGroup(NoTypeHVACComponent):
    # width, height, origin, valid_zone_group, zone_group_attributes are
    # inherited from NoTypeHVACComponent (fixes pydantic-xml nested serializer bug).
    # zone_element_list and building_zone_handle_list are injected at model_rebuild().
    pass

BuildingZoneHandle

Bases: BaseModel

Source code in dsbxml\hvac\network.py
117
118
class BuildingZoneHandle(BaseModel):
    building_zone_handle: list[str] = element(tag="BuildingZoneHandle", default_factory=list)

building_zone_handle = element(tag='BuildingZoneHandle', default_factory=list) class-attribute instance-attribute

HVACConnections

Bases: BaseModel

Source code in dsbxml\hvac\network.py
121
122
class HVACConnections(BaseModel):
    hvac_connection: list[HVACConnection] = element(tag="HVACConnection")

hvac_connection = element(tag='HVACConnection') class-attribute instance-attribute

HVACConnection

Bases: BaseModel

Source code in dsbxml\hvac\network.py
125
126
127
128
129
130
131
132
133
134
class HVACConnection(BaseModel):
    object_ids: Annotated[ObjectIDs, Field(default_factory=ObjectIDs)] = element(
        tag="ObjectIDs"
    )
    loopHandle: int = element(tag="LoopHandle")
    subLoopType: int = element(tag="SubLoopType")
    loopType: int = element(tag="LoopType")
    plantLoopType: int = element(tag="PlantLoopType")
    loopFlowDirection: int = element(tag="LoopFlowDirection")
    element_list: ElementList = element(tag="ElementList")

object_ids = element(tag='ObjectIDs') class-attribute instance-attribute

loopHandle = element(tag='LoopHandle') class-attribute instance-attribute

subLoopType = element(tag='SubLoopType') class-attribute instance-attribute

loopType = element(tag='LoopType') class-attribute instance-attribute

plantLoopType = element(tag='PlantLoopType') class-attribute instance-attribute

loopFlowDirection = element(tag='LoopFlowDirection') class-attribute instance-attribute

element_list = element(tag='ElementList') class-attribute instance-attribute

ElementList

Bases: BaseModel

Source code in dsbxml\hvac\network.py
137
138
class ElementList(BaseModel):
    hvac_connection_element: list[HVACConnectionElement] = element(tag="HVACConnectionElement")

hvac_connection_element = element(tag='HVACConnectionElement') class-attribute instance-attribute

HVACConnectionElement

Bases: BaseModel

Source code in dsbxml\hvac\network.py
141
142
143
class HVACConnectionElement(BaseModel):
    line: Line = element(tag="Line")
    segment_list: SegmentList = element(tag="SegmentList")

line = element(tag='Line') class-attribute instance-attribute

segment_list = element(tag='SegmentList') class-attribute instance-attribute

Components

HVAC_COMPONENT_MAPPING = {'Sub-loop node': SubLoopNode, 'Zone mixer': ZoneMixer, 'Zone splitter': ZoneSplitter, 'Splitter': Splitter, 'Mixer': Mixer, 'Setpoint manager': SetpointManager, 'Pump': Pump, 'Boiler': Boiler, 'Generator': Generator, 'Heat pump heating': HeatPumpHeating, 'Water heater heat pump': WaterHeaterHeatPump, 'Chiller': Chiller, 'Heat pump cooling': HeatPumpCooling, 'Cooling tower': CoolingTower, 'Fluid cooler': FluidCooler, 'Chilled water storage': ChilledWaterStorage, 'Ice thermal storage': IceThermalStorage, 'Water heater': WaterHeater, 'Domestic water connections': DomesticWaterConnections, 'Fluid-to-fluid heat exchanger': FluidToFluidHeatExchanger, 'Ground heat exchanger': GroundHeatExchanger, 'Air handling unit': AirHandlingUnit, 'Unitary system': UnitarySystem, 'Unitary heat pump air-to-air': UnitaryHeatPumpAirToAir, 'Unitary heat pump water-to-air': UnitaryHeatPumpWaterToAir, 'Tempering valve': TemperingValve, 'Solar collector': SolarCollector, 'Generic heating coil': GenericHeatingCoil, 'Water cooling coil': WaterCoolingCoil} module-attribute

HVACConnectorNode

Bases: BaseModel

Source code in dsbxml\hvac\components.py
25
26
27
28
29
30
class HVACConnectorNode(BaseModel):
    object_ids: Annotated[ObjectIDs, Field(default_factory=ObjectIDs)] = element(
        tag="ObjectIDs"
    )
    name: str = element(tag="Name", default="")
    active: int = element(tag="Active", default=0)

object_ids = element(tag='ObjectIDs') class-attribute instance-attribute

name = element(tag='Name', default='') class-attribute instance-attribute

active = element(tag='Active', default=0) class-attribute instance-attribute

BranchConnectionList

Bases: BaseModel

Source code in dsbxml\hvac\components.py
33
34
35
36
class BranchConnectionList(BaseModel):
    hvac_connector_node: list[HVACConnectorNode] = element(
        tag="HVACConnectorNode", default_factory=list
    )

hvac_connector_node = element(tag='HVACConnectorNode', default_factory=list) class-attribute instance-attribute

HVACSubLoopNodeConnection

Bases: BaseModel

Source code in dsbxml\hvac\components.py
39
40
41
42
43
44
45
class HVACSubLoopNodeConnection(BaseModel):
    object_ids: Annotated[ObjectIDs, Field(default_factory=ObjectIDs)] = element(
        tag="ObjectIDs"
    )
    connected: int = element(tag="Connected", default=0)
    coordinate: WrappedPoint3D | None = element(tag="Coordinate", default=None)
    attributes: NameAttributes = element(tag="Attributes")

object_ids = element(tag='ObjectIDs') class-attribute instance-attribute

connected = element(tag='Connected', default=0) class-attribute instance-attribute

coordinate = element(tag='Coordinate', default=None) class-attribute instance-attribute

attributes = element(tag='Attributes') class-attribute instance-attribute

FlowConnections

Bases: BaseModel

Source code in dsbxml\hvac\components.py
48
49
50
51
class FlowConnections(BaseModel):
    hvac_sub_loop_node_connection: list[HVACSubLoopNodeConnection] = element(
        tag="HVACSubLoopNodeConnection", default_factory=list
    )

hvac_sub_loop_node_connection = element(tag='HVACSubLoopNodeConnection', default_factory=list) class-attribute instance-attribute

ExhaustUnitComponentList

Bases: BaseModel

Source code in dsbxml\hvac\components.py
54
55
56
57
class ExhaustUnitComponentList(BaseModel):
    air_handling_unit_hvac_component: list[AirHandlingUnitHVACComponent] = element(
        tag="AirHandlingUnitHVACComponent", default_factory=list
    )

air_handling_unit_hvac_component = element(tag='AirHandlingUnitHVACComponent', default_factory=list) class-attribute instance-attribute

IntakeUnitComponentList

Bases: BaseModel

Source code in dsbxml\hvac\components.py
60
61
62
63
class IntakeUnitComponentList(BaseModel):
    air_handling_unit_hvac_component: list[AirHandlingUnitHVACComponent] = element(
        tag="AirHandlingUnitHVACComponent", default_factory=list
    )

air_handling_unit_hvac_component = element(tag='AirHandlingUnitHVACComponent', default_factory=list) class-attribute instance-attribute

NoTypeHVACComponent

Bases: BaseModel

Source code in dsbxml\hvac\components.py
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
class NoTypeHVACComponent(BaseModel):
    type: str | None = attr(default=None)

    # The schema puts these first, before ImageRectangle, for the types that have
    # them (an outdoor air system; the water heater inside a heat pump water
    # heater). pydantic writes base-class fields before subclass fields, so they
    # are declared here, unset (and so not written) for every other type.
    heat_recovery: int | None = element(tag="HeatRecovery", default=None)
    recirculation: int | None = element(tag="Recirculation", default=None)
    hot_water_heat_exchanger: int | None = element(tag="HotWaterHeatExchanger", default=None)

    image_rectangle: ImageRectangle | None = element(tag="ImageRectangle", default=None)
    connecting_plant_loop_handle: list[int] = element(
        tag="ConnectingPlantLoopHandle", default_factory=list
    )
    connectingAirLoopHandle: int = element(tag="ConnectingAirLoopHandle", default=-1)
    loopType: int = element(tag="LoopType", default=0)
    subLoopType: int = element(tag="SubLoopType", default=0)
    plantLoopType: int = element(tag="PlantLoopType", default=0)
    airLoopDuctType: int = element(tag="AirLoopDuctType", default=0)
    componentType: int = element(tag="ComponentType", default=0)
    location: int = element(tag="Location", default=0)
    connectionOffset: XSDFloat = element(tag="ConnectionOffset", default=0.0)
    editable: int = element(tag="Editable", default=0)
    zoneBranchFlag: int = element(tag="ZoneBranchFlag", default=0)
    orientation: int = element(tag="Orientation", default=0)
    waterInConnectionOrientation: int = element(tag="WaterInConnectionOrientation", default=0)
    waterOutConnectionOrientation: int = element(tag="WaterOutConnectionOrientation", default=0)
    airInConnectionOrientation: int = element(tag="AirInConnectionOrientation", default=0)
    airOutConnectionOrientation: int = element(tag="AirOutConnectionOrientation", default=0)
    waterInConnection: int = element(tag="WaterInConnection", default=0)
    waterOutConnection: int = element(tag="WaterOutConnection", default=0)
    airInConnection: int = element(tag="AirInConnection", default=0)
    airOutConnection: int = element(tag="AirOutConnection", default=0)
    waterInConnected: int = element(tag="WaterInConnected", default=0)
    waterOutConnected: int = element(tag="WaterOutConnected", default=0)
    airInConnected: int = element(tag="AirInConnected", default=0)
    airOutConnected: int = element(tag="AirOutConnected", default=0)
    fanPlacement: int = element(tag="FanPlacement", default=0)
    water_in_connection_coordinate: WrappedPoint3D | None = element(
        tag="WaterInConnectionCoordinate", default=None
    )
    water_out_connection_coordinate: WrappedPoint3D | None = element(
        tag="WaterOutConnectionCoordinate", default=None
    )
    air_in_connection_coordinate: WrappedPoint3D | None = element(
        tag="AirInConnectionCoordinate", default=None
    )
    air_out_connection_coordinate: WrappedPoint3D | None = element(
        tag="AirOutConnectionCoordinate", default=None
    )
    attributes: NameAttributes | None = element(tag="Attributes", default=None)
    zone_component_attribute_list: ZoneComponentAttributeList | None = element(
        tag="ZoneComponentAttributeList", default=None
    )
    refrigerant_connected: int | None = element(tag="RefrigerantConnected", default=None)
    valid_zone_group: str | None = element(tag="ValidZoneGroup", default=None)
    width: XSDFloat | None = element(tag="Width", default=None)
    height: XSDFloat | None = element(tag="Height", default=None)
    loop_flow_direction: int | None = element(tag="LoopFlowDirection", default=None)
    number_of_flow_connections: int | None = element(
        tag="NumberOfFlowConnections", default=None
    )
    flow_connections: FlowConnections | None = element(tag="FlowConnections", default=None)
    hvac_sub_loop_node_connection: HVACSubLoopNodeConnection | None = element(
        tag="HVACSubLoopNodeConnection", default=None
    )
    origin: WrappedPoint3D | None = element(tag="Origin", default=None)
    control_point: WrappedPoint3D | None = element(tag="ControlPoint", default=None)
    upstream_node: WrappedPoint3D | None = element(tag="UpStreamNode", default=None)
    downstream_node: WrappedPoint3D | None = element(tag="DownStreamNode", default=None)
    segment_list: SegmentList | None = element(tag="SegmentList", default=None)
    water_equipment_list: WaterEquipmentList | None = element(
        tag="WaterEquipmentList", default=None
    )
    hvac_connector_node: HVACConnectorNode | None = element(
        tag="HVACConnectorNode", default=None
    )
    branch_connection_list: BranchConnectionList | None = element(
        tag="BranchConnectionList", default=None
    )
    dx_heating_coil: UnitaryDXHeatingCoil | None = element(tag="DXHeatingCoil", default=None)
    refrigerant_connection_coordinate: WrappedPoint3D | None = element(
        tag="RefrigerantConnectionCoordinate", default=None
    )
    building_zone_handle_list: BuildingZoneHandle | None = element(
        tag="BuildingZoneHandleList", default=None
    )
    dx_cooling_coil: UnitaryDXCoolingCoil | None = element(tag="DXCoolingCoil", default=None)
    water_cooled_condenser: WaterCooledCondenser | None = element(
        tag="WaterCooledCondenser", default=None
    )
    zone_element_list: ZoneElementList | None = element(tag="ZoneElementList", default=None)
    zone_group_attributes: NameAttributes | None = element(
        tag="ZoneGroupAttributes", default=None
    )
    mixing_box_width: XSDFloat | None = element(tag="MixingBoxWidth", default=None)
    fan_type: int | None = element(tag="FanType", default=None)
    doas_air_in_connected: int | None = element(tag="DOASAirInConnected", default=None)
    doas_air_out_connected: int | None = element(tag="DOASAirOutConnected", default=None)
    outdoor_air_system: OutdoorAirSystem | None = element(tag="OutdoorAirSystem", default=None)
    intake_damper: IntakeDamper | None = element(tag="IntakeDamper", default=None)
    exhaust_damper: ExhaustDamper | None = element(tag="ExhaustDamper", default=None)
    doas_intake_damper: DOASIntakeDamper | None = element(tag="DOASIntakeDamper", default=None)
    doas_exhaust_damper: DOASExhaustDamper | None = element(
        tag="DOASExhaustDamper", default=None
    )
    mixing_damper: MixingDamper | None = element(tag="MixingDamper", default=None)
    exhaust_unit_component_list: ExhaustUnitComponentList | None = element(
        tag="ExhaustUnitComponentList", default=None
    )
    intake_unit_component_list: IntakeUnitComponentList | None = element(
        tag="IntakeUnitComponentList", default=None
    )
    line_array: LineArray | None = element(tag="LineArray", default=None)
    chiller_hr_heat_exchanger: ChillerHRHeatExchanger | None = element(
        tag="ChillerHRHeatExchanger", default=None
    )
    absorption_chiller_unit: AbsorptionChillerUnit | None = element(
        tag="AbsorptionChillerUnit", default=None
    )
    absorption_chiller_generator_heat_exchanger: (
        AbsorptionChillerGeneratorHeatExchanger | None
    ) = element(tag="AbsorptionChillerGeneratorHeatExchanger", default=None)
    has_reheat_coil: int | None = element(tag="HasReheatCoil", default=None)
    reheat_coil: ReheatCoil | None = element(tag="ReheatCoil", default=None)
    heater_element: WaterHeaterElement | None = element(tag="HeaterElement", default=None)
    heat_pump_condenser: HeatPumpCondenser | None = element(
        tag="HeatPumpCondenser", default=None
    )
    heat_exchanger_element: HeatExchangerElement | None = element(
        tag="HeatExchangerElement", default=None
    )
    chilled_water_storage_heat_exchanger: ChilledWaterStorageHeatExchanger | None = element(
        tag="ChilledWaterStorageHeatExchanger", default=None
    )
    water_heater: HeatPumpWaterHeaterTank | None = element(tag="WaterHeater", default=None)
    water_heater_y_offset: XSDFloat | None = element(tag="WaterHeaterYOffset", default=None)
    supply_fan: HeatPumpWaterHeaterFan | None = element(tag="SupplyFan", default=None)
    supply_fan_x_offset: XSDFloat | None = element(tag="SupplyFanXOffset", default=None)
    supply_fan_y_offset: XSDFloat | None = element(tag="SupplyFanYOffset", default=None)
    air_to_water_heat_pump_coil: AirToWaterHeatPumpCoil | None = element(
        tag="AirToWaterHeatPumpCoil", default=None
    )
    air_to_water_heat_pump_coil_x_offset: XSDFloat | None = element(
        tag="AirToWaterHeatPumpCoilXOffset", default=None
    )
    air_to_water_heat_pump_coil_y_offset: XSDFloat | None = element(
        tag="AirToWaterHeatPumpCoilYOffset", default=None
    )
    air_to_water_hp_coil_connections: AirToWaterHPCoilConnections | None = element(
        tag="AirToWaterHPCoilConnections", default=None
    )
    supply_diffuser: SupplyDiffuser | None = element(tag="SupplyDiffuser", default=None)
    extract_grille: ExtractGrille | None = element(tag="ExtractGrille", default=None)
    intake_louvre: IntakeLouvre | None = element(tag="IntakeLouvre", default=None)
    mixing_box: MixingBox | None = element(tag="MixingBox", default=None)
    cooled_beam: CooledBeam | None = element(tag="CooledBeam", default=None)
    unit_element_list: UnitElementList | None = element(tag="UnitElementList", default=None)
    supply_louvre: SupplyLouvre | None = element(tag="SupplyLouvre", default=None)
    dual_duct_mixing_box: DualDuctMixingBox | None = element(
        tag="DualDuctMixingBox", default=None
    )
    outdoor_air_supply: int | None = element(tag="OutdoorAirSupply", default=None)
    warm_air_in_connected: int | None = element(tag="WarmAirInConnected", default=None)
    cold_air_in_connected: int | None = element(tag="ColdAirInConnected", default=None)
    has_heating_element: int | None = element(tag="HasHeatingElement", default=None)
    heating_element: RadiantHeatingElement | None = element(tag="HeatingElement", default=None)
    has_cooling_element: int | None = element(tag="HasCoolingElement", default=None)
    cooling_element: RadiantCoolingElement | None = element(tag="CoolingElement", default=None)

type = attr(default=None) class-attribute instance-attribute

heat_recovery = element(tag='HeatRecovery', default=None) class-attribute instance-attribute

recirculation = element(tag='Recirculation', default=None) class-attribute instance-attribute

hot_water_heat_exchanger = element(tag='HotWaterHeatExchanger', default=None) class-attribute instance-attribute

image_rectangle = element(tag='ImageRectangle', default=None) class-attribute instance-attribute

connecting_plant_loop_handle = element(tag='ConnectingPlantLoopHandle', default_factory=list) class-attribute instance-attribute

connectingAirLoopHandle = element(tag='ConnectingAirLoopHandle', default=(-1)) class-attribute instance-attribute

loopType = element(tag='LoopType', default=0) class-attribute instance-attribute

subLoopType = element(tag='SubLoopType', default=0) class-attribute instance-attribute

plantLoopType = element(tag='PlantLoopType', default=0) class-attribute instance-attribute

airLoopDuctType = element(tag='AirLoopDuctType', default=0) class-attribute instance-attribute

componentType = element(tag='ComponentType', default=0) class-attribute instance-attribute

location = element(tag='Location', default=0) class-attribute instance-attribute

connectionOffset = element(tag='ConnectionOffset', default=0.0) class-attribute instance-attribute

editable = element(tag='Editable', default=0) class-attribute instance-attribute

zoneBranchFlag = element(tag='ZoneBranchFlag', default=0) class-attribute instance-attribute

orientation = element(tag='Orientation', default=0) class-attribute instance-attribute

waterInConnectionOrientation = element(tag='WaterInConnectionOrientation', default=0) class-attribute instance-attribute

waterOutConnectionOrientation = element(tag='WaterOutConnectionOrientation', default=0) class-attribute instance-attribute

airInConnectionOrientation = element(tag='AirInConnectionOrientation', default=0) class-attribute instance-attribute

airOutConnectionOrientation = element(tag='AirOutConnectionOrientation', default=0) class-attribute instance-attribute

waterInConnection = element(tag='WaterInConnection', default=0) class-attribute instance-attribute

waterOutConnection = element(tag='WaterOutConnection', default=0) class-attribute instance-attribute

airInConnection = element(tag='AirInConnection', default=0) class-attribute instance-attribute

airOutConnection = element(tag='AirOutConnection', default=0) class-attribute instance-attribute

waterInConnected = element(tag='WaterInConnected', default=0) class-attribute instance-attribute

waterOutConnected = element(tag='WaterOutConnected', default=0) class-attribute instance-attribute

airInConnected = element(tag='AirInConnected', default=0) class-attribute instance-attribute

airOutConnected = element(tag='AirOutConnected', default=0) class-attribute instance-attribute

fanPlacement = element(tag='FanPlacement', default=0) class-attribute instance-attribute

water_in_connection_coordinate = element(tag='WaterInConnectionCoordinate', default=None) class-attribute instance-attribute

water_out_connection_coordinate = element(tag='WaterOutConnectionCoordinate', default=None) class-attribute instance-attribute

air_in_connection_coordinate = element(tag='AirInConnectionCoordinate', default=None) class-attribute instance-attribute

air_out_connection_coordinate = element(tag='AirOutConnectionCoordinate', default=None) class-attribute instance-attribute

attributes = element(tag='Attributes', default=None) class-attribute instance-attribute

zone_component_attribute_list = element(tag='ZoneComponentAttributeList', default=None) class-attribute instance-attribute

refrigerant_connected = element(tag='RefrigerantConnected', default=None) class-attribute instance-attribute

valid_zone_group = element(tag='ValidZoneGroup', default=None) class-attribute instance-attribute

width = element(tag='Width', default=None) class-attribute instance-attribute

height = element(tag='Height', default=None) class-attribute instance-attribute

loop_flow_direction = element(tag='LoopFlowDirection', default=None) class-attribute instance-attribute

number_of_flow_connections = element(tag='NumberOfFlowConnections', default=None) class-attribute instance-attribute

flow_connections = element(tag='FlowConnections', default=None) class-attribute instance-attribute

hvac_sub_loop_node_connection = element(tag='HVACSubLoopNodeConnection', default=None) class-attribute instance-attribute

origin = element(tag='Origin', default=None) class-attribute instance-attribute

control_point = element(tag='ControlPoint', default=None) class-attribute instance-attribute

upstream_node = element(tag='UpStreamNode', default=None) class-attribute instance-attribute

downstream_node = element(tag='DownStreamNode', default=None) class-attribute instance-attribute

segment_list = element(tag='SegmentList', default=None) class-attribute instance-attribute

water_equipment_list = element(tag='WaterEquipmentList', default=None) class-attribute instance-attribute

hvac_connector_node = element(tag='HVACConnectorNode', default=None) class-attribute instance-attribute

branch_connection_list = element(tag='BranchConnectionList', default=None) class-attribute instance-attribute

dx_heating_coil = element(tag='DXHeatingCoil', default=None) class-attribute instance-attribute

refrigerant_connection_coordinate = element(tag='RefrigerantConnectionCoordinate', default=None) class-attribute instance-attribute

building_zone_handle_list = element(tag='BuildingZoneHandleList', default=None) class-attribute instance-attribute

dx_cooling_coil = element(tag='DXCoolingCoil', default=None) class-attribute instance-attribute

water_cooled_condenser = element(tag='WaterCooledCondenser', default=None) class-attribute instance-attribute

zone_element_list = element(tag='ZoneElementList', default=None) class-attribute instance-attribute

zone_group_attributes = element(tag='ZoneGroupAttributes', default=None) class-attribute instance-attribute

mixing_box_width = element(tag='MixingBoxWidth', default=None) class-attribute instance-attribute

fan_type = element(tag='FanType', default=None) class-attribute instance-attribute

doas_air_in_connected = element(tag='DOASAirInConnected', default=None) class-attribute instance-attribute

doas_air_out_connected = element(tag='DOASAirOutConnected', default=None) class-attribute instance-attribute

outdoor_air_system = element(tag='OutdoorAirSystem', default=None) class-attribute instance-attribute

intake_damper = element(tag='IntakeDamper', default=None) class-attribute instance-attribute

exhaust_damper = element(tag='ExhaustDamper', default=None) class-attribute instance-attribute

doas_intake_damper = element(tag='DOASIntakeDamper', default=None) class-attribute instance-attribute

doas_exhaust_damper = element(tag='DOASExhaustDamper', default=None) class-attribute instance-attribute

mixing_damper = element(tag='MixingDamper', default=None) class-attribute instance-attribute

exhaust_unit_component_list = element(tag='ExhaustUnitComponentList', default=None) class-attribute instance-attribute

intake_unit_component_list = element(tag='IntakeUnitComponentList', default=None) class-attribute instance-attribute

line_array = element(tag='LineArray', default=None) class-attribute instance-attribute

chiller_hr_heat_exchanger = element(tag='ChillerHRHeatExchanger', default=None) class-attribute instance-attribute

absorption_chiller_unit = element(tag='AbsorptionChillerUnit', default=None) class-attribute instance-attribute

absorption_chiller_generator_heat_exchanger = element(tag='AbsorptionChillerGeneratorHeatExchanger', default=None) class-attribute instance-attribute

has_reheat_coil = element(tag='HasReheatCoil', default=None) class-attribute instance-attribute

reheat_coil = element(tag='ReheatCoil', default=None) class-attribute instance-attribute

heater_element = element(tag='HeaterElement', default=None) class-attribute instance-attribute

heat_pump_condenser = element(tag='HeatPumpCondenser', default=None) class-attribute instance-attribute

heat_exchanger_element = element(tag='HeatExchangerElement', default=None) class-attribute instance-attribute

chilled_water_storage_heat_exchanger = element(tag='ChilledWaterStorageHeatExchanger', default=None) class-attribute instance-attribute

water_heater = element(tag='WaterHeater', default=None) class-attribute instance-attribute

water_heater_y_offset = element(tag='WaterHeaterYOffset', default=None) class-attribute instance-attribute

supply_fan = element(tag='SupplyFan', default=None) class-attribute instance-attribute

supply_fan_x_offset = element(tag='SupplyFanXOffset', default=None) class-attribute instance-attribute

supply_fan_y_offset = element(tag='SupplyFanYOffset', default=None) class-attribute instance-attribute

air_to_water_heat_pump_coil = element(tag='AirToWaterHeatPumpCoil', default=None) class-attribute instance-attribute

air_to_water_heat_pump_coil_x_offset = element(tag='AirToWaterHeatPumpCoilXOffset', default=None) class-attribute instance-attribute

air_to_water_heat_pump_coil_y_offset = element(tag='AirToWaterHeatPumpCoilYOffset', default=None) class-attribute instance-attribute

air_to_water_hp_coil_connections = element(tag='AirToWaterHPCoilConnections', default=None) class-attribute instance-attribute

supply_diffuser = element(tag='SupplyDiffuser', default=None) class-attribute instance-attribute

extract_grille = element(tag='ExtractGrille', default=None) class-attribute instance-attribute

intake_louvre = element(tag='IntakeLouvre', default=None) class-attribute instance-attribute

mixing_box = element(tag='MixingBox', default=None) class-attribute instance-attribute

cooled_beam = element(tag='CooledBeam', default=None) class-attribute instance-attribute

unit_element_list = element(tag='UnitElementList', default=None) class-attribute instance-attribute

supply_louvre = element(tag='SupplyLouvre', default=None) class-attribute instance-attribute

dual_duct_mixing_box = element(tag='DualDuctMixingBox', default=None) class-attribute instance-attribute

outdoor_air_supply = element(tag='OutdoorAirSupply', default=None) class-attribute instance-attribute

warm_air_in_connected = element(tag='WarmAirInConnected', default=None) class-attribute instance-attribute

cold_air_in_connected = element(tag='ColdAirInConnected', default=None) class-attribute instance-attribute

has_heating_element = element(tag='HasHeatingElement', default=None) class-attribute instance-attribute

heating_element = element(tag='HeatingElement', default=None) class-attribute instance-attribute

has_cooling_element = element(tag='HasCoolingElement', default=None) class-attribute instance-attribute

cooling_element = element(tag='CoolingElement', default=None) class-attribute instance-attribute

HVACComponent

Bases: NoTypeHVACComponent

Source code in dsbxml\hvac\components.py
250
251
class HVACComponent(NoTypeHVACComponent):
    pass

SubLoopNode

Bases: NoTypeHVACComponent

Source code in dsbxml\hvac\components.py
254
255
class SubLoopNode(NoTypeHVACComponent):
    type: Literal["Sub-loop node"] = attr(default="Sub-loop node")

type = attr(default='Sub-loop node') class-attribute instance-attribute

ZoneMixer

Bases: NoTypeHVACComponent

Source code in dsbxml\hvac\components.py
258
259
class ZoneMixer(NoTypeHVACComponent):
    type: Literal["Zone mixer"] = attr(default="Zone mixer")

type = attr(default='Zone mixer') class-attribute instance-attribute

ZoneSplitter

Bases: NoTypeHVACComponent

Source code in dsbxml\hvac\components.py
262
263
class ZoneSplitter(NoTypeHVACComponent):
    type: Literal["Zone splitter"] = attr(default="Zone splitter")

type = attr(default='Zone splitter') class-attribute instance-attribute

Splitter

Bases: NoTypeHVACComponent

Source code in dsbxml\hvac\components.py
266
267
class Splitter(NoTypeHVACComponent):
    type: Literal["Splitter"] = attr(default="Splitter")

type = attr(default='Splitter') class-attribute instance-attribute

Mixer

Bases: NoTypeHVACComponent

Source code in dsbxml\hvac\components.py
270
271
class Mixer(NoTypeHVACComponent):
    type: Literal["Mixer"] = attr(default="Mixer")

type = attr(default='Mixer') class-attribute instance-attribute

SetpointManager

Bases: NoTypeHVACComponent

Source code in dsbxml\hvac\components.py
274
275
class SetpointManager(NoTypeHVACComponent):
    type: Literal["Setpoint manager"] = attr(default="Setpoint manager")

type = attr(default='Setpoint manager') class-attribute instance-attribute

AirHandlingUnit

Bases: NoTypeHVACComponent

Source code in dsbxml\hvac\components.py
278
279
class AirHandlingUnit(NoTypeHVACComponent):
    type: Literal["Air handling unit"] = attr(default="Air handling unit")

type = attr(default='Air handling unit') class-attribute instance-attribute

Pump

Bases: NoTypeHVACComponent

Source code in dsbxml\hvac\components.py
282
283
class Pump(NoTypeHVACComponent):
    type: Literal["Pump"] = attr(default="Pump")

type = attr(default='Pump') class-attribute instance-attribute

Boiler

Bases: NoTypeHVACComponent

Source code in dsbxml\hvac\components.py
286
287
class Boiler(NoTypeHVACComponent):
    type: Literal["Boiler"] = attr(default="Boiler")

type = attr(default='Boiler') class-attribute instance-attribute

CoolingTower

Bases: NoTypeHVACComponent

Source code in dsbxml\hvac\components.py
290
291
class CoolingTower(NoTypeHVACComponent):
    type: Literal["Cooling tower"] = attr(default="Cooling tower")

type = attr(default='Cooling tower') class-attribute instance-attribute

Chiller

Bases: NoTypeHVACComponent

Source code in dsbxml\hvac\components.py
294
295
class Chiller(NoTypeHVACComponent):
    type: Literal["Chiller"] = attr(default="Chiller")

type = attr(default='Chiller') class-attribute instance-attribute

WaterCooledCondenser

Bases: NoTypeHVACComponent

Source code in dsbxml\hvac\components.py
298
299
class WaterCooledCondenser(NoTypeHVACComponent):
    pass

ChillerHRHeatExchanger

Bases: NoTypeHVACComponent

Source code in dsbxml\hvac\components.py
302
303
class ChillerHRHeatExchanger(NoTypeHVACComponent):
    pass

AbsorptionChillerUnit

Bases: NoTypeHVACComponent

Source code in dsbxml\hvac\components.py
306
307
class AbsorptionChillerUnit(NoTypeHVACComponent):
    pass

AbsorptionChillerGeneratorHeatExchanger

Bases: NoTypeHVACComponent

Source code in dsbxml\hvac\components.py
310
311
class AbsorptionChillerGeneratorHeatExchanger(NoTypeHVACComponent):
    pass

OutdoorAirSystem

Bases: NoTypeHVACComponent

Source code in dsbxml\hvac\components.py
314
315
316
317
318
319
320
321
322
class OutdoorAirSystem(NoTypeHVACComponent):
    heat_recovery: int = element(tag="HeatRecovery", default=0)
    recirculation: int = element(tag="Recirculation", default=0)
    heat_recovery_device: HeatRecoveryDevice | None = element(
        tag="HeatRecoveryDevice", default=None
    )
    component_list: OutdoorAirSystemComponentList | None = element(
        tag="OutdoorAirSystemComponentList", default=None
    )

heat_recovery = element(tag='HeatRecovery', default=0) class-attribute instance-attribute

recirculation = element(tag='Recirculation', default=0) class-attribute instance-attribute

heat_recovery_device = element(tag='HeatRecoveryDevice', default=None) class-attribute instance-attribute

component_list = element(tag='OutdoorAirSystemComponentList', default=None) class-attribute instance-attribute

IntakeDamper

Bases: NoTypeHVACComponent

Source code in dsbxml\hvac\components.py
325
326
class IntakeDamper(NoTypeHVACComponent):
    pass

ExhaustDamper

Bases: NoTypeHVACComponent

Source code in dsbxml\hvac\components.py
329
330
class ExhaustDamper(NoTypeHVACComponent):
    pass

DOASIntakeDamper

Bases: NoTypeHVACComponent

Source code in dsbxml\hvac\components.py
333
334
class DOASIntakeDamper(NoTypeHVACComponent):
    pass

DOASExhaustDamper

Bases: NoTypeHVACComponent

Source code in dsbxml\hvac\components.py
337
338
class DOASExhaustDamper(NoTypeHVACComponent):
    pass

MixingDamper

Bases: NoTypeHVACComponent

Source code in dsbxml\hvac\components.py
341
342
class MixingDamper(NoTypeHVACComponent):
    pass

HeatRecoveryDevice

Bases: NoTypeHVACComponent

Source code in dsbxml\hvac\components.py
345
346
class HeatRecoveryDevice(NoTypeHVACComponent):
    pass

OutdoorAirSystemHVACComponent

Bases: HVACComponent

Source code in dsbxml\hvac\components.py
349
350
class OutdoorAirSystemHVACComponent(HVACComponent):
    pass

OutdoorAirSystemComponentList

Bases: BaseModel

Source code in dsbxml\hvac\components.py
353
354
355
356
class OutdoorAirSystemComponentList(BaseModel):
    outdoor_air_system_hvac_component: list[OutdoorAirSystemHVACComponent] = element(
        tag="OutdoorAirSystemHVACComponent", default_factory=list
    )

outdoor_air_system_hvac_component = element(tag='OutdoorAirSystemHVACComponent', default_factory=list) class-attribute instance-attribute

UnitaryDXCoolingCoil

Bases: NoTypeHVACComponent

The DX coil inside a "Unitary cooling coil" (tag DXCoolingCoil).

Source code in dsbxml\hvac\components.py
361
362
class UnitaryDXCoolingCoil(NoTypeHVACComponent):
    """The DX coil inside a "Unitary cooling coil" (tag ``DXCoolingCoil``)."""

UnitaryDXHeatingCoil

Bases: NoTypeHVACComponent

The DX coil inside a "Unitary heating coil" (tag DXHeatingCoil).

Source code in dsbxml\hvac\components.py
365
366
class UnitaryDXHeatingCoil(NoTypeHVACComponent):
    """The DX coil inside a "Unitary heating coil" (tag ``DXHeatingCoil``)."""

ReheatCoil

Bases: NoTypeHVACComponent

Source code in dsbxml\hvac\components.py
369
370
class ReheatCoil(NoTypeHVACComponent):
    pass

WaterHeaterElement

Bases: NoTypeHVACComponent

The heater element of a water heater (tag HeaterElement).

Source code in dsbxml\hvac\components.py
373
374
class WaterHeaterElement(NoTypeHVACComponent):
    """The heater element of a water heater (tag ``HeaterElement``)."""

HeatPumpCondenser

Bases: NoTypeHVACComponent

Source code in dsbxml\hvac\components.py
377
378
class HeatPumpCondenser(NoTypeHVACComponent):
    pass

HeatExchangerElement

Bases: NoTypeHVACComponent

Source code in dsbxml\hvac\components.py
381
382
class HeatExchangerElement(NoTypeHVACComponent):
    pass

ChilledWaterStorageHeatExchanger

Bases: NoTypeHVACComponent

Source code in dsbxml\hvac\components.py
385
386
class ChilledWaterStorageHeatExchanger(NoTypeHVACComponent):
    pass

RadiantHeatingElement

Bases: NoTypeHVACComponent

Heating element of a zone radiant surface (tag HeatingElement).

Source code in dsbxml\hvac\components.py
389
390
class RadiantHeatingElement(NoTypeHVACComponent):
    """Heating element of a zone radiant surface (tag ``HeatingElement``)."""

RadiantCoolingElement

Bases: NoTypeHVACComponent

Cooling element of a zone radiant surface (tag CoolingElement).

Source code in dsbxml\hvac\components.py
393
394
class RadiantCoolingElement(NoTypeHVACComponent):
    """Cooling element of a zone radiant surface (tag ``CoolingElement``)."""

DualDuctMixingBox

Bases: NoTypeHVACComponent

Source code in dsbxml\hvac\components.py
397
398
class DualDuctMixingBox(NoTypeHVACComponent):
    pass

SupplyLouvre

Bases: NoTypeHVACComponent

Source code in dsbxml\hvac\components.py
401
402
class SupplyLouvre(NoTypeHVACComponent):
    pass

HeatPumpWaterHeaterTank

Bases: NoTypeHVACComponent

The water heater inside a "Water heater heat pump" (tag WaterHeater).

Source code in dsbxml\hvac\components.py
405
406
class HeatPumpWaterHeaterTank(NoTypeHVACComponent):
    """The water heater inside a "Water heater heat pump" (tag ``WaterHeater``)."""

HeatPumpWaterHeaterFan

Bases: NoTypeHVACComponent

The supply fan inside a "Water heater heat pump" (tag SupplyFan).

Source code in dsbxml\hvac\components.py
409
410
class HeatPumpWaterHeaterFan(NoTypeHVACComponent):
    """The supply fan inside a "Water heater heat pump" (tag ``SupplyFan``)."""

AirToWaterHeatPumpCoil

Bases: NoTypeHVACComponent

Source code in dsbxml\hvac\components.py
413
414
class AirToWaterHeatPumpCoil(NoTypeHVACComponent):
    pass

AirToWaterHPCoilConnections

Bases: BaseModel

Source code in dsbxml\hvac\components.py
417
418
class AirToWaterHPCoilConnections(BaseModel):
    line_array: LineArray | None = element(tag="LineArray", default=None)

line_array = element(tag='LineArray', default=None) class-attribute instance-attribute

WaterEquipmentList

Bases: BaseModel

Source code in dsbxml\hvac\components.py
421
422
class WaterEquipmentList(BaseModel):
    hvac_component: list[HVACComponent] = element(tag="HVACComponent", default_factory=list)

hvac_component = element(tag='HVACComponent', default_factory=list) class-attribute instance-attribute

VRFAirConditionerUnit

Bases: NoTypeHVACComponent

Source code in dsbxml\hvac\components.py
425
426
class VRFAirConditionerUnit(NoTypeHVACComponent):
    pass

AirHandlingUnitHVACComponent

Bases: HVACComponent

Source code in dsbxml\hvac\components.py
429
430
class AirHandlingUnitHVACComponent(HVACComponent):
    pass

Generator

Bases: NoTypeHVACComponent

Source code in dsbxml\hvac\components.py
433
434
class Generator(NoTypeHVACComponent):
    type: Literal["Generator"] = attr(default="Generator")

type = attr(default='Generator') class-attribute instance-attribute

HeatPumpHeating

Bases: NoTypeHVACComponent

Source code in dsbxml\hvac\components.py
437
438
class HeatPumpHeating(NoTypeHVACComponent):
    type: Literal["Heat pump heating"] = attr(default="Heat pump heating")

type = attr(default='Heat pump heating') class-attribute instance-attribute

HeatPumpCooling

Bases: NoTypeHVACComponent

Source code in dsbxml\hvac\components.py
441
442
class HeatPumpCooling(NoTypeHVACComponent):
    type: Literal["Heat pump cooling"] = attr(default="Heat pump cooling")

type = attr(default='Heat pump cooling') class-attribute instance-attribute

FluidCooler

Bases: NoTypeHVACComponent

Source code in dsbxml\hvac\components.py
445
446
class FluidCooler(NoTypeHVACComponent):
    type: Literal["Fluid cooler"] = attr(default="Fluid cooler")

type = attr(default='Fluid cooler') class-attribute instance-attribute

ChilledWaterStorage

Bases: NoTypeHVACComponent

Source code in dsbxml\hvac\components.py
449
450
class ChilledWaterStorage(NoTypeHVACComponent):
    type: Literal["Chilled water storage"] = attr(default="Chilled water storage")

type = attr(default='Chilled water storage') class-attribute instance-attribute

IceThermalStorage

Bases: NoTypeHVACComponent

Source code in dsbxml\hvac\components.py
453
454
class IceThermalStorage(NoTypeHVACComponent):
    type: Literal["Ice thermal storage"] = attr(default="Ice thermal storage")

type = attr(default='Ice thermal storage') class-attribute instance-attribute

WaterHeater

Bases: NoTypeHVACComponent

Source code in dsbxml\hvac\components.py
457
458
class WaterHeater(NoTypeHVACComponent):
    type: Literal["Water heater"] = attr(default="Water heater")

type = attr(default='Water heater') class-attribute instance-attribute

DomesticWaterConnections

Bases: NoTypeHVACComponent

Source code in dsbxml\hvac\components.py
461
462
class DomesticWaterConnections(NoTypeHVACComponent):
    type: Literal["Domestic water connections"] = attr(default="Domestic water connections")

type = attr(default='Domestic water connections') class-attribute instance-attribute

FluidToFluidHeatExchanger

Bases: NoTypeHVACComponent

Source code in dsbxml\hvac\components.py
465
466
467
468
class FluidToFluidHeatExchanger(NoTypeHVACComponent):
    type: Literal["Fluid-to-fluid heat exchanger"] = attr(
        default="Fluid-to-fluid heat exchanger"
    )

type = attr(default='Fluid-to-fluid heat exchanger') class-attribute instance-attribute

GroundHeatExchanger

Bases: NoTypeHVACComponent

Source code in dsbxml\hvac\components.py
471
472
class GroundHeatExchanger(NoTypeHVACComponent):
    type: Literal["Ground heat exchanger"] = attr(default="Ground heat exchanger")

type = attr(default='Ground heat exchanger') class-attribute instance-attribute

UnitarySystem

Bases: NoTypeHVACComponent

Source code in dsbxml\hvac\components.py
475
476
class UnitarySystem(NoTypeHVACComponent):
    type: Literal["Unitary system"] = attr(default="Unitary system")

type = attr(default='Unitary system') class-attribute instance-attribute

UnitaryHeatPumpAirToAir

Bases: NoTypeHVACComponent

Source code in dsbxml\hvac\components.py
479
480
class UnitaryHeatPumpAirToAir(NoTypeHVACComponent):
    type: Literal["Unitary heat pump air-to-air"] = attr(default="Unitary heat pump air-to-air")

type = attr(default='Unitary heat pump air-to-air') class-attribute instance-attribute

TemperingValve

Bases: NoTypeHVACComponent

Source code in dsbxml\hvac\components.py
483
484
class TemperingValve(NoTypeHVACComponent):
    type: Literal["Tempering valve"] = attr(default="Tempering valve")

type = attr(default='Tempering valve') class-attribute instance-attribute

SolarCollector

Bases: NoTypeHVACComponent

Source code in dsbxml\hvac\components.py
487
488
class SolarCollector(NoTypeHVACComponent):
    type: Literal["Solar collector"] = attr(default="Solar collector")

type = attr(default='Solar collector') class-attribute instance-attribute

WaterHeaterHeatPump

Bases: NoTypeHVACComponent

Source code in dsbxml\hvac\components.py
491
492
class WaterHeaterHeatPump(NoTypeHVACComponent):
    type: Literal["Water heater heat pump"] = attr(default="Water heater heat pump")

type = attr(default='Water heater heat pump') class-attribute instance-attribute

UnitaryHeatPumpWaterToAir

Bases: NoTypeHVACComponent

Source code in dsbxml\hvac\components.py
495
496
497
498
class UnitaryHeatPumpWaterToAir(NoTypeHVACComponent):
    type: Literal["Unitary heat pump water-to-air"] = attr(
        default="Unitary heat pump water-to-air"
    )

type = attr(default='Unitary heat pump water-to-air') class-attribute instance-attribute

WaterCoolingCoil

Bases: NoTypeHVACComponent

Source code in dsbxml\hvac\components.py
501
502
class WaterCoolingCoil(NoTypeHVACComponent):
    type: Literal["Water cooling coil"] = attr(default="Water cooling coil")

type = attr(default='Water cooling coil') class-attribute instance-attribute

GenericHeatingCoil

Bases: NoTypeHVACComponent

Source code in dsbxml\hvac\components.py
505
506
class GenericHeatingCoil(NoTypeHVACComponent):
    type: Literal["Generic heating coil"] = attr(default="Generic heating coil")

type = attr(default='Generic heating coil') class-attribute instance-attribute

HVACComponents

Bases: BaseModel

Source code in dsbxml\hvac\components.py
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
class HVACComponents(BaseModel):
    hvac_component: list[HVACComponent] = element(tag="HVACComponent", default_factory=list)

    @field_validator("hvac_component", mode="before")
    @classmethod
    def recast_components(cls, components):
        if not isinstance(components, list):
            components = [components]
        result = []
        for component in components:
            if isinstance(component, dict):
                comp_type = component.get("type", "")
                result.append(HVAC_COMPONENT_MAPPING.get(comp_type, HVACComponent)(**component))
            else:
                result.append(component)
        return result

hvac_component = element(tag='HVACComponent', default_factory=list) class-attribute instance-attribute

recast_components(components) classmethod

Source code in dsbxml\hvac\components.py
545
546
547
548
549
550
551
552
553
554
555
556
557
@field_validator("hvac_component", mode="before")
@classmethod
def recast_components(cls, components):
    if not isinstance(components, list):
        components = [components]
    result = []
    for component in components:
        if isinstance(component, dict):
            comp_type = component.get("type", "")
            result.append(HVAC_COMPONENT_MAPPING.get(comp_type, HVACComponent)(**component))
        else:
            result.append(component)
    return result

Air handling unit components

UNIT_COMPONENT_MAPPING = {'Supply fan': SupplyFan, 'Zone ADU louvre': ZoneADULouvre, 'Zone ADU PIU intake louvre': ZoneADUPIUIntakeLouvre, 'Water cooling coil': WaterCoolingCoil, 'Generic heating coil': GenericHeatingCoil, 'DX cooling coil': DXCoolingCoil, 'DX heating coil': DXHeatingCoil, 'Variable refrigerant flow cooling DX coil': VariableRefrigerantFlowCoolingDXCoil, 'Variable refrigerant flow heating DX coil': VariableRefrigerantFlowHeatingDXCoil, 'Water-to-air heat pump cooling coil': WaterToAirHeatPumpCoolingCoil, 'Water-to-air heat pump heating coil': WaterToAirHeatPumpHeatingCoil} module-attribute

UnitElementList

Bases: BaseModel

Source code in dsbxml\hvac\unit_components.py
16
17
class UnitElementList(BaseModel):
    hvac_component: list[HVACComponent] = element(tag="HVACComponent", default_factory=list)

hvac_component = element(tag='HVACComponent', default_factory=list) class-attribute instance-attribute

SupplyFan

Bases: NoTypeHVACComponent

Source code in dsbxml\hvac\unit_components.py
20
21
class SupplyFan(NoTypeHVACComponent):
    type: Literal["Supply fan"] = attr()

type = attr() class-attribute instance-attribute

ZoneADULouvre

Bases: NoTypeHVACComponent

Source code in dsbxml\hvac\unit_components.py
24
25
class ZoneADULouvre(NoTypeHVACComponent):
    type: Literal["Zone ADU louvre"] = attr()

type = attr() class-attribute instance-attribute

ZoneADUPIUIntakeLouvre

Bases: NoTypeHVACComponent

Source code in dsbxml\hvac\unit_components.py
28
29
class ZoneADUPIUIntakeLouvre(NoTypeHVACComponent):
    type: Literal["Zone ADU PIU intake louvre"] = attr()

type = attr() class-attribute instance-attribute

VariableRefrigerantFlowCoolingDXCoil

Bases: NoTypeHVACComponent

Source code in dsbxml\hvac\unit_components.py
32
33
class VariableRefrigerantFlowCoolingDXCoil(NoTypeHVACComponent):
    type: Literal["Variable refrigerant flow cooling DX coil"] = attr()

type = attr() class-attribute instance-attribute

VariableRefrigerantFlowHeatingDXCoil

Bases: NoTypeHVACComponent

Source code in dsbxml\hvac\unit_components.py
36
37
class VariableRefrigerantFlowHeatingDXCoil(NoTypeHVACComponent):
    type: Literal["Variable refrigerant flow heating DX coil"] = attr()

type = attr() class-attribute instance-attribute

DXCoolingCoil

Bases: NoTypeHVACComponent

Source code in dsbxml\hvac\unit_components.py
40
41
class DXCoolingCoil(NoTypeHVACComponent):
    type: Literal["DX cooling coil"] = attr()

type = attr() class-attribute instance-attribute

DXHeatingCoil

Bases: NoTypeHVACComponent

Source code in dsbxml\hvac\unit_components.py
44
45
class DXHeatingCoil(NoTypeHVACComponent):
    type: Literal["DX heating coil"] = attr()

type = attr() class-attribute instance-attribute

WaterToAirHeatPumpCoolingCoil

Bases: NoTypeHVACComponent

Source code in dsbxml\hvac\unit_components.py
48
49
class WaterToAirHeatPumpCoolingCoil(NoTypeHVACComponent):
    type: Literal["Water-to-air heat pump cooling coil"] = attr()

type = attr() class-attribute instance-attribute

WaterToAirHeatPumpHeatingCoil

Bases: NoTypeHVACComponent

Source code in dsbxml\hvac\unit_components.py
52
53
class WaterToAirHeatPumpHeatingCoil(NoTypeHVACComponent):
    type: Literal["Water-to-air heat pump heating coil"] = attr()

type = attr() class-attribute instance-attribute

Zone components

ZONE_COMPONENT_MAPPING = {'Zone ADU single duct CAV no reheat': ZoneADUSingleDuctCAVNoReheat, 'Zone ADU single duct VAV reheat': ZoneADUSingleDuctVAVReheat, 'Zone ADU single duct VAV no reheat': ZoneADUSingleDuctVAVNoReheat, 'Zone ADU parallel PIU': ZoneADUParallelPIU, 'Zone ADU cooled beam': ZoneADUCooledBeam, 'Zone ADU four-pipe induction': ZoneADUFourPipeInduction, 'Zone ADU dual duct VAV': ZoneADUDualDuctVAV, 'Zone ADU series PIU': ZoneADUSeriesPIU, 'Zone extract': ZoneExtract, 'Zone fan-coil unit': ZoneFanCoilUnit, 'Zone terminal packaged heat pump': ZoneTerminalPackagedHeatPump, 'Zone water-to-air heat pump': ZoneWaterToAirHeatPump, 'Zone variable refrigerant flow unit': ZoneVariableRefrigerantFlowUnit, 'Zone high temperature radiant heating': ZoneHighTemperatureRadiantHeating, 'Zone heated floor': ZoneHeatedFloor, 'Zone chilled ceiling': ZoneChilledCeiling, 'Zone radiant surface': ZoneRadiantSurface, 'Zone convective electric baseboard': ZoneConvectiveElectricBaseboard, 'Zone convective water baseboard': ZoneConvectiveWaterBaseboard, 'Zone radiative convective electric baseboard': ZoneRadiativeConvectiveElectricBaseboard, 'Zone radiative convective water baseboard': ZoneRadiativeConvectiveWaterBaseboard} module-attribute

ZoneElementList

Bases: BaseModel

Source code in dsbxml\hvac\zone_components.py
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
class ZoneElementList(BaseModel):
    hvac_zone_component: list[HVACComponent] = element(
        tag="HVACZoneComponent", default_factory=list
    )

    @field_validator("hvac_zone_component", mode="before")
    @classmethod
    def recast_components(cls, components) -> list:
        if not isinstance(components, list):
            components = [components]
        result = []
        for component in components:
            if isinstance(component, dict):
                comp_type = component.get("type", "")
                result.append(ZONE_COMPONENT_MAPPING.get(comp_type, HVACComponent)(**component))
            else:
                result.append(component)
        return result

hvac_zone_component = element(tag='HVACZoneComponent', default_factory=list) class-attribute instance-attribute

recast_components(components) classmethod

Source code in dsbxml\hvac\zone_components.py
17
18
19
20
21
22
23
24
25
26
27
28
29
@field_validator("hvac_zone_component", mode="before")
@classmethod
def recast_components(cls, components) -> list:
    if not isinstance(components, list):
        components = [components]
    result = []
    for component in components:
        if isinstance(component, dict):
            comp_type = component.get("type", "")
            result.append(ZONE_COMPONENT_MAPPING.get(comp_type, HVACComponent)(**component))
        else:
            result.append(component)
    return result

ExtractGrille

Bases: NoTypeHVACComponent

Source code in dsbxml\hvac\zone_components.py
33
34
class ExtractGrille(NoTypeHVACComponent):
    pass

SupplyDiffuser

Bases: NoTypeHVACComponent

Source code in dsbxml\hvac\zone_components.py
37
38
class SupplyDiffuser(NoTypeHVACComponent):
    pass

IntakeLouvre

Bases: NoTypeHVACComponent

Source code in dsbxml\hvac\zone_components.py
41
42
class IntakeLouvre(NoTypeHVACComponent):
    pass

MixingBox

Bases: NoTypeHVACComponent

Source code in dsbxml\hvac\zone_components.py
45
46
class MixingBox(NoTypeHVACComponent):
    pass

CooledBeam

Bases: NoTypeHVACComponent

Source code in dsbxml\hvac\zone_components.py
49
50
class CooledBeam(NoTypeHVACComponent):
    pass

ZoneExtract

Bases: NoTypeHVACComponent

Source code in dsbxml\hvac\zone_components.py
55
56
class ZoneExtract(NoTypeHVACComponent):
    type: Literal["Zone extract"] = attr(default="Zone extract")

type = attr(default='Zone extract') class-attribute instance-attribute

ADU

Bases: NoTypeHVACComponent

Source code in dsbxml\hvac\zone_components.py
59
60
class ADU(NoTypeHVACComponent):
    pass

ZoneADUSingleDuctCAVNoReheat

Bases: ADU

Source code in dsbxml\hvac\zone_components.py
63
64
65
66
class ZoneADUSingleDuctCAVNoReheat(ADU):
    type: Literal["Zone ADU single duct CAV no reheat"] = attr(
        default="Zone ADU single duct CAV no reheat"
    )

type = attr(default='Zone ADU single duct CAV no reheat') class-attribute instance-attribute

ZoneADUSingleDuctVAVReheat

Bases: ADU

Source code in dsbxml\hvac\zone_components.py
69
70
71
72
class ZoneADUSingleDuctVAVReheat(ADU):
    type: Literal["Zone ADU single duct VAV reheat"] = attr(
        default="Zone ADU single duct VAV reheat"
    )

type = attr(default='Zone ADU single duct VAV reheat') class-attribute instance-attribute

ZoneADUSingleDuctVAVNoReheat

Bases: ADU

Source code in dsbxml\hvac\zone_components.py
75
76
77
78
class ZoneADUSingleDuctVAVNoReheat(ADU):
    type: Literal["Zone ADU single duct VAV no reheat"] = attr(
        default="Zone ADU single duct VAV no reheat"
    )

type = attr(default='Zone ADU single duct VAV no reheat') class-attribute instance-attribute

ZoneADUParallelPIU

Bases: ADU

Source code in dsbxml\hvac\zone_components.py
81
82
class ZoneADUParallelPIU(ADU):
    type: Literal["Zone ADU parallel PIU"] = attr(default="Zone ADU parallel PIU")

type = attr(default='Zone ADU parallel PIU') class-attribute instance-attribute

ZoneADUCooledBeam

Bases: ADU

Source code in dsbxml\hvac\zone_components.py
85
86
class ZoneADUCooledBeam(ADU):
    type: Literal["Zone ADU cooled beam"] = attr(default="Zone ADU cooled beam")

type = attr(default='Zone ADU cooled beam') class-attribute instance-attribute

ZoneADUFourPipeInduction

Bases: ADU

Source code in dsbxml\hvac\zone_components.py
89
90
class ZoneADUFourPipeInduction(ADU):
    type: Literal["Zone ADU four-pipe induction"] = attr(default="Zone ADU four-pipe induction")

type = attr(default='Zone ADU four-pipe induction') class-attribute instance-attribute

ZoneADUSeriesPIU

Bases: ADU

Source code in dsbxml\hvac\zone_components.py
93
94
class ZoneADUSeriesPIU(ADU):
    type: Literal["Zone ADU series PIU"] = attr(default="Zone ADU series PIU")

type = attr(default='Zone ADU series PIU') class-attribute instance-attribute

ZoneADUDualDuctVAV

Bases: ADU

Source code in dsbxml\hvac\zone_components.py
97
98
class ZoneADUDualDuctVAV(ADU):
    type: Literal["Zone ADU dual duct VAV"] = attr(default="Zone ADU dual duct VAV")

type = attr(default='Zone ADU dual duct VAV') class-attribute instance-attribute

ZoneUnit

Bases: NoTypeHVACComponent

Source code in dsbxml\hvac\zone_components.py
101
102
class ZoneUnit(NoTypeHVACComponent):
    pass

ZoneFanCoilUnit

Bases: ZoneUnit

Source code in dsbxml\hvac\zone_components.py
105
106
class ZoneFanCoilUnit(ZoneUnit):
    type: Literal["Zone fan-coil unit"] = attr(default="Zone fan-coil unit")

type = attr(default='Zone fan-coil unit') class-attribute instance-attribute

ZoneTerminalPackagedHeatPump

Bases: ZoneUnit

Source code in dsbxml\hvac\zone_components.py
109
110
111
112
class ZoneTerminalPackagedHeatPump(ZoneUnit):
    type: Literal["Zone terminal packaged heat pump"] = attr(
        default="Zone terminal packaged heat pump"
    )

type = attr(default='Zone terminal packaged heat pump') class-attribute instance-attribute

ZoneWaterToAirHeatPump

Bases: ZoneUnit

Source code in dsbxml\hvac\zone_components.py
115
116
class ZoneWaterToAirHeatPump(ZoneUnit):
    type: Literal["Zone water-to-air heat pump"] = attr(default="Zone water-to-air heat pump")

type = attr(default='Zone water-to-air heat pump') class-attribute instance-attribute

ZoneVariableRefrigerantFlowUnit

Bases: ZoneUnit

Source code in dsbxml\hvac\zone_components.py
119
120
121
122
class ZoneVariableRefrigerantFlowUnit(ZoneUnit):
    type: Literal["Zone variable refrigerant flow unit"] = attr(
        default="Zone variable refrigerant flow unit"
    )

type = attr(default='Zone variable refrigerant flow unit') class-attribute instance-attribute

ZoneHighTemperatureRadiantHeating

Bases: NoTypeHVACComponent

Source code in dsbxml\hvac\zone_components.py
125
126
127
128
class ZoneHighTemperatureRadiantHeating(NoTypeHVACComponent):
    type: Literal["Zone high temperature radiant heating"] = attr(
        default="Zone high temperature radiant heating"
    )

type = attr(default='Zone high temperature radiant heating') class-attribute instance-attribute

ZoneHeatedFloor

Bases: NoTypeHVACComponent

Source code in dsbxml\hvac\zone_components.py
131
132
class ZoneHeatedFloor(NoTypeHVACComponent):
    type: Literal["Zone heated floor"] = attr(default="Zone heated floor")

type = attr(default='Zone heated floor') class-attribute instance-attribute

ZoneChilledCeiling

Bases: NoTypeHVACComponent

Source code in dsbxml\hvac\zone_components.py
135
136
class ZoneChilledCeiling(NoTypeHVACComponent):
    type: Literal["Zone chilled ceiling"] = attr(default="Zone chilled ceiling")

type = attr(default='Zone chilled ceiling') class-attribute instance-attribute

ZoneRadiantSurface

Bases: NoTypeHVACComponent

Source code in dsbxml\hvac\zone_components.py
139
140
class ZoneRadiantSurface(NoTypeHVACComponent):
    type: Literal["Zone radiant surface"] = attr(default="Zone radiant surface")

type = attr(default='Zone radiant surface') class-attribute instance-attribute

ZoneConvectiveElectricBaseboard

Bases: NoTypeHVACComponent

Source code in dsbxml\hvac\zone_components.py
143
144
145
146
class ZoneConvectiveElectricBaseboard(NoTypeHVACComponent):
    type: Literal["Zone convective electric baseboard"] = attr(
        default="Zone convective electric baseboard"
    )

type = attr(default='Zone convective electric baseboard') class-attribute instance-attribute

ZoneConvectiveWaterBaseboard

Bases: NoTypeHVACComponent

Source code in dsbxml\hvac\zone_components.py
149
150
151
152
class ZoneConvectiveWaterBaseboard(NoTypeHVACComponent):
    type: Literal["Zone convective water baseboard"] = attr(
        default="Zone convective water baseboard"
    )

type = attr(default='Zone convective water baseboard') class-attribute instance-attribute

ZoneRadiativeConvectiveElectricBaseboard

Bases: NoTypeHVACComponent

Source code in dsbxml\hvac\zone_components.py
155
156
157
158
class ZoneRadiativeConvectiveElectricBaseboard(NoTypeHVACComponent):
    type: Literal["Zone radiative convective electric baseboard"] = attr(
        default="Zone radiative convective electric baseboard"
    )

type = attr(default='Zone radiative convective electric baseboard') class-attribute instance-attribute

ZoneRadiativeConvectiveWaterBaseboard

Bases: NoTypeHVACComponent

Source code in dsbxml\hvac\zone_components.py
161
162
163
164
class ZoneRadiativeConvectiveWaterBaseboard(NoTypeHVACComponent):
    type: Literal["Zone radiative convective water baseboard"] = attr(
        default="Zone radiative convective water baseboard"
    )

type = attr(default='Zone radiative convective water baseboard') class-attribute instance-attribute