pyidf.setpoint_managers module

Data objects in group “Setpoint Managers”

class pyidf.setpoint_managers.SetpointManagerColdest

Bases: pyidf.helper.DataObject

Corresponds to IDD object SetpointManager:Coldest This SetpointManager is used in dual duct systems to reset the setpoint temperature of the air in the heating supply duct. Usually it is used in conjunction with a SetpointManager:Warmest resetting the temperature of the air in the cooling supply duct.

control_variable

field Control Variable

Default value: Temperature

Parameters:value (str) – value for IDD Field Control Variable Raises:ValueError – if value is not a valid value Returns:the value of control_variable or None if not set Return type:str

hvac_air_loop_name

field HVAC Air Loop Name

Enter the name of an AirLoopHVAC object.

Parameters:value (str) – value for IDD Field HVAC Air Loop Name Raises:ValueError – if value is not a valid value Returns:the value of hvac_air_loop_name or None if not set Return type:str

maximum_setpoint_temperature

field Maximum Setpoint Temperature

Units: C

Default value: 50.0

Parameters:value (float) – value for IDD Field Maximum Setpoint Temperature Raises:ValueError – if value is not a valid value Returns:the value of maximum_setpoint_temperature or None if not set Return type:float

minimum_setpoint_temperature

field Minimum Setpoint Temperature

Units: C

Default value: 20.0

Parameters:value (float) – value for IDD Field Minimum Setpoint Temperature Raises:ValueError – if value is not a valid value Returns:the value of minimum_setpoint_temperature or None if not set Return type:float

name

field Name

Parameters:value (str) – value for IDD Field Name Raises:ValueError – if value is not a valid value Returns:the value of name or None if not set Return type:str

setpoint_node_or_nodelist_name

field Setpoint Node or NodeList Name

Node(s) at which the temperature will be set

Parameters:value (str) – value for IDD Field Setpoint Node or NodeList Name Raises:ValueError – if value is not a valid value Returns:the value of setpoint_node_or_nodelist_name or None if not set Return type:str

strategy

field Strategy

Default value: MinimumTemperature

Parameters:value (str) – value for IDD Field Strategy Raises:ValueError – if value is not a valid value Returns:the value of strategy or None if not set Return type:str

class pyidf.setpoint_managers.SetpointManagerCondenserEnteringReset

Bases: pyidf.helper.DataObject

Corresponds to IDD object SetpointManager:CondenserEnteringReset This setpoint manager uses one curve to determine the optimum condenser entering water temperature for a given timestep and two other curves to place boundary conditions on the setpoint value.

control_variable

field Control Variable

Default value: Temperature

Parameters:value (str) – value for IDD Field Control Variable Raises:ValueError – if value is not a valid value Returns:the value of control_variable or None if not set Return type:str

cooling_tower_design_inlet_air_wetbulb_temperature

field Cooling Tower Design Inlet Air Wet-Bulb Temperature

Units: C

Default value: 25.56

Parameters:value (float) – value for IDD Field Cooling Tower Design Inlet Air Wet-Bulb Temperature Raises:ValueError – if value is not a valid value Returns:the value of cooling_tower_design_inlet_air_wetbulb_temperature or None if not set Return type:float

default_condenser_entering_water_temperature_schedule_name

field Default Condenser Entering Water Temperature Schedule Name

This scheduled setpoint value is only used in a given timestep if the

“Optimized” Condenser Entering Temperature does not fall within the prescribed

boundary conditions.

Parameters:value (str) – value for IDD Field Default Condenser Entering Water Temperature Schedule Name Raises:ValueError – if value is not a valid value Returns:the value of default_condenser_entering_water_temperature_schedule_name or None if not set Return type:str

maximum_condenser_entering_water_temperature

field Maximum Condenser Entering Water Temperature

Units: C

Default value: 32.0

Parameters:value (float) – value for IDD Field Maximum Condenser Entering Water Temperature Raises:ValueError – if value is not a valid value Returns:the value of maximum_condenser_entering_water_temperature or None if not set Return type:float

minimum_design_wetbulb_temperature_curve_name

field Minimum Design Wetbulb Temperature Curve Name

Parameters:value (str) – value for IDD Field Minimum Design Wetbulb Temperature Curve Name Raises:ValueError – if value is not a valid value Returns:the value of minimum_design_wetbulb_temperature_curve_name or None if not set Return type:str

minimum_lift

field Minimum Lift

Units: deltaC

Default value: 11.1

Parameters:value (float) – value for IDD Field Minimum Lift Raises:ValueError – if value is not a valid value Returns:the value of minimum_lift or None if not set Return type:float

minimum_outside_air_wetbulb_temperature_curve_name

field Minimum Outside Air Wetbulb Temperature Curve Name

Parameters:value (str) – value for IDD Field Minimum Outside Air Wetbulb Temperature Curve Name Raises:ValueError – if value is not a valid value Returns:the value of minimum_outside_air_wetbulb_temperature_curve_name or None if not set Return type:str

name

field Name

Parameters:value (str) – value for IDD Field Name Raises:ValueError – if value is not a valid value Returns:the value of name or None if not set Return type:str

optimized_cond_entering_water_temperature_curve_name

field Optimized Cond Entering Water Temperature Curve Name

Parameters:value (str) – value for IDD Field Optimized Cond Entering Water Temperature Curve Name Raises:ValueError – if value is not a valid value Returns:the value of optimized_cond_entering_water_temperature_curve_name or None if not set Return type:str

setpoint_node_or_nodelist_name

field Setpoint Node or NodeList Name

Node(s) at which control variable will be set

Parameters:value (str) – value for IDD Field Setpoint Node or NodeList Name Raises:ValueError – if value is not a valid value Returns:the value of setpoint_node_or_nodelist_name or None if not set Return type:str

class pyidf.setpoint_managers.SetpointManagerCondenserEnteringResetIdeal

Bases: pyidf.helper.DataObject

Corresponds to IDD object SetpointManager:CondenserEnteringReset:Ideal This setpoint manager determine the ideal optimum condenser entering water temperature setpoint for a given timestep.

control_variable

field Control Variable

Default value: Temperature

Parameters:value (str) – value for IDD Field Control Variable Raises:ValueError – if value is not a valid value Returns:the value of control_variable or None if not set Return type:str

maximum_condenser_entering_water_temperature

field Maximum Condenser Entering Water Temperature

Units: C

Default value: 32.0

Parameters:value (float) – value for IDD Field Maximum Condenser Entering Water Temperature Raises:ValueError – if value is not a valid value Returns:the value of maximum_condenser_entering_water_temperature or None if not set Return type:float

minimum_lift

field Minimum Lift

Units: deltaC

Default value: 11.1

Parameters:value (float) – value for IDD Field Minimum Lift Raises:ValueError – if value is not a valid value Returns:the value of minimum_lift or None if not set Return type:float

name

field Name

Parameters:value (str) – value for IDD Field Name Raises:ValueError – if value is not a valid value Returns:the value of name or None if not set Return type:str

setpoint_node_or_nodelist_name

field Setpoint Node or NodeList Name

Node(s) at which control variable will be set

Parameters:value (str) – value for IDD Field Setpoint Node or NodeList Name Raises:ValueError – if value is not a valid value Returns:the value of setpoint_node_or_nodelist_name or None if not set Return type:str

class pyidf.setpoint_managers.SetpointManagerFollowGroundTemperature

Bases: pyidf.helper.DataObject

Corresponds to IDD object SetpointManager:FollowGroundTemperature This setpoint manager is used to place a temperature setpoint on a system node that is derived from a current ground temperature. The ground temperatures are specified in different Site:GroundTemperature:* objects and used during the simulation. This setpoint manager is primarily intended for condenser or plant loops using some type of ground heat exchanger.

control_variable

field Control Variable

Default value: Temperature

Parameters:value (str) – value for IDD Field Control Variable Raises:ValueError – if value is not a valid value Returns:the value of control_variable or None if not set Return type:str

maximum_setpoint_temperature

field Maximum Setpoint Temperature

Units: C

Parameters:value (float) – value for IDD Field Maximum Setpoint Temperature Raises:ValueError – if value is not a valid value Returns:the value of maximum_setpoint_temperature or None if not set Return type:float

