ScriptApplicationComposer¶

class ScriptApplicationComposer.ScriptModuleRepository¶

Bases: object

An instance of an object implementing this interface is injected into the scriptengine scope under the name “modulerepository”.

get_toplevel_instances()¶

Gets all Toplevel-Module-Instances of the primary project.

Return type:: list
Returns:: Returns all Toplevel-Module-Instances of the primary project.

get_all_instances()¶

Gets all Module-Instances of the primary project.

Return type:: list
Returns:: Returns all Module-Instances of the primary project.

get_toplevel_modules()¶

Gets all Toplevel-Modules available in the primary project.

Return type:: list
Returns:: Returns all Toplevel-Modules available in the primary project.

get_all_modules()¶

Gets all Modules available in the primary project.

Return type:: list
Returns:: Returns all Modules available in the primary project.

find_module(stQualifiedName)¶

Finds the module with its declaration at the given qualified path (namespace.modulename).

Parameters:: stQualifiedName (str) – The qualified path of the module description.
Return type:: ScriptModule
Returns:: The module defined by the module description at the qualified path.

get_compatible_modules(slot)¶

Gets all modules which are compatible to a specified slot.

Parameters:: slot (ScriptModuleSlot) – The slot for which comaptible modules shall be searched.
Return type:: list
Returns:: Returns a list of all compatible modules as ScriptModule-Objects.

add_toplevel_instance(stInstanceName, scriptMd)¶

Adds a toplevel instance to the module tree.

Parameters:

stInstanceName (str) – The desired name for the toplevel instance.
scriptMd (ScriptModule) – The ScriptModule-Object describing the desired module type.

Return type:

ScriptObject

Returns:

Returns the added toplevel instance ScriptObject-Object or None if the operation failed.

add_submodule_instance(stInstanceName, scriptMd, scriptSlot, index)¶

Adds a submodule instance to the module tree under the specified slot.

The slot has to have an ownership of type submodule, otherwise the operation will return None.

Parameters:

stInstanceName (str) – The desired name of the submodule instance.
scriptMd (ScriptModule) – The ScriptModule-Object describing the desired module type.
scriptSlot (ScriptModuleSlotInstance) – The ScriptModuleSlot-Object under which the new submodule instance shall be created.
index (int) – The index defining the position of the created submodule instance under the slot.

Return type:

ScriptObject

Returns:

Returns the added submodule instance as ScriptObject-Object or None if the operation failed.

add_reference_instance(scriptObj, scriptSlot, index)¶

Adds a reference instance to the module tree under the specified slot.

The slot has to have an ownership of type reference, otherwise the operation will return None.

Parameters:

scriptObj (ScriptObject) – The ScriptObject-Object of the module instance which shall be reference by the created reference instance.
scriptSlot (ScriptModuleSlotInstance) – The ScriptModuleSlot-Object under which the new reference instance shall be created.
index (int) – The index defining the position of the created reference instance under the slot. Not relevant if scriptSlot is a Single-slot.

Return type:

ScriptObject

Returns:

Returns the added reference instance as ScriptObject-Object or None if the operation failed.

set_generator(stGenGuid, bEnable)¶

Enables generators in the generator settings.

Parameters:

stGenGuid (str) – The string representation of Guid of the generator, which shall be enabled.
bEnable (bool) – Whether the generator shall be enabled or not.

Return type:

bool

Returns:

Returns True if enabling succeeded.

load_wildcard_setting(stFileName)¶

Loads a specific XML file into the wildcard options dialog.

Parameters:: stFileName (str) – The file to be loaded into the wildcard dialogs settings. If None the current filename or last used filename is used.
Return type:: bool
Returns:: Returns True if loading succeeded.

create_module_declaration_object(stDeclObjectName, stDeclObjectText)¶

Adds a module declaration object to the POU-Pool.

Parameters:

stDeclObjectName (str) – The name of the module declaration object.
stDeclObjectText (str) – The declaration text in the module declaration object. This text can be changed using the module declaration object afterwards.

Return type:

ScriptObject

Returns:

Returns the module declaration object as ScriptObject-Object or None if the operation failed.

generate()¶

Generate an IEC-Application from configured module instance tree.

