pyidf.energy_management_system module

Data objects in group “Energy Management System”

class pyidf.energy_management_system.EnergyManagementSystemActuator

Bases: pyidf.helper.DataObject

Corresponds to IDD object EnergyManagementSystem:Actuator Hardware portion of EMS used to set up actuators in the model

actuated_component_control_type

field Actuated Component Control Type

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

actuated_component_type

field Actuated Component Type

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

actuated_component_unique_name

field Actuated Component Unique Name

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

name

field Name

This name becomes a variable for use in Erl programs

no spaces allowed in 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.energy_management_system.EnergyManagementSystemConstructionIndexVariable

Bases: pyidf.helper.DataObject

Corresponds to IDD object EnergyManagementSystem:ConstructionIndexVariable Declares EMS variable that identifies a construction

construction_object_name

field Construction Object Name

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

name

field Name

This name becomes a variable for use in Erl programs

no spaces allowed in 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.energy_management_system.EnergyManagementSystemCurveOrTableIndexVariable

Bases: pyidf.helper.DataObject

Corresponds to IDD object EnergyManagementSystem:CurveOrTableIndexVariable Declares EMS variable that identifies a curve or table

curve_or_table_object_name

field Curve or Table Object Name

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

name

field Name

This name becomes a variable for use in Erl programs

no spaces allowed in 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.energy_management_system.EnergyManagementSystemGlobalVariable

Bases: pyidf.helper.DataObject

Corresponds to IDD object EnergyManagementSystem:GlobalVariable Declares Erl variable as having global scope No spaces allowed in names used for Erl variables

add_extensible(erl_variable_1_name=None)

Add values for extensible fields

Parameters:erl_variable_1_name (str) – value for IDD Field Erl Variable 1 Name if value is None it will not be checked against the specification and is assumed to be a missing value

extensibles

Get list of all extensibles

class pyidf.energy_management_system.EnergyManagementSystemInternalVariable

Bases: pyidf.helper.DataObject

Corresponds to IDD object EnergyManagementSystem:InternalVariable Declares EMS variable as an internal data variable

internal_data_index_key_name

field Internal Data Index Key Name

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

internal_data_type

field Internal Data Type

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

name

field Name

This name becomes a variable for use in Erl programs

no spaces allowed in 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.energy_management_system.EnergyManagementSystemMeteredOutputVariable

Bases: pyidf.helper.DataObject

Corresponds to IDD object EnergyManagementSystem:MeteredOutputVariable This object sets up an EnergyPlus output variable from an Erl variable

ems_program_or_subroutine_name

field EMS Program or Subroutine Name

optional for global scope variables, required for local scope variables

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

ems_variable_name

field EMS Variable Name

must be an acceptable EMS variable, no spaces

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

enduse_category

field End-Use Category

choose how the metered output should be classified for end-use category

Parameters:value (str) – value for IDD Field End-Use Category Raises:ValueError – if value is not a valid value Returns:the value of enduse_category or None if not set Return type:str

enduse_subcategory

field End-Use Subcategory

enter a user-defined subcategory for this metered output

Parameters:value (str) – value for IDD Field End-Use Subcategory Raises:ValueError – if value is not a valid value Returns:the value of enduse_subcategory or None if not set Return type:str

group_type

field Group Type

choose a general classification, building (internal services), HVAC (air systems), or plant (hydronic systems), or system

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

resource_type

field Resource Type

choose the type of fuel, water, electricity, pollution or heat rate that should be metered.

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

units

field Units

optional but will result in dimensionless units for blank

EnergyPlus units are standard SI units

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

update_frequency

field Update Frequency

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

class pyidf.energy_management_system.EnergyManagementSystemOutputVariable

Bases: pyidf.helper.DataObject

Corresponds to IDD object EnergyManagementSystem:OutputVariable This object sets up an EnergyPlus output variable from an Erl variable

ems_program_or_subroutine_name

field EMS Program or Subroutine Name

optional for global scope variables, required for local scope variables

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

ems_variable_name

field EMS Variable Name

must be an acceptable EMS variable

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

type_of_data_in_variable

field Type of Data in Variable

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

units

field Units

optional but will result in dimensionless units for blank

EnergyPlus units are standard SI units

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

update_frequency

field Update Frequency

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

class pyidf.energy_management_system.EnergyManagementSystemProgram

Bases: pyidf.helper.DataObject

Corresponds to IDD object EnergyManagementSystem:Program This input defines an Erl program Each field after the name is a line of EMS Runtime Language

add_extensible(program_line_1=None)

Add values for extensible fields

Parameters:program_line_1 (str) – value for IDD Field Program Line 1 if value is None it will not be checked against the specification and is assumed to be a missing value

extensibles

Get list of all extensibles

name

field Name

no spaces allowed in 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.energy_management_system.EnergyManagementSystemProgramCallingManager

Bases: pyidf.helper.DataObject

Corresponds to IDD object EnergyManagementSystem:ProgramCallingManager Input EMS program. a program needs a name a description of when it should be called and then lines of program code for EMS Runtime language

add_extensible(program_name_1=None)

Add values for extensible fields

Parameters:program_name_1 (str) – value for IDD Field Program Name 1 if value is None it will not be checked against the specification and is assumed to be a missing value

energyplus_model_calling_point

field EnergyPlus Model Calling Point

Parameters:value (str) – value for IDD Field EnergyPlus Model Calling Point Raises:ValueError – if value is not a valid value Returns:the value of energyplus_model_calling_point or None if not set Return type:str

extensibles

Get list of all extensibles

name

field Name

no spaces allowed in 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.energy_management_system.EnergyManagementSystemSensor

Bases: pyidf.helper.DataObject

Corresponds to IDD object EnergyManagementSystem:Sensor Declares EMS variable as a sensor a list of output variables and meters that can be reported are available after a run on the report (.rdd) or meter dictionary file (.mdd) if the Output:VariableDictionary has been requested.

name

field Name

This name becomes a variable for use in Erl programs

no spaces allowed in 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

outputvariable_or_outputmeter_index_key_name

field Output:Variable or Output:Meter Index Key Name

Parameters:value (str) – value for IDD Field Output:Variable or Output:Meter Index Key Name Raises:ValueError – if value is not a valid value Returns:the value of outputvariable_or_outputmeter_index_key_name or None if not set Return type:str

outputvariable_or_outputmeter_name

field Output:Variable or Output:Meter Name

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

class pyidf.energy_management_system.EnergyManagementSystemSubroutine

Bases: pyidf.helper.DataObject

Corresponds to IDD object EnergyManagementSystem:Subroutine This input defines an Erl program subroutine Each field after the name is a line of EMS Runtime Language

add_extensible(program_line_1=None)

Add values for extensible fields

Parameters:program_line_1 (str) – value for IDD Field Program Line 1 if value is None it will not be checked against the specification and is assumed to be a missing value

extensibles

Get list of all extensibles

name

field Name

no spaces allowed in 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.energy_management_system.EnergyManagementSystemTrendVariable

Bases: pyidf.helper.DataObject

Corresponds to IDD object EnergyManagementSystem:TrendVariable This object sets up an EMS trend variable from an Erl variable A trend variable logs values across timesteps

ems_variable_name

field EMS Variable Name

must be a global scope EMS variable

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

name

field Name

no spaces allowed in 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_timesteps_to_be_logged

field Number of Timesteps to be Logged

value >= 1

Parameters:value (int) – value for IDD Field Number of Timesteps to be Logged Raises:ValueError – if value is not a valid value Returns:the value of number_of_timesteps_to_be_logged or None if not set Return type:int