Unitary Equipment¶

10 object types from idfpy.models.unitary · EnergyPlus 26.2

Object	Summary
AirLoopHVAC:Unitary:Furnace:HeatCool	Unitary system, heating and cooling with constant volume supply fan (continuous or cycling), direct expansion …
AirLoopHVAC:Unitary:Furnace:HeatOnly	Unitary system, heating-only with constant volume supply fan (continuous or cycling) and heating coil (gas, …
AirLoopHVAC:UnitaryHeatCool	Unitary system, heating and cooling with constant volume supply fan (continuous or cycling), direct expansion …
AirLoopHVAC:UnitaryHeatCool:VAVChangeoverBypass	Unitary system, heating and cooling with constant volume supply fan (continuous or cycling), direct expansion …
AirLoopHVAC:UnitaryHeatOnly	Unitary system, heating-only with constant volume supply fan (continuous or cycling) and heating coil (gas, …
AirLoopHVAC:UnitaryHeatPump:AirToAir	Unitary heat pump system, heating and cooling, single-speed with supply fan, direct expansion (DX) cooling …
AirLoopHVAC:UnitaryHeatPump:AirToAir:MultiSpeed	Unitary system, heating and cooling, multi-speed with constant volume supply fan (continuous or cycling), …
AirLoopHVAC:UnitaryHeatPump:WaterToAir	Unitary heat pump system, heating and cooling, single-speed with constant volume supply fan (continuous or …
AirLoopHVAC:UnitarySystem	AirloopHVAC:UnitarySystem is a generic HVAC system type that allows any configuration of coils and/or fan.
UnitarySystemPerformance:Multispeed	The UnitarySystemPerformance object is used to specify the air flow ratio at each operating speed.

AirLoopHVAC:Unitary:Furnace:HeatCool¶

from idfpy.models import AirLoopHVACUnitaryFurnaceHeatCool

Unitary system, heating and cooling with constant volume supply fan (continuous or cycling), direct expansion (DX) cooling coil, heating coil (gas, electric, hot water, or steam), and optional reheat coil for dehumidification control. Identical to AirLoopHVAC:UnitaryHeatCool.

Field	Type	Default	Details
`name` Name required	string
`availability_schedule_name` Availability Schedule Name	reference		Availability schedule name for this system. Schedule value > 0 means the system is available. If this field is blank, the system is always available. A schedule value greater than zero (usually 1 is used) indicates that the unit is available to operate as needed. A value less than or equal to zero (usually zero is used) denotes that the unit must be off. Names a ExternalInterface:FunctionalMockupUnitExport:To:Schedule, ExternalInterface:FunctionalMockupUnitImport:To:Schedule, ExternalInterface:Schedule, Schedule:Compact, Schedule:Constant, Schedule:File, Schedule:Year, Schedule:Year:Rules
`furnace_air_inlet_node_name` Furnace Air Inlet Node Name required	string
`furnace_air_outlet_node_name` Furnace Air Outlet Node Name required	string
`supply_air_fan_operating_mode_schedule_name` Supply Air Fan Operating Mode Schedule Name	reference		A fan operating mode schedule value of 0 indicates cycling fan mode (supply air fan cycles on and off in tandem with the cooling or heating coil). Any other schedule value indicates continuous fan mode (supply air fan operates continuously regardless of cooling or heating coil operation). Provide a schedule with non-zero values when high humidity control is specified. Leaving this schedule name blank will default to cycling fan mode for the entire simulation period. Names a ExternalInterface:FunctionalMockupUnitExport:To:Schedule, ExternalInterface:FunctionalMockupUnitImport:To:Schedule, ExternalInterface:Schedule, Schedule:Compact, Schedule:Constant, Schedule:File, Schedule:Year, Schedule:Year:Rules
`maximum_supply_air_temperature` Maximum Supply Air Temperature	number or `Autosize` C	`80.0`
`cooling_supply_air_flow_rate` Cooling Supply Air Flow Rate required	number or `Autosize` m3/s		Must be less than or equal to the fan's maximum flow rate.
`heating_supply_air_flow_rate` Heating Supply Air Flow Rate required	number or `Autosize` m3/s		Must be less than or equal to the fan's maximum flow fate.
`no_load_supply_air_flow_rate` No Load Supply Air Flow Rate	number or `Autosize` m3/s		Must be less than or equal to the fan's maximum flow rate. Only used when fan operating mode is continuous (disregarded for cycling fan mode). This air flow rate is used when no heating or cooling is required (i.e., the DX coil compressor and heating coil are off). If this field is left blank or zero, the supply air flow rate from the previous on cycle (either cooling or heating) is used.
`controlling_zone_or_thermostat_location` Controlling Zone or Thermostat Location required	reference		Names a Zone
`supply_fan_object_type` Supply Fan Object Type required	choice		Fan:ConstantVolume only works with continuous fan operating mode (i.e. supply air fan operating mode schedule values not equal to 0). One of `Fan:ConstantVolume`, `Fan:OnOff`
`supply_fan_name` Supply Fan Name required	reference		Names a Fan:ConstantVolume, Fan:OnOff
`fan_placement` Fan Placement	choice	`BlowThrough`	One of `BlowThrough`, `DrawThrough`
`heating_coil_object_type` Heating Coil Object Type required	choice		works with gas, electric, hot water and steam heating coils One of `Coil:Heating:Electric`, `Coil:Heating:Fuel`, `Coil:Heating:Steam`, `Coil:Heating:Water`
`heating_coil_name` Heating Coil Name required	reference		Names a Coil:Heating:Electric, Coil:Heating:Fuel, Coil:Heating:Steam, Coil:Heating:Water
`cooling_coil_object_type` Cooling Coil Object Type required	choice		Only works with DX cooling coil types One of `Coil:Cooling:DX:SingleSpeed`, `Coil:Cooling:DX:VariableSpeed`, `CoilSystem:Cooling:DX:HeatExchangerAssisted`
`cooling_coil_name` Cooling Coil Name required	reference		Names a Coil:Cooling:DX:SingleSpeed, Coil:Cooling:DX:SingleSpeed:ThermalStorage, Coil:Cooling:DX:VariableSpeed, CoilSystem:Cooling:DX:HeatExchangerAssisted
`dehumidification_control_type` Dehumidification Control Type	choice	`None`	None = meet sensible load only Multimode = activate enhanced dehumidification mode as needed and meet sensible load. Valid only with cooling coil type CoilSystem:Cooling:DX:HeatExchangerAssisted. This control mode allows the heat exchanger to be turned on and off based on the zone dehumidification requirements. A ZoneControl:Humidistat object is also required. CoolReheat = cool beyond the dry-bulb setpoint. as required to meet the humidity setpoint. Valid with all cooling coil types. When a heat exchanger assisted cooling coil is used, the heat exchanger is locked on at all times. A ZoneControl:Humidistat object is also required. One of `CoolReheat`, `Multimode`, `None`
`reheat_coil_object_type` Reheat Coil Object Type	choice		Only required if dehumidification control type is "CoolReheat" works with gas, electric, hot water and steam heating coils One of `Coil:Heating:Desuperheater`, `Coil:Heating:Electric`, `Coil:Heating:Fuel`, `Coil:Heating:Steam`, `Coil:Heating:Water`
`reheat_coil_name` Reheat Coil Name	reference		Only required if dehumidification control type is "CoolReheat" Names a Coil:Heating:Electric, Coil:Heating:Fuel, Coil:Heating:Steam, Coil:Heating:Water

Referenced by 2 object types

AirLoopHVAC:DedicatedOutdoorAirSystem, Branch

AirLoopHVAC:Unitary:Furnace:HeatOnly¶

from idfpy.models import AirLoopHVACUnitaryFurnaceHeatOnly

Unitary system, heating-only with constant volume supply fan (continuous or cycling) and heating coil (gas, electric, hot water, or steam). Identical to AirLoopHVAC:UnitaryHeatOnly.

Field	Type	Default	Details
`name` Name required	string
`availability_schedule_name` Availability Schedule Name	reference		Availability schedule name for this system. Schedule value > 0 means the system is available. If this field is blank, the system is always available. Names a ExternalInterface:FunctionalMockupUnitExport:To:Schedule, ExternalInterface:FunctionalMockupUnitImport:To:Schedule, ExternalInterface:Schedule, Schedule:Compact, Schedule:Constant, Schedule:File, Schedule:Year, Schedule:Year:Rules
`furnace_air_inlet_node_name` Furnace Air Inlet Node Name required	string
`furnace_air_outlet_node_name` Furnace Air Outlet Node Name required	string
`supply_air_fan_operating_mode_schedule_name` Supply Air Fan Operating Mode Schedule Name	reference		A fan operating mode schedule value of 0 indicates cycling fan mode (supply air fan cycles on and off in tandem with the heating coil). Any other schedule value indicates continuous fan mode (supply air fan operates continuously regardless of heating coil operation). Leaving this schedule name blank will default to cycling fan mode for the entire simulation period. Names a ExternalInterface:FunctionalMockupUnitExport:To:Schedule, ExternalInterface:FunctionalMockupUnitImport:To:Schedule, ExternalInterface:Schedule, Schedule:Compact, Schedule:Constant, Schedule:File, Schedule:Year, Schedule:Year:Rules
`maximum_supply_air_temperature` Maximum Supply Air Temperature	number or `Autosize` C	`80.0`
`heating_supply_air_flow_rate` Heating Supply Air Flow Rate required	number or `Autosize` m3/s		This value should be > 0 and <= than the fan air flow rate.
`controlling_zone_or_thermostat_location` Controlling Zone or Thermostat Location required	reference		Names a Zone
`supply_fan_object_type` Supply Fan Object Type required	choice		Fan:ConstantVolume only works with continuous fan operating mode (i.e. fan operating mode schedule values are greater than 0). One of `Fan:ConstantVolume`, `Fan:OnOff`
`supply_fan_name` Supply Fan Name required	reference		Names a Fan:ConstantVolume, Fan:OnOff
`fan_placement` Fan Placement	choice	`BlowThrough`	One of `BlowThrough`, `DrawThrough`
`heating_coil_object_type` Heating Coil Object Type required	choice		works with gas, electric, hot water and steam heating coils One of `Coil:Heating:Electric`, `Coil:Heating:Fuel`, `Coil:Heating:Steam`, `Coil:Heating:Water`
`heating_coil_name` Heating Coil Name required	reference		Names a Coil:Heating:Electric, Coil:Heating:Fuel, Coil:Heating:Steam, Coil:Heating:Water

Referenced by 2 object types

AirLoopHVAC:DedicatedOutdoorAirSystem, Branch

AirLoopHVAC:UnitaryHeatCool¶

from idfpy.models import AirLoopHVACUnitaryHeatCool

Unitary system, heating and cooling with constant volume supply fan (continuous or cycling), direct expansion (DX) cooling coil, heating coil (gas, electric, hot water, or steam), and optional reheat coil for dehumidification control. Identical to AirLoopHVAC:Unitary:Furnace:HeatCool.

Field	Type	Default	Details
`name` Name required	string
`availability_schedule_name` Availability Schedule Name	reference		Availability schedule name for this system. Schedule value > 0 means the system is available. If this field is blank, the system is always available. Names a ExternalInterface:FunctionalMockupUnitExport:To:Schedule, ExternalInterface:FunctionalMockupUnitImport:To:Schedule, ExternalInterface:Schedule, Schedule:Compact, Schedule:Constant, Schedule:File, Schedule:Year, Schedule:Year:Rules
`unitary_system_air_inlet_node_name` Unitary System Air Inlet Node Name required	string
`unitary_system_air_outlet_node_name` Unitary System Air Outlet Node Name required	string
`supply_air_fan_operating_mode_schedule_name` Supply Air Fan Operating Mode Schedule Name	reference		A fan operating mode schedule value of 0 indicates cycling fan mode (supply air fan cycles on and off in tandem with the cooling or heating coil). Any other schedule value indicates continuous fan mode (supply air fan operates continuously regardless of cooling or heating coil operation). Provide a schedule with non-zero values when high humidity control is specified. Leaving this schedule name blank will default to cycling fan mode for the entire simulation period. Names a ExternalInterface:FunctionalMockupUnitExport:To:Schedule, ExternalInterface:FunctionalMockupUnitImport:To:Schedule, ExternalInterface:Schedule, Schedule:Compact, Schedule:Constant, Schedule:File, Schedule:Year, Schedule:Year:Rules
`maximum_supply_air_temperature` Maximum Supply Air Temperature	number or `Autosize` C	`80.0`
`cooling_supply_air_flow_rate` Cooling Supply Air Flow Rate required	number or `Autosize` m3/s		Must be less than or equal to the fan's maximum flow rate.
`heating_supply_air_flow_rate` Heating Supply Air Flow Rate required	number or `Autosize` m3/s		Must be less than or equal to the fan's maximum flow rate.
`no_load_supply_air_flow_rate` No Load Supply Air Flow Rate	number or `Autosize` m3/s		Must be less than or equal to the fan's maximum flow rate. Only used when fan operating mode is continuous (disregarded for cycling fan mode). This air flow rate is used when no heating or cooling is required (i.e., the DX coil compressor and heating coil are off). If this field is left blank or zero, the supply air flow rate from the previous on cycle (either cooling or heating) is used.
`controlling_zone_or_thermostat_location` Controlling Zone or Thermostat Location required	reference		Names a Zone
`supply_fan_object_type` Supply Fan Object Type required	choice		Fan:ConstantVolume only works with continuous fan operating mode (i.e. supply air fan operating mode schedule values not equal to 0). One of `Fan:ConstantVolume`, `Fan:OnOff`
`supply_fan_name` Supply Fan Name required	reference		Names a Fan:ConstantVolume, Fan:OnOff
`fan_placement` Fan Placement	choice	`BlowThrough`	One of `BlowThrough`, `DrawThrough`
`heating_coil_object_type` Heating Coil Object Type required	choice		works with gas, electric, hot water and steam heating coils One of `Coil:Heating:Electric`, `Coil:Heating:Fuel`, `Coil:Heating:Steam`, `Coil:Heating:Water`
`heating_coil_name` Heating Coil Name required	reference		Names a Coil:Heating:Electric, Coil:Heating:Fuel, Coil:Heating:Steam, Coil:Heating:Water
`cooling_coil_object_type` Cooling Coil Object Type required	choice		Only works with DX cooling coil types or Coil:Cooling:DX:VariableSpeed. One of `Coil:Cooling:DX:SingleSpeed`, `Coil:Cooling:DX:VariableSpeed`, `CoilSystem:Cooling:DX:HeatExchangerAssisted`
`cooling_coil_name` Cooling Coil Name required	reference		Names a Coil:Cooling:DX:SingleSpeed, Coil:Cooling:DX:SingleSpeed:ThermalStorage, Coil:Cooling:DX:VariableSpeed, CoilSystem:Cooling:DX:HeatExchangerAssisted
`dehumidification_control_type` Dehumidification Control Type	choice	`None`	None = meet sensible load only Multimode = activate enhanced dehumidification mode as needed and meet sensible load. Valid only with cooling coil type CoilSystem:Cooling:DX:HeatExchangerAssisted. This control mode allows the heat exchanger to be turned on and off based on the zone dehumidification requirements. A ZoneControl:Humidistat object is also required. CoolReheat = cool beyond the dry-bulb setpoint. as required to meet the humidity setpoint. Valid with all cooling coil types. When a heat exchanger assisted Cooling coil is used, the heat exchanger is locked on at all times. A ZoneControl:Humidistat object is also required. One of `CoolReheat`, `Multimode`, `None`
`reheat_coil_object_type` Reheat Coil Object Type	choice		Only required if dehumidification control type is "CoolReheat" works with gas, electric, desuperheating, hot water and steam heating coils One of `Coil:Heating:Desuperheater`, `Coil:Heating:Electric`, `Coil:Heating:Fuel`, `Coil:Heating:Steam`, `Coil:Heating:Water`
`reheat_coil_name` Reheat Coil Name	reference		Only required if dehumidification control type is "CoolReheat" Names a Coil:Heating:Electric, Coil:Heating:Fuel, Coil:Heating:Steam, Coil:Heating:Water

Referenced by 2 object types

AirLoopHVAC:DedicatedOutdoorAirSystem, Branch

AirLoopHVAC:UnitaryHeatCool:VAVChangeoverBypass¶

from idfpy.models import AirLoopHVACUnitaryHeatCoolVAVChangeoverBypass

Unitary system, heating and cooling with constant volume supply fan (continuous or cycling), direct expansion (DX) cooling coil, heating coil (gas, electric, hot water, steam, or DX air-to-air heat pump) and bypass damper for variable volume flow to terminal units. Used with AirTerminal:SingleDuct:VAV:HeatAndCool:Reheat or AirTerminal:SingleDuct:VAV:HeatAndCool:NoReheat.

Field	Type	Default	Details
`name` Name required	string		Enter a unique name for this unitary system.
`availability_schedule_name` Availability Schedule Name	reference		Availability schedule name for this system. Schedule value > 0 means the system is available. If this field is blank, the system is always available. Enter the availability schedule name. Schedule values of zero denote system is Off. Non-zero schedule values denote system is available to operate. Names a ExternalInterface:FunctionalMockupUnitExport:To:Schedule, ExternalInterface:FunctionalMockupUnitImport:To:Schedule, ExternalInterface:Schedule, Schedule:Compact, Schedule:Constant, Schedule:File, Schedule:Year, Schedule:Year:Rules
`cooling_supply_air_flow_rate` Cooling Supply Air Flow Rate required	number or `Autosize` m3/s		Enter the system air flow rate during cooling operation or specify autosize.
`heating_supply_air_flow_rate` Heating Supply Air Flow Rate required	number or `Autosize` m3/s		Enter the system air flow rate during heating operation or specify autosize.
`no_load_supply_air_flow_rate` No Load Supply Air Flow Rate	number or `Autosize` m3/s		Only used when the supply air fan operating mode is continuous (see field Supply air fan operating mode schedule name). This system air flow rate is used when no heating or cooling is required and the coils are off. If this field is left blank or zero, the system air flow rate from the previous on cycle (either cooling or heating) is used.
`cooling_outdoor_air_flow_rate` Cooling Outdoor Air Flow Rate required	number or `Autosize` m3/s		Enter the outdoor air flow rate during cooling operation or specify autosize.
`heating_outdoor_air_flow_rate` Heating Outdoor Air Flow Rate required	number or `Autosize` m3/s		Enter the outdoor air flow rate during heating operation or specify autosize.
`no_load_outdoor_air_flow_rate` No Load Outdoor Air Flow Rate	number or `Autosize` m3/s		Only used when the supply air fan operating mode is continuous (see field Supply air fan operating mode schedule name). This outdoor air flow rate is used when no heating or cooling is required and the coils are off. If this field is left blank or zero, the outdoor air flow rate from the previous on cycle (either cooling or heating) is used.
`outdoor_air_flow_rate_multiplier_schedule_name` Outdoor Air Flow Rate Multiplier Schedule Name	reference		Enter the name of a schedule that contains multipliers for the outdoor air flow rates. Schedule values must be from 0 to 1. If field is left blank, model assumes multiplier is 1 for the entire simulation period. Names a ExternalInterface:FunctionalMockupUnitExport:To:Schedule, ExternalInterface:FunctionalMockupUnitImport:To:Schedule, ExternalInterface:Schedule, Schedule:Compact, Schedule:Constant, Schedule:File, Schedule:Year, Schedule:Year:Rules
`air_inlet_node_name` Air Inlet Node Name required	string		Enter the name of the unitary system's air inlet node.
`bypass_duct_mixer_node_name` Bypass Duct Mixer Node Name required	string		Enter the name of the bypass duct mixer node. This name should be the name of the return air node for the outdoor air mixer associated with this system. This node name must be different from the air inlet node name.
`bypass_duct_splitter_node_name` Bypass Duct Splitter Node Name required	string		Enter the name of the bypass duct splitter node. This splitter air node is the outlet node of the last component in this unitary system. For blow through fan placement, the splitter air node is the outlet node of the heating coil. For draw through fan placement, the splitter node is the outlet node of the supply air fan.
`air_outlet_node_name` Air Outlet Node Name required	string		Enter the name of the unitary system's air outlet node.
`outdoor_air_mixer_object_type` Outdoor Air Mixer Object Type required	choice		currently only one type OutdoorAir:Mixer object is available. One of `OutdoorAir:Mixer`
`outdoor_air_mixer_name` Outdoor Air Mixer Name required	reference		Enter the name of the outdoor air mixer used with this unitary system. Names a OutdoorAir:Mixer
`supply_air_fan_object_type` Supply Air Fan Object Type required	choice		Specify the type of supply air fan used in this unitary system. One of `Fan:ConstantVolume`, `Fan:OnOff`, `Fan:SystemModel`
`supply_air_fan_name` Supply Air Fan Name required	reference		Enter the name of the supply air fan used in this unitary system. Names a Fan:ConstantVolume, Fan:OnOff, Fan:SystemModel
`supply_air_fan_placement` Supply Air Fan Placement required	choice		Specify supply air fan placement as either blow through or draw through. BlowThrough means the supply air fan is located before the cooling coil. DrawThrough means the supply air fan is located after the heating coil. One of `BlowThrough`, `DrawThrough`
`supply_air_fan_operating_mode_schedule_name` Supply Air Fan Operating Mode Schedule Name	reference		Enter the name of a schedule to control the supply air fan. Schedule Name values of zero mean that the supply air fan will cycle off if there is no cooling or heating load in any of the zones being served by this system. Non-zero schedule values mean that the supply air fan will operate continuously even if there is no cooling or heating load in any of the zones being served. If this field is left blank, the supply air fan will operate continuously for the entire simulation period. Names a ExternalInterface:FunctionalMockupUnitExport:To:Schedule, ExternalInterface:FunctionalMockupUnitImport:To:Schedule, ExternalInterface:Schedule, Schedule:Compact, Schedule:Constant, Schedule:File, Schedule:Year, Schedule:Year:Rules
`cooling_coil_object_type` Cooling Coil Object Type required	choice		Specify the type of cooling coil used in this unitary system. One of `Coil:Cooling:DX:SingleSpeed`, `Coil:Cooling:DX:TwoStageWithHumidityControlMode`, `Coil:Cooling:DX:VariableSpeed`, `CoilSystem:Cooling:DX:HeatExchangerAssisted`
`cooling_coil_name` Cooling Coil Name required	reference		Enter the name of the cooling coil used in this unitary system. Names a Coil:Cooling:DX:SingleSpeed, Coil:Cooling:DX:SingleSpeed:ThermalStorage, Coil:Cooling:DX:TwoStageWithHumidityControlMode, Coil:Cooling:DX:VariableSpeed, CoilSystem:Cooling:DX:HeatExchangerAssisted
`heating_coil_object_type` Heating Coil Object Type required	choice		works with DX, gas, electric, hot water and steam heating coils Specify the type of heating coil used in this unitary system. One of `Coil:Heating:DX:SingleSpeed`, `Coil:Heating:DX:VariableSpeed`, `Coil:Heating:Electric`, `Coil:Heating:Fuel`, `Coil:Heating:Steam`, `Coil:Heating:Water`
`heating_coil_name` Heating Coil Name required	reference		Enter the name of the heating coil used in this unitary system. Names a Coil:Heating:DX:VariableSpeed, Coil:Heating:Electric, Coil:Heating:Fuel, Coil:Heating:Steam, Coil:Heating:Water
`priority_control_mode` Priority Control Mode	choice	`ZonePriority`	CoolingPriority = system provides cooling if any zone requires cooling. HeatingPriority = system provides heating if any zone requires heating. ZonePriority = system controlled based on the total number of zones requiring cooling or heating (highest number of zones in cooling or heating determines the system's operating mode). LoadPriority = system provides cooling or heating based on total zone loads. One of `CoolingPriority`, `HeatingPriority`, `LoadPriority`, `ZonePriority`
`minimum_outlet_air_temperature_during_cooling_operation` Minimum Outlet Air Temperature During Cooling Operation	number C	`8.0`	Specify the minimum outlet air temperature allowed for this unitary system during cooling operation. This value should be less than the maximum outlet air temperature during heating operation. Range: > 0
`maximum_outlet_air_temperature_during_heating_operation` Maximum Outlet Air Temperature During Heating Operation	number C	`50.0`	Specify the maximum outlet air temperature allowed for this unitary system during heating operation. This value should be greater than the minimum outlet air temperature during cooling operation. Range: > 0
`dehumidification_control_type` Dehumidification Control Type	choice	`None`	None = meet sensible load only. Multimode = activate enhanced dehumidification mode as needed and meet sensible load. Valid only with Coil:Cooling:DX:TwoStageWithHumidityControlMode. CoolReheat = cool beyond the Dry-Bulb temperature setpoint as required to meet the humidity setpoint. Valid only with Coil:Cooling:DX:TwoStageWithHumidityControlMode. For all dehumidification controls, the max humidity setpoint on this unitary system's air outlet node is used. This must be set using ZoneControl:Humidistat and SetpointManager:SingleZone:Humidity:Maximum, SetpointManager:MultiZone:Humidity:Maximum or SetpointManager:MultiZone:MaximumHumidity:Average objects. One of `CoolReheat`, `Multimode`, `None`
`plenum_or_mixer_inlet_node_name` Plenum or Mixer Inlet Node Name	string		Enter the name of the bypass duct node connected to a plenum or mixer. This field is required when this HVAC System is connected to a plenum or mixer. This is a different node name than that entered in the Bypass Duct Splitter Node Name field.
`minimum_runtime_before_operating_mode_change` Minimum Runtime Before Operating Mode Change	number hr	`0.25`	This is the minimum amount of time the unit operates in cooling or heating mode before changing modes. Range: ≥ 0

Referenced by 2 object types

AirLoopHVAC:DedicatedOutdoorAirSystem, Branch

AirLoopHVAC:UnitaryHeatOnly¶

from idfpy.models import AirLoopHVACUnitaryHeatOnly

Unitary system, heating-only with constant volume supply fan (continuous or cycling) and heating coil (gas, electric, hot water, or steam). Identical to AirLoopHVAC:Unitary:Furnace:HeatOnly.

Field	Type	Default	Details
`name` Name required	string
`availability_schedule_name` Availability Schedule Name	reference		Availability schedule name for this system. Schedule value > 0 means the system is available. If this field is blank, the system is always available. Names a ExternalInterface:FunctionalMockupUnitExport:To:Schedule, ExternalInterface:FunctionalMockupUnitImport:To:Schedule, ExternalInterface:Schedule, Schedule:Compact, Schedule:Constant, Schedule:File, Schedule:Year, Schedule:Year:Rules
`unitary_system_air_inlet_node_name` Unitary System Air Inlet Node Name required	string
`unitary_system_air_outlet_node_name` Unitary System Air Outlet Node Name required	string
`supply_air_fan_operating_mode_schedule_name` Supply Air Fan Operating Mode Schedule Name	reference		A fan operating mode schedule value of 0 indicates cycling fan mode (supply air fan cycles on and off in tandem with the heating coil). Any other schedule value indicates continuous fan mode (supply air fan operates continuously regardless of heating coil operation). Leaving this schedule name blank will default to cycling fan mode for the entire simulation period. Names a ExternalInterface:FunctionalMockupUnitExport:To:Schedule, ExternalInterface:FunctionalMockupUnitImport:To:Schedule, ExternalInterface:Schedule, Schedule:Compact, Schedule:Constant, Schedule:File, Schedule:Year, Schedule:Year:Rules
`maximum_supply_air_temperature` Maximum Supply Air Temperature	number or `Autosize` C	`80.0`
`heating_supply_air_flow_rate` Heating Supply Air Flow Rate required	number or `Autosize` m3/s		This value should be > 0 and <= than the fan air flow rate.
`controlling_zone_or_thermostat_location` Controlling Zone or Thermostat Location required	reference		Names a Zone
`supply_fan_object_type` Supply Fan Object Type required	choice		Fan:ConstantVolume only works with continuous fan operating mode (i.e. fan operating mode schedule values are greater than 0). One of `Fan:ConstantVolume`, `Fan:OnOff`
`supply_fan_name` Supply Fan Name required	reference		Names a Fan:ConstantVolume, Fan:OnOff
`fan_placement` Fan Placement	choice	`BlowThrough`	One of `BlowThrough`, `DrawThrough`
`heating_coil_object_type` Heating Coil Object Type required	choice		works with gas, electric, hot water and steam heating coils One of `Coil:Heating:Electric`, `Coil:Heating:Fuel`, `Coil:Heating:Steam`, `Coil:Heating:Water`
`heating_coil_name` Heating Coil Name required	reference		Names a Coil:Heating:Electric, Coil:Heating:Fuel, Coil:Heating:Steam, Coil:Heating:Water

Referenced by 2 object types

AirLoopHVAC:DedicatedOutdoorAirSystem, Branch

AirLoopHVAC:UnitaryHeatPump:AirToAir¶

from idfpy.models import AirLoopHVACUnitaryHeatPumpAirToAir

Unitary heat pump system, heating and cooling, single-speed with supply fan, direct expansion (DX) cooling coil, DX heating coil (air-to-air heat pump), and supplemental heating coil (gas, electric, hot water, or steam).

Field	Type	Default	Details
`name` Name required	string
`availability_schedule_name` Availability Schedule Name	reference		Availability schedule name for this system. Schedule value > 0 means the system is available. If this field is blank, the system is always available. A schedule value greater than zero (usually 1 is used) indicates that the unit is available to operate as needed. A value less than or equal to zero (usually zero is used) denotes that the unit must be off. Names a ExternalInterface:FunctionalMockupUnitExport:To:Schedule, ExternalInterface:FunctionalMockupUnitImport:To:Schedule, ExternalInterface:Schedule, Schedule:Compact, Schedule:Constant, Schedule:File, Schedule:Year, Schedule:Year:Rules
`air_inlet_node_name` Air Inlet Node Name required	string
`air_outlet_node_name` Air Outlet Node Name required	string
`cooling_supply_air_flow_rate` Cooling Supply Air Flow Rate required	number or `Autosize` m3/s		Must be less than or equal to the fan's maximum flow rate.
`heating_supply_air_flow_rate` Heating Supply Air Flow Rate required	number or `Autosize` m3/s		Must be less than or equal to the fan's maximum flow rate.
`no_load_supply_air_flow_rate` No Load Supply Air Flow Rate	number or `Autosize` m3/s		Must be less than or equal to the fan's maximum flow rate. Only used when fan operating mode is continuous (disregarded for cycling fan mode). This air flow rate is used when no heating or cooling is required (i.e., the DX coil compressor and supplemental heating coil are off). If this field is left blank or zero, the supply air flow rate from the previous on cycle (either cooling or heating) is used.
`controlling_zone_or_thermostat_location` Controlling Zone or Thermostat Location required	reference		Names a Zone
`supply_air_fan_object_type` Supply Air Fan Object Type required	choice		Fan:ConstantVolume only works with continuous fan operating mode (i.e. fan operating mode schedule values are greater than 0 or the fan operating mode schedule name field is left blank). One of `Fan:ConstantVolume`, `Fan:OnOff`
`supply_air_fan_name` Supply Air Fan Name required	reference		Needs to match in the fan object Names a Fan:ConstantVolume, Fan:OnOff
`heating_coil_object_type` Heating Coil Object Type required	choice		Only works with Coil:Heating:DX:SingleSpeed or Coil:Heating:DX:VariableSpeed or CoilSystem:IntegratedHeatPump:AirSource One of `Coil:Heating:DX:SingleSpeed`, `Coil:Heating:DX:VariableSpeed`, `CoilSystem:IntegratedHeatPump:AirSource`
`heating_coil_name` Heating Coil Name required	reference		Needs to match in the DX heating coil object Names a Coil:Heating:DX:SingleSpeed, Coil:Heating:DX:VariableRefrigerantFlow, Coil:Heating:DX:VariableSpeed, CoilSystem:IntegratedHeatPump:AirSource
`cooling_coil_object_type` Cooling Coil Object Type required	choice		Only works with Coil:Cooling:DX:SingleSpeed or CoilSystem:Cooling:DX:HeatExchangerAssisted or Coil:Cooling:DX:VariableSpeed or CoilSystem:IntegratedHeatPump:AirSource One of `Coil:Cooling:DX:SingleSpeed`, `Coil:Cooling:DX:VariableSpeed`, `CoilSystem:Cooling:DX:HeatExchangerAssisted`, `CoilSystem:IntegratedHeatPump:AirSource`
`cooling_coil_name` Cooling Coil Name required	reference		Needs to match in the DX cooling coil object Names a Coil:Cooling:DX:SingleSpeed, Coil:Cooling:DX:SingleSpeed:ThermalStorage, Coil:Cooling:DX:VariableSpeed, CoilSystem:Cooling:DX:HeatExchangerAssisted, CoilSystem:IntegratedHeatPump:AirSource
`supplemental_heating_coil_object_type` Supplemental Heating Coil Object Type required	choice		works with gas, electric, hot water and steam heating coils One of `Coil:Heating:Electric`, `Coil:Heating:Fuel`, `Coil:Heating:Steam`, `Coil:Heating:Water`
`supplemental_heating_coil_name` Supplemental Heating Coil Name required	reference		Needs to match in the supplemental heating coil object Names a Coil:Heating:Electric, Coil:Heating:Fuel, Coil:Heating:Steam, Coil:Heating:Water
`maximum_supply_air_temperature_from_supplemental_heater` Maximum Supply Air Temperature from Supplemental Heater required	number or `Autosize` C
`maximum_outdoor_dry_bulb_temperature_for_supplemental_heater_operation` Maximum Outdoor Dry-Bulb Temperature for Supplemental Heater Operation	number C	`21.0`	Range: ≤ 21
`fan_placement` Fan Placement	choice	`BlowThrough`	One of `BlowThrough`, `DrawThrough`
`supply_air_fan_operating_mode_schedule_name` Supply Air Fan Operating Mode Schedule Name	reference		A fan operating mode schedule value of 0 indicates cycling fan mode (supply air fan cycles on and off in tandem with the cooling or heating coil). Any other schedule value indicates continuous fan mode (supply air fan operates continuously regardless of cooling or heating coil operation). Leaving this schedule name blank will default to cycling fan mode for the entire simulation period. Names a ExternalInterface:FunctionalMockupUnitExport:To:Schedule, ExternalInterface:FunctionalMockupUnitImport:To:Schedule, ExternalInterface:Schedule, Schedule:Compact, Schedule:Constant, Schedule:File, Schedule:Year, Schedule:Year:Rules
`dehumidification_control_type` Dehumidification Control Type	choice	`None`	None = meet sensible load only Multimode = activate enhanced dehumidification mode as needed and meet sensible load. Valid only with cooling coil type CoilSystem:Cooling:DX:HeatExchangerAssisted. This control mode allows the heat exchanger to be turned on and off based on the zone dehumidification requirements. A ZoneControl:Humidistat object is also required. CoolReheat = cool beyond the dry-bulb setpoint. as required to meet the humidity setpoint. Valid with all cooling coil types. When a heat exchanger assisted Cooling coil is used, the heat exchanger is locked on at all times. A ZoneControl:Humidistat object is also required. One of `CoolReheat`, `Multimode`, `None`
`dx_heating_coil_sizing_ratio` DX Heating Coil Sizing Ratio	number	`1.0`	Used to adjust heat pump heating capacity with respect to DX cooling capacity used only for heat pump configurations (i.e., a DX cooling and DX heating coil is used). Range: > 0

Referenced by 2 object types

AirLoopHVAC:DedicatedOutdoorAirSystem, Branch

AirLoopHVAC:UnitaryHeatPump:AirToAir:MultiSpeed¶

from idfpy.models import AirLoopHVACUnitaryHeatPumpAirToAirMultiSpeed

Unitary system, heating and cooling, multi-speed with constant volume supply fan (continuous or cycling), direct expansion (DX) cooling coil, heating coil (DX air-to-air heat pump, gas, electric, hot water, or steam), and supplemental heating coil (gas, electric, hot water, or steam).

Field	Type	Default	Details
`name` Name required	string
`availability_schedule_name` Availability Schedule Name	reference		Availability schedule name for this system. Schedule value > 0 means the system is available. If this field is blank, the system is always available. Names a ExternalInterface:FunctionalMockupUnitExport:To:Schedule, ExternalInterface:FunctionalMockupUnitImport:To:Schedule, ExternalInterface:Schedule, Schedule:Compact, Schedule:Constant, Schedule:File, Schedule:Year, Schedule:Year:Rules
`air_inlet_node_name` Air Inlet Node Name required	string
`air_outlet_node_name` Air Outlet Node Name required	string
`controlling_zone_or_thermostat_location` Controlling Zone or Thermostat Location required	reference		Names a Zone
`supply_air_fan_object_type` Supply Air Fan Object Type required	choice		Select the type of supply air fan used in this unitary system. One of `Fan:ConstantVolume`, `Fan:OnOff`
`supply_air_fan_name` Supply Air Fan Name required	reference		Enter the name of the supply air fan used in this unitary system. Names a Fan:ConstantVolume, Fan:OnOff
`supply_air_fan_placement` Supply Air Fan Placement required	choice		Select supply air fan placement as either BlowThrough or DrawThrough. BlowThrough means the supply air fan is located before the cooling coil. DrawThrough means the supply air fan is located after the heating coil but before the optional supplemental heating coil. One of `BlowThrough`, `DrawThrough`
`supply_air_fan_operating_mode_schedule_name` Supply Air Fan Operating Mode Schedule Name	reference		Enter the name of a schedule to control the supply air fan. Schedule values of zero mean that the supply air fan will cycle off if there is no cooling or heating load in the control zone. Non-zero schedule values mean that the supply air fan will operate continuously even if there is no cooling or heating load in the control zone. If this field is left blank, the supply air fan will operate continuously for the entire simulation period. Names a ExternalInterface:FunctionalMockupUnitExport:To:Schedule, ExternalInterface:FunctionalMockupUnitImport:To:Schedule, ExternalInterface:Schedule, Schedule:Compact, Schedule:Constant, Schedule:File, Schedule:Year, Schedule:Year:Rules
`heating_coil_object_type` Heating Coil Object Type required	choice		Multi Speed DX, Electric, Gas, and Single speed Water and Steam coils One of `Coil:Heating:DX:MultiSpeed`, `Coil:Heating:Electric:MultiStage`, `Coil:Heating:Gas:MultiStage`, `Coil:Heating:Steam`, `Coil:Heating:Water`
`heating_coil_name` Heating Coil Name required	reference		Names a Coil:Heating:DX:MultiSpeed, Coil:Heating:Electric:MultiStage, Coil:Heating:Gas:MultiStage
`dx_heating_coil_sizing_ratio` DX Heating Coil Sizing Ratio	number	`1.0`	Used to adjust heat pump heating capacity with respect to DX cooling capacity used only for heat pump configurations (i.e., a DX cooling and DX heating coil is used). Range: > 0
`cooling_coil_object_type` Cooling Coil Object Type required	choice		Only works with Coil:Cooling:DX:MultiSpeed One of `Coil:Cooling:DX:MultiSpeed`
`cooling_coil_name` Cooling Coil Name required	reference		Needs to match in the DX Cooling Coil object Names a Coil:Cooling:DX:MultiSpeed
`supplemental_heating_coil_object_type` Supplemental Heating Coil Object Type	choice		works with gas, electric, hot water and steam heating coils One of `Coil:Heating:Electric`, `Coil:Heating:Fuel`, `Coil:Heating:Steam`, `Coil:Heating:Water`
`supplemental_heating_coil_name` Supplemental Heating Coil Name	reference		Needs to match in the supplemental heating coil object Names a Coil:Heating:Electric, Coil:Heating:Fuel, Coil:Heating:Steam, Coil:Heating:Water
`maximum_supply_air_temperature_from_supplemental_heater` Maximum Supply Air Temperature from Supplemental Heater	number or `Autosize` C
`maximum_outdoor_dry_bulb_temperature_for_supplemental_heater_operation` Maximum Outdoor Dry-Bulb Temperature for Supplemental Heater Operation	number C	`21.0`	Range: ≤ 21
`auxiliary_on_cycle_electric_power` Auxiliary On-Cycle Electric Power	number W	`0.0`	Range: ≥ 0
`auxiliary_off_cycle_electric_power` Auxiliary Off-Cycle Electric Power	number W	`0.0`	Range: ≥ 0
`design_heat_recovery_water_flow_rate` Design Heat Recovery Water Flow Rate	number m3/s	`0.0`	If non-zero, then the heat recovery inlet and outlet node names must be entered. Used for heat recovery to an EnergyPlus plant loop. Range: ≥ 0
`maximum_temperature_for_heat_recovery` Maximum Temperature for Heat Recovery	number C	`80.0`	Range: ≥ 0, ≤ 100
`heat_recovery_water_inlet_node_name` Heat Recovery Water Inlet Node Name	string
`heat_recovery_water_outlet_node_name` Heat Recovery Water Outlet Node Name	string
`no_load_supply_air_flow_rate` No Load Supply Air Flow Rate	number or `Autosize` m3/s		Only used when the supply air fan operating mode is continuous (see field Supply Air Fan Operating Mode Schedule Name). This air flow rate is used when no heating or cooling is required and the coils are off. If this field is left blank or zero, the supply air flow rate from the previous on cycle (either cooling or heating) is used.
`number_of_speeds_for_heating` Number of Speeds for Heating required	integer		Enter the number of the following sets of data for air flow rates. If Heating Coil Object Type is Coil:Heating:Water or Coil:Heating:Steam, this field should be 1. Range: ≥ 1, ≤ 4
`number_of_speeds_for_cooling` Number of Speeds for Cooling required	integer		Enter the number of the following sets of data for air flow rates. Range: ≥ 2, ≤ 4
`heating_speed_1_supply_air_flow_rate` Heating Speed 1 Supply Air Flow Rate required	number or `Autosize` m3/s		Enter the operating supply air flow rate during heating operation or specify autosize.
`heating_speed_2_supply_air_flow_rate` Heating Speed 2 Supply Air Flow Rate	number or `Autosize` m3/s		Enter the operating supply air flow rate during heating operation or specify autosize.
`heating_speed_3_supply_air_flow_rate` Heating Speed 3 Supply Air Flow Rate	number or `Autosize` m3/s		Enter the operating supply air flow rate during heating operation or specify autosize.
`heating_speed_4_supply_air_flow_rate` Heating Speed 4 Supply Air Flow Rate	number or `Autosize` m3/s		Enter the operating supply air flow rate during heating operation or specify autosize.
`cooling_speed_1_supply_air_flow_rate` Cooling Speed 1 Supply Air Flow Rate required	number or `Autosize` m3/s		Enter the operating supply air flow rate during cooling operation or specify autosize.
`cooling_speed_2_supply_air_flow_rate` Cooling Speed 2 Supply Air Flow Rate required	number or `Autosize` m3/s		Enter the operating supply air flow rate during cooling operation or specify autosize.
`cooling_speed_3_supply_air_flow_rate` Cooling Speed 3 Supply Air Flow Rate	number or `Autosize` m3/s		Enter the operating supply air flow rate during cooling operation or specify autosize.
`cooling_speed_4_supply_air_flow_rate` Cooling Speed 4 Supply Air Flow Rate	number or `Autosize` m3/s		Enter the operating supply air flow rate during cooling operation or specify autosize.

Referenced by 2 object types

AirLoopHVAC:DedicatedOutdoorAirSystem, Branch

AirLoopHVAC:UnitaryHeatPump:WaterToAir¶

from idfpy.models import AirLoopHVACUnitaryHeatPumpWaterToAir

Unitary heat pump system, heating and cooling, single-speed with constant volume supply fan (continuous or cycling), direct expansion (DX) cooling coil, DX heating coil (water-to-air heat pump), and supplemental heating coil (gas, electric, hot water, or steam).

Field	Type	Default	Details
`name` Name required	string
`availability_schedule_name` Availability Schedule Name	reference		Availability schedule name for this system. Schedule value > 0 means the system is available. If this field is blank, the system is always available. Names a ExternalInterface:FunctionalMockupUnitExport:To:Schedule, ExternalInterface:FunctionalMockupUnitImport:To:Schedule, ExternalInterface:Schedule, Schedule:Compact, Schedule:Constant, Schedule:File, Schedule:Year, Schedule:Year:Rules
`air_inlet_node_name` Air Inlet Node Name required	string
`air_outlet_node_name` Air Outlet Node Name required	string
`supply_air_flow_rate` Supply Air Flow Rate required	number or `Autosize` m3/s		This value should be > 0 and <= than the fan air flow rate.
`controlling_zone_or_thermostat_location` Controlling Zone or Thermostat Location required	reference		Names a Zone
`supply_air_fan_object_type` Supply Air Fan Object Type required	choice		Only works with On/Off Fan One of `Fan:OnOff`
`supply_air_fan_name` Supply Air Fan Name required	reference		Needs to match Fan:OnOff object Names a Fan:OnOff
`heating_coil_object_type` Heating Coil Object Type required	choice		One of `Coil:Heating:WaterToAirHeatPump:EquationFit`, `Coil:Heating:WaterToAirHeatPump:ParameterEstimation`, `Coil:Heating:WaterToAirHeatPump:VariableSpeedEquationFit`
`heating_coil_name` Heating Coil Name required	reference		Needs to match in the water-to-air heat pump heating coil object Names a Coil:Heating:WaterToAirHeatPump:EquationFit, Coil:Heating:WaterToAirHeatPump:ParameterEstimation, Coil:Heating:WaterToAirHeatPump:VariableSpeedEquationFit
`heating_convergence` Heating Convergence	number	`0.001`	Range: > 0
`cooling_coil_object_type` Cooling Coil Object Type required	choice		One of `Coil:Cooling:WaterToAirHeatPump:EquationFit`, `Coil:Cooling:WaterToAirHeatPump:ParameterEstimation`, `Coil:Cooling:WaterToAirHeatPump:VariableSpeedEquationFit`
`cooling_coil_name` Cooling Coil Name required	reference		Needs to match in the water-to-air heat pump cooling coil object Names a Coil:Cooling:WaterToAirHeatPump:EquationFit, Coil:Cooling:WaterToAirHeatPump:ParameterEstimation, Coil:Cooling:WaterToAirHeatPump:VariableSpeedEquationFit
`cooling_convergence` Cooling Convergence	number	`0.001`	Range: > 0
`supplemental_heating_coil_object_type` Supplemental Heating Coil Object Type required	choice		works with gas, electric, hot water and steam heating coils One of `Coil:Heating:Electric`, `Coil:Heating:Fuel`, `Coil:Heating:Steam`, `Coil:Heating:Water`
`supplemental_heating_coil_name` Supplemental Heating Coil Name required	reference		Needs to match in the supplemental heating coil object Names a Coil:Heating:Electric, Coil:Heating:Fuel, Coil:Heating:Steam, Coil:Heating:Water
`maximum_supply_air_temperature_from_supplemental_heater` Maximum Supply Air Temperature from Supplemental Heater required	number or `Autosize` C
`maximum_outdoor_dry_bulb_temperature_for_supplemental_heater_operation` Maximum Outdoor Dry-Bulb Temperature for Supplemental Heater Operation	number C	`21.0`	Range: ≤ 21
`outdoor_dry_bulb_temperature_sensor_node_name` Outdoor Dry-Bulb Temperature Sensor Node Name	string
`fan_placement` Fan Placement	choice	`BlowThrough`	One of `BlowThrough`, `DrawThrough`
`supply_air_fan_operating_mode_schedule_name` Supply Air Fan Operating Mode Schedule Name	reference		Enter the name of a schedule that controls fan operation. Schedule values of 0 denote cycling fan operation (fan cycles with cooling or heating coil). Schedule values greater than 0 denote constant fan operation (fan runs continually regardless of coil operation). The fan operating mode defaults to cycling fan operation if this field is left blank. Names a ExternalInterface:FunctionalMockupUnitExport:To:Schedule, ExternalInterface:FunctionalMockupUnitImport:To:Schedule, ExternalInterface:Schedule, Schedule:Compact, Schedule:Constant, Schedule:File, Schedule:Year, Schedule:Year:Rules
`dehumidification_control_type` Dehumidification Control Type	choice	`None`	None = meet sensible load only CoolReheat = cool beyond the dry-bulb setpoint. as required to meet the humidity setpoint. Valid only with Coil:Cooling:WaterToAirHeatPump:EquationFit or Coil:Cooling:WaterToAirHeatPump:VariableSpeedEquationFit One of `CoolReheat`, `None`
`heat_pump_coil_water_flow_mode` Heat Pump Coil Water Flow Mode	choice	`Cycling`	used only when the heat pump coils are of the type WaterToAirHeatPump:EquationFit Constant results in 100% water flow regardless of compressor PLR Cycling results in water flow that matches compressor PLR ConstantOnDemand results in 100% water flow whenever the coil is on, but is 0% whenever the coil has no load One of `Constant`, `ConstantOnDemand`, `Cycling`
`dx_heating_coil_sizing_ratio` DX Heating Coil Sizing Ratio	number	`1.0`	Used to adjust heat pump heating capacity with respect to DX cooling capacity used only for heat pump configurations (i.e., a DX cooling and DX heating coil is used). Range: > 0

Referenced by 2 object types

AirLoopHVAC:DedicatedOutdoorAirSystem, Branch

AirLoopHVAC:UnitarySystem¶

from idfpy.models import AirLoopHVACUnitarySystem

AirloopHVAC:UnitarySystem is a generic HVAC system type that allows any configuration of coils and/or fan. This object is a replacement of other AirloopHVAC objects. This object can be used in outdoor air systems, outdoor air units, air loops, and as zone equipment if desired.

Field	Type	Default	Details
`name` Name required	string		Unique name for the Unitary System.
`control_type` Control Type	choice	`Load`	Load control requires a Controlling Zone name. SetPoint control requires set points at coil outlet node. SingleZoneVAV also requires a Controlling Zone name and allows load control at low speed fan until the load exceeds capacity or outlet air temperature limits. The fan speed is then increased. One of `Load`, `SetPoint`, `SingleZoneVAV`
`controlling_zone_or_thermostat_location` Controlling Zone or Thermostat Location	reference		Used only for Load based control Zone name where thermostat is located. Required when Control Type = Load. Names a Zone
`dehumidification_control_type` Dehumidification Control Type	choice	`None`	None = meet sensible load only. Required when Control Type = SingleZoneVAV. Multimode = activate enhanced dehumidification mode as needed and meet sensible load. Valid only with cooling coil type Coil:Cooling:DX:TwoStageWithHumidityControlMode or CoilSystem:Cooling:DX:HeatExchangerAssisted. This control mode either switches the coil mode or allows the heat exchanger to be turned on and off based on the zone dehumidification requirements. A ZoneControl:Humidistat object is also required. CoolReheat = cool beyond the dry-bulb setpoint. as required to meet the humidity setpoint. Valid with all cooling coil types. When a heat exchanger assisted cooling coil is used, the heat exchanger is locked on at all times. A ZoneControl:Humidistat object is also required. One of `CoolReheat`, `Multimode`, `None`
`availability_schedule_name` Availability Schedule Name	reference		Availability schedule name for this system. Schedule value > 0 means the system is available. If this field is blank, the system is always available. A schedule value greater than zero (usually 1 is used) indicates that the unit is available to operate as needed. A value less than or equal to zero (usually zero is used) denotes that the unit must be off. Names a ExternalInterface:FunctionalMockupUnitExport:To:Schedule, ExternalInterface:FunctionalMockupUnitImport:To:Schedule, ExternalInterface:Schedule, Schedule:Compact, Schedule:Constant, Schedule:File, Schedule:Year, Schedule:Year:Rules
`air_inlet_node_name` Air Inlet Node Name required	string		Enter the node name used as the inlet air node for the unitary system.
`air_outlet_node_name` Air Outlet Node Name required	string		Enter the node name used as the outlet air node for the unitary system.
`supply_fan_object_type` Supply Fan Object Type	choice		Enter the type of supply air fan if included in the unitary system. Fan:ConstantVolume only works with continuous fan operating mode (i.e. supply air fan operating mode schedule values greater than 0). Specify a Fan:SystemModel or a Fan:OnOff object when the Supply Air Fan Operating Mode Schedule Name input field above is left blank. Specify a Fan:SystemModel or a Fan:VariableVolume when modeling VAV systems which used setpoint based control if the fan is included in the unitary system object. The ComponentModel fan type may be substituted for the ConstantVolume or VariableVolume fan types when more detailed fan modeling is required. The variable or constant volume fan may be specified on the branch instead of contained within the unitary system object (i.e., this field may be blank for certain configurations). One of `Fan:ComponentModel`, `Fan:ConstantVolume`, `Fan:OnOff`, `Fan:SystemModel`, `Fan:VariableVolume`
`supply_fan_name` Supply Fan Name	reference		Enter the name of the supply air fan if included in the unitary system. Names a Fan:ComponentModel, Fan:ConstantVolume, Fan:OnOff, Fan:SystemModel, Fan:VariableVolume
`fan_placement` Fan Placement	choice		Enter the type of supply air fan if included in the unitary system. One of `BlowThrough`, `DrawThrough`
`supply_air_fan_operating_mode_schedule_name` Supply Air Fan Operating Mode Schedule Name	reference		A fan operating mode schedule value of 0 indicates cycling fan mode (supply air fan cycles on and off in tandem with the cooling or heating coil). Any other schedule value indicates continuous fan mode (supply air fan operates continuously regardless of cooling or heating coil operation). Provide a schedule with non-zero values when high humidity control is specified. Leaving this schedule name blank will default to constant fan mode for the entire simulation period. This field is not used when set point based control is used where a set point controls the coil. SingleZoneVAV control type is only active when constant fan operating mode is active. Names a ExternalInterface:FunctionalMockupUnitExport:To:Schedule, ExternalInterface:FunctionalMockupUnitImport:To:Schedule, ExternalInterface:Schedule, Schedule:Compact, Schedule:Constant, Schedule:File, Schedule:Year, Schedule:Year:Rules
`heating_coil_object_type` Heating Coil Object Type	choice		Enter the type of heating coil if included in the unitary system. One of `Coil:Heating:DX:MultiSpeed`, `Coil:Heating:DX:SingleSpeed`, `Coil:Heating:DX:VariableSpeed`, `Coil:Heating:Desuperheater`, `Coil:Heating:Electric`, `Coil:Heating:Electric:MultiStage`, `Coil:Heating:Fuel`, `Coil:Heating:Gas:MultiStage`, `Coil:Heating:Steam`, `Coil:Heating:Water`, `Coil:Heating:WaterToAirHeatPump:EquationFit`, `Coil:Heating:WaterToAirHeatPump:ParameterEstimation`, `Coil:Heating:WaterToAirHeatPump:VariableSpeedEquationFit`, `Coil:UserDefined`
`heating_coil_name` Heating Coil Name	reference		Enter the name of the heating coil if included in the unitary system. Names a Coil:Heating:DX:MultiSpeed, Coil:Heating:DX:SingleSpeed, Coil:Heating:DX:VariableRefrigerantFlow, Coil:Heating:DX:VariableSpeed, Coil:Heating:Desuperheater, Coil:Heating:Electric, Coil:Heating:Electric:MultiStage, Coil:Heating:Fuel, Coil:Heating:Gas:MultiStage, Coil:Heating:Steam, Coil:Heating:Water, Coil:Heating:WaterToAirHeatPump:EquationFit and 3 more
`dx_heating_coil_sizing_ratio` DX Heating Coil Sizing Ratio	number	`1.0`	Used to adjust heat pump heating capacity with respect to DX cooling capacity used only for heat pump configurations (i.e., a DX cooling and DX heating coil is used). Range: > 0
`cooling_coil_object_type` Cooling Coil Object Type	choice		Enter the type of cooling coil if included in the unitary system. One of `Coil:Cooling:DX`, `Coil:Cooling:DX:MultiSpeed`, `Coil:Cooling:DX:SingleSpeed`, `Coil:Cooling:DX:SingleSpeed:ThermalStorage`, `Coil:Cooling:DX:TwoSpeed`, `Coil:Cooling:DX:TwoStageWithHumidityControlMode`, `Coil:Cooling:DX:VariableSpeed`, `Coil:Cooling:Water`, `Coil:Cooling:Water:DetailedGeometry`, `Coil:Cooling:WaterToAirHeatPump:EquationFit`, `Coil:Cooling:WaterToAirHeatPump:ParameterEstimation`, `Coil:Cooling:WaterToAirHeatPump:VariableSpeedEquationFit`, `Coil:UserDefined`, `CoilSystem:Cooling:DX:HeatExchangerAssisted`, `CoilSystem:Cooling:Water:HeatExchangerAssisted`
`cooling_coil_name` Cooling Coil Name	reference		Enter the name of the cooling coil if included in the unitary system. Names a Coil:Cooling:DX, Coil:Cooling:DX:MultiSpeed, Coil:Cooling:DX:SingleSpeed, Coil:Cooling:DX:SingleSpeed:ThermalStorage, Coil:Cooling:DX:TwoSpeed, Coil:Cooling:DX:TwoStageWithHumidityControlMode, Coil:Cooling:DX:VariableSpeed, Coil:Cooling:Water, Coil:Cooling:Water:DetailedGeometry, Coil:Cooling:WaterToAirHeatPump:EquationFit, Coil:Cooling:WaterToAirHeatPump:ParameterEstimation, Coil:Cooling:WaterToAirHeatPump:VariableSpeedEquationFit and 3 more
`use_doas_dx_cooling_coil` Use DOAS DX Cooling Coil	choice	`No`	If Yes, the DX cooling coil runs as 100% DOAS DX coil. If No, the DX cooling coil runs as a regular DX coil. If left blank the default is regular dx coil. One of `No`, `Yes`
`minimum_supply_air_temperature` Minimum Supply Air Temperature	number or `Autosize` C	`2.0`	When Use DOAS DX Cooling Coil is specified as Yes, Minimum Supply Air Temperature defines the minimum DOAS DX cooling coil leaving air temperature that should be maintained to avoid frost formation. This field is not autosizable when the input for Use DOAS DX Cooling Coil = Yes. When Control Type = SingleZoneVAV, enter the minimum air temperature limit for reduced fan speed.
`latent_load_control` Latent Load Control	choice	`SensibleOnlyLoadControl`	SensibleOnlyLoadControl is selected when thermostat or SingleZoneVAV control is used. LatentOnlyLoadControl is selected when humidistat control is used. LatentWithSensibleLoadControl is selected when thermostat control is used and dehumidification is required only when a sensible load exists. LatentOrSensibleLoadControl is selected when thermostat control is used and dehumidification is required any time the humidistat set point is exceeded. One of `LatentOnlyLoadControl`, `LatentOrSensibleLoadControl`, `LatentWithSensibleLoadControl`, `SensibleOnlyLoadControl`
`supplemental_heating_coil_object_type` Supplemental Heating Coil Object Type	choice		Enter the type of supplemental heating or reheat coil if included in the unitary system. Only required if dehumidification control type is "CoolReheat". This coil supplements heating mode operation or reheats the supply air during dehumidification mode operation. If set point based control is used the coils operate to meet their respective supply air temperature set point. One of `Coil:Heating:Desuperheater`, `Coil:Heating:Electric`, `Coil:Heating:Electric:Multistage`, `Coil:Heating:Fuel`, `Coil:Heating:Steam`, `Coil:Heating:Water`, `Coil:UserDefined`
`supplemental_heating_coil_name` Supplemental Heating Coil Name	reference		Enter the name of the supplemental heating coil if included in the unitary system. Only required if dehumidification control type is "CoolReheat". Names a Coil:Heating:Desuperheater, Coil:Heating:Electric, Coil:Heating:Electric:MultiStage, Coil:Heating:Fuel, Coil:Heating:Steam, Coil:Heating:Water, Coil:UserDefined
`cooling_supply_air_flow_rate_method` Cooling Supply Air Flow Rate Method	choice		Enter the method used to determine the cooling supply air volume flow rate. None is used when a cooling coil is not included in the unitary system or this field may be blank. SupplyAirFlowRate is selected when the magnitude of the supply air volume is used. FlowPerFloorArea is selected when the supply air volume flow rate is based on total floor area served by the unitary system. FractionOfAutosizedCoolingValue is selected when the supply air volume is a fraction of the value determined by the simulation. FlowPerCoolingCapacity is selected when the supply air volume is a fraction of the cooling capacity as determined by the simulation. One of `FlowPerCoolingCapacity`, `FlowPerFloorArea`, `FractionOfAutosizedCoolingValue`, `None`, `SupplyAirFlowRate`
`cooling_supply_air_flow_rate` Cooling Supply Air Flow Rate	number or `Autosize` m3/s		Enter the magnitude of the supply air volume flow rate during cooling operation. Required field when Cooling Supply Air Flow Rate Method is SupplyAirFlowRate. This field may be blank if a cooling coil is not included in the unitary system.
`cooling_supply_air_flow_rate_per_floor_area` Cooling Supply Air Flow Rate Per Floor Area	number m3/s-m2		Enter the supply air volume flow rate per total floor area fraction. Required field when Cooling Supply Air Flow Rate Method is FlowPerFloorArea. This field may be blank if a cooling coil is not included in the unitary system. Range: ≥ 0
`cooling_fraction_of_autosized_cooling_supply_air_flow_rate` Cooling Fraction of Autosized Cooling Supply Air Flow Rate	number		Enter the supply air volume flow rate as a fraction of the cooling supply air flow rate. Required field when Cooling Supply Air Flow Rate Method is FractionOfAutosizedCoolingValue. This field may be blank if a cooling coil is not included in the unitary system. Range: ≥ 0
`cooling_supply_air_flow_rate_per_unit_of_capacity` Cooling Supply Air Flow Rate Per Unit of Capacity	number m3/s-W		Enter the supply air volume flow rate as a fraction of the cooling capacity. Required field when Cooling Supply Air Flow Rate Method is FlowPerCoolingCapacity. This field may be blank if a cooling coil is not included in the unitary system. Range: ≥ 0
`heating_supply_air_flow_rate_method` Heating Supply Air Flow Rate Method	choice		Enter the method used to determine the heating supply air volume flow rate. None is used when a heating coil is not included in the unitary system or this field may be blank. SupplyAirFlowRate is selected when the magnitude of the supply air volume is used. FlowPerFloorArea is selected when the supply air volume flow rate is based on total floor area served by the unitary system. FractionOfAutosizedHeatingValue is selected when the supply air volume is a fraction of the value determined by the simulation. FlowPerHeatingCapacity is selected when the supply air volume is a fraction of the heating capacity as determined by the simulation. One of `FlowPerFloorArea`, `FlowPerHeatingCapacity`, `FractionOfAutosizedHeatingValue`, `None`, `SupplyAirFlowRate`
`heating_supply_air_flow_rate` Heating Supply Air Flow Rate	number or `Autosize` m3/s		Enter the magnitude of the supply air volume flow rate during heating operation. Required field when Heating Supply Air Flow Rate Method is SupplyAirFlowRate. This field may be blank if a heating coil is not included in the unitary system.
`heating_supply_air_flow_rate_per_floor_area` Heating Supply Air Flow Rate Per Floor Area	number m3/s-m2		Enter the supply air volume flow rate per total floor area fraction. Required field when Heating Supply Air Flow Rate Method is FlowPerFloorArea. This field may be blank if a heating coil is not included in the unitary system. Range: ≥ 0
`heating_fraction_of_autosized_heating_supply_air_flow_rate` Heating Fraction of Autosized Heating Supply Air Flow Rate	number		Enter the supply air volume flow rate as a fraction of the heating supply air flow rate. Required field when Heating Supply Air Flow Rate Method is FractionOfAutosizedHeatingValue. This field may be blank if a heating coil is not included in the unitary system. Range: ≥ 0
`heating_supply_air_flow_rate_per_unit_of_capacity` Heating Supply Air Flow Rate Per Unit of Capacity	number m3/s-W		Enter the supply air volume flow rate as a fraction of the heating capacity. Required field when Heating Supply Air Flow Rate Method is FlowPerHeatingCapacity. This field may be blank if a heating coil is not included in the unitary system. Range: ≥ 0
`no_load_supply_air_flow_rate_method` No Load Supply Air Flow Rate Method	choice		Enter the method used to determine the supply air volume flow rate when no cooling or heating is required. None is used when a cooling and heating coil is not included in the unitary system or this field may be blank. SupplyAirFlowRate is selected when the magnitude of the supply air volume is used. FlowPerFloorArea is selected when the supply air volume flow rate is based on total floor area served by the unitary system. FractionOfAutosizedCoolingValue is selected when the supply air volume is a fraction of the cooling value determined by the simulation. FractionOfAutosizedHeatingValue is selected when the supply air volume is a fraction of the heating value determined by the simulation. FlowPerCoolingCapacity is selected when the supply air volume is a fraction of the cooling capacity as determined by the simulation. FlowPerHeatingCapacity is selected when the supply air volume is a fraction of the heating capacity as determined by the simulation. One of `FlowPerCoolingCapacity`, `FlowPerFloorArea`, `FlowPerHeatingCapacity`, `FractionOfAutosizedCoolingValue`, `FractionOfAutosizedHeatingValue`, `None`, `SupplyAirFlowRate`
`no_load_supply_air_flow_rate` No Load Supply Air Flow Rate	number or `Autosize` m3/s		Enter the magnitude of the supply air volume flow rate during when no cooling or heating is required. Required field when No Load Supply Air Flow Rate Method is SupplyAirFlowRate.
`no_load_supply_air_flow_rate_per_floor_area` No Load Supply Air Flow Rate Per Floor Area	number m3/s-m2		Enter the supply air volume flow rate per total floor area fraction. Required field when No Load Supply Air Flow Rate Method is FlowPerFloorArea. Range: ≥ 0
`no_load_fraction_of_autosized_cooling_supply_air_flow_rate` No Load Fraction of Autosized Cooling Supply Air Flow Rate	number		Enter the supply air volume flow rate as a fraction of the cooling supply air flow rate. Required field when No Load Supply Air Flow Rate Method is FractionOfAutosizedCoolingValue. Range: ≥ 0
`no_load_fraction_of_autosized_heating_supply_air_flow_rate` No Load Fraction of Autosized Heating Supply Air Flow Rate	number		Enter the supply air volume flow rate as a fraction of the heating supply air flow rate. Required field when No Load Supply Air Flow Rate Method is FractionOfAutosizedHeatingValue. Range: ≥ 0
`no_load_supply_air_flow_rate_per_unit_of_capacity_during_cooling_operation` No Load Supply Air Flow Rate Per Unit of Capacity During Cooling Operation	number m3/s-W		Enter the supply air volume flow rate as a fraction of the cooling capacity. Required field when No Load Supply Air Flow Rate Method is FlowPerCoolingCapacity. Range: ≥ 0
`no_load_supply_air_flow_rate_per_unit_of_capacity_during_heating_operation` No Load Supply Air Flow Rate Per Unit of Capacity During Heating Operation	number m3/s-W		Enter the supply air volume flow rate as a fraction of the heating capacity. Required field when No Load Supply Air Flow Rate Method is FlowPerHeatingCapacity. Range: ≥ 0
`no_load_supply_air_flow_rate_control_set_to_low_speed` No Load Supply Air Flow Rate Control Set To Low Speed	choice	`Yes`	This field is not used when Design Specification Multispeed Object Type input is present When Yes is selected the minimum air flow rate is used. When No is selected the maximum air flow rate is used. One of `No`, `Yes`
`maximum_supply_air_temperature` Maximum Supply Air Temperature	number or `Autosize` C	`80.0`	Enter the maximum supply air temperature leaving the heating coil. When Control Type = SingleZoneVAV, enter the maximum air temperature limit for reduced fan speed.
`maximum_outdoor_dry_bulb_temperature_for_supplemental_heater_operation` Maximum Outdoor Dry-Bulb Temperature for Supplemental Heater Operation	number C	`21.0`	Enter the maximum outdoor dry-bulb temperature for supplemental heater operation.
`outdoor_dry_bulb_temperature_sensor_node_name` Outdoor Dry-Bulb Temperature Sensor Node Name	string		If this field is blank, outdoor temperature from the weather file is used. If this field is not blank, the node name specified determines the outdoor temperature used for controlling supplemental heater operation.
`ancillary_on_cycle_electric_power` Ancillary On-Cycle Electric Power	number W	`0.0`	Enter the value of ancillary electric power for controls or other devices consumed during the on cycle. Range: ≥ 0
`ancillary_off_cycle_electric_power` Ancillary Off-Cycle Electric Power	number W	`0.0`	Enter the value of ancillary electric power for controls or other devices consumed during the off cycle. Range: ≥ 0
`design_heat_recovery_water_flow_rate` Design Heat Recovery Water Flow Rate	number m3/s	`0.0`	If non-zero, then the heat recovery inlet and outlet node names must be entered. Used for heat recovery to an EnergyPlus plant loop. Range: ≥ 0
`maximum_temperature_for_heat_recovery` Maximum Temperature for Heat Recovery	number C	`80.0`	Enter the maximum heat recovery inlet temperature allowed for heat recovery. Range: ≥ 0, ≤ 100
`heat_recovery_water_inlet_node_name` Heat Recovery Water Inlet Node Name	string		Enter the name of the heat recovery water inlet node if plant water loop connections are present.
`heat_recovery_water_outlet_node_name` Heat Recovery Water Outlet Node Name	string		Enter the name of the heat recovery water outlet node if plant water loop connections are present.
`design_specification_multispeed_object_type` Design Specification Multispeed Object Type	choice		Enter the type of performance specification object used to describe the multispeed coil. One of `UnitarySystemPerformance:Multispeed`
`design_specification_multispeed_object_name` Design Specification Multispeed Object Name	reference		The name of the performance specification object used to describe the multispeed coil. Names a UnitarySystemPerformance:Multispeed

Referenced by 7 object types

AirLoopHVAC:DedicatedOutdoorAirSystem, AirLoopHVAC:OutdoorAirSystem:EquipmentList, AirTerminal:SingleDuct:Mixer, Branch, FaultModel:TemperatureSensorOffset:CoilSupplyAir, SpaceHVAC:ZoneEquipmentSplitter, ZoneHVAC:EquipmentList

UnitarySystemPerformance:Multispeed¶

from idfpy.models import UnitarySystemPerformanceMultispeed extensible

The UnitarySystemPerformance object is used to specify the air flow ratio at each operating speed. This object is primarily used for multispeed DX and water coils to allow operation at alternate flow rates different from those specified in the coil object.

Field	Type	Default	Details
`name` Name required	string
`number_of_speeds_for_heating` Number of Speeds for Heating required	integer		Used only for Multi speed coils Enter the number of the following sets of data for air flow rates. Range: ≥ 0, ≤ 10
`number_of_speeds_for_cooling` Number of Speeds for Cooling required	integer		Used only for Multi speed coils Enter the number of the following sets of data for air flow rates. Range: ≥ 0, ≤ 10
`single_mode_operation` Single Mode Operation	choice	`No`	Controls coil operation during each HVAC timestep. This choice does not apply to speed 1 operation. Yes = operate at the highest speed possible without exceeding the current load. No = allow operation at the average of two adjacent speeds to match the current load. One of `No`, `Yes`
`no_load_supply_air_flow_rate_ratio` No Load Supply Air Flow Rate Ratio	number	`1.0`	Used to define the no load operating air flow rate when the system fan is specified to operate continuously. Range: ≥ 0, ≤ 1
`flow_ratios`	list		Each item: `heating_speed_supply_air_flow_ratio`, `cooling_speed_supply_air_flow_ratio`

Referenced by 3 object types

AirLoopHVAC:UnitarySystem, ZoneHVAC:TerminalUnit:VariableRefrigerantFlow, ZoneHVAC:WaterToAirHeatPump