RDM Devices

All properties described below relating to an RDM device’s status are obtained by the Status Monitor.

RDM Devices Overview

GET

Get an overview of RDM devices including their statuses.

GET /api/rdm_devices[?fixture=fixtureNumber][&unpatched=true]

fixture can be used the filter the response to devices patched to a single fixture. Set unpatched to true to return only unpatched devices.

One of fixture or unpatched is required and may not be provided together.

Returns a JSON array of objects with the following attributes:

Attribute	Value Type	Description	Value Example
uid	string	RDM device UID	"1234:56789abc"
patch	string	Combined universe key and address (see Universe Key String Format). Only included if status is online.	"dmx:2:101"
rdm	object	RDM parameters cached from the latest status monitor run. Only included if status is online.	{}
status	string	"online", "offline", "loading", or "unknown"	"online"
updated_at	string	ISO 8601-formatted timestamp of the last status update, or null if unknown	2024-06-27T09:30

RDM Device

GET

Get a single RDM device including its status.

GET /api/rdm_devices/{deviceId}

Returns a JSON object with the same properties as contained in the RDM Devices Overview GET response.

Universe Key String Format

A universe key string takes the form:

• protocol:index for protocols dmx, pathport, sacn, art-net;

• protocol:kinetPowerSupplyNum:kinetPort for protocol kinet;

• protocol:remoteDeviceType:remoteDeviceNum for protocol rio-dmx;

• protocol:remoteDeviceType:remoteDeviceNum:port for protocols edn, edn-spi.

Where:

• kinetPowerSupplyNum is an integer;

• kinetPort is an integer;

• remoteDeviceType can be rio08, rio44 or rio80, edn10 or edn20;

• remoteDeviceNum is an integer;

• port is an integer.

For example:

• "dmx:1"

• "rio-dmx:rio44:1"