Device Info Plugin

Version: 1.0

Status:

DeviceInfo plugin for Thunder framework.

Table of Contents

• Introduction
• Description
• Configuration
• Interfaces
• Methods
• Properties

Introduction

Scope

This document describes purpose and functionality of the DeviceInfo plugin. It includes detailed specification about its configuration, methods and properties provided.

Case Sensitivity

All identifiers of the interfaces described in this document are case-sensitive. Thus, unless stated otherwise, all keywords, entities, properties, relations and actions should be treated as such.

Acronyms, Abbreviations and Terms

The table below provides and overview of acronyms used in this document and their definitions.

Acronym	Description
API	Application Programming Interface
HTTP	Hypertext Transfer Protocol
JSON	JavaScript Object Notation; a data interchange format
JSON-RPC	A remote procedure call protocol encoded in JSON

The table below provides and overview of terms and abbreviations used in this document and their definitions.

Term	Description
callsign	The name given to an instance of a plugin. One plugin can be instantiated multiple times, but each instance the instance name, callsign, must be unique.

References

Ref ID	Description
HTTP	HTTP specification
JSON-RPC	JSON-RPC 2.0 specification
JSON	JSON specification
Thunder	Thunder API Reference

Description

The DeviceInfo plugin allows retrieving of various device-related information.

The plugin is designed to be loaded and executed within the Thunder framework. For more information about the framework refer to [Thunder].

Configuration

The table below lists configuration options of the plugin.

