RDM Get#
Methods#
POST#
Request to start an RDM Get operation. A 202
response will be returned if the request has been successfully queued. Results are available via a websocket subscription (see subscribe_rdm_get_set).
POST /api/rdm/get
Payload is a JSON object with the following attributes:
Attribute |
Value Type |
Description |
Value Example |
---|---|---|---|
|
string in Universe Key String Format or RDM Universe Key |
The universe on which to perform the RDM Get operation. |
|
|
string |
Format is |
|
|
string |
RDM PID for the Get operation. Can be one of the Supported RDM PIDs or the raw PID value as a hex string, e.g. |
|
|
object |
Optional. Metadata for the PID, i.e. query params (see Meta). |
|
|
integer |
Optional. Expected length of the response data. Only relevant if a raw PID value has been provided for |
Meta#
STATUS_MESSAGES#
For the STATUS_MESSAGES
PID, the meta
object should have the following parameters:
Attribute |
Value Type |
Description |
---|---|---|
|
integer |
Type of status messages to retrieve. Set to STATUS_NONE ( |
PARAMETER_DESCRIPTION#
For the PARAMETER_DESCRIPTION
PID, the meta
object should have the following parameters:
Attribute |
Value Type |
Description |
---|---|---|
|
integer |
The manufacturer-specific PID for which a description is requested. Range 0x8000 to 0xFFDF. |
DMX_PERSONALITY_DESCRIPTION#
For the DMX_PERSONALITY_DESCRIPTION
PID, the meta
object should have the following parameters:
Attribute |
Value Type |
Description |
---|---|---|
|
integer |
Index of the requested personality. |
SLOT_DESCRIPTION#
For the SLOT_DESCRIPTION
PID, the meta
object should have the following parameters:
Attribute |
Value Type |
---|---|
|
integer |
SENSOR_DEFINITION and SENSOR_VALUE#
For the SENSOR_DEFINITION
and SENSOR_VALUE
PIDs, the meta
object should have the following parameters:
Attribute |
Value Type |
---|---|
|
integer |
Universe Key String Format#
A universe key string for RDM takes the form:
protocol:index
for protocolsdmx
andart-net
;protocol:remoteDeviceType:remoteDeviceNum:port
for protocoledn
.
Where:
remoteDeviceType
can beedn10
oredn20
;remoteDeviceNum
is an integer;port
is an integer.
For example:
"dmx:1"
"edn:edn20:1:5"
Supported RDM PIDs#
The following PIDs are directly supported for RDM Get operations:
COMMS_STATUS
STATUS_MESSAGES
SUPPORTED_PARAMETERS
PARAMETER_DESCRIPTION
DEVICE_INFO
DEVICE_MODEL_DESCRIPTION
MANUFACTURER_LABEL
DEVICE_LABEL
FACTORY_DEFAULTS
SOFTWARE_VERSION_LABEL
BOOT_SOFTWARE_VERSION_ID
BOOT_SOFTWARE_VERSION_LABEL
DMX_PERSONALITY
DMX_PERSONALITY_DESCRIPTION
DMX_START_ADDRESS
SLOT_INFO
SLOT_DESCRIPTION
SENSOR_DEFINITION
SENSOR_VALUE
LAMP_HOURS
LAMP_STATE