Return type:: bool
Returns:: Returns True in case of success.

scan_all_modules()¶

Scans all available module declarations.

Return type:: bool
Returns:: Returns True in case of no error.

generate_and_login()¶

Generates the IEC-Application from the module tree.

It then uploads this application and logs on.

Return type:: bool

update_all_module_instances()¶: Update all module instances to the current version of the module descriptions.

class ScriptApplicationComposer.ScriptApplicationComposerObjectMarker¶

Bases: object

Every ScriptObject instance will be extended using this interface.

property is_module_instance_object¶

Gets a bool indicating whether this ScriptObject is a ModuleInstanceObject object.

Return type:: bool

property is_module_reference_object¶

Gets a bool indicating whether this ScriptObject is a ModuleReference object.

Return type:: bool

property is_module_declaration_object¶

Gets a bool indicating whether this ScriptObject is a ModuleDeclObject object.

Return type:: bool

class ScriptApplicationComposer.ScriptModuleInstanceObject¶

Bases: ScriptApplicationComposerObjectMarker

Functionality for manipulating ModuleInstanceObject-Objects.

All Objects implementing ModuleInstanceObject will be extended with this methods.

property name¶

Gets the Instance-Name of the ModuleInstanceObject-Object.

Return type:: str

property module¶

Gets the Module this instance is type of.

Return type:: ScriptModule

property parameters¶

Gets the Parameters of the Instance (see ScriptModule).

Return type:: list

property ios¶

Gets the IOs of the Instance (see ScriptModule).

Return type:: list

property slots¶

Gets the Slots of the Instance (see ScriptModule).

Return type:: list

property inst_refs¶

Gets the InstanceReferences of the Instance (see ScriptModule).

Return type:: list

property toplevel_info¶

Gets the ToplevelInfo of the Instance (see ScriptModule).

Returns None if the instance is not toplevel.

Return type:: ScriptModuleToplevelInfoInstance

property parent_instance¶

Gets the parent module instance or None if this instance is toplevel.

Return type:: ScriptObject

property parent_slot¶

Gets the slot this module instance is connected to or None if this instance is toplevel.

Return type:: ScriptModuleSlotInstance

property is_submodule¶

Whether this module instance is a submodule or not.

Return type:: bool

class ScriptApplicationComposer.ScriptModuleReferenceObject¶

Bases: ScriptApplicationComposerObjectMarker

Functionality for manipulating ModuleReferenceObjects.

All Objects implementing ModuleReferenceObject will be extended with this methods.

property target¶

Returns the referenced module instance object or None if the referenced instance does not exit.

Return type:: ScriptObject

property target_path¶

Returns the (relative) instance path of the referenced object.

The components of the path are separated by “/” characters, the parent path is denoted by the special string “..”.

Return type:: str

class ScriptApplicationComposer.ScriptModule¶

Bases: object

Interface providing necessary information and functionalities dealing with Modules in Python.

Equalling the type Module in the application composer interface collection.

property name¶

Gets the name of the Module.

Return type:: str

property qualified_name¶

Gets the fully qualified Name (namespace.modulename) of the Module.

Return type:: str

property parameters¶

Gets all Module-Parameters.

Return type:: list

property ios¶

Gets all Module-IOs.

Return type:: list

property slots¶

Gets all Module-Slots.

Return type:: list

property inst_refs¶

Gets all Module-InstanceReferences.

Return type:: list

property var_arrays¶

Gets all Module-VarArrays.

Return type:: list

property toplevel_info¶

Gets the Module-ToplevelInfo.

Returns None if module is not toplevel.

Return type:: ScriptModuleToplevelInfo

property meta_data¶

Gets the Module-MetaData.

Returns None if module is not toplevel.

Return type:: ScriptModuleMetaData

property proxies¶

Gets all Module-Proxies.

Return type:: list

property iec_declaration¶

Gets the declaration of the corresponding Module-IEC-FB.

Return type:: ScriptModuleIECDecl

property is_param_page_disabled¶

Whether the Editors Parameters-Page is dissabled or not.

Return type:: bool

property is_toplevel_page_disabled¶

Whether the Editors Toplevel-Page is dissabled or not.