minimum_setpoint_temperature

field Minimum Setpoint Temperature

Units: C

Parameters:value (float) – value for IDD Field Minimum Setpoint Temperature Raises:ValueError – if value is not a valid value Returns:the value of minimum_setpoint_temperature or None if not set Return type:float

name

field Name

Parameters:value (str) – value for IDD Field Name Raises:ValueError – if value is not a valid value Returns:the value of name or None if not set Return type:str

offset_temperature_difference

field Offset Temperature Difference

Units: deltaC

Parameters:value (float) – value for IDD Field Offset Temperature Difference Raises:ValueError – if value is not a valid value Returns:the value of offset_temperature_difference or None if not set Return type:float

reference_ground_temperature_object_type

field Reference Ground Temperature Object Type

Parameters:value (str) – value for IDD Field Reference Ground Temperature Object Type Raises:ValueError – if value is not a valid value Returns:the value of reference_ground_temperature_object_type or None if not set Return type:str

setpoint_node_or_nodelist_name

field Setpoint Node or NodeList Name

Node(s) at which control variable will be set

Parameters:value (str) – value for IDD Field Setpoint Node or NodeList Name Raises:ValueError – if value is not a valid value Returns:the value of setpoint_node_or_nodelist_name or None if not set Return type:str

class pyidf.setpoint_managers.SetpointManagerFollowOutdoorAirTemperature

Bases: pyidf.helper.DataObject

Corresponds to IDD object SetpointManager:FollowOutdoorAirTemperature This setpoint manager is used to place a temperature setpoint on a system node that is derived from the current outdoor air environmental conditions. The outdoor air conditions are obtained from the weather information during the simulation.

control_variable

field Control Variable

Default value: Temperature

Parameters:value (str) – value for IDD Field Control Variable Raises:ValueError – if value is not a valid value Returns:the value of control_variable or None if not set Return type:str

maximum_setpoint_temperature

field Maximum Setpoint Temperature

Units: C

Parameters:value (float) – value for IDD Field Maximum Setpoint Temperature Raises:ValueError – if value is not a valid value Returns:the value of maximum_setpoint_temperature or None if not set Return type:float

minimum_setpoint_temperature

field Minimum Setpoint Temperature

Units: C

Parameters:value (float) – value for IDD Field Minimum Setpoint Temperature Raises:ValueError – if value is not a valid value Returns:the value of minimum_setpoint_temperature or None if not set Return type:float

name

field Name

Parameters:value (str) – value for IDD Field Name Raises:ValueError – if value is not a valid value Returns:the value of name or None if not set Return type:str

offset_temperature_difference

field Offset Temperature Difference

Units: deltaC

Parameters:value (float) – value for IDD Field Offset Temperature Difference Raises:ValueError – if value is not a valid value Returns:the value of offset_temperature_difference or None if not set Return type:float

reference_temperature_type

field Reference Temperature Type

Default value: OutdoorAirWetBulb

Parameters:value (str) – value for IDD Field Reference Temperature Type Raises:ValueError – if value is not a valid value Returns:the value of reference_temperature_type or None if not set Return type:str

setpoint_node_or_nodelist_name

field Setpoint Node or NodeList Name

Node(s) at which control variable will be set

Parameters:value (str) – value for IDD Field Setpoint Node or NodeList Name Raises:ValueError – if value is not a valid value Returns:the value of setpoint_node_or_nodelist_name or None if not set Return type:str

class pyidf.setpoint_managers.SetpointManagerFollowSystemNodeTemperature

Bases: pyidf.helper.DataObject

Corresponds to IDD object SetpointManager:FollowSystemNodeTemperature This setpoint manager is used to place a temperature setpoint on a system node that is derived from the current temperatures at a separate system node. The current value of the temperature at a reference node is obtained and used to generate setpoint on a second system node. If the reference node is also designated to be an outdoor air (intake) node, then this setpoint manager can be used to follow outdoor air conditions that are adjusted for altitude.

control_variable

field Control Variable

Default value: Temperature

Parameters:value (str) – value for IDD Field Control Variable Raises:ValueError – if value is not a valid value Returns:the value of control_variable or None if not set Return type:str

maximum_limit_setpoint_temperature

field Maximum Limit Setpoint Temperature

Units: C

Parameters:value (float) – value for IDD Field Maximum Limit Setpoint Temperature Raises:ValueError – if value is not a valid value Returns:the value of maximum_limit_setpoint_temperature or None if not set Return type:float

minimum_limit_setpoint_temperature

field Minimum Limit Setpoint Temperature

Units: C

Parameters:value (float) – value for IDD Field Minimum Limit Setpoint Temperature Raises:ValueError – if value is not a valid value Returns:the value of minimum_limit_setpoint_temperature or None if not set Return type:float

name

field Name

Parameters:value (str) – value for IDD Field Name Raises:ValueError – if value is not a valid value Returns:the value of name or None if not set Return type:str

offset_temperature_difference

field Offset Temperature Difference

Units: deltaC

Parameters:value (float) – value for IDD Field Offset Temperature Difference Raises:ValueError – if value is not a valid value Returns:the value of offset_temperature_difference or None if not set Return type:float

reference_node_name

field Reference Node Name

Parameters:value (str) – value for IDD Field Reference Node Name Raises:ValueError – if value is not a valid value Returns:the value of reference_node_name or None if not set Return type:str

reference_temperature_type

field Reference Temperature Type

Default value: NodeDryBulb

Parameters:value (str) – value for IDD Field Reference Temperature Type Raises:ValueError – if value is not a valid value Returns:the value of reference_temperature_type or None if not set Return type:str

setpoint_node_or_nodelist_name

field Setpoint Node or NodeList Name

Node(s) at which control variable will be set

Parameters:value (str) – value for IDD Field Setpoint Node or NodeList Name Raises:ValueError – if value is not a valid value Returns:the value of setpoint_node_or_nodelist_name or None if not set Return type:str

class pyidf.setpoint_managers.SetpointManagerMixedAir

Bases: pyidf.helper.DataObject

Corresponds to IDD object SetpointManager:MixedAir The Mixed Air Setpoint Manager is meant to be used in conjunction with a Controller:OutdoorAir object. This setpoint manager is used to establish a temperature setpoint at the mixed air node.

control_variable

field Control Variable

Default value: Temperature

Parameters:value (str) – value for IDD Field Control Variable Raises:ValueError – if value is not a valid value Returns:the value of control_variable or None if not set Return type:str

fan_inlet_node_name

field Fan Inlet Node Name

Parameters:value (str) – value for IDD Field Fan Inlet Node Name Raises:ValueError – if value is not a valid value Returns:the value of fan_inlet_node_name or None if not set Return type:str

fan_outlet_node_name

field Fan Outlet Node Name

Parameters:value (str) – value for IDD Field Fan Outlet Node Name Raises:ValueError – if value is not a valid value Returns:the value of fan_outlet_node_name or None if not set Return type:str

name

field Name

Parameters:value (str) – value for IDD Field Name Raises:ValueError – if value is not a valid value Returns:the value of name or None if not set Return type:str

reference_setpoint_node_name

field Reference Setpoint Node Name

Parameters:value (str) – value for IDD Field Reference Setpoint Node Name Raises:ValueError – if value is not a valid value Returns:the value of reference_setpoint_node_name or None if not set Return type:str

setpoint_node_or_nodelist_name

field Setpoint Node or NodeList Name

Node(s) at which the temperature will be set

Parameters:value (str) – value for IDD Field Setpoint Node or NodeList Name Raises:ValueError – if value is not a valid value Returns:the value of setpoint_node_or_nodelist_name or None if not set Return type:str

class pyidf.setpoint_managers.SetpointManagerMultiZoneCoolingAverage

Bases: pyidf.helper.DataObject

Corresponds to IDD object SetpointManager:MultiZone:Cooling:Average This setpoint manager sets the average supply air temperature based on the cooling load requirements of all controlled zones in an air loop served by a central air-conditioner.

hvac_air_loop_name

field HVAC Air Loop Name

Enter the name of an AirLoopHVAC object

