pyidf.controllers module

Data objects in group “Controllers”

class pyidf.controllers.AirLoopHvacControllerList

Bases: pyidf.helper.DataObject

Corresponds to IDD object AirLoopHVAC:ControllerList List controllers in order of control sequence

controller_1_name

field Controller 1 Name

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

controller_1_object_type

field Controller 1 Object Type

Parameters:value (str) – value for IDD Field Controller 1 Object Type Raises:ValueError – if value is not a valid value Returns:the value of controller_1_object_type or None if not set Return type:str

controller_2_name

field Controller 2 Name

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

controller_2_object_type

field Controller 2 Object Type

Parameters:value (str) – value for IDD Field Controller 2 Object Type Raises:ValueError – if value is not a valid value Returns:the value of controller_2_object_type or None if not set Return type:str

controller_3_name

field Controller 3 Name

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

controller_3_object_type

field Controller 3 Object Type

Parameters:value (str) – value for IDD Field Controller 3 Object Type Raises:ValueError – if value is not a valid value Returns:the value of controller_3_object_type or None if not set Return type:str

controller_4_name

field Controller 4 Name

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

controller_4_object_type

field Controller 4 Object Type

Parameters:value (str) – value for IDD Field Controller 4 Object Type Raises:ValueError – if value is not a valid value Returns:the value of controller_4_object_type or None if not set Return type:str

controller_5_name

field Controller 5 Name

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

controller_5_object_type

field Controller 5 Object Type

Parameters:value (str) – value for IDD Field Controller 5 Object Type Raises:ValueError – if value is not a valid value Returns:the value of controller_5_object_type or None if not set Return type:str

controller_6_name

field Controller 6 Name

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

controller_6_object_type

field Controller 6 Object Type

Parameters:value (str) – value for IDD Field Controller 6 Object Type Raises:ValueError – if value is not a valid value Returns:the value of controller_6_object_type or None if not set Return type:str

controller_7_name

field Controller 7 Name

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

controller_7_object_type

field Controller 7 Object Type

Parameters:value (str) – value for IDD Field Controller 7 Object Type Raises:ValueError – if value is not a valid value Returns:the value of controller_7_object_type or None if not set Return type:str

controller_8_name

field Controller 8 Name

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

controller_8_object_type

field Controller 8 Object Type

Parameters:value (str) – value for IDD Field Controller 8 Object Type Raises:ValueError – if value is not a valid value Returns:the value of controller_8_object_type 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

class pyidf.controllers.ControllerMechanicalVentilation

Bases: pyidf.helper.DataObject

Corresponds to IDD object Controller:MechanicalVentilation This object is used in conjunction with Controller:OutdoorAir to specify outdoor ventilation air based on outdoor air specified in the DesignSpecification:OutdoorAir object The Controller:OutdoorAir object is associated with a specific air loop, so the outdoor air flow rates specified in Controller:MechanicalVentilation correspond to the zones attached to that specific air loop. Duplicate groups of Zone name, Design Specification Outdoor Air Object Name, and Design Specification Zone Air Distribution Object Name to increase allowable number of entries

add_extensible(zone_1_name=None, design_specification_outdoor_air_object_name_1=None, design_specification_zone_air_distribution_object_name_1=None)

Add values for extensible fields

Parameters:

• zone_1_name (str) – value for IDD Field Zone 1 Name if value is None it will not be checked against the specification and is assumed to be a missing value
• design_specification_outdoor_air_object_name_1 (str) – value for IDD Field Design Specification Outdoor Air Object Name 1 if value is None it will not be checked against the specification and is assumed to be a missing value
• design_specification_zone_air_distribution_object_name_1 (str) – value for IDD Field Design Specification Zone Air Distribution Object Name 1 if value is None it will not be checked against the specification and is assumed to be a missing value

availability_schedule_name

field Availability Schedule Name

If this field is blank, the controller uses the values from the associated Controller:OutdoorAir.

Schedule values greater than 0 indicate mechanical ventilation is enabled

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

demand_controlled_ventilation

field Demand Controlled Ventilation

Default value: No

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

extensibles

Get list of all extensibles

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

system_outdoor_air_method

field System Outdoor Air Method

Default value: VentilationRateProcedure

Parameters:value (str) – value for IDD Field System Outdoor Air Method Raises:ValueError – if value is not a valid value Returns:the value of system_outdoor_air_method or None if not set Return type:str

zone_maximum_outdoor_air_fraction

field Zone Maximum Outdoor Air Fraction

Units: dimensionless

Default value: 1.0

