External Interface¶

13 object types from idfpy.models.external_interface · EnergyPlus 26.2

Object	Summary
ExternalInterface	This object activates the external interface of EnergyPlus.
ExternalInterface:Actuator	Hardware portion of EMS used to set up actuators in the model
ExternalInterface:FunctionalMockupUnitExport:From:Variable	This object declares an FMU input variable
ExternalInterface:FunctionalMockupUnitExport:To:Actuator	Hardware portion of EMS used to set up actuators in the model that are dynamically updated from the FMU.
ExternalInterface:FunctionalMockupUnitExport:To:Schedule	This objects contains only one value, which is used during the first call of EnergyPlus
ExternalInterface:FunctionalMockupUnitExport:To:Variable	Declares Erl variable as having global scope No spaces allowed in names used for Erl variables
ExternalInterface:FunctionalMockupUnitImport	This object declares an FMU
ExternalInterface:FunctionalMockupUnitImport:From:Variable	This object declares an FMU input variable
ExternalInterface:FunctionalMockupUnitImport:To:Actuator	Hardware portion of EMS used to set up actuators in the model that are dynamically updated from the FMU.
ExternalInterface:FunctionalMockupUnitImport:To:Schedule	This objects contains only one value, which is used during the first call of EnergyPlus
ExternalInterface:FunctionalMockupUnitImport:To:Variable	Declares Erl variable as having global scope No spaces allowed in names used for Erl variables
ExternalInterface:Schedule	A ExternalInterface:Schedule contains only one value, which is used during the warm-up period and the system …
ExternalInterface:Variable	This input object is similar to EnergyManagementSystem:GlobalVariable.

ExternalInterface¶

from idfpy.models import 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.

Field	Type	Default	Details
`name_of_external_interface` Name of External Interface required	choice		Name of External Interface Currently, the only valid entries are PtolemyServer, FunctionalMockupUnitImport, and FunctionalMockupUnitExport. One of `FunctionalMockupUnitExport`, `FunctionalMockupUnitImport`, `PtolemyServer`

ExternalInterface:Actuator¶

from idfpy.models import ExternalInterfaceActuator

Hardware portion of EMS used to set up actuators in the model

Field	Type	Details
`name` Name required	string	This name becomes a variable for use in Erl programs no spaces allowed in name
`actuated_component_unique_name` Actuated Component Unique Name required	string
`actuated_component_type` Actuated Component Type required	string
`actuated_component_control_type` Actuated Component Control Type required	string
`optional_initial_value` Optional Initial Value	number	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.

ExternalInterface:FunctionalMockupUnitExport:From:Variable¶

from idfpy.models import ExternalInterfaceFunctionalMockupUnitExportFromVariable

This object declares an FMU input variable

Field	Type	Default	Details
`output_variable_index_key_name` Output:Variable Index Key Name required	string
`output_variable_name` Output:Variable Name required	string
`fmu_variable_name` FMU Variable Name required	string

ExternalInterface:FunctionalMockupUnitExport:To:Actuator¶

from idfpy.models import ExternalInterfaceFunctionalMockupUnitExportToActuator

Hardware portion of EMS used to set up actuators in the model that are dynamically updated from the FMU.

Field	Type	Details
`name` Name required	string	This name becomes a read-only variable for use in Erl programs no spaces allowed in name
`actuated_component_unique_name` Actuated Component Unique Name required	string
`actuated_component_type` Actuated Component Type required	string
`actuated_component_control_type` Actuated Component Control Type required	string
`fmu_variable_name` FMU Variable Name required	string
`initial_value` Initial Value	number	Used during EnergyPlus sizing and warm-up. If no value is specified, then the actuated component will only be updated after sizing and warm-up.

ExternalInterface:FunctionalMockupUnitExport:To:Schedule¶

from idfpy.models import ExternalInterfaceFunctionalMockupUnitExportToSchedule

This objects contains only one value, which is used during the first call of EnergyPlus

Field	Type	Details
`schedule_name` Schedule Name required	string
`schedule_type_limits_names` Schedule Type Limits Names	reference	Names a ScheduleTypeLimits
`fmu_variable_name` FMU Variable Name required	string
`initial_value` Initial Value	number	Used during EnergyPlus sizing and warm-up.

Referenced by 350 object types

ExternalInterface:FunctionalMockupUnitExport:To:Variable¶

from idfpy.models import ExternalInterfaceFunctionalMockupUnitExportToVariable

