pyidf.zone_hvac_controls_and_thermostats module

Data objects in group “Zone HVAC Controls and Thermostats”

class pyidf.zone_hvac_controls_and_thermostats.ThermostatSetpointDualSetpoint

Bases: pyidf.helper.DataObject

Corresponds to IDD object ThermostatSetpoint:DualSetpoint Used for a heating and cooling thermostat with dual setpoints. The setpoints can be scheduled and varied throughout the simulation for both heating and cooling.

cooling_setpoint_temperature_schedule_name

field Cooling Setpoint Temperature Schedule Name

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

heating_setpoint_temperature_schedule_name

field Heating Setpoint Temperature Schedule Name

Parameters:value (str) – value for IDD Field Heating Setpoint Temperature Schedule Name Raises:ValueError – if value is not a valid value Returns:the value of heating_setpoint_temperature_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

class pyidf.zone_hvac_controls_and_thermostats.ThermostatSetpointSingleCooling

Bases: pyidf.helper.DataObject

Corresponds to IDD object ThermostatSetpoint:SingleCooling Used for a cooling only thermostat. The setpoint can be scheduled and varied throughout the simulation but only cooling is allowed.

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_temperature_schedule_name

field Setpoint Temperature Schedule Name

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

class pyidf.zone_hvac_controls_and_thermostats.ThermostatSetpointSingleHeating

Bases: pyidf.helper.DataObject

Corresponds to IDD object ThermostatSetpoint:SingleHeating Used for a heating only thermostat. The setpoint can be scheduled and varied throughout the simulation but only heating is allowed with this control type.

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_temperature_schedule_name

field Setpoint Temperature Schedule Name

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

class pyidf.zone_hvac_controls_and_thermostats.ThermostatSetpointSingleHeatingOrCooling

Bases: pyidf.helper.DataObject

Corresponds to IDD object ThermostatSetpoint:SingleHeatingOrCooling Used for a heating and cooling thermostat with a single setpoint. The setpoint can be scheduled and varied throughout the simulation for both heating and cooling.

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_temperature_schedule_name

field Setpoint Temperature Schedule Name

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

class pyidf.zone_hvac_controls_and_thermostats.ThermostatSetpointThermalComfortFangerDualSetpoint

Bases: pyidf.helper.DataObject

Corresponds to IDD object ThermostatSetpoint:ThermalComfort:Fanger:DualSetpoint Used for heating and cooling thermal comfort control with dual setpoints. The PMV setpoints can be scheduled and varied throughout the simulation for both heating and cooling.

fanger_thermal_comfort_cooling_schedule_name

field Fanger Thermal Comfort Cooling Schedule Name

Schedule values should be Predicted Mean Vote (PMV)

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

fanger_thermal_comfort_heating_schedule_name

field Fanger Thermal Comfort Heating Schedule Name

Schedule values should be Predicted Mean Vote (PMV)

Parameters:value (str) – value for IDD Field Fanger Thermal Comfort Heating Schedule Name Raises:ValueError – if value is not a valid value Returns:the value of fanger_thermal_comfort_heating_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

class pyidf.zone_hvac_controls_and_thermostats.ThermostatSetpointThermalComfortFangerSingleCooling

Bases: pyidf.helper.DataObject

Corresponds to IDD object ThermostatSetpoint:ThermalComfort:Fanger:SingleCooling Used for cooling only thermal comfort control. The PMV setpoint can be scheduled and varied throughout the simulation but only cooling is allowed with this control type.

fanger_thermal_comfort_schedule_name

field Fanger Thermal Comfort Schedule Name

Schedule values should be Predicted Mean Vote (PMV)

Parameters:value (str) – value for IDD Field Fanger Thermal Comfort Schedule Name Raises:ValueError – if value is not a valid value Returns:the value of fanger_thermal_comfort_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

class pyidf.zone_hvac_controls_and_thermostats.ThermostatSetpointThermalComfortFangerSingleHeating

Bases: pyidf.helper.DataObject

Corresponds to IDD object ThermostatSetpoint:ThermalComfort:Fanger:SingleHeating Used for heating only thermal comfort control. The PMV setpoint can be scheduled and varied throughout the simulation but only heating is allowed with this control type.

fanger_thermal_comfort_schedule_name

field Fanger Thermal Comfort Schedule Name

Schedule values should be Predicted Mean Vote (PMV)