Name	Type	M/O	Description
callsign	string	mandatory	Plugin instance name (default: DeviceInfo)
classname	string	mandatory	Class name: DeviceInfo
locator	string	mandatory	Library name: libThunderDeviceInfo.so
startmode	string	mandatory	Determines in which state the plugin should be moved to at startup of the framework
hdr	boolean	mandatory	Does the device support HDR (true or false)
atmos	boolean	mandatory	Does the device support Dolby Atmos (true or false)
cec	boolean	mandatory	Does the device support HDMI CEC (true or false)
hdcp	string	mandatory	HDCP version supported by the device (unavailable, hdcp_14, hdcp_20, hdcp_21, hdcp_22)
audio	array	mandatory	Supported audio outputs
audio[#]	string	mandatory	Audio output (other, rf_modulator, analog, spdif, hdmi, displayport)
video	array	mandatory	Supported video outputs
video[#]	string	mandatory	Video output (other, rf_modulator, composite, svideo, component, scart_rgb, hdmi, displayport)
resolution	array	mandatory	Supported output resolutions
resolution[#]	string	mandatory	Output resolution (unknown, 480i, 480p, 576i, 576p, 720p, 1080i, 1080p, 2160p30, 2160p60, 4320p30, 4320p60)
modelName	string	mandatory	Model Name
modelYear	integer	mandatory	Model Year
friendlyName	string	mandatory	Friendly Name
systemIntegratorName	string	mandatory	System Integrator Name
platformName	string	mandatory	Platform Name

Interfaces

This plugin implements the following interfaces:

• DeviceInfo.json (version 1.0.0) (uncompliant-extended format)

Methods

The following methods are provided by the DeviceInfo plugin:

DeviceInfo interface methods:

Method	Description
supportedresolutions	Supported resolutions on the selected video display port
defaultresolution	Default resolution on the selected video display port
supportedhdcp	Supported hdcp version on the selected video display port
audiocapabilities	Audio capabilities for the specified audio port
ms12capabilities	Audio ms12 capabilities for the specified audio port
supportedms12audioprofiles	Supported ms12 audio profiles for the specified audio port

supportedresolutions ^method

Supported resolutions on the selected video display port.

Parameters

Name	Type	M/O	Description
params	object	mandatory	...
params.videoDisplay	string	mandatory	Video output supported by the device (must be one of the following: COMPONET, COMPOSITE, DISPLAYPORT, HDMI0, HDMI1, OTHER, RF_MODULATOR, SCART_RGB, SVIDEO)

Result

Name	Type	M/O	Description
result	object	mandatory	...
result.supportedResolutions	array	mandatory	An array of resolution supported by the device
result.supportedResolutions[#]	string	mandatory	Resolution supported by the device (must be one of the following: 1080i, 1080i25, 1080i50, 1080i60, 1080p, 1080p24, 1080p25, 1080p30, 1080p50, 1080p60, 2160p24, 2160p25, 2160p30, 2160p50, 2160p60, 4320p30, 4320p60, 480i, 480p, 576i, 576p, 576p50, 720p, 720p24, 720p25, 720p30, 720p50, 720p60, unknown)

Errors

Message	Description
ERROR_GENERAL	general error

Example

Request

{
  "jsonrpc": "2.0",
  "id": 42,
  "method": "DeviceInfo.1.supportedresolutions",
  "params": {
    "videoDisplay": "displayport"
  }
}

Response

{
  "jsonrpc": "2.0",
  "id": 42,
  "result": {
    "supportedResolutions": [
      "1080p"
    ]
  }
}

defaultresolution ^method

Default resolution on the selected video display port.

Parameters

Name	Type	M/O	Description
params	object	mandatory	...
params.videoDisplay	string	mandatory	Video output supported by the device (must be one of the following: COMPONET, COMPOSITE, DISPLAYPORT, HDMI0, HDMI1, OTHER, RF_MODULATOR, SCART_RGB, SVIDEO)

Result

Name	Type	M/O	Description
result	object	mandatory	...
result.defaultResolution	string	mandatory	Resolution supported by the device (must be one of the following: 1080i, 1080i25, 1080i50, 1080i60, 1080p, 1080p24, 1080p25, 1080p30, 1080p50, 1080p60, 2160p24, 2160p25, 2160p30, 2160p50, 2160p60, 4320p30, 4320p60, 480i, 480p, 576i, 576p, 576p50, 720p, 720p24, 720p25, 720p30, 720p50, 720p60, unknown)

Errors

Message	Description
ERROR_GENERAL	general error

Example

Request

{
  "jsonrpc": "2.0",
  "id": 42,
  "method": "DeviceInfo.1.defaultresolution",
  "params": {
    "videoDisplay": "displayport"
  }
}

Response

{
  "jsonrpc": "2.0",
  "id": 42,
  "result": {
    "defaultResolution": "1080p"
  }
}

supportedhdcp ^method

Supported hdcp version on the selected video display port.

Parameters

Name	Type	M/O	Description
params	object	mandatory	...
params.videoDisplay	string	mandatory	Video output supported by the device (must be one of the following: COMPONET, COMPOSITE, DISPLAYPORT, HDMI0, HDMI1, OTHER, RF_MODULATOR, SCART_RGB, SVIDEO)

Result

Name	Type	M/O	Description
result	object	mandatory	...
result.supportedHDCPVersion	string	mandatory	HDCP support (must be one of the following: 1.4, 2.0, 2.1, 2.2, unavailable)

Errors

Message	Description
ERROR_GENERAL	general error

Example

Request

{
  "jsonrpc": "2.0",
  "id": 42,
  "method": "DeviceInfo.1.supportedhdcp",
  "params": {
    "videoDisplay": "displayport"
  }
}

Response

{
  "jsonrpc": "2.0",
  "id": 42,
  "result": {
    "supportedHDCPVersion": "hdcp_20"
  }
}

audiocapabilities ^method

Audio capabilities for the specified audio port.

Parameters

Name	Type	M/O	Description
params	object	mandatory	...
params.audioPort	string	mandatory	Audio output supported by the device (must be one of the following: ANALOG, DISPLAYPORT, HDMI0, HDMI1, OTHER, RF_MODULATOR, SPDIF0)

Result

Name	Type	M/O	Description
result	object	mandatory	...
result.AudioCapabilities	array	mandatory	An array of audio capabilities
result.AudioCapabilities[#]	string	mandatory	Audio capability (must be one of the following: ATMOS, DAPv2, DOLBY DIGITAL, DOLBY DIGITAL PLUS, Dual Audio Decode, MS12, none)

Errors

Message	Description
ERROR_GENERAL	general error

Example

Request

{
  "jsonrpc": "2.0",
  "id": 42,
  "method": "DeviceInfo.1.audiocapabilities",
  "params": {
    "audioPort": "analog"
  }
}

Response

{
  "jsonrpc": "2.0",
  "id": 42,
  "result": {
    "AudioCapabilities": [
      "none"
    ]
  }
}

ms12capabilities ^method

Audio ms12 capabilities for the specified audio port.

Parameters

Name	Type	M/O	Description
params	object	mandatory	...
params.audioPort	string	mandatory	Audio output supported by the device (must be one of the following: ANALOG, DISPLAYPORT, HDMI0, HDMI1, OTHER, RF_MODULATOR, SPDIF0)

Result

Name	Type	M/O	Description
result	object	mandatory	...
result.MS12Capabilities	array	mandatory	An array of MS12 audio capabilities
result.MS12Capabilities[#]	string	mandatory	MS12 audio capability (must be one of the following: Dialogue Enhancer, Dolby Volume, Inteligent Equalizer, none)

Errors

Message	Description
ERROR_GENERAL	general error

Example

Request

{
  "jsonrpc": "2.0",
  "id": 42,
  "method": "DeviceInfo.1.ms12capabilities",
  "params": {
    "audioPort": "analog"
  }
}

Response

{
  "jsonrpc": "2.0",
  "id": 42,
  "result": {
    "MS12Capabilities": [
      "dolby_volume"
    ]
  }
}

supportedms12audioprofiles ^method

Supported ms12 audio profiles for the specified audio port.

Parameters

Name	Type	M/O	Description
params	object	mandatory	...
params.audioPort	string	mandatory	Audio output supported by the device (must be one of the following: ANALOG, DISPLAYPORT, HDMI0, HDMI1, OTHER, RF_MODULATOR, SPDIF0)

Result

Name	Type	M/O	Description
result	object	mandatory	...
result.supportedMS12AudioProfiles	array	mandatory	An array of ms12 audio profiles
result.supportedMS12AudioProfiles[#]	string	mandatory	MS12 Profile (must be one of the following: Movie, Music, None, Voice)

Errors

Message	Description
ERROR_GENERAL	General error

Example

Request

{
  "jsonrpc": "2.0",
  "id": 42,
  "method": "DeviceInfo.1.supportedms12audioprofiles",
  "params": {
    "audioPort": "analog"
  }
}

Response

{
  "jsonrpc": "2.0",
  "id": 42,
  "result": {
    "supportedMS12AudioProfiles": [
      "music"
    ]
  }
}

Properties

The following properties are provided by the DeviceInfo plugin:

DeviceInfo interface properties:

Property	R/W	Description
deviceaudiocapabilities	read-only	Audio capabilities of the device
devicevideocapabilities	read-only	Video capabilities of the device
deviceinfo	read-only	Device meta data
systeminfo	read-only	System general information
addresses	read-only	Network interface addresses
socketinfo	read-only	Socket information
supportedaudioports	read-only	Audio ports supported on the device (all ports that are physically present)
supportedvideodisplays	read-only	Video ports supported on the device (all ports that are physically present)
hostedid	read-only	EDID of the host
firmwareversion	read-only	Versions maintained in version
serialnumber	read-only	Serial number set by manufacturer
make	read-only	Device manufacturer
modelid	read-only	Device model number or SKU
modelname	read-only	Device model name
modelyear	read-only	Device model year
friendlyname	read-only	Device friendly name
platformname	read-only	Device Platform name
devicetype	read-only	Device type
distributorid	read-only	Partner ID or distributor ID for device

deviceaudiocapabilities ^property

Provides access to the audio capabilities of the device.

This property is read-only.

Value

Name	Type	M/O	Description
(property)	object	mandatory	Audio capabilities of the device
(property).audiooutputcapabilities	array	mandatory	An array of audiooutputcapabilities
(property).audiooutputcapabilities[#]	object	mandatory	Audio capabilities of the output
(property).audiooutputcapabilities[#]?.audioPort	string	optional	Audio Output support (must be one of the following: ANALOG, DISPLAYPORT, HDMI0, HDMI1, OTHER, RF_MODULATOR, SPDIF0)
(property).audiooutputcapabilities[#].audiocapabilities	array	mandatory	Audio capabilities for the specified audio port
(property).audiooutputcapabilities[#].audiocapabilities[#]	string	mandatory	Audio capability (must be one of the following: ATMOS, DAPv2, DOLBY DIGITAL, DOLBY DIGITAL PLUS, Dual Audio Decode, MS12, none)
(property).audiooutputcapabilities[#].ms12capabilities	array	mandatory	Audio ms12 capabilities for the specified audio port
(property).audiooutputcapabilities[#].ms12capabilities[#]	string	mandatory	MS12 audio capability (must be one of the following: Dialogue Enhancer, Dolby Volume, Inteligent Equalizer, none)
(property).audiooutputcapabilities[#].ms12profiles	array	mandatory	Audio ms12 profiles for the specified audio port
(property).audiooutputcapabilities[#].ms12profiles[#]	string	mandatory	MS12 Profile (must be one of the following: Movie, Music, None, Voice)

Example

Get Request

{
  "jsonrpc": "2.0",
  "id": 42,
  "method": "DeviceInfo.1.deviceaudiocapabilities"
}

Get Response

{
  "jsonrpc": "2.0",
  "id": 42,
  "result": {
    "audiooutputcapabilities": [
      {
        "audioPort": "analog",
        "audiocapabilities": [
          "none"
        ],
        "ms12capabilities": [
          "dolby_volume"
        ],
        "ms12profiles": [
          "music"
        ]
      }
    ]
  }
}

devicevideocapabilities ^property

Provides access to the video capabilities of the device.

This property is read-only.

Value

Name	Type	M/O	Description
(property)	object	mandatory	Video capabilities of the device
(property).hostedid	string	mandatory	EDID of the host
(property).hdr	boolean	mandatory	Is HDR supported by this device
(property).atmos	boolean	mandatory	Is Atmos supported by this device
(property).cec	boolean	mandatory	Is CEC supported by this device
(property).videooutputcapabilities	array	mandatory	An array of videooutputcapabilities
(property).videooutputcapabilities[#]	object	mandatory	Video capabilities of the output
(property).videooutputcapabilities[#].hdcp	string	mandatory	HDCP support (must be one of the following: 1.4, 2.0, 2.1, 2.2, unavailable)
(property).videooutputcapabilities[#]?.videoDisplay	string	optional	Video Output support (must be one of the following: COMPONET, COMPOSITE, DISPLAYPORT, HDMI0, HDMI1, OTHER, RF_MODULATOR, SCART_RGB, SVIDEO)
(property).videooutputcapabilities[#].output_resolutions	array	mandatory	Supported resolutions
(property).videooutputcapabilities[#].output_resolutions[#]	string	mandatory	Resolution supported by the device (must be one of the following: 1080i, 1080i25, 1080i50, 1080i60, 1080p, 1080p24, 1080p25, 1080p30, 1080p50, 1080p60, 2160p24, 2160p25, 2160p30, 2160p50, 2160p60, 4320p30, 4320p60, 480i, 480p, 576i, 576p, 576p50, 720p, 720p24, 720p25, 720p30, 720p50, 720p60, unknown)
(property).videooutputcapabilities[#].defaultresolution	string	mandatory	Default resolution (must be one of the following: 1080i, 1080i25, 1080i50, 1080i60, 1080p, 1080p24, 1080p25, 1080p30, 1080p50, 1080p60, 2160p24, 2160p25, 2160p30, 2160p50, 2160p60, 4320p30, 4320p60, 480i, 480p, 576i, 576p, 576p50, 720p, 720p24, 720p25, 720p30, 720p50, 720p60, unknown)

Example

Get Request

{
  "jsonrpc": "2.0",
  "id": 42,
  "method": "DeviceInfo.1.devicevideocapabilities"
}

Get Response

{
  "jsonrpc": "2.0",
  "id": 42,
  "result": {
    "hostedid": "...",
    "hdr": false,
    "atmos": false,
    "cec": true,
    "videooutputcapabilities": [
      {
        "hdcp": "hdcp_20",
        "videoDisplay": "displayport",
        "output_resolutions": [
          "1080p"
        ],
        "defaultresolution": "1080p"
      }
    ]
  }
}

deviceinfo ^property

Provides access to the device meta data.

This property is read-only.

Value

Name	Type	M/O	Description
(property)	object	mandatory	Device meta data
(property)?.devicetype	string	optional	Device type
(property)?.friendlyname	string	optional	Friendly name
(property)?.distributorid	string	optional	Partner ID or distributor ID for device
(property)?.make	string	optional	Device manufacturer
(property)?.modelname	string	optional	Model Name
(property)?.modelyear	integer	optional	Model Year
(property)?.platformname	string	optional	Platform name
(property)?.serialnumber	string	optional	Device serial number
(property)?.sku	string	optional	Device model number or SKU

Example

Get Request

{
  "jsonrpc": "2.0",
  "id": 42,
  "method": "DeviceInfo.1.deviceinfo"
}

Get Response

{
  "jsonrpc": "2.0",
  "id": 42,
  "result": {
    "devicetype": "IpStb",
    "friendlyname": "my device",
    "distributorid": "Comcast",
    "make": "pace",
    "modelname": "model A",
    "modelyear": 2020,
    "platformname": "linux",
    "serialnumber": "WPEuCfrLF45",
    "sku": "PX051AEI"
  }
}

systeminfo ^property

Provides access to the system general information.

This property is read-only.

Value

Name	Type	M/O	Description
(property)	object	mandatory	System general information
(property).version	string	mandatory	Software version (in form version#hashtag)
(property).uptime	integer	mandatory	System uptime (in seconds)
(property).totalram	integer	mandatory	Total installed system RAM memory (in bytes)
(property).freeram	integer	mandatory	Free system RAM memory (in bytes)
(property).totalswap	integer	mandatory	Total swap space (in bytes)
(property).freeswap	integer	mandatory	Swap space still available (in bytes)
(property).devicename	string	mandatory	Host name
(property).cpuload	string	mandatory	Current CPU load (percentage)
(property).cpuloadavg	object	mandatory	CPU load average
(property).cpuloadavg.avg1min	integer	mandatory	1min cpuload average
(property).cpuloadavg.avg5min	integer	mandatory	5min cpuload average
(property).cpuloadavg.avg15min	integer	mandatory	15min cpuload average
(property).serialnumber	string	mandatory	Device serial number
(property).time	string	mandatory	Current system date and time

Example

Get Request

{
  "jsonrpc": "2.0",
  "id": 42,
  "method": "DeviceInfo.1.systeminfo"
}

Get Response

{
  "jsonrpc": "2.0",
  "id": 42,
  "result": {
    "version": "1.0#14452f612c3747645d54974255d11b8f3b4faa54",
    "uptime": 120,
    "totalram": 655757312,
    "freeram": 563015680,
    "totalswap": 789132680,
    "freeswap": 789132680,
    "devicename": "buildroot",
    "cpuload": "2",
    "cpuloadavg": {
      "avg1min": 789132680,
      "avg5min": 789132680,
      "avg15min": 789132680
    },
    "serialnumber": "WPEuCfrLF45",
    "time": "Mon, 11 Mar 2019 14:38:18"
  }
}

addresses ^property

Provides access to the network interface addresses.

This property is read-only.

Value

Name	Type	M/O	Description
(property)	array	mandatory	Network interface addresses
(property)[#]	object	mandatory	...
(property)[#].name	string	mandatory	Interface name
(property)[#].mac	string	mandatory	Interface MAC address
(property)[#]?.ip	array	optional	An array of Interface IP address
(property)[#]?.ip[#]	string	mandatory	Interface IP address

Example

Get Request

{
  "jsonrpc": "2.0",
  "id": 42,
  "method": "DeviceInfo.1.addresses"
}

Get Response

{
  "jsonrpc": "2.0",
  "id": 42,
  "result": [
    {
      "name": "lo",
      "mac": "00:00:00:00:00",
      "ip": [
        "127.0.0.1"
      ]
    }
  ]
}

socketinfo ^property

Provides access to the socket information.

This property is read-only.

Value

Name	Type	M/O	Description
(property)	object	mandatory	Socket information
(property)?.total	integer	optional	Number of total
(property)?.open	integer	optional	Number of open
(property)?.link	integer	optional	Number of link
(property)?.exception	integer	optional	Number of exception
(property)?.shutdown	integer	optional	Number of shutdown
(property).runs	integer	mandatory	Number of runs

Example

Get Request

{
  "jsonrpc": "2.0",
  "id": 42,
  "method": "DeviceInfo.1.socketinfo"
}

Get Response

{
  "jsonrpc": "2.0",
  "id": 42,
  "result": {
    "total": 0,
    "open": 0,
    "link": 0,
    "exception": 0,
    "shutdown": 0,
    "runs": 1
  }
}

supportedaudioports ^property

Provides access to the audio ports supported on the device (all ports that are physically present).

This property is read-only.

Value

Name	Type	M/O	Description
(property)	object	mandatory	Audio ports supported on the device (all ports that are physically present)
(property).supportedAudioPorts	array	mandatory	Audio Output support
(property).supportedAudioPorts[#]	string	mandatory	Audio output supported by the device (must be one of the following: ANALOG, DISPLAYPORT, HDMI0, HDMI1, OTHER, RF_MODULATOR, SPDIF0)

Errors

Message	Description
ERROR_GENERAL	General error

Example

Get Request

{
  "jsonrpc": "2.0",
  "id": 42,
  "method": "DeviceInfo.1.supportedaudioports"
}

Get Response

{
  "jsonrpc": "2.0",
  "id": 42,
  "result": {
    "supportedAudioPorts": [
      "analog"
    ]
  }
}

supportedvideodisplays ^property

Provides access to the video ports supported on the device (all ports that are physically present).

This property is read-only.

Value

Name	Type	M/O	Description
(property)	object	mandatory	Video ports supported on the device (all ports that are physically present)
(property).supportedVideoDisplays	array	mandatory	Video Output support
(property).supportedVideoDisplays[#]	string	mandatory	Video output supported by the device (must be one of the following: COMPONET, COMPOSITE, DISPLAYPORT, HDMI0, HDMI1, OTHER, RF_MODULATOR, SCART_RGB, SVIDEO)

Errors

Message	Description
ERROR_GENERAL	General error

Example

Get Request

{
  "jsonrpc": "2.0",
  "id": 42,
  "method": "DeviceInfo.1.supportedvideodisplays"
}

Get Response

{
  "jsonrpc": "2.0",
  "id": 42,
  "result": {
    "supportedVideoDisplays": [
      "displayport"
    ]
  }
}

hostedid ^property

Provides access to the EDID of the host.

This property is read-only.

Value

Name	Type	M/O	Description
(property)	object	mandatory	EDID of the host
(property).EDID	string	mandatory	A base64 encoded byte array string representing the EDID

Errors

Message	Description
ERROR_GENERAL	General error

Example

Get Request

{
  "jsonrpc": "2.0",
  "id": 42,
  "method": "DeviceInfo.1.hostedid"
}

Get Response

{
  "jsonrpc": "2.0",
  "id": 42,
  "result": {
    "EDID": "AP///////wAQrMLQVEJTMQUdAQOANR546q11qVRNnSYPUFSlSwCBALMA0QBxT6lAgYDRwAEBVl4AoKCgKVAwIDUADighAAAaAAAA/wBNWTNORDkxVjFTQlQKAAAA/ABERUxMIFAyNDE4RAogAAAA/QAxVh1xHAAKICAgICAgARsCAxuxUJAFBAMCBxYBBhESFRMUHyBlAwwAEAACOoAYcTgtQFgsRQAOKCEAAB4BHYAYcRwWIFgsJQAOKCEAAJ6/FgCggDgTQDAgOgAOKCEAABp+OQCggDgfQDAgOgAOKCEAABoAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA2A"
  }
}

firmwareversion ^property

Provides access to the versions maintained in version.txt.

This property is read-only.

Value

Name	Type	M/O	Description
(property)	object	mandatory	Versions maintained in version.txt
(property).imagename	string	mandatory	Name of firmware image
(property)?.sdk	string	optional	SDK version string
(property)?.mediarite	string	optional	Mediarite value
(property)?.yocto	string	optional	Yocto version (must be one of the following: daisy, dunfell, kirkstone, morty)

Errors

Message	Description
ERROR_GENERAL	General error

Example

Get Request

{
  "jsonrpc": "2.0",
  "id": 42,
  "method": "DeviceInfo.1.firmwareversion"
}

Get Response

{
  "jsonrpc": "2.0",
  "id": 42,
  "result": {
    "imagename": "PX051AEI_VBN_2203_sprint_20220331225312sdy_NG",
    "sdk": "17.3",
    "mediarite": "8.3.53",
    "yocto": "dunfell"
  }
}

serialnumber ^property

Provides access to the serial number set by manufacturer.

This property is read-only.

Value

Name	Type	M/O	Description
(property)	object	mandatory	Serial number set by manufacturer
(property).serialnumber	string	mandatory	Device Serial Number

Errors

Message	Description
ERROR_GENERAL	General error

Example

Get Request

{
  "jsonrpc": "2.0",
  "id": 42,
  "method": "DeviceInfo.1.serialnumber"
}

Get Response

{
  "jsonrpc": "2.0",
  "id": 42,
  "result": {
    "serialnumber": "PAW400003744"
  }
}

make ^property

Provides access to the device manufacturer.

This property is read-only.

Value

Name	Type	M/O	Description
(property)	object	mandatory	Device manufacturer
(property).make	string	mandatory	Device manufacturer (must be one of the following: Amlogic_Inc, Pioneer, arris, cisco, commscope, element, hisense, llama, pace, platco, raspberrypi_org, samsung, sercomm, sky, technicolor)

Errors

Message	Description
ERROR_GENERAL	General error

Example

Get Request

{
  "jsonrpc": "2.0",
  "id": 42,
  "method": "DeviceInfo.1.make"
}

Get Response

{
  "jsonrpc": "2.0",
  "id": 42,
  "result": {
    "make": "pace"
  }
}

modelid ^property

Provides access to the device model number or SKU.

This property is read-only.

Value

Name	Type	M/O	Description
(property)	object	mandatory	Device model number or SKU
(property).sku	string	mandatory	Device model number or SKU (must be one of the following: AX013AN, AX014AN, AX061AEI, CMXI11BEI, CS011AN, CXD01ANI, ELTE11MWR, HSTP11MWR, HSTP11MWRFX50, LS301, MX011AN, PI, PITU11MWR, PLTL11AEI, PX001AN, PX013AN, PX022AN, PX032ANI, PX051AEI, PXD01ANI, SCXI11AIC, SCXI11BEI, SKTL11AEI, SKXI11ADS, SKXI11AIS, SKXI11ANS, SX022AN, TX061AEI, XUSHTB11MWR, XUSHTC11MWR, XUSPTC11MWR, ZWCN11MWI)

Errors

Message	Description
ERROR_GENERAL	General error

Example

Get Request

{
  "jsonrpc": "2.0",
  "id": 42,
  "method": "DeviceInfo.1.modelid"
}

Get Response

{
  "jsonrpc": "2.0",
  "id": 42,
  "result": {
    "sku": "PX051AEI"
  }
}

modelname ^property

Provides access to the device model name.

This property is read-only.

Value

Name	Type	M/O	Description
(property)	object	mandatory	Device model name
(property).model	string	mandatory	Device model name

Errors

Message	Description
ERROR_GENERAL	General error

Example

Get Request

{
  "jsonrpc": "2.0",
  "id": 42,
  "method": "DeviceInfo.1.modelname"
}

Get Response

{
  "jsonrpc": "2.0",
  "id": 42,
  "result": {
    "model": "Pace Xi5"
  }
}

modelyear ^property

Provides access to the device model year.

This property is read-only.

Value

Name	Type	M/O	Description
(property)	object	mandatory	Device model year
(property).year	integer	mandatory	Device model year

Errors

Message	Description
ERROR_GENERAL	General error

Example

Get Request

{
  "jsonrpc": "2.0",
  "id": 42,
  "method": "DeviceInfo.1.modelyear"
}

Get Response

{
  "jsonrpc": "2.0",
  "id": 42,
  "result": {
    "year": 2020
  }
}

friendlyname ^property

Provides access to the device friendly name.

This property is read-only.

Value

Name	Type	M/O	Description
(property)	object	mandatory	Device friendly name
(property).name	string	mandatory	Device friendly name

Errors

Message	Description
ERROR_GENERAL	General error

Example

Get Request

{
  "jsonrpc": "2.0",
  "id": 42,
  "method": "DeviceInfo.1.friendlyname"
}

Get Response

{
  "jsonrpc": "2.0",
  "id": 42,
  "result": {
    "name": "My device"
  }
}

platformname ^property

Provides access to the device Platform name.

This property is read-only.

Value

Name	Type	M/O	Description
(property)	object	mandatory	Device Platform name
(property).name	string	mandatory	Device Platform name

Errors

Message	Description
ERROR_GENERAL	General error

Example

Get Request

{
  "jsonrpc": "2.0",
  "id": 42,
  "method": "DeviceInfo.1.platformname"
}

Get Response

{
  "jsonrpc": "2.0",
  "id": 42,
  "result": {
    "name": "Linux"
  }
}

devicetype ^property

Provides access to the device type.

This property is read-only.

Value

Name	Type	M/O	Description
(property)	object	mandatory	Device type
(property).devicetype	string	mandatory	Device type (must be one of the following: IpStb, QamIpStb, hybrid, mediaclient, tv)

Errors

Message	Description
ERROR_GENERAL	General error

Example

Get Request

{
  "jsonrpc": "2.0",
  "id": 42,
  "method": "DeviceInfo.1.devicetype"
}

Get Response

{
  "jsonrpc": "2.0",
  "id": 42,
  "result": {
    "devicetype": "IpStb"
  }
}

distributorid ^property

Provides access to the partner ID or distributor ID for device.

This property is read-only.

Value

Name	Type	M/O	Description
(property)	object	mandatory	Partner ID or distributor ID for device
(property).distributorid	string	mandatory	Partner ID or distributor ID for device (must be one of the following: MIT, charter, charter-dev, comcast, cox, cox-dev, cox-hospitality, cox-qa, rogers, rogers-dev, shaw, shaw-dev, sky-de, sky-deu, sky-deu-dev, sky-it, sky-it-dev, sky-italia, sky-uk, sky-uk-dev, videotron, xglobal)

Errors

Message	Description
ERROR_GENERAL	General error

Example

Get Request

{
  "jsonrpc": "2.0",
  "id": 42,
  "method": "DeviceInfo.1.distributorid"
}

Get Response

{
  "jsonrpc": "2.0",
  "id": 42,
  "result": {
    "distributorid": "comcast"
  }
}