get

The get command fetches information from devices. For each device, the retrieved information is a subset of the device object, which contains all configuration, status, supported features, and other information about the device.


Command Type	SDVoE
Minimum Version	2.x.x

Usage

get <target> <subset>

Arguments

Argument	Required	Description
`target`	Yes	Device ID of a single device, or a device group. See Targets.
`subset`	Yes	The subset of the device object to retrieve. See Subsets.

Targets

Value	Fetches from
`<device_id>`	A single device
`ALL`	All devices
`ALL_TX`	All transmitter devices
`ALL_RX`	All receiver devices

Subsets

Value	Retrieves
`device`	All available information for the device(s)
`settings`	Detailed configuration and state: most of the device object, excluding the EDID, temperature, and enumerations of available configuration choices
`identity`	Basic identity information: device name, device type, firmware version
`hello`	Basic information available when the device is first detected on the network, such as device type and firmware version
`list`	Device id, name, and whether the device is active. Most useful with a group target, e.g. `get all list`
`edid`	The EDID of the device(s)
`temperature`	The temperature of the device(s)
`capabilities`	The capabilities of the device(s)
`gpio`	GPIO mode and value
`multiview`	The layout currently loaded on a receiver operating in MultiView mode
`usb_tree`	The USB device tree behind a USB extender

Examples

Fetch everything about one device
get d88039a4fa19 device

Read a device's EDID
get d88039a4fa19 edid

List the IDs of every device in the system
get all list

Return value

The small subsets answer directly:

get 6cdffb01f5ba list
{
  "status": "SUCCESS",
  "request_id": null,
  "result": {
    "devices": [
      {
        "device_id": "6cdffb01f5ba",
        "device_name": "RokuTV",
        "status": { "active": true }
      }
    ],
    "error": []
  },
  "error": null
}

The subsets that query the device itself, including device, temperature and multiview, answer PROCESSING with a request_id. Read the result with request:

get 6cdffb01f5ba device
{
  "status": "PROCESSING",
  "request_id": 224522,
  "result": null,
  "error": null
}

The completed result carries a devices array of device objects. A device that cannot answer a subset appears in the reply's error array rather than failing the whole command:

get 6cdffb01f5ba usb_tree, on a device without a USB extender
{
  "status": "SUCCESS",
  "request_id": null,
  "result": {
    "usb_tree": [],
    "error": [
      {
        "device_id": "6cdffb01f5ba",
        "device_name": "RokuTV",
        "reason": "DEVICE_TYPE",
        "message": "This device does not support usb tree command."
      }
    ]
  },
  "error": null
}

REST API

Endpoint type	SDVoE API command, forwarded to the Control Server
Address	`/api/device`, `/api/device/{target}`
Role	Governed by the device lock rather than by a DisplayNet role

GET /api/device

The list of discovered devices.

GET /api/device/{target}

The `hello` subset.

POST /api/device/{target}
{
  "op": "get",
  "subset": "String"
}

Every other subset.

Values labeled with a type name such as String or Integer are placeholders, not literal text. Replace them with actual values; fields marked (optional) can be omitted.

{target} takes a DisplayNet device name as readily as a device ID, and a locked device refuses a mutating operation. See SDVoE API operations for what DisplayNet adds to these calls.

Usage​

Arguments​

Targets​

Subsets​

Examples​

Return value​

REST API​

See also​