Remote Device

Note

The endpoints listed on this page require a project to be loaded on the controller.

Methods

GET

Returns data about all the remote devices in the project.

GET /api/remote_device

Returns a JSON object with a single remote_devices attribute, which has an array value. Each item in the array is a Remote Device object with the following attributes:

Attribute	Value Type	Description	Value Example
name	string	The user assigned name of the Remote Device.	Ballroom Touch Screen
name_with_type	string	A combination of the user assigned name of the device, and the device type.	Ballroom Touch Screen (TPS 5)
num	integer	Remote device number (address)	1
type	string	One of the remote device types as listed below.	"RIO 44"
physical_devices	array	Physical devices assigned to this remote device. Array of Physical Remote Device objects (see table below).	[{"firmware_version":"2.8.0","needs_firmware_reload": false,"online": true,"serial": "001234"},{"firmware_version":null,"needs_firmware_reload": false,"online": false,"serial": "005678"}]
outputs	array	Array of Output objects (see table below); only returned for RIO 44 and RIO 08 on the queried controller	[{"output":1,"value":true},{"output":2,"value":true},{"output":3,"value":true},{"output":4,"value":true}]
inputs	array	Array of Input objects (see table below); only returned for RIO 44 and RIO 80 on the queried controller	[{"input":1,"type":"Contact Closure","value":true},{"input":2,"type":"Contact Closure","value":true},{"input":3,"type":"Contact Closure","value":true},{"input":4,"type":"Contact Closure","value":true}]
online	boolean	Whether the logical device is assigned to a physical remote device that is online and running a compatible firmware version	true

The Physical Remote Device JSON object has the following attributes:

serial	string	Serial number of the automatically or manually assigned physical device	"001234"
manual	boolean	true if the remote device is manually assigned to the project by its serial number, or false if it was automatically assigned by remote device number	true
firmware_version	string	The firmware version running on the remote device, or null if offline	1.0.0
needs_firmware_reload	boolean	Whether the remote device requires a firmware reload due to incompatibility with the controller, or null if the device does not support remote firmware reload	true
online	boolean	Whether the remote device is detected as being online on the local network	true

The Output JSON object has the following attributes:

Attribute	Value Type	Description	Value Example
output	integer	Number of the output, as labelled on the remote device	1
state	boolean	true means the output is on, false means it is off	true

The Input JSON object has the following attributes:

Attribute	Value Type	Description	Value Example
input	integer	Number of the input, as labelled on the remote device	1
type	string	Analog, Digital, or Contact Closure	Digital
value	integer or boolean	Value type depends on input type - Analog inputs return an integer, 0-255; other types return a bool.	true

Remote Device Types

The following remote device types are reported by the HTTP API:

• RIO 08

• RIO 44

• RIO 80

• BPS

• BPI

• RIO A

• RIO D

• RIO G4

• RIO D4

• EDN 10

• EDN 20

• TPS

• TPS 5

• TPS 8