Return type:: bool

property device_generator_data¶

Returns the data provided for the device generator.

Return type:: ScriptModuleDeviceGeneratorData

property alarm_generator_data¶

Returns the data provided for the alarm generator.

Return type:: ScriptModuleAlarmGeneratorData

class ScriptApplicationComposer.ScriptModuleParameter¶

Bases: object

Interface providing necessary information and functionalities for dealing with Module-Parameters in Python.

property name¶

Localized (multi-lingual) name of the Parameter.

Return type:: str

property description¶

Localized (multi-lingual) description of the Parameter.

Return type:: str

property id¶

Id of the Parameter. The Id is unique among all Parameters of one module.

Return type:: str

get_value()¶

The current value of the Parameter.

If no value is set, default or initial values that are actually used are returned. If this parameter does not belong to a Module instance an empty string is returned.

Return type:: str

property type¶

The IEC-Type of the Parameter.

Return type:: str

property var_path¶

Gets the instance path of the Parameters variable relative to the instance FB of the module.

Return type:: str

property minimum¶

Gets the minimum value, that is defined for the parameter.

Return type:: str

property maximum¶

Gets the maximum value, that is defined for the parameter.

Return type:: str

property group_id¶

The GroupID of the parameter or an empty string if the parameter does not belong to a group.

Version added:: 3.5.13.0
Return type:: str

property group_name¶

The localized GroupName of the parameter or an empty string if the parameter does not belong to a group.

Version added:: 3.5.13.0
Return type:: str

class ScriptApplicationComposer.ScriptModuleParameterInstance¶

Bases: ScriptModuleParameter

Interface providing necessary information and functionalities for dealing with Module-Parameter-Instances in Python.

set_value(value)¶

Sets the current value of the Parameter.

By setting a parameter its standard initial or default values are no longer used.

Parameters:: value (str) – The value to set for the Parameter.

get_initial_value()¶

Gets the initial value of the parameter as string. Never returns None.

Version added:: 3.5.13.0
Return type:: str

class ScriptApplicationComposer.ScriptModuleIo¶

Bases: object

Interface providing necessary information and functionallities for dealing with Module-IOs in Python.

property name¶

Localized (multi-lingual) name of the IO.

Return type:: str

property description¶

Localized (multi-lingual) description of the IO.

Return type:: str

property id¶

Id of the IO. The Id is unique among all IOs of one module.

Return type:: str

property is_output¶

Returns whether the IO is output or not.

Return type:: bool

property is_input¶

Returns whether the IO is input or not.

Return type:: bool

get_display_name()¶

The current representation of the current IO-Channels mapping meant for display.

If not mapped, a value indicating “missing” is returned. If this IO does not belong to an instance an empty string is returned.

Return type:: str

property type¶

The IEC-Type of the IO-Channel.

Return type:: str

property var_path¶

Gets the instance path of the IO-Channels variable relative to the instance FB of the module.

Return type:: str

class ScriptApplicationComposer.ScriptModuleIoInstance¶

Bases: ScriptModuleIo

Interface providing necessary information and functionallities for dealing with Module-IO-Instances in Python.

set_void_mapping()¶: Sets a void mapping, which equals an IO-Channel with no connection.

set_missing_mapping()¶

Sets a missing mapping.

This indicates that this io channel has no connections (as for void), but remembers the user to set a mapping whenever code is generated by the application composer.

set_direct_mapping(other)¶

Sets a direct mapping to another IOChannel.

Parameters:: other (ScriptModuleIoInstance) – The IO-Channel this channel shall be connected to. Note that Inputs only can be connected to Outputs and vice versa.

set_io_channel_mapping(channel)¶

Sets a channel mapping, which connects this IO to a physical IO-Channel.

A possible example for a valid string used for this type of mapping is “param::Device.EtherCAT_Master.EL9800:1:2000007:dwIn1”.

Parameters:: channel (str) – String specifying the desired physical IO-Channel in the form “param::Device.VisibleParameterPath”.

set_expression_mapping(expression)¶

Sets a channel mapping to an ST-Expression.

Parameters:: expression (str) – String holding the ST-Expression.