Parameters:value (str) – value for IDD Field HVAC Air Loop Name Raises:ValueError – if value is not a valid value Returns:the value of hvac_air_loop_name or None if not set Return type:str

maximum_setpoint_temperature

field Maximum Setpoint Temperature

Units: C

Default value: 18.0

Parameters:value (float) – value for IDD Field Maximum Setpoint Temperature Raises:ValueError – if value is not a valid value Returns:the value of maximum_setpoint_temperature or None if not set Return type:float

minimum_setpoint_temperature

field Minimum Setpoint Temperature

Units: C

Default value: 12.0

Parameters:value (float) – value for IDD Field Minimum Setpoint Temperature Raises:ValueError – if value is not a valid value Returns:the value of minimum_setpoint_temperature or None if not set Return type:float

name

field Name

Parameters:value (str) – value for IDD Field Name Raises:ValueError – if value is not a valid value Returns:the value of name or None if not set Return type:str

setpoint_node_or_nodelist_name

field Setpoint Node or NodeList Name

Node(s) at which the temperature will be set

Parameters:value (str) – value for IDD Field Setpoint Node or NodeList Name Raises:ValueError – if value is not a valid value Returns:the value of setpoint_node_or_nodelist_name or None if not set Return type:str

class pyidf.setpoint_managers.SetpointManagerMultiZoneHeatingAverage

Bases: pyidf.helper.DataObject

Corresponds to IDD object SetpointManager:MultiZone:Heating:Average This setpoint manager sets the average supply air temperature based on the heating load requirements of all controlled zones in an air loop served by a central air-conditioner.

hvac_air_loop_name

field HVAC Air Loop Name

Enter the name of an AirLoopHVAC object

Parameters:value (str) – value for IDD Field HVAC Air Loop Name Raises:ValueError – if value is not a valid value Returns:the value of hvac_air_loop_name or None if not set Return type:str

maximum_setpoint_temperature

field Maximum Setpoint Temperature

Units: C

Default value: 50.0

Parameters:value (float) – value for IDD Field Maximum Setpoint Temperature Raises:ValueError – if value is not a valid value Returns:the value of maximum_setpoint_temperature or None if not set Return type:float

minimum_setpoint_temperature

field Minimum Setpoint Temperature

Units: C

Default value: 20.0

Parameters:value (float) – value for IDD Field Minimum Setpoint Temperature Raises:ValueError – if value is not a valid value Returns:the value of minimum_setpoint_temperature or None if not set Return type:float

name

field Name

Parameters:value (str) – value for IDD Field Name Raises:ValueError – if value is not a valid value Returns:the value of name or None if not set Return type:str

setpoint_node_or_nodelist_name

field Setpoint Node or NodeList Name

Node(s) at which the temperature will be set

Parameters:value (str) – value for IDD Field Setpoint Node or NodeList Name Raises:ValueError – if value is not a valid value Returns:the value of setpoint_node_or_nodelist_name or None if not set Return type:str

class pyidf.setpoint_managers.SetpointManagerMultiZoneHumidityMaximum

Bases: pyidf.helper.DataObject

Corresponds to IDD object SetpointManager:MultiZone:Humidity:Maximum This setpoint manager sets the maximum supply air humidity ratio based on dehumidification requirements of a controlled zone with critical humidity ratio setpoint (i.e., a zone with the lowest humidity ratio setpoint) in an air loop served by a central air-conditioner.

hvac_air_loop_name

field HVAC Air Loop Name

Enter the name of an AirLoopHVAC object

Parameters:value (str) – value for IDD Field HVAC Air Loop Name Raises:ValueError – if value is not a valid value Returns:the value of hvac_air_loop_name or None if not set Return type:str

maximum_setpoint_humidity_ratio

field Maximum Setpoint Humidity Ratio

Units: kgWater/kgDryAir

Default value: 0.015

Parameters:value (float) – value for IDD Field Maximum Setpoint Humidity Ratio Raises:ValueError – if value is not a valid value Returns:the value of maximum_setpoint_humidity_ratio or None if not set Return type:float

minimum_setpoint_humidity_ratio

field Minimum Setpoint Humidity Ratio

Units: kgWater/kgDryAir

Default value: 0.008

Parameters:value (float) – value for IDD Field Minimum Setpoint Humidity Ratio Raises:ValueError – if value is not a valid value Returns:the value of minimum_setpoint_humidity_ratio or None if not set Return type:float

name

field Name

Parameters:value (str) – value for IDD Field Name Raises:ValueError – if value is not a valid value Returns:the value of name or None if not set Return type:str

setpoint_node_or_nodelist_name

field Setpoint Node or NodeList Name

Node(s) at which the humidity ratio will be set

Parameters:value (str) – value for IDD Field Setpoint Node or NodeList Name Raises:ValueError – if value is not a valid value Returns:the value of setpoint_node_or_nodelist_name or None if not set Return type:str

class pyidf.setpoint_managers.SetpointManagerMultiZoneHumidityMinimum

Bases: pyidf.helper.DataObject

Corresponds to IDD object SetpointManager:MultiZone:Humidity:Minimum This setpoint manager sets the minimum supply air humidity ratio based on humidification requirements of a controlled zone with critical humidity ratio setpoint (i.e., a zone with the highest humidity ratio setpoint) in an air loop served by a central air-conditioner.

hvac_air_loop_name

field HVAC Air Loop Name

Enter the name of an AirLoopHVAC object

Parameters:value (str) – value for IDD Field HVAC Air Loop Name Raises:ValueError – if value is not a valid value Returns:the value of hvac_air_loop_name or None if not set Return type:str

maximum_setpoint_humidity_ratio

field Maximum Setpoint Humidity Ratio

Units: kgWater/kgDryAir

Default value: 0.012

Parameters:value (float) – value for IDD Field Maximum Setpoint Humidity Ratio Raises:ValueError – if value is not a valid value Returns:the value of maximum_setpoint_humidity_ratio or None if not set Return type:float

minimum_setpoint_humidity_ratio

field Minimum Setpoint Humidity Ratio

Units: kgWater/kgDryAir

Default value: 0.005

Parameters:value (float) – value for IDD Field Minimum Setpoint Humidity Ratio Raises:ValueError – if value is not a valid value Returns:the value of minimum_setpoint_humidity_ratio or None if not set Return type:float

name

field Name

Parameters:value (str) – value for IDD Field Name Raises:ValueError – if value is not a valid value Returns:the value of name or None if not set Return type:str

setpoint_node_or_nodelist_name

field Setpoint Node or NodeList Name

Node(s) at which the humidity ratio will be set

Parameters:value (str) – value for IDD Field Setpoint Node or NodeList Name Raises:ValueError – if value is not a valid value Returns:the value of setpoint_node_or_nodelist_name or None if not set Return type:str

class pyidf.setpoint_managers.SetpointManagerMultiZoneMaximumHumidityAverage

Bases: pyidf.helper.DataObject

Corresponds to IDD object SetpointManager:MultiZone:MaximumHumidity:Average This setpoint manager sets the average supply air maximum humidity ratio based on moisture load requirements of all controlled zones in an air loop served by a central air-conditioner.

hvac_air_loop_name

field HVAC Air Loop Name

Enter the name of an AirLoopHVAC object

Parameters:value (str) – value for IDD Field HVAC Air Loop Name Raises:ValueError – if value is not a valid value Returns:the value of hvac_air_loop_name or None if not set Return type:str

maximum_setpoint_humidity_ratio

field Maximum Setpoint Humidity Ratio

Units: kgWater/kgDryAir

Default value: 0.015

Parameters:value (float) – value for IDD Field Maximum Setpoint Humidity Ratio Raises:ValueError – if value is not a valid value Returns:the value of maximum_setpoint_humidity_ratio or None if not set Return type:float

minimum_setpoint_humidity_ratio

field Minimum Setpoint Humidity Ratio

Units: kgWater/kgDryAir

Default value: 0.008

Parameters:value (float) – value for IDD Field Minimum Setpoint Humidity Ratio Raises:ValueError – if value is not a valid value Returns:the value of minimum_setpoint_humidity_ratio or None if not set Return type:float

name

field Name

