Skip to main content

Full Device Response (get device)

The get <target> device command returns the complete device object, which fully describes a device including its configuration, state, and supported features. This is the most comprehensive subset available from the get command.

Response structure

{
"device_id": String,
"device_name": String,
"identity": DeviceIdentity,
"capabilities": DeviceCapabilities,
"configuration": DeviceConfig,
"status": DeviceStatus,
"streams": [StreamObject, ...],
"subscriptions": [SubscriptionObject, ...],
"nodes": [Node, ...]
}
Member nameTypeDescription
device_idStringUnique identifier for the device. Always present in the response.
device_nameStringThe device's name. Always present in the response.
identityDeviceIdentityDevice identification information including firmware version and device type.
capabilitiesDeviceCapabilitiesFeatures and hardware capabilities supported by the device.
configurationDeviceConfigConfigurable settings that customize device behavior.
statusDeviceStatusReal-time information about the device's current state including temperature.
streamsArray of StreamObjectStreams of data sent on the network by this device.
subscriptionsArray of SubscriptionObjectStreams of data received from the network.
nodesArray of NodeHardware modules present on the device with their status and configuration.

Comparison with other subsets

The get device response differs from other get subsets:

SubsetIncludes
deviceAll members listed above, plus EDID data, temperature, and enumeration of available configuration choices
settingsSimilar to device, but excludes EDID, temperature, and configuration choice enumerations
identityOnly identity and configuration members
capabilitiesOnly capabilities member

Example response

The following example shows a response from a DN-300 TX transmitter. The specific nodes, streams, and configuration options vary with the device model and capabilities.