class ScriptApplicationComposer.ScriptModuleSlot¶

Bases: object

Interface providing necessary information and functionallities for dealing with Module-Slots in Python.

property role¶

Localized (multi-lingual) description of the slot role.

Return type:: str

property id¶

Id of the Slot. The Id is unique among all Slots of a module.

Return type:: str

property is_submodule_slot¶

Returns whether the Slot is meant to hold submodules or not.

Return type:: bool

property is_reference_slot¶

Returns whether the Slot is meant to hold references to modules or not.

Return type:: bool

property is_single¶

Returns whether the Slot is a Single-Slot, which only can hold one instance, or not.

Return type:: bool

property is_multi¶

Returns whether the Slot is a Multi-Slot, which can hold multiple instances, or not.

Return type:: bool

property max_connections¶

Gets the number of the maximum of submodules or references, that can be connected to this Slot.

Return type:: int

property min_connections¶

Gets the number of the minimum of submodules or references, that have to be connected to this Slot.

Return type:: int

property default_inst_name¶

Gets the default name for module instances, which are connected to this Slot.

If no default name is defined an empty string is returned.

Return type:: str

property type¶

Gets the interface type of this Slot.

Slot is corresponding to the interface, that FBs have to implement, when they shall be connectable to this slot.

Return type:: str

property var_path¶

The IEC instance path of the slot variable relative to the FB instance of the module.

Return type:: str

property var_array_size_path¶

Returns instance path.

For Multi-Slots the instance path of the variable, which holds the number of connected submodules or references, relative to the FB instance of the module. For Single-Slots an empty string is returned.

Return type:: string

property inst_prefix¶

Gets the optional prefix, that is prepended to the name of the FB instance variables of submodules.

This string can either have a value or is empty, what indicates a prefix, or that no prefix is wished. When this string is None no prefix wishes at all are given.

Return type:: str

property pragmas¶

Returns the compiler-pragmas, that are to be inserted before instances of submodule function blocks.

Return type:: list

class ScriptApplicationComposer.ScriptModuleSlotInstance¶

Bases: ScriptModuleSlot

Interface providing necessary information and functionalities for dealing with Module-Slot-Instances in Python.

property connected_sub_modules¶

Returns a List of connected ModuleInstanceObject-Objects to this Slot.

When there are no submodules connected an empty list is returned.

Return type:: list

property connected_ref_modules¶

Returns a List of connected ModuleReferenceObject-Objects to this Slot.

When there are no references connected an empty list is returned.

Return type:: list

class ScriptApplicationComposer.ScriptModuleInstRef¶

Bases: object

Interface providing necessary information and functionalities for dealing with Module-InstanceReferences in Python.

property description¶

Localized (multi-lingual) description of the InstanceReference role.

Return type:: str

property is_single¶

Returns whether the InstanceReference can only hold a single instance or not.

Return type:: bool

property is_multi¶

Returns whether the InstanceReference can hold multiple instances or not.

Return type:: bool

property max_connections¶

Maximum number of connectable instances.

Return type:: int

property min_connections¶

Minimal number of connectable instances.

Return type:: int

property type¶

Gets the interface type of the InstanceReference.

Only FB instances which implement this interface can be connected to this InstanceReference.

Return type:: str

property is_interface_type¶

Returns whether the reference type is an interface.

Return type:: bool

property array_size_var_path¶

Returns instance path.

Only defined if the InstanceReference is able to hold multiple instances (see “is_multi”). The IEC instance path of the variable, which holds the number of connected instances, relative to the FB instance. of the module.

Return type:: str

get_connected_instances()¶

Return a list of connected instances.

If there are no instances connected an empty list is returned.

Return type:: list

class ScriptApplicationComposer.ScriptModuleInstRefInstance¶

Bases: ScriptModuleInstRef

Interface providing necessary information and functionalities for dealing with Module-InstanceReference-Instances in Python.

set_connected_instances(listInstances)¶

Replaces the current list of instances of the InstanceReference instance by the given list of strings describing FB instances.

Parameters:: listInstances (list) – List of strings describing the new FB instances to be connected to this InstanceReference. If this is None or an empty list all InstanceReferences are removed.