Parameters:value (str) – value for IDD Field Name Raises:ValueError – if value is not a valid value Returns:the value of name or None if not set Return type:str

setpoint_node_or_nodelist_name

field Setpoint Node or NodeList Name

Node(s) at which the humidity ratio will be set

Parameters:value (str) – value for IDD Field Setpoint Node or NodeList Name Raises:ValueError – if value is not a valid value Returns:the value of setpoint_node_or_nodelist_name or None if not set Return type:str

class pyidf.setpoint_managers.SetpointManagerMultiZoneMinimumHumidityAverage

Bases: pyidf.helper.DataObject

Corresponds to IDD object SetpointManager:MultiZone:MinimumHumidity:Average This setpoint manager sets the average supply air minimum humidity ratio based on moisture load requirements of all controlled zones in an air loop served by a central air-conditioner.

hvac_air_loop_name

field HVAC Air Loop Name

Enter the name of an AirLoopHVAC object

Parameters:value (str) – value for IDD Field HVAC Air Loop Name Raises:ValueError – if value is not a valid value Returns:the value of hvac_air_loop_name or None if not set Return type:str

maximum_setpoint_humidity_ratio

field Maximum Setpoint Humidity Ratio

Units: kgWater/kgDryAir

Default value: 0.012

Parameters:value (float) – value for IDD Field Maximum Setpoint Humidity Ratio Raises:ValueError – if value is not a valid value Returns:the value of maximum_setpoint_humidity_ratio or None if not set Return type:float

minimum_setpoint_humidity_ratio

field Minimum Setpoint Humidity Ratio

Units: kgWater/kgDryAir

Default value: 0.005

Parameters:value (float) – value for IDD Field Minimum Setpoint Humidity Ratio Raises:ValueError – if value is not a valid value Returns:the value of minimum_setpoint_humidity_ratio or None if not set Return type:float

name

field Name

Parameters:value (str) – value for IDD Field Name Raises:ValueError – if value is not a valid value Returns:the value of name or None if not set Return type:str

setpoint_node_or_nodelist_name

field Setpoint Node or NodeList Name

Node(s) at which the humidity ratio will be set

Parameters:value (str) – value for IDD Field Setpoint Node or NodeList Name Raises:ValueError – if value is not a valid value Returns:the value of setpoint_node_or_nodelist_name or None if not set Return type:str

class pyidf.setpoint_managers.SetpointManagerOutdoorAirPretreat

Bases: pyidf.helper.DataObject

Corresponds to IDD object SetpointManager:OutdoorAirPretreat This setpoint manager determines the required conditions at the outdoor air stream node which will produce the reference setpoint condition at the mixed air node when mixed with the return air stream

control_variable

field Control Variable

Parameters:value (str) – value for IDD Field Control Variable Raises:ValueError – if value is not a valid value Returns:the value of control_variable or None if not set Return type:str

maximum_setpoint_humidity_ratio

field Maximum Setpoint Humidity Ratio

Applicable only if Control variable is

MaximumHumidityRatio, MinimumHumidityRatio, or HumidityRatio - then minimum is 0.00001

Units: kgWater/kgDryAir

Default value: 1.0

value <= 1.0

Parameters:value (float) – value for IDD Field Maximum Setpoint Humidity Ratio Raises:ValueError – if value is not a valid value Returns:the value of maximum_setpoint_humidity_ratio or None if not set Return type:float

maximum_setpoint_temperature

field Maximum Setpoint Temperature

Applicable only if Control variable is Temperature

Units: C

Default value: 99.0

Parameters:value (float) – value for IDD Field Maximum Setpoint Temperature Raises:ValueError – if value is not a valid value Returns:the value of maximum_setpoint_temperature or None if not set Return type:float

minimum_setpoint_humidity_ratio

field Minimum Setpoint Humidity Ratio

Applicable only if Control variable is

MaximumHumidityRatio, MinimumHumidityRatio, or HumidityRatio - then minimum is 0.00001

Units: kgWater/kgDryAir

Default value: 1e-05

value <= 1.0

Parameters:value (float) – value for IDD Field Minimum Setpoint Humidity Ratio Raises:ValueError – if value is not a valid value Returns:the value of minimum_setpoint_humidity_ratio or None if not set Return type:float

minimum_setpoint_temperature

field Minimum Setpoint Temperature

Applicable only if Control variable is Temperature

Units: C

Default value: -99.0

Parameters:value (float) – value for IDD Field Minimum Setpoint Temperature Raises:ValueError – if value is not a valid value Returns:the value of minimum_setpoint_temperature or None if not set Return type:float

mixed_air_stream_node_name

field Mixed Air Stream Node Name

Name of Mixed Air Node

Parameters:value (str) – value for IDD Field Mixed Air Stream Node Name Raises:ValueError – if value is not a valid value Returns:the value of mixed_air_stream_node_name or None if not set Return type:str

name

field Name

Parameters:value (str) – value for IDD Field Name Raises:ValueError – if value is not a valid value Returns:the value of name or None if not set Return type:str

outdoor_air_stream_node_name

field Outdoor Air Stream Node Name

Name of Outdoor Air Stream Node

Parameters:value (str) – value for IDD Field Outdoor Air Stream Node Name Raises:ValueError – if value is not a valid value Returns:the value of outdoor_air_stream_node_name or None if not set Return type:str

reference_setpoint_node_name

field Reference Setpoint Node Name

The current setpoint at this node is the

desired condition for the Mixed Air Node

This node must have a valid setpoint

which has been set by another setpoint manager

Parameters:value (str) – value for IDD Field Reference Setpoint Node Name Raises:ValueError – if value is not a valid value Returns:the value of reference_setpoint_node_name or None if not set Return type:str

return_air_stream_node_name

field Return Air Stream Node Name

Name of Return Air Stream Node

Parameters:value (str) – value for IDD Field Return Air Stream Node Name Raises:ValueError – if value is not a valid value Returns:the value of return_air_stream_node_name or None if not set Return type:str

setpoint_node_or_nodelist_name

field Setpoint Node or NodeList Name

Node(s) at which the temperature or humidity

ratio will be set

Parameters:value (str) – value for IDD Field Setpoint Node or NodeList Name Raises:ValueError – if value is not a valid value Returns:the value of setpoint_node_or_nodelist_name or None if not set Return type:str

class pyidf.setpoint_managers.SetpointManagerOutdoorAirReset

Bases: pyidf.helper.DataObject

Corresponds to IDD object SetpointManager:OutdoorAirReset The Outdoor Air Reset Setpoint Manager sets the supply air temperature according to the outdoor air temperature using a reset rule.

control_variable

field Control Variable

Default value: Temperature

Parameters:value (str) – value for IDD Field Control Variable Raises:ValueError – if value is not a valid value Returns:the value of control_variable or None if not set Return type:str

name

field Name

Parameters:value (str) – value for IDD Field Name Raises:ValueError – if value is not a valid value Returns:the value of name or None if not set Return type:str

outdoor_high_temperature

field Outdoor High Temperature

Units: C

Parameters:value (float) – value for IDD Field Outdoor High Temperature Raises:ValueError – if value is not a valid value Returns:the value of outdoor_high_temperature or None if not set Return type:float

outdoor_high_temperature_2

field Outdoor High Temperature 2

2nd outdoor air temperature reset rule

Units: C

Parameters:value (float) – value for IDD Field Outdoor High Temperature 2 Raises:ValueError – if value is not a valid value Returns:the value of outdoor_high_temperature_2 or None if not set Return type:float

outdoor_low_temperature

field Outdoor Low Temperature

Units: C

Parameters:value (float) – value for IDD Field Outdoor Low Temperature Raises:ValueError – if value is not a valid value Returns:the value of outdoor_low_temperature or None if not set Return type:float

outdoor_low_temperature_2

field Outdoor Low Temperature 2

2nd outdoor air temperature reset rule

Units: C

Parameters:value (float) – value for IDD Field Outdoor Low Temperature 2 Raises:ValueError – if value is not a valid value Returns:the value of outdoor_low_temperature_2 or None if not set Return type:float

schedule_name

field Schedule Name

Optional input.

Schedule allows scheduling of the outdoor air reset rule - a schedule value

