Skip to end of metadata
Go to start of metadata

This function is used in Python Scripting.

Description

Enables/disables a device in Ignition.

Client Permission Restrictions

Permission Type: Device 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 run in the Gateway scope.

Syntax

system.device.setDeviceEnabled(deviceName, enabled)

  • Parameters

String deviceName - The name of the device in Ignition.

Boolean enabled - Specifies whether the device connection will be set to enabled or disabled state.

  • Returns

Nothing

  • Scope

Gateway, Vision Client, Perspective Session

Code Examples
Code Snippet
# Example 1: Enable a device.
 
system.device.setDeviceEnabled("CLX", 1)
Code Snippet
# Example 2: Disable a device.
 
system.device.setDeviceEnabled("CLX", 0)
Keywords

system device setDeviceEnabled, device.setDeviceEnabled