pyidf.external_interface module¶

Data objects in group “External Interface”

class pyidf.external_interface.ExternalInterface¶

Bases: pyidf.helper.DataObject

Corresponds to IDD object ExternalInterface This object activates the external interface of EnergyPlus. If the object ExternalInterface is present, then all ExtnernalInterface:* objects will receive their values from the BCVTB interface or from FMUs at each zone time step. If this object is not present, then the values of these objects will be fixed at the value declared in the “initial value” field of the corresponding object, and a warning will be written to the EnergyPlus error file.

name_of_external_interface¶

field Name of External Interface

Name of External Interface

Currently, the only valid entries are PtolemyServer, FunctionalMockupUnitImport, and FunctionalMockupUnitExport.

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

class pyidf.external_interface.ExternalInterfaceActuator¶

Bases: pyidf.helper.DataObject

Corresponds to IDD object ExternalInterface: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

optional_initial_value¶

field Optional Initial Value

If specified, it is used during warm-up and system sizing.
If not specified, then the actuator only overwrites the
actuated component after the warm-up and system sizing.

Parameters:	value (float) – value for IDD Field Optional Initial Value
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of optional_initial_value or None if not set
Return type:	float

class pyidf.external_interface.ExternalInterfaceFunctionalMockupUnitExportFromVariable¶

Bases: pyidf.helper.DataObject

Corresponds to IDD object ExternalInterface:FunctionalMockupUnitExport:From:Variable This object declares an FMU input variable

fmu_variable_name¶

field FMU Variable Name

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

outputvariable_index_key_name¶

field Output:Variable Index Key Name

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

outputvariable_name¶

field Output:Variable Name

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

class pyidf.external_interface.ExternalInterfaceFunctionalMockupUnitExportToActuator¶

Bases: pyidf.helper.DataObject

Corresponds to IDD object ExternalInterface:FunctionalMockupUnitExport:To:Actuator Hardware portion of EMS used to set up actuators in the model that are dynamically updated from the FMU.

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

fmu_variable_name¶

field FMU Variable Name

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

initial_value¶

field Initial Value

Used during the first call of EnergyPlus.

Parameters:	value (float) – value for IDD Field Initial Value
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of initial_value or None if not set
Return type:	float

name¶

field Name

This name becomes a read-only 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.external_interface.ExternalInterfaceFunctionalMockupUnitExportToSchedule¶

Bases: pyidf.helper.DataObject

Corresponds to IDD object ExternalInterface:FunctionalMockupUnitExport:To:Schedule This objects contains only one value, which is used during the first call of EnergyPlus

fmu_variable_name¶

field FMU Variable Name

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

initial_value¶

field Initial Value

Used during the first call of EnergyPlus.

Parameters:	value (float) – value for IDD Field Initial Value
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of initial_value or None if not set
Return type:	float

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

schedule_type_limits_names¶

field Schedule Type Limits Names

Parameters:	value (str) – value for IDD Field Schedule Type Limits Names
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of schedule_type_limits_names or None if not set
Return type:	str

class pyidf.external_interface.ExternalInterfaceFunctionalMockupUnitExportToVariable¶

Bases: pyidf.helper.DataObject

Corresponds to IDD object ExternalInterface:FunctionalMockupUnitExport:To:Variable Declares Erl variable as having global scope No spaces allowed in names used for Erl variables

fmu_variable_name¶

field FMU Variable Name

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

initial_value¶

field Initial Value

Used during the first call of EnergyPlus.

Parameters:	value (float) – value for IDD Field Initial Value
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of initial_value or None if not set
Return type:	float

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.external_interface.ExternalInterfaceFunctionalMockupUnitImport¶

Bases: pyidf.helper.DataObject

Corresponds to IDD object ExternalInterface:FunctionalMockupUnitImport This object declares an FMU

fmu_file_name¶

field FMU File Name

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

fmu_loggingon¶

field FMU LoggingOn

Parameters:	value (int) – value for IDD Field FMU LoggingOn
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of fmu_loggingon or None if not set
Return type:	int

fmu_timeout¶

field FMU Timeout

in milli-seconds