Parameters:value (str) – value for IDD Field Fanger Thermal Comfort Schedule Name Raises:ValueError – if value is not a valid value Returns:the value of fanger_thermal_comfort_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

class pyidf.zone_hvac_controls_and_thermostats.ThermostatSetpointThermalComfortFangerSingleHeatingOrCooling

Bases: pyidf.helper.DataObject

Corresponds to IDD object ThermostatSetpoint:ThermalComfort:Fanger:SingleHeatingOrCooling Used for heating and cooling thermal comfort control with a single setpoint. The PMV setpoint can be scheduled and varied throughout the simulation for both heating and cooling.

fanger_thermal_comfort_schedule_name

field Fanger Thermal Comfort Schedule Name

Schedule values should be Predicted Mean Vote (PMV)

Parameters:value (str) – value for IDD Field Fanger Thermal Comfort Schedule Name Raises:ValueError – if value is not a valid value Returns:the value of fanger_thermal_comfort_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

class pyidf.zone_hvac_controls_and_thermostats.ZoneControlContaminantController

Bases: pyidf.helper.DataObject

Corresponds to IDD object ZoneControl:ContaminantController Used to control a zone to a specified indoor level of CO2 or generic contaminants, or to specify minimum CO2 concentration schedule name for a zone.

carbon_dioxide_control_availability_schedule_name

field Carbon Dioxide Control Availability Schedule Name

Availability schedule name for CO2 controller. Schedule value > 0 means the CO2

controller is enabled. If this field is blank, then CO2 controller is always enabled.

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

carbon_dioxide_setpoint_schedule_name

field Carbon Dioxide Setpoint Schedule Name

Schedule values should be carbon dioxide concentration in parts per million (ppm)

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

controlled_zone_name

field Controlled Zone Name

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

generic_contaminant_control_availability_schedule_name

field Generic Contaminant Control Availability Schedule Name

Availability schedule name for generic contaminant controller. Schedule value > 0 means

the generic contaminant controller is enabled. If this field is blank, then generic

contaminant controller is always enabled.

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

generic_contaminant_setpoint_schedule_name

field Generic Contaminant Setpoint Schedule Name

Schedule values should be generic contaminant concentration in parts per

million (ppm)

This field is used when the field System Outdoor Air Method =

IndoorAirQualityProcedureGenericContaminant in Controller:MechanicalVentilation

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

minimum_carbon_dioxide_concentration_schedule_name

field Minimum Carbon Dioxide Concentration Schedule Name

Schedule values should be carbon dioxide concentration in parts per

million (ppm)

This field is used when the field System Outdoor Air Method =

ProportionalControlBasedonOccupancySchedule or ProportionalControlBasedOnDesignOccupancy

in Controller:MechanicalVentilation

Parameters:value (str) – value for IDD Field Minimum Carbon Dioxide Concentration Schedule Name Raises:ValueError – if value is not a valid value Returns:the value of minimum_carbon_dioxide_concentration_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

class pyidf.zone_hvac_controls_and_thermostats.ZoneControlHumidistat

Bases: pyidf.helper.DataObject

Corresponds to IDD object ZoneControl:Humidistat Specifies zone relative humidity setpoint schedules for humidifying and dehumidifying.

dehumidifying_relative_humidity_setpoint_schedule_name

field Dehumidifying Relative Humidity Setpoint Schedule Name

hourly schedule values should be in Relative Humidity (percent)

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

humidifying_relative_humidity_setpoint_schedule_name

field Humidifying Relative Humidity Setpoint Schedule Name

hourly schedule values should be in Relative Humidity (percent)

Parameters:value (str) – value for IDD Field Humidifying Relative Humidity Setpoint Schedule Name Raises:ValueError – if value is not a valid value Returns:the value of humidifying_relative_humidity_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

zone_name

field Zone Name

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

class pyidf.zone_hvac_controls_and_thermostats.ZoneControlThermostat

Bases: pyidf.helper.DataObject

Corresponds to IDD object ZoneControl:Thermostat Define the Thermostat settings for a zone or list of zones. If you use a ZoneList in the Zone or ZoneList name field then this definition applies to all the zones in the ZoneList.

control_1_name

field Control 1 Name

Control names are names of individual control objects (e.g. ThermostatSetpoint:SingleHeating)

Schedule values in these objects list actual setpoint temperatures for the control types

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

