|
| 1 | +<!-- Generated automatically, DO NOT EDIT! --> |
| 2 | +<a name="DeviceIdentification_Plugin"></a> |
| 3 | +# DeviceIdentification Plugin |
| 4 | + |
| 5 | +**Version: [1.0.6](https://github.com/rdkcentral/rdkservices/blob/main/DeviceIdentification/CHANGELOG.md)** |
| 6 | + |
| 7 | +A DeviceIdentification plugin for Thunder framework. |
| 8 | + |
| 9 | +### Table of Contents |
| 10 | + |
| 11 | +- [Abbreviation, Acronyms and Terms](#Abbreviation,_Acronyms_and_Terms) |
| 12 | +- [Description](#Description) |
| 13 | +- [Configuration](#Configuration) |
| 14 | +- [Properties](#Properties) |
| 15 | + |
| 16 | +<a name="Abbreviation,_Acronyms_and_Terms"></a> |
| 17 | +# Abbreviation, Acronyms and Terms |
| 18 | + |
| 19 | +[[Refer to this link](userguide/aat.md)] |
| 20 | + |
| 21 | +<a name="Description"></a> |
| 22 | +# Description |
| 23 | + |
| 24 | +The `DeviceIdentification` plugin allows you to retrieve various device-related information. |
| 25 | + |
| 26 | +The plugin is designed to be loaded and executed within the Thunder framework. For more information about the framework refer to [[Thunder](#Thunder)]. |
| 27 | + |
| 28 | +<a name="Configuration"></a> |
| 29 | +# Configuration |
| 30 | + |
| 31 | +The table below lists configuration options of the plugin. |
| 32 | + |
| 33 | +| Name | Type | Description | |
| 34 | +| :-------- | :-------- | :-------- | |
| 35 | +| callsign | string | Plugin instance name (default: *DeviceIdentification*) | |
| 36 | +| classname | string | Class name: *DeviceIdentification* | |
| 37 | +| locator | string | Library name: *libWPEFrameworkDeviceIdentification.so* | |
| 38 | +| autostart | boolean | Determines if the plugin shall be started automatically along with the framework | |
| 39 | + |
| 40 | +<a name="Properties"></a> |
| 41 | +# Properties |
| 42 | + |
| 43 | +The following properties are provided by the DeviceIdentification plugin: |
| 44 | + |
| 45 | +DeviceIdentification interface properties: |
| 46 | + |
| 47 | +| Property | Description | |
| 48 | +| :-------- | :-------- | |
| 49 | +| [deviceidentification](#deviceidentification) <sup>RO</sup> | Device platform specific information | |
| 50 | + |
| 51 | + |
| 52 | +<a name="deviceidentification"></a> |
| 53 | +## *deviceidentification* |
| 54 | + |
| 55 | +Provides access to the device platform specific information. |
| 56 | + |
| 57 | +> This property is **read-only**. |
| 58 | +
|
| 59 | +### Events |
| 60 | + |
| 61 | +No Events |
| 62 | + |
| 63 | +### Value |
| 64 | + |
| 65 | +| Name | Type | Description | |
| 66 | +| :-------- | :-------- | :-------- | |
| 67 | +| (property) | object | Device platform specific information | |
| 68 | +| (property).firmwareversion | string | Version of the device firmware | |
| 69 | +| (property).chipset | string | Chipset used for this device | |
| 70 | +| (property).deviceid | string | Device unique identifier | |
| 71 | + |
| 72 | +### Example |
| 73 | + |
| 74 | +#### Get Request |
| 75 | + |
| 76 | +```json |
| 77 | +{ |
| 78 | + "jsonrpc": "2.0", |
| 79 | + "id": 42, |
| 80 | + "method": "DeviceIdentification.deviceidentification" |
| 81 | +} |
| 82 | +``` |
| 83 | + |
| 84 | +#### Get Response |
| 85 | + |
| 86 | +```json |
| 87 | +{ |
| 88 | + "jsonrpc": "2.0", |
| 89 | + "id": 42, |
| 90 | + "result": { |
| 91 | + "firmwareversion": "1.0.0", |
| 92 | + "chipset": "BCM2711", |
| 93 | + "deviceid": "WPEuCfrLF45" |
| 94 | + } |
| 95 | +} |
| 96 | +``` |
| 97 | + |
| 98 | + |
0 commit comments