Units: ms

Parameters:	value (float) – value for IDD Field FMU Timeout
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of fmu_timeout or None if not set
Return type:	float

class pyidf.external_interface.ExternalInterfaceFunctionalMockupUnitImportFromVariable¶

Bases: pyidf.helper.DataObject

Corresponds to IDD object ExternalInterface:FunctionalMockupUnitImport:From:Variable This object declares an FMU input variable

fmu_file_name¶

field FMU File Name

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

fmu_instance_name¶

field FMU Instance Name

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

fmu_variable_name¶

field FMU Variable Name

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

outputvariable_index_key_name¶

field Output:Variable Index Key Name

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

outputvariable_name¶

field Output:Variable Name

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

class pyidf.external_interface.ExternalInterfaceFunctionalMockupUnitImportToActuator¶

Bases: pyidf.helper.DataObject

Corresponds to IDD object ExternalInterface:FunctionalMockupUnitImport:To:Actuator Hardware portion of EMS used to set up actuators in the model that are dynamically updated from the FMU.

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

fmu_file_name¶

field FMU File Name

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

fmu_instance_name¶

field FMU Instance Name

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

fmu_variable_name¶

field FMU Variable Name

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

initial_value¶

field Initial Value

Used during the first call of EnergyPlus.

Parameters:	value (float) – value for IDD Field Initial Value
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of initial_value or None if not set
Return type:	float

name¶

field Name

This name becomes a read-only 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.external_interface.ExternalInterfaceFunctionalMockupUnitImportToSchedule¶

Bases: pyidf.helper.DataObject

Corresponds to IDD object ExternalInterface:FunctionalMockupUnitImport:To:Schedule This objects contains only one value, which is used during the first call of EnergyPlus

fmu_file_name¶

field FMU File Name

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

fmu_instance_name¶

field FMU Instance Name

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

fmu_variable_name¶

field FMU Variable Name

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

initial_value¶

field Initial Value

Used during the first call of EnergyPlus.

Parameters:	value (float) – value for IDD Field Initial Value
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of initial_value 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

schedule_type_limits_names¶

field Schedule Type Limits Names

Parameters:	value (str) – value for IDD Field Schedule Type Limits Names
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of schedule_type_limits_names or None if not set
Return type:	str

class pyidf.external_interface.ExternalInterfaceFunctionalMockupUnitImportToVariable¶

Bases: pyidf.helper.DataObject

Corresponds to IDD object ExternalInterface:FunctionalMockupUnitImport:To:Variable Declares Erl variable as having global scope No spaces allowed in names used for Erl variables

fmu_file_name¶

field FMU File Name

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

fmu_instance_name¶

field FMU Instance Name

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

fmu_variable_name¶

field FMU Variable Name

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

initial_value¶

field Initial Value

Used during the first call of EnergyPlus.

Parameters:	value (float) – value for IDD Field Initial Value
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of initial_value or None if not set
Return type:	float

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.external_interface.ExternalInterfaceSchedule¶

Bases: pyidf.helper.DataObject

Corresponds to IDD object ExternalInterface:Schedule A ExternalInterface:Schedule contains only one value, which is used during the warm-up period and the system sizing.

initial_value¶

field Initial Value

Used during warm-up and system sizing.

Parameters:	value (float) – value for IDD Field Initial Value
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of initial_value 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

schedule_type_limits_name¶

field Schedule Type Limits Name

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

class pyidf.external_interface.ExternalInterfaceVariable¶

Bases: pyidf.helper.DataObject

Corresponds to IDD object ExternalInterface:Variable This input object is similar to EnergyManagementSystem:GlobalVariable. However, at the beginning of each zone time step, its value is set to the value received from the external interface. During the warm-up period and the system sizing, its value is set to the value specified by the field “initial value.” This object can be used to move data into Erl subroutines.

initial_value¶

field Initial Value

Used during warm-up and system sizing.

Parameters:	value (float) – value for IDD Field Initial Value
Raises:	`ValueError` – if value is not a valid value
Returns:	the value of initial_value or None if not set
Return type:	float

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

pyidf.external_interface module¶

Related Topics

This Page