of 1 means use the first rule; a value of 2 means use the second rule.

Parameters:value (str) – value for IDD Field Schedule Name Raises:ValueError – if value is not a valid value Returns:the value of schedule_name or None if not set Return type:str

setpoint_at_outdoor_high_temperature

field Setpoint at Outdoor High Temperature

Units: C

Parameters:value (float) – value for IDD Field Setpoint at Outdoor High Temperature Raises:ValueError – if value is not a valid value Returns:the value of setpoint_at_outdoor_high_temperature or None if not set Return type:float

setpoint_at_outdoor_high_temperature_2

field Setpoint at Outdoor High Temperature 2

2nd outdoor air temperature reset rule

Units: C

Parameters:value (float) – value for IDD Field Setpoint at Outdoor High Temperature 2 Raises:ValueError – if value is not a valid value Returns:the value of setpoint_at_outdoor_high_temperature_2 or None if not set Return type:float

setpoint_at_outdoor_low_temperature

field Setpoint at Outdoor Low Temperature

Units: C

Parameters:value (float) – value for IDD Field Setpoint at Outdoor Low Temperature Raises:ValueError – if value is not a valid value Returns:the value of setpoint_at_outdoor_low_temperature or None if not set Return type:float

setpoint_at_outdoor_low_temperature_2

field Setpoint at Outdoor Low Temperature 2

2nd outdoor air temperature reset rule

Units: C

Parameters:value (float) – value for IDD Field Setpoint at Outdoor Low Temperature 2 Raises:ValueError – if value is not a valid value Returns:the value of setpoint_at_outdoor_low_temperature_2 or None if not set Return type:float

setpoint_node_or_nodelist_name

field Setpoint Node or NodeList Name

Node(s) at which temperature will be set

Parameters:value (str) – value for IDD Field Setpoint Node or NodeList Name Raises:ValueError – if value is not a valid value Returns:the value of setpoint_node_or_nodelist_name or None if not set Return type:str

class pyidf.setpoint_managers.SetpointManagerReturnAirBypassFlow

Bases: pyidf.helper.DataObject

Corresponds to IDD object SetpointManager:ReturnAirBypassFlow This setpoint manager determines the required mass flow rate through a return air bypass duct to meet the specified temperature setpoint

control_variable

field Control Variable

Default value: Flow

Parameters:value (str) – value for IDD Field Control Variable Raises:ValueError – if value is not a valid value Returns:the value of control_variable or None if not set Return type:str

hvac_air_loop_name

field HVAC Air Loop Name

Enter the name of an AirLoopHVAC object.

Parameters:value (str) – value for IDD Field HVAC Air Loop Name Raises:ValueError – if value is not a valid value Returns:the value of hvac_air_loop_name or None if not set Return type:str

name

field Name

Parameters:value (str) – value for IDD Field Name Raises:ValueError – if value is not a valid value Returns:the value of name or None if not set Return type:str

temperature_setpoint_schedule_name

field Temperature Setpoint Schedule Name

Parameters:value (str) – value for IDD Field Temperature Setpoint Schedule Name Raises:ValueError – if value is not a valid value Returns:the value of temperature_setpoint_schedule_name or None if not set Return type:str

class pyidf.setpoint_managers.SetpointManagerReturnTemperatureChilledWater

Bases: pyidf.helper.DataObject

Corresponds to IDD object SetpointManager:ReturnTemperature:ChilledWater This setpoint manager is used to place a temperature setpoint on a plant supply outlet node based on a target return water setpoint. The setpoint manager attempts to achieve the desired return water temperature by adjusting the supply temperature setpoint based on the plant conditions at each system time step.

maximum_supply_temperature_setpoint

field Maximum Supply Temperature Setpoint

This is the maximum reset temperature for the chilled water supply.

Units: C

Default value: 10.0

Parameters:value (float) – value for IDD Field Maximum Supply Temperature Setpoint Raises:ValueError – if value is not a valid value Returns:the value of maximum_supply_temperature_setpoint or None if not set Return type:float

minimum_supply_temperature_setpoint

field Minimum Supply Temperature Setpoint

This is the minimum chilled water supply temperature setpoint. This is also used as the default

setpoint during no-load or negative-load conditions and during initialization.

Units: C

Default value: 5.0

Parameters:value (float) – value for IDD Field Minimum Supply Temperature Setpoint Raises:ValueError – if value is not a valid value Returns:the value of minimum_supply_temperature_setpoint or None if not set Return type:float

name

field Name

Parameters:value (str) – value for IDD Field Name Raises:ValueError – if value is not a valid value Returns:the value of name or None if not set Return type:str

plant_loop_supply_inlet_node

field Plant Loop Supply Inlet Node

This is the name of the supply inlet node for the plant being controlled with this

setpoint manager. The temperature on this node is controlled by actuating the

supply setpoint.

Parameters:value (str) – value for IDD Field Plant Loop Supply Inlet Node Raises:ValueError – if value is not a valid value Returns:the value of plant_loop_supply_inlet_node or None if not set Return type:str

plant_loop_supply_outlet_node

field Plant Loop Supply Outlet Node

This is the name of the supply outlet node for the plant being controlled by this

setpoint manager. Typically this is where the setpoint will be actuated for

supply equipment to control to, but not necessarily. This setpoint manager will

mine that information from the internal plant data structures.

Parameters:value (str) – value for IDD Field Plant Loop Supply Outlet Node Raises:ValueError – if value is not a valid value Returns:the value of plant_loop_supply_outlet_node or None if not set Return type:str

return_temperature_setpoint_constant_value

field Return Temperature Setpoint Constant Value

This is the desired return temperature target, which is met by adjusting the

supply temperature setpoint. This constant value is only used if

the Design Chilled Water Return Temperature Input Type is Constant

Units: C

Default value: 13.0

Parameters:value (float) – value for IDD Field Return Temperature Setpoint Constant Value Raises:ValueError – if value is not a valid value Returns:the value of return_temperature_setpoint_constant_value or None if not set Return type:float

return_temperature_setpoint_input_type

field Return Temperature Setpoint Input Type

This defines whether the chilled water return temperature target is constant,

scheduled, or specified on the supply inlet node by a separate setpoint manager.

Parameters:value (str) – value for IDD Field Return Temperature Setpoint Input Type Raises:ValueError – if value is not a valid value Returns:the value of return_temperature_setpoint_input_type or None if not set Return type:str

return_temperature_setpoint_schedule_name

field Return Temperature Setpoint Schedule Name

This is the desired return temperature target, which is met by adjusting the

supply temperature setpoint. This is a schedule name to allow the return temperature

target value to be scheduled. This field is only used if

the Design Chilled Water Return Temperature Input Type is Scheduled

Parameters:value (str) – value for IDD Field Return Temperature Setpoint Schedule Name Raises:ValueError – if value is not a valid value Returns:the value of return_temperature_setpoint_schedule_name or None if not set Return type:str

class pyidf.setpoint_managers.SetpointManagerReturnTemperatureHotWater

Bases: pyidf.helper.DataObject

Corresponds to IDD object SetpointManager:ReturnTemperature:HotWater This setpoint manager is used to place a temperature setpoint on a plant supply outlet node based on a target return water setpoint. The setpoint manager attempts to achieve the desired return water temperature by adjusting the supply temperature setpoint based on the plant conditions at each system time step.

maximum_supply_temperature_setpoint

field Maximum Supply Temperature Setpoint

This is the maximum hot water supply temperature setpoint. This is also used as the default

setpoint during no-load or negative-load conditions and during initialization.

Units: C

Default value: 82.0

Parameters:value (float) – value for IDD Field Maximum Supply Temperature Setpoint Raises:ValueError – if value is not a valid value Returns:the value of maximum_supply_temperature_setpoint or None if not set Return type:float

minimum_supply_temperature_setpoint

field Minimum Supply Temperature Setpoint

This is the minimum reset temperature for the hot water supply.

Units: C

Default value: 77.0

Parameters:value (float) – value for IDD Field Minimum Supply Temperature Setpoint Raises:ValueError – if value is not a valid value Returns:the value of minimum_supply_temperature_setpoint or None if not set Return type:float