class ScriptApplicationComposer.ScriptModuleVarArray¶

Bases: object

Interface providing information and functionalities for dealing with Module-VarArrays.

property id¶

Id of the VarArray. The Id is unique among the VarArrays of a module.

Return type:: str

property type¶

The IEC-Type of the array elements.

Return type:: str

property var_path¶

The IEC instance path of the array variable, relative to the module FB instance.

Return type:: str

property array_size_var_path¶

The IEC instance path of the variable, which holds the size of the array, relative to the module FB instance.

Return type:: str

property instance_name¶

The optional instance name of the array variable.

Return type:: str

property pragmas¶

Returns the compiler-pragmas that are to be inserted before the created array variables.

Return type:: list

class ScriptApplicationComposer.ScriptModuleMetaData¶

Bases: object

Interface providing necessary information and functionalities for dealing with Module-MetaData in Python.

property description¶

Localized (multi-lingual) description of the module.

Return type:: str

property category¶

The hierarchic category of the module. The components are separated by ‘|’.

Return type:: str

property inst_prefix¶

An optional, default instance prefix that is prepended to the name of the FB-instance variables of submodules and to the names of VarArray variables.

“” is a possible value. If no prefix is given, ‘inst_prefix’ is None.

Return type:: str

property default_inst_name¶

Returns the default name for instances of this module type.

Return type:: str

class ScriptApplicationComposer.ScriptModuleAlarmGeneratorData¶

Bases: object

Interface providing necessary information and functionalities for dealing with the Alarm-Generator in Python.

property set_alarms¶

Returns a list of all alarms generated for a module.

Return type:: list

class ScriptApplicationComposer.ScriptModuleSetAlarm¶

Bases: object

Interface providing necessary information for a alarm, which is generated by the alarm generator.

property alarm_id¶

Returns the internal id of the module alarm.

Return type:: str

property module_call_flags¶

Returns the type of module calls for alarming.

Return type:: int

property message¶

Returns the message of the module alarm.

Return type:: str

property alarm_class¶

Returns the alarm class of the module alarm.

Return type:: str

property latch_var_1¶

Returns the latch variable 1 of the module alarm.

Return type:: str

property latch_var_2¶

Returns the latch variable 2 of the module alarm.

Return type:: str

property deactivation¶

Returns the deactivation variable of the module alarm.

Return type:: str

property pending_time¶

Returns the pending time of the module alarm.

Return type:: str

property higher_prio_alarm_id¶

Returns the id of the higher priority alarm of the current module alarm.

Return type:: str

property expression¶

Returns the expression being alarm watched.

Return type:: str

property comparer¶

Returns the type of comparison for UpperLimit, LowerLimit and Equality alarms.

Return type:: str

property limit_expression_1¶

Returns the limiting expression for UpperLimit and LowerLimit alarms, the equality expression for Equality alarms, the lower area expression for InsideRange and OutsideRange alarms.

Return type:: str

property limit_expression_2¶

Returns the higher area expression for InsideRange and OutsideRange alarms.

Return type:: str

property inclide_limit_1¶

Returns whether the lower area expression (limit_expression_1) is includes in the defined area.

Return type:: bool

property inclide_limit_2¶

Returns whether the higher area expression (limit_expression_2) is includes in the defined area.

Return type:: bool

property inside_range¶

Returns whether a InsideRange or OutsideRange alarm is used.

Return type:: bool

property hysteresis¶

Returns the alarm hysteresis for UpperLimit, LowerLimit, Equality, InsideRange and OutsideRange expressions.

Return type:: double

property latch_vars¶

Returns all latch variables of the module alarm.

Return type:: Dictionary(int, string)

class ScriptApplicationComposer.ScriptModuleDeviceGeneratorData¶

Bases: object

Interface providing necessary information and functionalities for dealing with Module-DeviceGenerator-Data in Python.

property generated_devices¶

Returns a list of objects corresponding to the generated devices of the module.

Return type:: list

property generated_ios¶

Returns a list of objects corresponding to the generated ios of the module.

Return type:: list

property generated_inst_refs¶

Returns a list of objects corresponding to the generated instance references of the module.

Return type:: list

property generated_device_parameters¶