get 6cdffb011b0f device
{
"status": "SUCCESS",
"request_id": 23874,
"result": {
"devices": [
{
"device_id": "6cdffb011b0f",
"device_name": "apple",
"identity": {
"chipset_type": "AVP2000",
"engine": "PLETHORA",
"vendor_id": 122,
"product_id": 111,
"firmware_comment": "2.3.0.1-DN-300-R1",
"firmware_version": "2.3.0.1",
"firmware_rc": "0",
"is_receiver": false,
"is_transmitter": true,
"firmware_details": [
{
"type": "PRIMARY",
"details_available": true,
"firmware_version": "2.3.0.1",
"firmware_rc": "0"
},
{
"type": "GOLDEN",
"details_available": true,
"firmware_version": "1.5.0.105",
"firmware_rc": "0"
}
],
"chip_id": null
},
"capabilities": {
"color_generator_force": false,
"frame_rate_divider": true,
"hdmi_audio_downmix": true,
"hdmi_inputs": 1,
"hdmi_outputs": 0,
"hdmi_stream1_auto_stop": true,
"infrared_inputs": 1,
"infrared_outputs": 1,
"local_loopback": false,
"multich_audio_inputs": 1,
"multich_audio_outputs": 0,
"nbaset": true,
"net10gbe_dual_link": false,
"overlay": false,
"scaler": true,
"stereo_audio_inputs": 0,
"stereo_audio_input_outputs": 0,
"stereo_audio_outputs": 1,
"thumbnail": false,
"uarts": 2,
"usb_hid": false,
"usb_icron": true,
"usb_extender": true,
"video_processing": false,
"dhcp_option_43": true,
"dot1x": true,
"send_wol": true
},
"configuration": {
"device_name": "apple",
"locate_mode": false,
"secure_av": "default",
"resume_streaming": true,
"claimed": false,
"authenticated": false,
"device_mode": "TRANSMITTER",
"volatile_settings": false,
"dot1x_certificate": false
},
"status": {
"active": true,
"point_to_point": false,
"point_to_point_peer": "",
"boot_status": "PRIMARY",
"update_in_progress": false,
"igmp_reporting_mode": "INTERVAL",
"error_status": {
"has_error_code": false,
"error_code": 0
},
"temperature": 46
},
"streams": [
{
"type": "HDMI",
"index": 0,
"configuration": {
"address": "224.1.1.9",
"enable": true,
"auto_stop": false,
"remove_audio": false,
"source": {
"value": 0,
"choices": [
{
"value": 0,
"description": "HDMI video input",
"details": {
"ref_class": "NODE",
"ref_type": "HDMI_DECODER",
"ref_index": 0
}
},
{
"value": 1,
"description": "Frame rate converter",
"details": {
"ref_class": "NODE",
"ref_type": "FRAME_RATE_CONVERTER",
"ref_index": 0
}
}
]
}
},
"status": {
"state": "STREAMING"
},
"source": {
"ref_class": "NODE",
"ref_type": "HDMI_DECODER",
"ref_index": 0
}
},
{
"type": "HDMI",
"index": 1,
"configuration": {
"address": "0.0.0.0",
"enable": false,
"auto_stop": false,
"remove_audio": true
},
"status": {
"state": "STOPPED"
},
"source": {
"ref_class": "NODE",
"ref_type": "SCALER",
"ref_index": 0
}
},
{
"type": "HDMI_AUDIO",
"index": 0,
"configuration": {
"address": "224.1.1.16",
"enable": true,
"auto_stop": false
},
"status": {
"state": "STREAMING"
},
"source": {
"ref_class": "NODE",
"ref_type": "HDMI_DECODER",
"ref_index": 0
}
},
{
"type": "MULTICH_AUDIO",
"index": 0,
"configuration": {
"address": "0.0.0.0",
"enable": false,
"auto_stop": false
},
"status": {
"state": "STOPPED"
},
"source": {
"ref_class": "NODE",
"ref_type": "MULTICH_AUDIO_INPUT",
"ref_index": 0
}
},
{
"type": "RS232",
"index": 0,
"configuration": {
"address": "0.0.0.0",
"dest_index": 0,
"enable": false,
"auto_stop": false
},
"status": {
"state": "STOPPED"
},
"source": {
"ref_class": "NODE",
"ref_type": "UART",
"ref_index": 0
}
},
{
"type": "RS232",
"index": 3,
"configuration": {
"address": "192.168.1.130",
"dest_index": 3,
"enable": true,
"auto_stop": false
},
"status": {
"state": "STREAMING"
},
"source": {
"ref_class": "NODE",
"ref_type": "UART",
"ref_index": 3
}
},
{
"type": "INFRARED",
"index": 0,
"configuration": {
"address": "0.0.0.0",
"enable": false,
"auto_stop": false
},
"status": {
"state": "STOPPED"
},
"source": {
"ref_class": "NODE",
"ref_type": "INFRARED_DECODER",
"ref_index": 0
}
},
{
"type": "CEC",
"index": 0,
"configuration": {
"address": "0.0.0.0",
"enable": false,
"auto_stop": false
},
"status": {
"state": "STOPPED"
},
"source": {
"ref_class": "NODE",
"ref_type": "CEC",
"ref_index": 0
}
}
],
"subscriptions": [
{
"type": "HDMI_AUDIO",
"index": 0,
"configuration": {
"address": "0.0.0.0",
"enable": false,
"mute_msec": 0
},
"status": {
"state": "STOPPED"
}
},
{
"type": "STEREO_AUDIO",
"index": 0,
"configuration": {
"address": "0.0.0.0",
"enable": false
},
"status": {
"state": "STOPPED"
}
},
{
"type": "MULTICH_AUDIO",
"index": 0,
"configuration": {
"address": "0.0.0.0",
"enable": false
},
"status": {
"state": "STOPPED"
}
},
{
"type": "RS232",
"index": 0,
"configuration": {
"address": "0.0.0.0",
"enable": true
},
"status": {
"state": "STREAMING"
}
},
{
"type": "RS232",
"index": 3,
"configuration": {
"address": "0.0.0.0",
"enable": true
},
"status": {
"state": "STREAMING"
}
},
{
"type": "INFRARED",
"index": 0,
"configuration": {
"address": "0.0.0.0",
"enable": true
},
"status": {
"state": "STREAMING"
}
}
],
"nodes": [
{
"type": "STEREO_AUDIO_OUTPUT",
"index": 0,
"configuration": {},
"status": {},
"inputs": [
{
"name": "main",
"index": 0,
"configuration": {
"source": {
"value": 13,
"choices": [
{
"value": 2,
"description": "Local HDMI Downmix Audio",
"details": {
"ref_class": "NODE",
"ref_type": "HDMI_DECODER",
"ref_index": 0
}
},
{
"value": 8,
"description": "Network Multi Channel Audio",
"details": {
"ref_class": "SUBSCRIPTION",
"ref_type": "MULTICH_AUDIO",
"ref_index": 0
}
},
{
"value": 9,
"description": "Local Multi Channel Audio",
"details": {
"ref_class": "NODE",
"ref_type": "MULTICH_AUDIO_INPUT",
"ref_index": 0
}
},
{
"value": 13,
"description": "Network Stereo Audio",
"details": {
"ref_class": "SUBSCRIPTION",
"ref_type": "STEREO_AUDIO",
"ref_index": 0
}
},
{
"value": 15,
"description": "Network HDMI Downmix Audio",
"details": {
"ref_class": "SUBSCRIPTION",
"ref_type": "HDMI_AUDIO",
"ref_index": 0
}
}
]
}
},
"status": {
"source": {
"ref_class": "SUBSCRIPTION",
"ref_type": "STEREO_AUDIO",
"ref_index": 0
}
}
}
]
},
{
"type": "CEC",
"index": 0,
"configuration": {
"p2p_mode": "PASSTHROUGH",
"logical_addresses": {
"0_tv": false,
"1_recording_device_1": false,
"2_recording_device_2": false,
"3_tuner_1": false,
"4_playback_device_1": false,
"5_audio_system": false,
"6_tuner_2": false,
"7_tuner_3": false,
"8_playback_device_2": false,
"9_recording_device_3": false,
"10_tuner_4": false,
"11_playback_device_3": false,
"12_reserved": false,
"13_reserved": false,
"14_free_use": true
}
},
"status": {},
"inputs": []
},
{
"type": "COLOR_GENERATOR",
"index": 0,
"configuration": {
"enable": false,
"color": "000000",
"force_output": false
},
"status": {},
"inputs": []
},
{
"type": "FRAME_RATE_CONVERTER",
"index": 0,
"configuration": {},
"status": {
"divide_factor": 2
},
"inputs": [
{
"name": "main",
"index": 0,
"configuration": {},
"status": {
"source": {
"ref_class": "NODE",
"ref_type": "HDMI_DECODER",
"ref_index": 0
}
}
}
]
},
{
"type": "GPIO",
"index": 0,
"configuration": {
"tristate": 1,
"cfg_val": 0
},
"status": {
"stat_val": 0
},
"inputs": []
},
{
"type": "HDMI_DECODER",
"index": 0,
"configuration": {
"edid": "00ffffffffffff0012c7000156524c421c20010380341d780a01c1a057479827124c4c21080081400101010101010101010101010101023a801871382d40582c460040846300001e08e80030f2705a80b0588a00ba892100001e000000fc00444e2d3330300a202020202020000000fd0018550e853c000a202020202020017d02034073580102030405111213141f2021220607905d5e5f6263646061230d0707830f00006d030c001000383c20406801020367d85dc401788003e40f0000c0011d00bc52d01e20b828554040846300001e023a80d072382d40102c458040846300001e023a801871382d40582c450040846300001e000000000000000000f2",
"hdcp_support_enable": false,
"hdcp_22_support_disable": false,
"default_quantization_level_override": "DISABLED"
},
"status": {
"video": {
"width": 3840,
"height": 2160,
"frames_per_second": 60,
"color_space": "YCBCR_420",
"bits_per_pixel": 8,
"scan_mode": "PROGRESSIVE"
},
"has_video_details": true,
"video_details": {
"frame_rate": 59.94,
"pixel_clock": 593410560,
"total_width": 4400,
"total_height": 2250,
"hsync_width": 88,
"hsync_front_porch": 176,
"hsync_negative": false,
"vsync_width": 10,
"vsync_front_porch": 8,
"vsync_negative": false,
"vic": 97,
"has_hdmi_vic": false,
"hdmi_vic": 0,
"picture_aspect": "ASPECT_16_9",
"has_active_format": true,
"active_format": 8,
"it_content_type": "NO_DATA",
"scan_information": "UNDERSCAN",
"colorimetry": "BT709",
"rgb_range": "DEFAULT",
"ycc_range": "LIMITED",
"has_hdr": false,
"hdr": "SDR"
},
"has_audio_details": true,
"audio_details": {
"sampling_frequency": 48000,
"number_of_channels": 2
},
"has_audio_details_extended": true,
"audio_details_extended": {
"channel_allocation": 0,
"sample_size": 24,
"level_shift_value": 0,
"lfe_playback_level": 0,
"audio_encoding_type": "LPCM",
"is_downmix_inhibited": false
},
"hdcp_protected": false,
"hdcp_version": "NONE",
"hdmi_2_0_support": true,
"source_stable": true,
"audio_downmix_support": true
},
"inputs": [
{
"name": "main",
"index": 0,
"configuration": {},
"status": {
"source": {
"ref_class": "NODE",
"ref_type": "VIDEO_INPUT",
"ref_index": 0
}
}
}
]
},
{
"type": "MULTICH_AUDIO_INPUT",
"index": 0,
"configuration": {
"sampling_frequency": {
"value": 48000,
"choices": [
{"value": 22050, "description": "22.05kHz", "details": null},
{"value": 24000, "description": "24kHz", "details": null},
{"value": 32000, "description": "32kHz", "details": null},
{"value": 44100, "description": "44.1kHz", "details": null},
{"value": 48000, "description": "48kHz", "details": null},
{"value": 88200, "description": "88.2kHz", "details": null},
{"value": 96000, "description": "96kHz", "details": null},
{"value": 176400, "description": "176.4kHz", "details": null},
{"value": 192000, "description": "192kHz", "details": null},
{"value": 768000, "description": "768kHz", "details": null}
]
},
"number_of_channels": {
"value": 8,
"choices": [
{"value": 2, "description": "2 Channels", "details": null},
{"value": 3, "description": "3 Channels", "details": null},
{"value": 4, "description": "4 Channels", "details": null},
{"value": 5, "description": "5 Channels", "details": null},
{"value": 6, "description": "6 Channels", "details": null},
{"value": 7, "description": "7 Channels", "details": null},
{"value": 8, "description": "8 Channels", "details": null}
]
},
"channel_allocation": {
"value": 0,
"choices": [
{"value": 0, "description": "2 Channels (FL-FR)", "details": null},
{"value": 1, "description": "2.1 Channels (FL-FR-LFE)", "details": null},
{"value": 11, "description": "5.1 Channels (FL-FR-LFE-FC-RL-RR)", "details": null},
{"value": 19, "description": "7.1 Channels (FL-FR-LFE-FC-RL-RR-RLC-RRC)", "details": null}
]
},
"audio_encoding_type": "LPCM",
"mute_audio": false
},
"status": {
"data_lanes": 4,
"sampling_frequency": 0
},
"inputs": []
},
{
"type": "INFRARED_ENCODER",
"index": 0,
"configuration": {},
"status": {
"data_length_max": 1032
},
"inputs": [
{
"name": "network",
"index": 0,
"configuration": {},
"status": {
"source": {
"ref_class": "SUBSCRIPTION",
"ref_type": "INFRARED",
"ref_index": 0
}
}
}
]
},
{
"type": "INFRARED_DECODER",
"index": 0,
"configuration": {},
"status": {},
"inputs": []
},
{
"type": "LED",
"index": 0,
"configuration": {
"function": {
"value": 0,
"choices": [
{"value": 0, "description": "(Unknown)", "details": "UNKNOWN"},
{"value": 1, "description": "Blink LED", "details": "BLINK"},
{"value": 8, "description": "Default functionality", "details": "DEFAULT"}
]
}
},
"status": {},
"inputs": []
},
{
"type": "NETWORK_INTERFACE",
"index": 0,
"configuration": {
"hostname": "apple",
"ip": {
"address": "192.168.1.126",
"mode": "DHCP",
"mask": "255.255.255.0",
"gateway": "192.168.1.1"
},
"dhcp_option_43": {
"control_server_addresses": []
}
},
"status": {
"mac_address": "6cdffb011b0f",
"ip": {
"address": "192.168.1.126"
}
},
"inputs": []
},
{
"type": "NETWORK_PORT",
"index": 0,
"configuration": {
"speed": "SPEED_10G"
},
"status": {
"active": true,
"speed": 10.0,
"supports_speed_10g": true,
"supports_speed_5g": true,
"supports_speed_2_5g": true,
"supports_auto_10g": true,
"supports_auto_5g": true
},
"inputs": []
},
{
"type": "NETWORK_SWITCH",
"index": 0,
"configuration": {
"gigabit_port_1_enable": true
},
"status": {},
"inputs": []
},
{
"type": "SCALER",
"index": 0,
"configuration": {
"width": 0,
"height": 0
},
"status": {
"video": {
"width": 0,
"height": 0,
"frames_per_second": 60,
"color_space": "YCBCR_444",
"bits_per_pixel": 8,
"scan_mode": "PROGRESSIVE"
}
},
"inputs": [
{
"name": "main",
"index": 0,
"configuration": {
"source": {
"value": 0,
"choices": [
{
"value": 0,
"description": "HDMI video input",
"details": {
"ref_class": "NODE",
"ref_type": "HDMI_DECODER",
"ref_index": 0
}
},
{
"value": 1,
"description": "Frame rate converter",
"details": {
"ref_class": "NODE",
"ref_type": "FRAME_RATE_CONVERTER",
"ref_index": 0
}
}
]
}
},
"status": {
"source": {
"ref_class": "NODE",
"ref_type": "HDMI_DECODER",
"ref_index": 0
}
}
}
]
},
{
"type": "UART",
"index": 0,
"configuration": {
"baud_rate": 57600,
"data_bits": 8,
"stop_bits": 1,
"parity": "NONE"
},
"status": {
"usage": "EXPOSED"
},
"inputs": [
{
"name": "network",
"index": 0,
"configuration": {},
"status": {
"source": {
"ref_class": "SUBSCRIPTION",
"ref_type": "RS232",
"ref_index": 0
}
}
}
]
},
{
"type": "UART",
"index": 3,
"configuration": {
"baud_rate": 57600,
"data_bits": 8,
"stop_bits": 1,
"parity": "NONE"
},
"status": {
"usage": "RESERVED"
},
"inputs": [
{
"name": "network",
"index": 3,
"configuration": {},
"status": {
"source": {
"ref_class": "SUBSCRIPTION",
"ref_type": "RS232",
"ref_index": 3
}
}
}
]
},
{
"type": "USB_ICRON",
"index": 0,
"configuration": {
"extender_type": "LOCAL",
"program_mode": "NONE",
"rs232_port": 0
},
"status": {
"chip_present": true,
"mac_address": "6cdffb011b10",
"reachable": true,
"revision": "1.9.4",
"ip_mode": "DHCP",
"ip_address": "192.168.1.132",
"peer_mac_address": "",
"peer_device_id": "",
"link_status_support": true,
"linked": false,
"sui_enabled": true,
"sui_peers": []
},
"inputs": []
},
{
"type": "USB_EXTENDER",
"index": 0,
"configuration": {
"role": "LOCAL",
"program_mode": "NONE",
"rs232_port": 0,
"peers": []
},
"status": {
"chipset_type": "ICRON",
"chip_present": true,
"mac_address": "6cdffb011b10",
"reachable": true,
"revision": "1.9.4",
"ip_mode": "DHCP",
"ip_address": "192.168.1.132",
"link_status_support": true,
"sui_enabled": true,
"peers": [],
"role": "LOCAL"
},
"inputs": []
},
{
"type": "VIDEO_COMPRESSOR",
"index": 0,
"configuration": {
"always_compress": false,
"version": 1
},
"status": {
"version_support": 2
},
"inputs": []
},
{
"type": "VIDEO_INPUT",
"index": 0,
"configuration": {},
"status": {},
"inputs": []
}
]
}
],
"error": []
},
"error": null
}
Configuration choices

The choices arrays within configuration objects enumerate the allowed values for each configurable setting. They appear only in the get device response, not in get settings.