control_1_object_type

field Control 1 Object Type

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

control_2_name

field Control 2 Name

Control names are names of individual control objects (e.g. ThermostatSetpoint:SingleHeating)

Schedule values in these objects list actual setpoint temperatures for the control types

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

control_2_object_type

field Control 2 Object Type

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

control_3_name

field Control 3 Name

Control names are names of individual control objects (e.g. ThermostatSetpoint:SingleHeating)

Schedule values in these objects list actual setpoint temperatures for the control types

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

control_3_object_type

field Control 3 Object Type

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

control_4_name

field Control 4 Name

Control names are names of individual control objects (e.g. ThermostatSetpoint:SingleHeating)

Schedule values in these objects list actual setpoint temperatures for the control types

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

control_4_object_type

field Control 4 Object Type

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

control_type_schedule_name

field Control Type Schedule Name

This schedule contains appropriate control types for thermostat.

Control types are integers: 0 - Uncontrolled (floating, no thermostat), 1 = ThermostatSetpoint:SingleHeating,

2 = ThermostatSetpoint:SingleCooling, 3 = ThermostatSetpoint:SingleHeatingOrCooling, 4 = ThermostatSetpoint:DualSetpoint

Parameters:value (str) – value for IDD Field Control Type Schedule Name Raises:ValueError – if value is not a valid value Returns:the value of control_type_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

zone_or_zonelist_name

field Zone or ZoneList Name

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

class pyidf.zone_hvac_controls_and_thermostats.ZoneControlThermostatOperativeTemperature

Bases: pyidf.helper.DataObject

