DeviceIdentification API

Version: 1.0.0

Status:

DeviceIdentification interface for Thunder framework.

(Defined with IDeviceIdentification in IDeviceIdentification.h)

Introduction

Scope

This document describes purpose and functionality of the DeviceIdentification interface (version 1.0.0). It includes detailed specification about its 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

DeviceIdentification JSON-RPC interface.

This interface uses legacy lowercase naming convention. With the next major release the naming convention will change to camelCase.

Properties

The following properties are provided by the DeviceIdentification interface:

DeviceIdentification interface properties:

Property	R/W	Description
deviceidentification	read-only	Get device paltform specific information

deviceidentification ^property

Provides access to the get device paltform specific information.

This property is read-only.

Value

Name	Type	M/O	Description
(property)	object	mandatory	Get device paltform specific information
(property).deviceid	string	mandatory	Device ID
(property)?.firmwareversion	string	optional	Version of the device firmware
(property)?.chipset	string	optional	Chipset used for this device

Errors

Message	Description
`ERROR_UNAVAILABLE`	Identification not availbale

Example

Get Request

{
  "jsonrpc": "2.0",
  "id": 42,
  "method": "<callsign>.1.deviceidentification"
}

Get Response

{
  "jsonrpc": "2.0",
  "id": 42,
  "result": {
    "deviceid": "WPEuCfrLF45",
    "firmwareversion": "1.0.0",
    "chipset": "BCM2711"
  }
}