Skip to main content
Version: 8.1

system.device.listDevices

This function is used in Python Scripting.

Description

Returns a dataset of information about each configured device. Each row represents a single device.

Client Permission Restrictions

This scripting function has no Client Permission restrictions.

Syntax

system.device.listDevices()

Parameters

Nothing.

Returns

Dataset - A dataset, where each row represents a device. Contains 4 columns:

  • Name
  • Enabled
  • State
  • Driver

Scope

Gateway, Vision Client, Perspective Session

Code Examples

Code Snippet - Listing Devices Configured on Your Gateway
deviceDataset = system.device.listDevices()

# Assign the deviceDataset to a Power Table. This example assumes
# the Power Table is in the same container as the component that called this script
event.source.parent.getComponent('Power Table').data = deviceDataset

Keywords

system device listDevices, device.listDevices