Corresponds to IDD object ZoneControl:Thermostat:OperativeTemperature This object can be used with the ZoneList option on a thermostat or with one of the zones on that list (but you won’t be able to use the object list to pick only one of those zones. Thermostat names are <Zone Name> <global Thermostat name> internally.

fixed_radiative_fraction

field Fixed Radiative Fraction

value < 0.9

Parameters:value (float) – value for IDD Field Fixed Radiative Fraction Raises:ValueError – if value is not a valid value Returns:the value of fixed_radiative_fraction or None if not set Return type:float

radiative_fraction_input_mode

field Radiative Fraction Input Mode

Parameters:value (str) – value for IDD Field Radiative Fraction Input Mode Raises:ValueError – if value is not a valid value Returns:the value of radiative_fraction_input_mode or None if not set Return type:str

radiative_fraction_schedule_name

field Radiative Fraction Schedule Name

Schedule values of 0.0 indicate no operative temperature control

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

thermostat_name

field Thermostat Name

Enter the name of a ZoneControl:Thermostat object.

This object modifies a ZoneControl:Thermostat object to add a

radiative fraction.

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

class pyidf.zone_hvac_controls_and_thermostats.ZoneControlThermostatStagedDualSetpoint

Bases: pyidf.helper.DataObject

Corresponds to IDD object ZoneControl:Thermostat:StagedDualSetpoint Define the Thermostat StagedDualSetpoint settings for a zone or list of zones. If you use a ZoneList in the Zone or ZoneList name field then this definition applies to all the zones in the ZoneList.

cooling_temperature_setpoint_base_schedule_name

field Cooling Temperature Setpoint Base Schedule Name

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

cooling_throttling_temperature_range

field Cooling Throttling Temperature Range

Units: deltaC

Default value: 1.1

Parameters:value (float) – value for IDD Field Cooling Throttling Temperature Range Raises:ValueError – if value is not a valid value Returns:the value of cooling_throttling_temperature_range or None if not set Return type:float

heating_temperature_setpoint_schedule_name

field Heating Temperature Setpoint Schedule Name

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

heating_throttling_temperature_range

field Heating Throttling Temperature Range

Units: deltaC

Default value: 1.1

Parameters:value (float) – value for IDD Field Heating Throttling Temperature Range Raises:ValueError – if value is not a valid value Returns:the value of heating_throttling_temperature_range 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

number_of_cooling_stages

field Number of Cooling Stages

Enter the number of the following sets of data for cooling temperature offset

value >= 1

value <= 4

Parameters:value (int) – value for IDD Field Number of Cooling Stages Raises:ValueError – if value is not a valid value Returns:the value of number_of_cooling_stages or None if not set Return type:int

number_of_heating_stages

field Number of Heating Stages

Enter the number of the following sets of data for heating temperature offset

value >= 1

value <= 4

Parameters:value (int) – value for IDD Field Number of Heating Stages Raises:ValueError – if value is not a valid value Returns:the value of number_of_heating_stages or None if not set Return type:int

stage_1_cooling_temperature_offset

field Stage 1 Cooling Temperature Offset

The cooling temperature offset is used to determine cooling stage number for

multi stage equipment.

When the temperature difference of the cooling setpoint and the controlled zone

temperature at previous time step is greater than Stage 1 value and less than

Stage 2 value, the stage number is 1.

Units: deltaC

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

stage_1_heating_temperature_offset

field Stage 1 Heating Temperature Offset

The heating temperature offset is used to determine heating stage number for

multi stage equipment.

When the temperature difference of the heating setpoint and the controlled zone

temperature at previous time step is less than Stage 1 value and greater than

Stage 2 value, the stage number is 1.

Units: deltaC

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

stage_2_cooling_temperature_offset

field Stage 2 Cooling Temperature Offset

The cooling temperature offset is used to determine cooling stage number for

multi stage equipment.

When the temperature difference of the cooling setpoint and the controlled zone

temperature at previous time step is greater than Stage 2 value and less than

Stage 3 value, the stage number is 2.

The value of this field has to be greater than the value at the previous field.

Units: deltaC

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

stage_2_heating_temperature_offset

field Stage 2 Heating Temperature Offset

The heating temperature offset is used to determine heating stage number for

multi stage equipment.

When the temperature difference of the heating setpoint and the controlled zone

temperature at previous time step is less than Stage 2 value and greater than

Stage 3 value, the stage number is 2.

The value of this field has to be less the value at the previous field.

Units: deltaC

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

stage_3_cooling_temperature_offset

field Stage 3 Cooling Temperature Offset

The cooling temperature offset is used to determine cooling stage number for

multi stage equipment.

When the temperature difference of the cooling setpoint and the controlled zone

temperature at previous time step is greater than Stage 3 value and less than

Stage 4 value, the stage number is 3.

The value of this field has to be greater than the value at the previous field.

Units: deltaC

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

stage_3_heating_temperature_offset

field Stage 3 Heating Temperature Offset

The heating temperature offset is used to determine heating stage number for

multi stage equipment.

When the temperature difference of the heating setpoint and the controlled zone

temperature at previous time step is less than Stage 3 value and greater than

Stage 4 value, the stage number is 3.

The value of this field has to be less the value at the previous field.

Units: deltaC

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

stage_4_cooling_temperature_offset

field Stage 4 Cooling Temperature Offset

The cooling temperature offset is used to determine cooling stage number for

multi stage equipment.

When the temperature difference of the cooling setpoint and the controlled zone

temperature at previous time step is greater than Stage 4 value, the stage number is 4.

The value of this field has to be greater than the value at the previous field.

Units: deltaC

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

stage_4_heating_temperature_offset

field Stage 4 Heating Temperature Offset

The heating temperature offset is used to determine heating stage number for

multi stage equipment.

When the temperature difference of the heating setpoint and the controlled zone

temperature at previous time step is less than Stage 4 value, the stage number is 4.

The value of this field has to be less the value at the previous field.

Units: deltaC

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

zone_or_zonelist_name

field Zone or ZoneList Name

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

class pyidf.zone_hvac_controls_and_thermostats.ZoneControlThermostatTemperatureAndHumidity

Bases: pyidf.helper.DataObject

Corresponds to IDD object ZoneControl:Thermostat:TemperatureAndHumidity This object modifies a ZoneControl:Thermostat object to effect temperature control based on zone air humidity conditions.

dehumidification_control_type

field Dehumidification Control Type

Default value: Overcool

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

dehumidifying_relative_humidity_setpoint_schedule_name

field Dehumidifying Relative Humidity Setpoint Schedule Name

Schedule values should be in Relative Humidity (percent)

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

overcool_constant_range

field Overcool Constant Range

Maximum Overcool temperature range for cooling setpoint reduction.

Used with Dehumidification Control Type = Overcool.

A value of 0.0 indicates no zone temperature overcooling will be provided to

gain additional dehumidification.

Units: deltaC

Default value: 1.7

value <= 3.0

Parameters:value (float) – value for IDD Field Overcool Constant Range Raises:ValueError – if value is not a valid value Returns:the value of overcool_constant_range or None if not set Return type:float

overcool_control_ratio

field Overcool Control Ratio

The value of this input field is used to adjust the cooling setpoint temperature

(established by the associated ZoneControl:Thermostat object) downward based on the

difference between the zone air relative humidity level and the dehumidifying

relative humidity setpoint.

Units: percent/K

Default value: 3.6

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

overcool_range_input_method

field Overcool Range Input Method

Default value: Constant

Parameters:value (str) – value for IDD Field Overcool Range Input Method Raises:ValueError – if value is not a valid value Returns:the value of overcool_range_input_method or None if not set Return type:str

overcool_range_schedule_name

field Overcool Range Schedule Name

Schedule values of 0.0 indicates no zone temperature overcooling will be

provided to gain additional dehumidification.

Schedule values should be >= 0 and <= 3 (deltaC).

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

thermostat_name

field Thermostat Name

Enter the name of a ZoneControl:Thermostat object whose operation is to be modified to

effect temperature control based on zone air humidity conditions. If the ZoneControl:

Thermostat object references a ZoneList, simply enter the name of the ZoneControl:Thermostat

object and this temperature and humidity thermostat control will be applied to all zones

in the ZoneList. If the ZoneControl:Thermostat object references a ZoneList but it is

desired that only a single zone within the ZoneList be controlled based on temperature and

humidity control, then the name to be put here is <Zone Name> <Thermostat Name> where the

Thermostat Name is the the name of the ZoneControl:Thermostat object.

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

class pyidf.zone_hvac_controls_and_thermostats.ZoneControlThermostatThermalComfort

Bases: pyidf.helper.DataObject

Corresponds to IDD object ZoneControl:Thermostat:ThermalComfort If you use a ZoneList in the Zone or ZoneList name field then this definition applies to all the zones in the ZoneList.

averaging_method

field Averaging Method

The method used to calculate thermal comfort dry-bulb temperature setpoint

for multiple people objects in a zone

Default value: PeopleAverage

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

maximum_drybulb_temperature_setpoint

field Maximum Dry-Bulb Temperature Setpoint

Units: C

Default value: 50.0

value <= 50.0

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

minimum_drybulb_temperature_setpoint

field Minimum Dry-Bulb Temperature Setpoint

Units: C

value <= 50.0

Parameters:value (float) – value for IDD Field Minimum Dry-Bulb Temperature Setpoint Raises:ValueError – if value is not a valid value Returns:the value of minimum_drybulb_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

specific_people_name

field Specific People Name

Used only when Averaging Method = SpecificObject in the previous field.

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

thermal_comfort_control_1_name

field Thermal Comfort Control 1 Name

Control type names are names for individual control type objects.

Schedule values in these objects list actual setpoint temperatures for the control types

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

thermal_comfort_control_1_object_type

field Thermal Comfort Control 1 Object Type

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

thermal_comfort_control_2_name

field Thermal Comfort Control 2 Name

Control Type names are names for individual control type objects.

Schedule values in these objects list actual setpoint temperatures for the control types

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

thermal_comfort_control_2_object_type

field Thermal Comfort Control 2 Object Type

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

thermal_comfort_control_3_name

field Thermal Comfort Control 3 Name

Control type names are names for individual control type objects.

Schedule values in these objects list actual setpoint temperatures for the control types

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

thermal_comfort_control_3_object_type

field Thermal Comfort Control 3 Object Type

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

thermal_comfort_control_4_name

field Thermal Comfort Control 4 Name

Control type names are names for individual control type objects.

Schedule values in these objects list actual setpoint temperatures for the control types

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

thermal_comfort_control_4_object_type

field Thermal Comfort Control 4 Object Type

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

thermal_comfort_control_type_schedule_name

field Thermal Comfort Control Type Schedule Name

The Thermal Comfort Control Type Schedule contains values that are appropriate control types.

Thermal Comfort Control types are integers: 0 - Uncontrolled (floating),

1 = ThermostatSetpoint:ThermalComfort:Fanger:SingleHeating

2 = ThermostatSetpoint:ThermalComfort:Fanger:SingleCooling

3 = ThermostatSetpoint:ThermalComfort:Fanger:SingleHeatingOrCooling

4 = ThermostatSetpoint:ThermalComfort:Fanger:DualSetpoint

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

zone_or_zonelist_name

field Zone or ZoneList Name

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