Parameters:value (float) – value for IDD Field Zone Maximum Outdoor Air Fraction Raises:ValueError – if value is not a valid value Returns:the value of zone_maximum_outdoor_air_fraction or None if not set Return type:float

class pyidf.controllers.ControllerOutdoorAir

Bases: pyidf.helper.DataObject

Corresponds to IDD object Controller:OutdoorAir Controller to set the outdoor air flow rate for an air loop. Control options include fixed, proportional, scheduled, economizer, and demand-controlled ventilation.

actuator_node_name

field Actuator Node Name

Outdoor air inlet node entering the first pre-treat component if any

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

control_high_indoor_humidity_based_on_outdoor_humidity_ratio

field Control High Indoor Humidity Based on Outdoor Humidity Ratio

If No is selected, the outdoor air flow rate is modified any time indoor relative

humidity is above the humidistat setpoint. If Yes is selected, the outdoor air

flow rate is modified any time the indoor relative humidity is above the humidistat

setpoint and the outdoor humidity ratio is less than the indoor humidity ratio.

This field is only used when the field High Humidity Control = Yes.

Default value: Yes

Parameters:value (str) – value for IDD Field Control High Indoor Humidity Based on Outdoor Humidity Ratio Raises:ValueError – if value is not a valid value Returns:the value of control_high_indoor_humidity_based_on_outdoor_humidity_ratio or None if not set Return type:str

economizer_control_action_type

field Economizer Control Action Type

Default value: ModulateFlow

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

economizer_control_type

field Economizer Control Type

Default value: NoEconomizer

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

economizer_maximum_limit_dewpoint_temperature

field Economizer Maximum Limit Dewpoint Temperature

Enter the maximum outdoor dewpoint temperature limit for FixedDewPointAndDryBulb

economizer control type. No input or blank input means this limit is not operative.

Limit is applied regardless of economizer control type.

Units: C

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

economizer_maximum_limit_drybulb_temperature

field Economizer Maximum Limit Dry-Bulb Temperature

Enter the maximum outdoor dry-bulb temperature limit for FixedDryBulb

economizer control type. No input or blank input means this limit is

not operative. Limit is applied regardless of economizer control type.

Units: C

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

economizer_maximum_limit_enthalpy

field Economizer Maximum Limit Enthalpy

Enter the maximum outdoor enthalpy limit for FixedEnthalpy economizer control type.

No input or blank input means this limit is not operative

Limit is applied regardless of economizer control type.

Units: J/kg

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

economizer_minimum_limit_drybulb_temperature

field Economizer Minimum Limit Dry-Bulb Temperature

Enter the minimum outdoor dry-bulb temperature limit for economizer control.

No input or blank input means this limit is not operative

Limit is applied regardless of economizer control type.

Units: C

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

electronic_enthalpy_limit_curve_name

field Electronic Enthalpy Limit Curve Name

Enter the name of a quadratic or cubic curve which defines the maximum outdoor

humidity ratio (function of outdoor dry-bulb temperature) for ElectronicEnthalpy

economizer control type. No input or blank input means this limit is not operative

Limit is applied regardless of economizer control type.

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

heat_recovery_bypass_control_type

field Heat Recovery Bypass Control Type

BypassWhenWithinEconomizerLimits specifies that heat recovery

is active only when the economizer is off because conditions

are outside the economizer control limits

BypassWhenOAFlowGreaterThanMinimum specifies enhanced economizer

controls to allow heat recovery when economizer is active

(within limits) but the outdoor air flow rate is at the minimum.

Default value: BypassWhenWithinEconomizerLimits

Parameters:value (str) – value for IDD Field Heat Recovery Bypass Control Type Raises:ValueError – if value is not a valid value Returns:the value of heat_recovery_bypass_control_type or None if not set Return type:str

high_humidity_control

field High Humidity Control

Optional field to enable modified outdoor air flow rates based on zone relative humidity.

Select Yes to modify outdoor air flow rate based on a zone humidistat.

Select No to disable this feature.

If the field Economizer Control Type = NoEconomizer, then this option is disabled.

Default value: No

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

high_humidity_outdoor_air_flow_ratio

field High Humidity Outdoor Air Flow Ratio

Enter the ratio of outdoor air to the maximum outdoor air flow rate when modified air

flow rates are active based on high indoor humidity.

The minimum value must be greater than 0.

This field is only used when the field High Humidity Control = Yes.

Default value: 1.0

Parameters:value (float) – value for IDD Field High Humidity Outdoor Air Flow Ratio Raises:ValueError – if value is not a valid value Returns:the value of high_humidity_outdoor_air_flow_ratio or None if not set Return type:float

