query

The query command provides a simplified, read-only interface for retrieving device information. It consolidates device data into structured responses for common query types: routing status, video signal details, health metrics, and network configuration.

Command Type	DisplayNet
Minimum Version	3.x.x

Usage

query <target> <routing | video | health | network>
query <target> path <dotpath>

Arguments

Argument	Required	Description
target	Yes	Device(s) to query. See Targets.
subcommand	Yes	The query type. See Subcommands.
dotpath	path only	A dot-separated path into the device data tree. See Dot paths.

Targets

Value	Queries
<device>	A single device, by name (case-insensitive, spaces as underscores) or MAC address
<device>,<device>,...	Each listed device
all	All online devices
all_tx	All transmitter devices (includes transceivers)
all_rx	All receiver devices (includes transceivers)

Subcommands

Subcommand	Returns
routing	Active streams and subscriptions. Inactive streams and unsubscribed addresses are filtered out
video	Video and audio signal details. Transmitters return an input object, receivers an output object, transceivers both
health	Online state, temperature, error status, and firmware version
network	IP address, DHCP/static mode, subnet mask, gateway, hostname, and port status
path	The value at an arbitrary dot-path in the device data: a string for leaf nodes, a JSON object for subtrees

Dot paths

A dot-separated path into the device data tree, supporting nested object traversal and node lookups:

• identity.firmware_version
• status.temperature
• nodes[HDMI_DECODER:0].status.video
• streams[HDMI:0].configuration.address

Examples

Routing state of one device
query DN-300T routing

Health of every device
query all health

Read a single value by path
query DN-300T path identity.firmware_version

Return value

routing

query DN-300T routing
{
  "status": "SUCCESS",
  "request_id": null,
  "result": {
    "query_routing": [
      {
        "device_id": "6cdffb000420",
        "device_name": "DN-300T",
        "type": "TRX",
        "streams": [
          {
            "type": "HDMI",
            "index": 0,
            "state": "STREAMING",
            "address": "224.1.1.1"
          }
        ],
        "subscriptions": [
          {
            "type": "HDMI",
            "index": 0,
            "address": "224.1.1.3"
          }
        ]
      }
    ]
  },
  "error": null
}

video

query DN-300T video
{
  "status": "SUCCESS",
  "request_id": null,
  "result": {
    "query_video": [
      {
        "device_id": "6cdffb000420",
        "device_name": "DN-300T",
        "type": "TRX",
        "input": {
          "source_stable": "True",
          "width": "1920",
          "height": "1080",
          "frames_per_second": "60",
          "scan_mode": "PROGRESSIVE",
          "color_space": "RGB",
          "bits_per_pixel": "8",
          "colorimetry": "RGB",
          "hdr": "SDR",
          "hdcp_protected": "False",
          "hdcp_version": "NONE",
          "audio_channels": "2",
          "audio_sample_rate": "48000",
          "audio_encoding_type": "LPCM",
          "audio_sample_size": "16"
        },
        "output": {
          "source_stable": "True",
          "width": "3840",
          "height": "2160",
          "frames_per_second": "60",
          "scan_mode": "PROGRESSIVE",
          "color_space": "RGB",
          "bits_per_pixel": "8",
          "colorimetry": "BT2020",
          "hdr": "SDR",
          "hdcp_protected": "False",
          "hdcp_version": "NONE",
          "audio_channels": "2",
          "audio_sample_rate": "48000",
          "audio_encoding_type": "LPCM",
          "audio_sample_size": "16"
        }
      }
    ]
  },
  "error": null
}

info

Transmitters return only the input object, receivers only the output object, and transceivers both.

health

query all health
{
  "status": "SUCCESS",
  "request_id": null,
  "result": {
    "query_health": [
      {
        "device_id": "6cdffb000420",
        "device_name": "DN-300T",
        "type": "TRX",
        "active": "True",
        "temperature": "46",
        "error_status": {
          "has_error_code": false,
          "error_code": 0
        },
        "firmware_version": "2.2.0.0",
        "firmware_comment": "2.2.0.0-DN-300-R3"
      }
    ]
  },
  "error": null
}

network

query DN-300T network
{
  "status": "SUCCESS",
  "request_id": null,
  "result": {
    "query_network": [
      {
        "device_id": "6cdffb000420",
        "device_name": "DN-300T",
        "type": "TRX",
        "mac_address": "6cdffb000420",
        "ip_address": "192.168.1.142",
        "ip_mode": "DHCP",
        "subnet_mask": "255.255.255.0",
        "gateway": "192.168.1.1",
        "hostname": "DN-300T",
        "port_speed": "10",
        "port_active": "True"
      }
    ]
  },
  "error": null
}

path

query DN-300T path identity.firmware_version
{
  "status": "SUCCESS",
  "request_id": null,
  "result": {
    "query_path": [
      {
        "device_id": "6cdffb000420",
        "device_name": "DN-300T",
        "type": "TRX",
        "path": "identity.firmware_version",
        "value": "2.2.0.0"
      }
    ]
  },
  "error": null
}

info

If the path is not found, the response includes "value": null and an "error" field with a description.

REST API

Endpoint type	DisplayNet API command
Address	POST /api/displaynet/<operation>, or name the operation in the body of a POST /api/displaynet. See Sending commands.
Role	User

Operation	Parameters
query	target sub_command [dot_path]

A parameter in brackets is optional.

See also

• get: full device-object retrieval