This function is used in Python Scripting.

Description

Enables or disables a Tuple of equipment connections from a script.

Client Permission Restrictions

Permission Type: SECS/GEM Management

Client access to this scripting function is blocked to users that do not meet the role/zone requirements for the above permission type. This function is unaffected when called in the Gateway scope.

Syntax

system.secsgem.enableDisableEquipment(enable, names)

  • Parameters

Boolean enable - Set to True to enable equipment connections, or set to False to disable them.

Tuple names - A Tuple of strings. Each string should match an equipment connection configured on the Gateway. If this parameter contains the name of an equipment connection that does not exist, then a message will be included in the List returned by this function. 

  • Returns

List - A list of unicode strings. Each string contains a message about an equipment connection that could not be enabled/disabled. If the list is empty, then all specified equipment connections were successfully modified. 

  • Scope

Vision Client

Code Examples
Code Snippet - Disabling Equipment
# Executing this example script will attempt to disable two equipment connections.

# Create a Python Tuple of equipment names to disable. 
equipmentNames = ("ToolOne","ToolTwo")

# Invoke the Function.
result = system.secsgem.enableDisableEquipment(False, equipmentNames) 

# Print the results of any equipment connections that could not be modified. 
print result
Keywords

system secsgem enableDisableEquipment, secsgem.enableDisableEquipment