humidistat_control_zone_name

field Humidistat Control Zone Name

Enter the name of the zone where the humidistat is located.

This field is only used when the field High Humidity Control = Yes.

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

lockout_type

field Lockout Type

Default value: NoLockout

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

maximum_fraction_of_outdoor_air_schedule_name

field Maximum Fraction of Outdoor Air Schedule Name

schedule values multiply the design/mixed air flow rate

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

maximum_outdoor_air_flow_rate

field Maximum Outdoor Air Flow Rate

Units: m3/s

Parameters:value (float or “Autosize”) – value for IDD Field Maximum Outdoor Air Flow Rate Raises:ValueError – if value is not a valid value Returns:the value of maximum_outdoor_air_flow_rate or None if not set Return type:float or “Autosize”

mechanical_ventilation_controller_name

field Mechanical Ventilation Controller Name

Enter the name of a Controller:MechanicalVentilation object.

Optional field for defining outdoor ventilation air based on flow rate per unit floor

area and flow rate per person. Simplified method of demand-controlled ventilation.

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

minimum_fraction_of_outdoor_air_schedule_name

field Minimum Fraction of Outdoor Air Schedule Name

schedule values multiply the design/mixed air flow rate

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

minimum_limit_type

field Minimum Limit Type

Default value: ProportionalMinimum

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

minimum_outdoor_air_flow_rate

field Minimum Outdoor Air Flow Rate

Units: m3/s

Parameters:value (float or “Autosize”) – value for IDD Field Minimum Outdoor Air Flow Rate Raises:ValueError – if value is not a valid value Returns:the value of minimum_outdoor_air_flow_rate or None if not set Return type:float or “Autosize”

minimum_outdoor_air_schedule_name

field Minimum Outdoor Air Schedule Name

Schedule values multiply the minimum outdoor air flow rate

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

mixed_air_node_name

field Mixed Air Node Name

Parameters:value (str) – value for IDD Field Mixed Air Node Name Raises:ValueError – if value is not a valid value Returns:the value of mixed_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

relief_air_outlet_node_name

field Relief Air Outlet Node Name

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

return_air_node_name

field Return Air Node Name

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

time_of_day_economizer_control_schedule_name

field Time of Day Economizer Control Schedule Name

Optional schedule to simulate “push-button” type economizer control.

Schedule values greater than 0 indicate time-of-day economizer control is enabled.

Economizer control may be used with or without the high humidity control option.

When used together, high humidity control has priority over economizer control.

If the field Economizer Control Type = NoEconomizer, then this option is disabled.

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

class pyidf.controllers.ControllerWaterCoil

Bases: pyidf.helper.DataObject

Corresponds to IDD object Controller:WaterCoil Controller for a water coil which is located directly in an air loop branch or outdoor air equipment list. Controls the coil water flow to meet the specified leaving air setpoint(s). Used with Coil:Heating:Water, Coil:Cooling:Water, Coil:Cooling:Water:DetailedGeometry, and CoilSystem:Cooling:Water:HeatexchangerAssisted.

action

field Action

Leave blank to have this automatically selected from coil type.

Chilled water coils should be reverse action

Hot water coils should be normal action

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

actuator_node_name

field Actuator Node Name

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

actuator_variable

field Actuator Variable

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

control_variable

field Control Variable

keys HumidityRatio or TemperatureAndHumidityRatio

requires a ZoneControl:Humidistat object along

with SetpointManager:SingleZone:Humidity:Maximum,

SetpointManager:MultiZone:MaximumHumidity:Average, or

SetpointManager:Multizone:Humidity:Maximum object

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

controller_convergence_tolerance

field Controller Convergence Tolerance

Units: deltaC

Default value: “autosize”

Parameters:value (float or “Autosize”) – value for IDD Field Controller Convergence Tolerance Raises:ValueError – if value is not a valid value Returns:the value of controller_convergence_tolerance or None if not set Return type:float or “Autosize”

maximum_actuated_flow

field Maximum Actuated Flow

Units: m3/s

Parameters:value (float or “Autosize”) – value for IDD Field Maximum Actuated Flow Raises:ValueError – if value is not a valid value Returns:the value of maximum_actuated_flow or None if not set Return type:float or “Autosize”

minimum_actuated_flow

field Minimum Actuated Flow

Units: m3/s

Default value: 1e-07

Parameters:value (float) – value for IDD Field Minimum Actuated Flow Raises:ValueError – if value is not a valid value Returns:the value of minimum_actuated_flow 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

sensor_node_name

field Sensor Node Name

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