Returns a list of objects corresponding to the gerenrated device parameters of the module.

Return type:: list

class ScriptApplicationComposer.ScriptModuleGeneratedDevice¶

Bases: object

Interface providing necessary information and functionalitties for dealing with Module-DeviceGenerator-Generated-Devices in Python.

property device_id¶

Returns the internal identification of the (generated) device.

Return type:: str

property parent_device_id¶

Returns the internal identification of the parent (generated) device if available.

Return type:: str

property device_type¶

Returns the Device-Identification-Type of the generated device if available.

Return type:: str

property device_identification_id¶

Returns the Device-Identification-Id of the generated device if available.

Return type:: str

property device_version¶

Returns the Device-Identification-Version of the generated device if available.

Return type:: str

property device_module_id¶

Returns the Device-Identification-Module-Id of the generated device if available.

Return type:: str

property wildcard_type¶

Returns the Wildcard-Device-Type of the generated device if available.

Return type:: str

property wildcard_description¶

Return the Wildcard-Description of the generated device if available.

Return type:: str

property flexible_wildcard_maximum¶

Returns the maximum number of flexible Wildcard-Devices if available.

Return type:: str

class ScriptApplicationComposer.ScriptModuleGeneratedIO¶

Bases: object

Interface providing necessary information and functionalities for dealing with Module-DeviceGenerator-Generated-IOs in Python.

property io_id¶

Returns the internal id of the Generated-IO.

Return type:: str

property parent_id¶

Returns the parent (generated) device id of the Generated-IO.

Return type:: str

property connected_parameter_id¶

Returns the Device-Parameter-ID of the connected Generated-IO if available.

Return type:: str

property connected_connector_id¶

Returns the Device-Connector-ID of the connected Generated-IO if available.

Return type:: str

property connected_element_path¶

Returns the Device-Element-Path of the connected Generated-IO if available.

Return type:: str

property demanded_description¶

Returns the description of the demanded Generated-IO if available.

Return type:: str

property demanded_properties¶

Returns the demanded properties of the demanded Generated-IO if available.

Return type:: list

class ScriptApplicationComposer.ScriptModuleGeneratedInstRef¶

Bases: object

Interface providing necessary information and functionalitties for dealing with Module-DeviceGenerator-Generated-InstRefs in Python.

property inst_ref_id¶

Returns the internal id of the demanded Generated-InstRef if available.

Return type:: str

property parent_id¶

Returns the demanded id of the Instance reference.

Return type:: str

property demanded_description¶

Returns the description of the demanded Generated-InstRef if available.

Return type:: str

property demanded_properties¶

Returns the demanded properties of the demanded Generated-InstRef if available.

Return type:: list

class ScriptApplicationComposer.ScriptModuleGeneratedDeviceParameter¶

Bases: object

Interface providing necessary information and functionalities for dealing with Module-DeviceGenerator-Generated-Device-Parameters in Python.

property target_id¶

Returns the (generated) device id for which a parameter is set/added.

Return type:: str

property internal_id¶

Returns the internal id of the Generated-Device-Parameter.

Return type:: str

property connected_parameter_id¶

connected_parameter_id.

Return type:: str

property connected_connector_id¶

Returns the Device-Connector-ID of the Generated-Device-Parameter if available.

Return type:: str

property connected_element_path¶

Returns the Device-Element-Path of the Generated-Device-Parameter if available.

Return type:: str

property add_parameter_name¶

Returns the parameter name of the added Generated-Device-Parameter.

Return type:: str

property add_parameter_type¶

Returns the parameter type of the added Generated-Device-Parameter.

Return type:: str

property set_parameter_value¶

Returns the parameter value of the set Generated-Device-Parameter.

Return type:: str

class ScriptApplicationComposer.ScriptModuleToplevelInfo¶

Bases: object

Interface providing all neccessary information and functionalities for dealing with Module-ToplevelInfo.

get_home()¶

Gets the home location of a toplevel module where the composer generates the applications.

It has the form “Device.AppName” or holds the special string “POU Pool”.

Return type:: string

property gvl_name¶

Gets the name of the global variable list where the module instances will be declared.

Return type:: str

get_standard_task_high()¶

