Skip to main content
Version: 8.1

system.device.setDeviceEnabled

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

TypeParameterDescription
StringdeviceNameThe name of the device in Ignition.
BooleanenabledSpecifies 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