name

field Name

Parameters:value (str) – value for IDD Field Name Raises:ValueError – if value is not a valid value Returns:the value of name or None if not set Return type:str

plant_loop_supply_inlet_node

field Plant Loop Supply Inlet Node

This is the name of the supply inlet node for the plant being controlled with this

setpoint manager. The temperature on this node is controlled by actuating the

supply setpoint.

Parameters:value (str) – value for IDD Field Plant Loop Supply Inlet Node Raises:ValueError – if value is not a valid value Returns:the value of plant_loop_supply_inlet_node or None if not set Return type:str

plant_loop_supply_outlet_node

field Plant Loop Supply Outlet Node

This is the name of the supply outlet node for the plant being controlled by this

setpoint manager. Typically this is where the setpoint will be actuated for

supply equipment to control to, but not necessarily. This setpoint manager will

mine that information from the internal plant data structures.

Parameters:value (str) – value for IDD Field Plant Loop Supply Outlet Node Raises:ValueError – if value is not a valid value Returns:the value of plant_loop_supply_outlet_node or None if not set Return type:str

return_temperature_setpoint_constant_value

field Return Temperature Setpoint Constant Value

This is the desired return temperature target, which is met by adjusting the

supply temperature setpoint. This constant value is only used if

the Design Hot Water Return Temperature Input Type is Constant

Units: C

Default value: 71.0

Parameters:value (float) – value for IDD Field Return Temperature Setpoint Constant Value Raises:ValueError – if value is not a valid value Returns:the value of return_temperature_setpoint_constant_value or None if not set Return type:float

return_temperature_setpoint_input_type

field Return Temperature Setpoint Input Type

This defines whether the hot water return temperature target is constant,

scheduled, or specified on the supply inlet node by a separate setpoint manager.

Parameters:value (str) – value for IDD Field Return Temperature Setpoint Input Type Raises:ValueError – if value is not a valid value Returns:the value of return_temperature_setpoint_input_type or None if not set Return type:str

return_temperature_setpoint_schedule_name

field Return Temperature Setpoint Schedule Name

This is the desired return temperature target, which is met by adjusting the

supply temperature setpoint. This is a schedule name to allow the return temperature

target value to be scheduled. This field is only used if

the Design Hot Water Return Temperature Input Type is Scheduled

Parameters:value (str) – value for IDD Field Return Temperature Setpoint Schedule Name Raises:ValueError – if value is not a valid value Returns:the value of return_temperature_setpoint_schedule_name or None if not set Return type:str

class pyidf.setpoint_managers.SetpointManagerScheduled

Bases: pyidf.helper.DataObject

Corresponds to IDD object SetpointManager:Scheduled The simplest Setpoint Manager simply uses a schedule to determine one or more setpoints. Values of the nodes are not used as input.

control_variable

field Control Variable

Parameters:value (str) – value for IDD Field Control Variable Raises:ValueError – if value is not a valid value Returns:the value of control_variable or None if not set Return type:str

name

field Name

Parameters:value (str) – value for IDD Field Name Raises:ValueError – if value is not a valid value Returns:the value of name or None if not set Return type:str

schedule_name

field Schedule Name

Parameters:value (str) – value for IDD Field Schedule Name Raises:ValueError – if value is not a valid value Returns:the value of schedule_name or None if not set Return type:str

setpoint_node_or_nodelist_name

field Setpoint Node or NodeList Name

Node(s) at which control variable will be set

Parameters:value (str) – value for IDD Field Setpoint Node or NodeList Name Raises:ValueError – if value is not a valid value Returns:the value of setpoint_node_or_nodelist_name or None if not set Return type:str

class pyidf.setpoint_managers.SetpointManagerScheduledDualSetpoint

Bases: pyidf.helper.DataObject

Corresponds to IDD object SetpointManager:Scheduled:DualSetpoint This setpoint manager places a high and low schedule value on one or more nodes.

control_variable

field Control Variable

Default value: Temperature

Parameters:value (str) – value for IDD Field Control Variable Raises:ValueError – if value is not a valid value Returns:the value of control_variable or None if not set Return type:str

high_setpoint_schedule_name

field High Setpoint Schedule Name

Parameters:value (str) – value for IDD Field High Setpoint Schedule Name Raises:ValueError – if value is not a valid value Returns:the value of high_setpoint_schedule_name or None if not set Return type:str

low_setpoint_schedule_name

field Low Setpoint Schedule Name

Parameters:value (str) – value for IDD Field Low Setpoint Schedule Name Raises:ValueError – if value is not a valid value Returns:the value of low_setpoint_schedule_name or None if not set Return type:str

name

field Name

Parameters:value (str) – value for IDD Field Name Raises:ValueError – if value is not a valid value Returns:the value of name or None if not set Return type:str

setpoint_node_or_nodelist_name

field Setpoint Node or NodeList Name

Node(s) at which temperature will be set

Parameters:value (str) – value for IDD Field Setpoint Node or NodeList Name Raises:ValueError – if value is not a valid value Returns:the value of setpoint_node_or_nodelist_name or None if not set Return type:str

class pyidf.setpoint_managers.SetpointManagerSingleZoneCooling

Bases: pyidf.helper.DataObject

Corresponds to IDD object SetpointManager:SingleZone:Cooling This setpoint manager detects the control zone load to meet the current cooling setpoint, zone inlet node flow rate, and zone node temperature, and calculates a setpoint temperature for the supply air that will satisfy the zone cooling load for the control zone.

control_variable

field Control Variable

Default value: Temperature

Parameters:value (str) – value for IDD Field Control Variable Raises:ValueError – if value is not a valid value Returns:the value of control_variable or None if not set Return type:str

control_zone_name

field Control Zone Name

Parameters:value (str) – value for IDD Field Control Zone Name Raises:ValueError – if value is not a valid value Returns:the value of control_zone_name or None if not set Return type:str

maximum_supply_air_temperature

field Maximum Supply Air Temperature

Units: C

Default value: 99.0

Parameters:value (float) – value for IDD Field Maximum Supply Air Temperature Raises:ValueError – if value is not a valid value Returns:the value of maximum_supply_air_temperature or None if not set Return type:float

minimum_supply_air_temperature

field Minimum Supply Air Temperature

Units: C

Default value: -99.0

Parameters:value (float) – value for IDD Field Minimum Supply Air Temperature Raises:ValueError – if value is not a valid value Returns:the value of minimum_supply_air_temperature or None if not set Return type:float

name

field Name

Parameters:value (str) – value for IDD Field Name Raises:ValueError – if value is not a valid value Returns:the value of name or None if not set Return type:str

setpoint_node_or_nodelist_name

field Setpoint Node or NodeList Name

Node(s) at which the temperature will be set

Parameters:value (str) – value for IDD Field Setpoint Node or NodeList Name Raises:ValueError – if value is not a valid value Returns:the value of setpoint_node_or_nodelist_name or None if not set Return type:str

zone_inlet_node_name

field Zone Inlet Node Name

Parameters:value (str) – value for IDD Field Zone Inlet Node Name Raises:ValueError – if value is not a valid value Returns:the value of zone_inlet_node_name or None if not set Return type:str

zone_node_name

field Zone Node Name

Parameters:value (str) – value for IDD Field Zone Node Name Raises:ValueError – if value is not a valid value Returns:the value of zone_node_name or None if not set Return type:str

class pyidf.setpoint_managers.SetpointManagerSingleZoneHeating

Bases: pyidf.helper.DataObject

Corresponds to IDD object SetpointManager:SingleZone:Heating This setpoint manager detects the control zone load to meet the current heating setpoint, zone inlet node flow rate, and zone node temperature, and calculates a setpoint temperature for the supply air that will satisfy the zone heating load for the control zone.

control_variable

field Control Variable

Default value: Temperature

Parameters:value (str) – value for IDD Field Control Variable Raises:ValueError – if value is not a valid value Returns:the value of control_variable or None if not set Return type:str

control_zone_name

field Control Zone Name

Parameters:value (str) – value for IDD Field Control Zone Name Raises:ValueError – if value is not a valid value Returns:the value of control_zone_name or None if not set Return type:str

