FAQ

Device Identification

Published: May 19, 2020
Edited: May 21, 2020

Device Identification API

Version: 1.0

Status:

DeviceIdentification plugin for Thunder framework.

Table of Contents

Introduction

Scope

This document describes purpose and functionality of the DeviceIdentification plugin. It includes detailed specification of its configuration and properties provided.

Case Sensitivity

All identifiers on the interface 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

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 Description
classname string Class name: DeviceIdentification
autostart boolean Determines if the plugin is to be started automatically along with the framework

Properties

The following properties are provided by the DeviceIdentification plugin:

DeviceIdentification interface properties:

Property Description
deviceidentification RO Device paltform specific information

deviceidentification property

Provides access to the device paltform specific information.

This property is read-only.

Value

Name Type Description
(property) object Device paltform specific information
(property).firmwareversion string Version of the device firmware
(property).chipset string Chipset used for this device
(property)?.identifier string (optional) Device unique identifier

Example

Get Request

{
    "jsonrpc": "2.0",
    "id": 1234567890,
    "method": "DeviceIdentification.1.deviceidentification"
}

Get Response

{
    "jsonrpc": "2.0",
    "id": 1234567890,
    "result": {
        "firmwareversion": "1.0.0",
        "chipset": "BCM2711",
        "identifier": ""
    }
}
PHP Code Snippets Powered By : XYZScripts.com