Declares Erl variable as having global scope No spaces allowed in names used for Erl variables

Field	Type	Details
`name` Name required	string	This name becomes a variable for use in Erl programs no spaces allowed in name
`fmu_variable_name` FMU Variable Name required	string
`initial_value` Initial Value required	number	Used during EnergyPlus sizing and warm-up.

ExternalInterface:FunctionalMockupUnitImport¶

from idfpy.models import ExternalInterfaceFunctionalMockupUnitImport

This object declares an FMU

Field	Type	Default	Details
`fmu_file_name` FMU File Name required	string
`fmu_timeout` FMU Timeout	number ms	`0.0`	in milli-seconds
`fmu_loggingon` FMU LoggingOn	integer	`0`

Referenced by 4 object types

ExternalInterface:FunctionalMockupUnitImport:From:Variable, ExternalInterface:FunctionalMockupUnitImport:To:Actuator, ExternalInterface:FunctionalMockupUnitImport:To:Schedule, ExternalInterface:FunctionalMockupUnitImport:To:Variable

ExternalInterface:FunctionalMockupUnitImport:From:Variable¶

from idfpy.models import ExternalInterfaceFunctionalMockupUnitImportFromVariable

This object declares an FMU input variable

Field	Type	Details
`output_variable_index_key_name` Output:Variable Index Key Name required	string
`output_variable_name` Output:Variable Name required	string
`fmu_file_name` FMU File Name required	reference	Names a ExternalInterface:FunctionalMockupUnitImport
`fmu_instance_name` FMU Instance Name required	string
`fmu_variable_name` FMU Variable Name required	string

ExternalInterface:FunctionalMockupUnitImport:To:Actuator¶

from idfpy.models import ExternalInterfaceFunctionalMockupUnitImportToActuator

Hardware portion of EMS used to set up actuators in the model that are dynamically updated from the FMU.

Field	Type	Details
`name` Name required	string	This name becomes a read-only variable for use in Erl programs no spaces allowed in name
`actuated_component_unique_name` Actuated Component Unique Name required	string
`actuated_component_type` Actuated Component Type required	string
`actuated_component_control_type` Actuated Component Control Type required	string
`fmu_file_name` FMU File Name required	reference	Names a ExternalInterface:FunctionalMockupUnitImport
`fmu_instance_name` FMU Instance Name required	string
`fmu_variable_name` FMU Variable Name required	string
`initial_value` Initial Value required	number	Used during the first call of EnergyPlus.

ExternalInterface:FunctionalMockupUnitImport:To:Schedule¶

from idfpy.models import ExternalInterfaceFunctionalMockupUnitImportToSchedule

This objects contains only one value, which is used during the first call of EnergyPlus

Field	Type	Details
`name` Name required	string
`schedule_type_limits_names` Schedule Type Limits Names	reference	Names a ScheduleTypeLimits
`fmu_file_name` FMU File Name required	reference	Names a ExternalInterface:FunctionalMockupUnitImport
`fmu_instance_name` FMU Instance Name required	string
`fmu_variable_name` FMU Variable Name required	string
`initial_value` Initial Value required	number	Used during the first call of EnergyPlus.

Referenced by 350 object types

ExternalInterface:FunctionalMockupUnitImport:To:Variable¶

from idfpy.models import ExternalInterfaceFunctionalMockupUnitImportToVariable

Declares Erl variable as having global scope No spaces allowed in names used for Erl variables

Field	Type	Details
`name` Name required	string	This name becomes a variable for use in Erl programs no spaces allowed in name
`fmu_file_name` FMU File Name required	reference	Names a ExternalInterface:FunctionalMockupUnitImport
`fmu_instance_name` FMU Instance Name required	string
`fmu_variable_name` FMU Variable Name required	string
`initial_value` Initial Value required	number	Used during the first call of EnergyPlus.

ExternalInterface:Schedule¶

from idfpy.models import ExternalInterfaceSchedule

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

Field	Type	Details
`name` Name required	string
`schedule_type_limits_name` Schedule Type Limits Name	reference	Names a ScheduleTypeLimits
`initial_value` Initial Value required	number	Used during warm-up and system sizing.

Referenced by 350 object types

ExternalInterface:Variable¶

from idfpy.models import ExternalInterfaceVariable

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.

Field	Type	Default	Details
`name` Name required	string		This name becomes a variable for use in Erl programs no spaces allowed in name
`initial_value` Initial Value required	number		Used during warm-up and system sizing.