maximum_supply_air_temperature

field Maximum Supply Air Temperature

Units: C

Default value: 99.0

Parameters:value (float) – value for IDD Field Maximum Supply Air Temperature Raises:ValueError – if value is not a valid value Returns:the value of maximum_supply_air_temperature or None if not set Return type:float

minimum_supply_air_temperature

field Minimum Supply Air Temperature

Units: C

Default value: -99.0

Parameters:value (float) – value for IDD Field Minimum Supply Air Temperature Raises:ValueError – if value is not a valid value Returns:the value of minimum_supply_air_temperature or None if not set Return type:float

name

field Name

Parameters:value (str) – value for IDD Field Name Raises:ValueError – if value is not a valid value Returns:the value of name or None if not set Return type:str

setpoint_node_or_nodelist_name

field Setpoint Node or NodeList Name

Node(s) at which the temperature will be set

Parameters:value (str) – value for IDD Field Setpoint Node or NodeList Name Raises:ValueError – if value is not a valid value Returns:the value of setpoint_node_or_nodelist_name or None if not set Return type:str

zone_inlet_node_name

field Zone Inlet Node Name

Parameters:value (str) – value for IDD Field Zone Inlet Node Name Raises:ValueError – if value is not a valid value Returns:the value of zone_inlet_node_name or None if not set Return type:str

zone_node_name

field Zone Node Name

Parameters:value (str) – value for IDD Field Zone Node Name Raises:ValueError – if value is not a valid value Returns:the value of zone_node_name or None if not set Return type:str

class pyidf.setpoint_managers.SetpointManagerSingleZoneHumidityMaximum

Bases: pyidf.helper.DataObject

Corresponds to IDD object SetpointManager:SingleZone:Humidity:Maximum The Single Zone Maximum Humidity Setpoint Manager allows the control of a single zone maximum humidity level. This setpoint manager can be used in conjunction with object ZoneControl:Humidistat to detect humidity levels.

control_variable

field Control Variable

This field is not really used and will be deleted from the object.

The required information is gotten internally or

not needed by the program.

Parameters:value (str) – value for IDD Field Control Variable Raises:ValueError – if value is not a valid value Returns:the value of control_variable or None if not set Return type:str

control_zone_air_node_name

field Control Zone Air Node Name

Name of the zone air node for the humidity control zone

Parameters:value (str) – value for IDD Field Control Zone Air Node Name Raises:ValueError – if value is not a valid value Returns:the value of control_zone_air_node_name or None if not set Return type:str

name

field Name

Parameters:value (str) – value for IDD Field Name Raises:ValueError – if value is not a valid value Returns:the value of name or None if not set Return type:str

schedule_name

field Schedule Name

This field is not really used and will be deleted from the object.

The required information is gotten internally or

not needed by the program.

Parameters:value (str) – value for IDD Field Schedule Name Raises:ValueError – if value is not a valid value Returns:the value of schedule_name or None if not set Return type:str

setpoint_node_or_nodelist_name

field Setpoint Node or NodeList Name

Node(s) at which humidity ratio setpoint will be set

Parameters:value (str) – value for IDD Field Setpoint Node or NodeList Name Raises:ValueError – if value is not a valid value Returns:the value of setpoint_node_or_nodelist_name or None if not set Return type:str

class pyidf.setpoint_managers.SetpointManagerSingleZoneHumidityMinimum

Bases: pyidf.helper.DataObject

Corresponds to IDD object SetpointManager:SingleZone:Humidity:Minimum The Single Zone Minimum Humidity Setpoint Manager allows the control of a single zone minimum humidity level. This setpoint manager can be used in conjunction with object ZoneControl:Humidistat to detect humidity levels.

control_variable

field Control Variable

This field is not really used and will be deleted from the object.

The required information is gotten internally or

not needed by the program.

Parameters:value (str) – value for IDD Field Control Variable Raises:ValueError – if value is not a valid value Returns:the value of control_variable or None if not set Return type:str

control_zone_air_node_name

field Control Zone Air Node Name

Name of the zone air node for the humidity control zone

Parameters:value (str) – value for IDD Field Control Zone Air Node Name Raises:ValueError – if value is not a valid value Returns:the value of control_zone_air_node_name or None if not set Return type:str

name

field Name

Parameters:value (str) – value for IDD Field Name Raises:ValueError – if value is not a valid value Returns:the value of name or None if not set Return type:str

schedule_name

field Schedule Name

This field is not really used and will be deleted from the object.

The required information is gotten internally or

not needed by the program.

Parameters:value (str) – value for IDD Field Schedule Name Raises:ValueError – if value is not a valid value Returns:the value of schedule_name or None if not set Return type:str

setpoint_node_or_nodelist_name

field Setpoint Node or NodeList Name

Node(s) at which humidity ratio setpoint will be set

Parameters:value (str) – value for IDD Field Setpoint Node or NodeList Name Raises:ValueError – if value is not a valid value Returns:the value of setpoint_node_or_nodelist_name or None if not set Return type:str

class pyidf.setpoint_managers.SetpointManagerSingleZoneOneStageCooling

Bases: pyidf.helper.DataObject

Corresponds to IDD object SetpointManager:SingleZone:OneStageCooling This object can be used with CoilSystem:Cooling:DX to model on/off cycling control of single stage air systems. Setpoints are modulated to run coil full on or full off depending on zone conditions. Intended for use with ZoneControl:Thermostat:StagedDualSetpoint

control_zone_name

field Control Zone Name

Parameters:value (str) – value for IDD Field Control Zone Name Raises:ValueError – if value is not a valid value Returns:the value of control_zone_name or None if not set Return type:str

cooling_stage_off_supply_air_setpoint_temperature

field Cooling Stage Off Supply Air Setpoint Temperature

This is the setpoint value applied when cooling device is to cycle OFF

Units: C

Default value: 99.0

Parameters:value (float) – value for IDD Field Cooling Stage Off Supply Air Setpoint Temperature Raises:ValueError – if value is not a valid value Returns:the value of cooling_stage_off_supply_air_setpoint_temperature or None if not set Return type:float

cooling_stage_on_supply_air_setpoint_temperature

field Cooling Stage On Supply Air Setpoint Temperature

This is the setpoint value applied when cooling device is to cycle ON

Units: C

Default value: -99.0

Parameters:value (float) – value for IDD Field Cooling Stage On Supply Air Setpoint Temperature Raises:ValueError – if value is not a valid value Returns:the value of cooling_stage_on_supply_air_setpoint_temperature or None if not set Return type:float

name

field Name

Parameters:value (str) – value for IDD Field Name Raises:ValueError – if value is not a valid value Returns:the value of name or None if not set Return type:str

setpoint_node_or_nodelist_name

field Setpoint Node or NodeList Name

Node(s) at which the temperature will be set

Parameters:value (str) – value for IDD Field Setpoint Node or NodeList Name Raises:ValueError – if value is not a valid value Returns:the value of setpoint_node_or_nodelist_name or None if not set Return type:str

class pyidf.setpoint_managers.SetpointManagerSingleZoneOneStageHeating

Bases: pyidf.helper.DataObject

Corresponds to IDD object SetpointManager:SingleZone:OneStageHeating This object can be used with CoilSystem:Heating:DX, Coil:Heating:Gas, Coil:Heating:Electric to model on/off cycling control of single stage air systems. Setpoints are modulated to run coil full on or full off depending on zone conditions. Intended for use with ZoneControl:Thermostat:StagedDualSetpoint.

control_zone_name

field Control Zone Name

Parameters:value (str) – value for IDD Field Control Zone Name Raises:ValueError – if value is not a valid value Returns:the value of control_zone_name or None if not set Return type:str

heating_stage_off_supply_air_setpoint_temperature

field Heating Stage Off Supply Air Setpoint Temperature

This is the setpoint value applied when heating device is to cycle OFF

Units: C

Default value: -99.0

Parameters:value (float) – value for IDD Field Heating Stage Off Supply Air Setpoint Temperature Raises:ValueError – if value is not a valid value Returns:the value of heating_stage_off_supply_air_setpoint_temperature or None if not set Return type:float

heating_stage_on_supply_air_setpoint_temperature

