Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Scripting_function


Panel
titleDescription

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

Client permissions restrictions


Panel
titleSyntax

system.device.listDevices()

  • Parameters

noneNothing

  • Returns

Dataset - A dataset, where each row represents a device. Contains 4 columns NameEnabledState, and Driver.

  • Scope

Gateway, Vision Client, Perspective Session

Panel
titleCode Examples
Code Block
languagepy
titleCode 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
Panel
titleKeywords

system device listDevices, device.listDevices