Returns the standard task info for the high priority task, or None` if this task was not enabled.

Return type:: ScriptModuleStdTaskInfo

get_standard_task_medium()¶

Returns the standard task info for the medium priority task, or None if this task was not enabled.

Return type:: ScriptModuleStdTaskInfo

get_standard_task_low()¶

Returns the standard task info for the low priority task, or None if this task was not enabled.

Return type:: ScriptModuleStdTaskInfo

property custom_tasks¶

Returns all defined custom tasks.

Return type:: str

property pragmas¶

Returns the compiler pragmas that are to be inserted before instances of the module function block.

Return type:: list

class ScriptApplicationComposer.ScriptModuleToplevelInfoInstance¶

Bases: ScriptModuleToplevelInfo

Interface providing all neccessary information and functionalities for dealing with Module-ToplevelInfo-Instances.

set_home(stHome)¶

Sets the home location of a toplevel module.

Parameters:: stHome (str) – String describing the home location in the form “Device.AppName” or by the special string “POU Pool”.

set_standard_task_high(stTaskName)¶

Sets the Name of the standard high priority task.

Parameters:: stTastName (str) – The desired task name.

set_standard_task_medium(stTaskName)¶

Sets the Name of the standard medium priority task.

Parameters:: stTastName (str) – The desired task name.

set_standard_task_low(stTaskName)¶

Sets the Name of the standard low priority task.

Parameters:: stTastName (str) – The desired task name.

class ScriptApplicationComposer.ScriptModuleStdTaskInfo¶

Bases: object

Interface providing all necessary information and functionallities for dealing with a StandardTaskInfo.

property name¶

The name of the task.

Return type:: str

property description¶

Localized (multi-lingual) description of the task.

Return type:: str

property is_update_ios¶

Whether module IOs that are directly mapped (i.e. not mapped to physical IOs) are read and written in this task or not.

Return type:: str

property is_create_if_missing¶

Whether the task is created, if it did not exist yet, or not.

Return type:: str

property is_readonly¶

Whether the name can be changed by the user or not.

Return type:: str

class ScriptApplicationComposer.ScriptModuleCustomTaskInfo¶

Bases: object

Interface providing all necessary information and functionalities for dealing with a CustomTaskInfo.

property method_name¶

The name of the method that will be called from this task.

Return type:: str

property priority¶

The priority of the task (0 (lowest) to 31 (highest)).

Return type:: int

property interval¶

The task interval in milliseconds.

Return type:: int

property is_shared¶

Whether several custom tasks may share one method or not.

Return type:: bool

property is_update_ios¶

Whether module IOs that are directly mapped (i.e. not to physical IOs) are read an written in this task or not.

Return type:: bool

class ScriptApplicationComposer.ScriptModuleProxy¶

Bases: object

Interface providing necessary information and functionallities for dealing with Module-Proxies in Python.

property id¶

The Id of the proxy. The Id is unique among all proxies of a module.

Return type:: str

property iec_declaration¶

Gets the FB declaration of this proxy (i.o.w. the Proxy-FB).

Return type:: ScriptModuleIECDecl

class ScriptApplicationComposer.ScriptModuleIECDecl¶

Bases: object

Interface providing necessary information and functionallities for dealing with module-bound Declarations in Python.

property name¶

Gets the name of the declaration object.

Return type:: str

property is_fb¶

Whether this declaration is an FB or not.

Return type:: bool

property is_interface¶

Whether this declaration is an interface or not.

Return type:: bool

property is_struct¶

Whether this declaration is a struct or not.

Return type:: bool

property is_method¶

Whether this declaration is a method or not.

Return type:: bool

property is_union¶

Whether this declaration is an union or not.

Return type:: bool

property is_other¶

Whether this declaration is of an other type or not.

Return type:: bool

class ScriptApplicationComposer.ScriptModuleDeclaration¶

Bases: ScriptApplicationComposerObjectMarker

Interface providing necessary information and functionalities dealing with Modules Declarations in Python.

This interface is equalling the type ModuleDeclObject in the application composer interface collection.

property decltext¶

Set or Gets the declaration text of the corresponding ModuleDeclObject.

Return type:: str