field Heating Stage On Supply Air Setpoint Temperature

This is the setpoint value applied when heating device is to cycle ON

Units: C

Default value: 99.0

Parameters:value (float) – value for IDD Field Heating Stage On Supply Air Setpoint Temperature Raises:ValueError – if value is not a valid value Returns:the value of heating_stage_on_supply_air_setpoint_temperature or None if not set Return type:float

name

field Name

Parameters:value (str) – value for IDD Field Name Raises:ValueError – if value is not a valid value Returns:the value of name or None if not set Return type:str

setpoint_node_or_nodelist_name

field Setpoint Node or NodeList Name

Node(s) at which the temperature will be set

Parameters:value (str) – value for IDD Field Setpoint Node or NodeList Name Raises:ValueError – if value is not a valid value Returns:the value of setpoint_node_or_nodelist_name or None if not set Return type:str

class pyidf.setpoint_managers.SetpointManagerSingleZoneReheat

Bases: pyidf.helper.DataObject

Corresponds to IDD object SetpointManager:SingleZone:Reheat This setpoint manager detects the control zone load, zone inlet node flow rate, and zone node temperature and calculates a setpoint temperature for the supply air that will satisfy the zone load (heating or cooling) for the control zone. This setpoint manager is not limited to reheat applications.

control_variable

field Control Variable

Default value: Temperature

Parameters:value (str) – value for IDD Field Control Variable Raises:ValueError – if value is not a valid value Returns:the value of control_variable or None if not set Return type:str

control_zone_name

field Control Zone Name

Parameters:value (str) – value for IDD Field Control Zone Name Raises:ValueError – if value is not a valid value Returns:the value of control_zone_name or None if not set Return type:str

maximum_supply_air_temperature

field Maximum Supply Air Temperature

Units: C

Default value: 99.0

Parameters:value (float) – value for IDD Field Maximum Supply Air Temperature Raises:ValueError – if value is not a valid value Returns:the value of maximum_supply_air_temperature or None if not set Return type:float

minimum_supply_air_temperature

field Minimum Supply Air Temperature

Units: C

Default value: -99.0

Parameters:value (float) – value for IDD Field Minimum Supply Air Temperature Raises:ValueError – if value is not a valid value Returns:the value of minimum_supply_air_temperature or None if not set Return type:float

name

field Name

Parameters:value (str) – value for IDD Field Name Raises:ValueError – if value is not a valid value Returns:the value of name or None if not set Return type:str

setpoint_node_or_nodelist_name

field Setpoint Node or NodeList Name

Node(s) at which the temperature will be set

Parameters:value (str) – value for IDD Field Setpoint Node or NodeList Name Raises:ValueError – if value is not a valid value Returns:the value of setpoint_node_or_nodelist_name or None if not set Return type:str

zone_inlet_node_name

field Zone Inlet Node Name

Parameters:value (str) – value for IDD Field Zone Inlet Node Name Raises:ValueError – if value is not a valid value Returns:the value of zone_inlet_node_name or None if not set Return type:str

zone_node_name

field Zone Node Name

Parameters:value (str) – value for IDD Field Zone Node Name Raises:ValueError – if value is not a valid value Returns:the value of zone_node_name or None if not set Return type:str

class pyidf.setpoint_managers.SetpointManagerWarmest

Bases: pyidf.helper.DataObject

Corresponds to IDD object SetpointManager:Warmest This SetpointManager resets the cooling supply air temperature of a central forced air HVAC system according to the cooling demand of the warmest zone.

control_variable

field Control Variable

Default value: Temperature

Parameters:value (str) – value for IDD Field Control Variable Raises:ValueError – if value is not a valid value Returns:the value of control_variable or None if not set Return type:str

hvac_air_loop_name

field HVAC Air Loop Name

Enter the name of an AirLoopHVAC object

Parameters:value (str) – value for IDD Field HVAC Air Loop Name Raises:ValueError – if value is not a valid value Returns:the value of hvac_air_loop_name or None if not set Return type:str

maximum_setpoint_temperature

field Maximum Setpoint Temperature

Units: C

Default value: 18.0

Parameters:value (float) – value for IDD Field Maximum Setpoint Temperature Raises:ValueError – if value is not a valid value Returns:the value of maximum_setpoint_temperature or None if not set Return type:float

minimum_setpoint_temperature

field Minimum Setpoint Temperature

Units: C

Default value: 12.0

Parameters:value (float) – value for IDD Field Minimum Setpoint Temperature Raises:ValueError – if value is not a valid value Returns:the value of minimum_setpoint_temperature or None if not set Return type:float

name

field Name

Parameters:value (str) – value for IDD Field Name Raises:ValueError – if value is not a valid value Returns:the value of name or None if not set Return type:str

setpoint_node_or_nodelist_name

field Setpoint Node or NodeList Name

Node(s) at which the temperature will be set

Parameters:value (str) – value for IDD Field Setpoint Node or NodeList Name Raises:ValueError – if value is not a valid value Returns:the value of setpoint_node_or_nodelist_name or None if not set Return type:str

strategy

field Strategy

Default value: MaximumTemperature

Parameters:value (str) – value for IDD Field Strategy Raises:ValueError – if value is not a valid value Returns:the value of strategy or None if not set Return type:str

class pyidf.setpoint_managers.SetpointManagerWarmestTemperatureFlow

Bases: pyidf.helper.DataObject

Corresponds to IDD object SetpointManager:WarmestTemperatureFlow This setpoint manager sets both the supply air temperature and the supply air flow rate.

control_variable

field Control Variable

Parameters:value (str) – value for IDD Field Control Variable Raises:ValueError – if value is not a valid value Returns:the value of control_variable or None if not set Return type:str

hvac_air_loop_name

field HVAC Air Loop Name

Enter the name of an AirLoopHVAC object.

Parameters:value (str) – value for IDD Field HVAC Air Loop Name Raises:ValueError – if value is not a valid value Returns:the value of hvac_air_loop_name or None if not set Return type:str

maximum_setpoint_temperature

field Maximum Setpoint Temperature

Units: C

Default value: 18.0

Parameters:value (float) – value for IDD Field Maximum Setpoint Temperature Raises:ValueError – if value is not a valid value Returns:the value of maximum_setpoint_temperature or None if not set Return type:float

minimum_setpoint_temperature

field Minimum Setpoint Temperature

Units: C

Default value: 12.0

Parameters:value (float) – value for IDD Field Minimum Setpoint Temperature Raises:ValueError – if value is not a valid value Returns:the value of minimum_setpoint_temperature or None if not set Return type:float

minimum_turndown_ratio

field Minimum Turndown Ratio

Fraction of the maximum supply air flow rate.

Used to define the minimum supply flow for the TemperatureFirst strategy.

Units: dimensionless

Default value: 0.2

Parameters:value (float) – value for IDD Field Minimum Turndown Ratio Raises:ValueError – if value is not a valid value Returns:the value of minimum_turndown_ratio or None if not set Return type:float

name

field Name

Parameters:value (str) – value for IDD Field Name Raises:ValueError – if value is not a valid value Returns:the value of name or None if not set Return type:str

setpoint_node_or_nodelist_name

field Setpoint Node or NodeList Name

Node(s) at which the temperature will be set

Parameters:value (str) – value for IDD Field Setpoint Node or NodeList Name Raises:ValueError – if value is not a valid value Returns:the value of setpoint_node_or_nodelist_name or None if not set Return type:str

strategy

field Strategy

For TemperatureFirst the manager tries to find the highest setpoint temperature

that will satisfy all the zone cooling loads at minimum supply air flow rate.

If this setpoint temperature is less than the minimum, the setpoint temperature is set

to the minimum, and the supply air flow rate is increased to meet the loads.

For FlowFirst the manager tries to find the lowest supply air flow rate

that will satisfy all the zone cooling loads at the maximum setpoint temperature.

If this flow is greater than the maximum, the flow is set to the maximum and the

setpoint temperature is reduced to satisfy the cooling loads.

Default value: TemperatureFirst

Parameters:value (str) – value for IDD Field Strategy Raises:ValueError – if value is not a valid value Returns:the value of strategy or None if not set Return type:str