Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions docs/_sidebar.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@
- [AVInput](apis/AVInputPlugin.md)
- [Bluetooth](apis/BluetoothPlugin.md)
- [DeviceDiagnostics](apis/DeviceDiagnosticsPlugin.md)
- [DeviceIdentification](apis/DeviceIdentificationPlugin.md)
- [DeviceInfo](apis/DeviceInfoPlugin.md)
- [DisplayInfo](apis/DisplayInfoPlugin.md)
- [DisplaySettings](apis/DisplaySettingsPlugin.md)
Expand All @@ -16,13 +17,16 @@
- [HdcpProfile](apis/HdcpProfilePlugin.md)
- [HdmiCecSink](apis/HdmiCecSinkPlugin.md)
- [HdmiCecSource](apis/HdmiCecSourcePlugin.md)
- [HomeKitTV](apis/HomeKitTVPlugin.md)
- [LEDControl](apis/LEDControlPlugin.md)
- [LinearPlaybackControl](apis/LinearPlaybackControlPlugin.md)
- [MaintenanceManager](apis/MaintenanceManagerPlugin.md)
- [MessageControl](apis/MessageControlPlugin.md)
- [MiracastPlayer](apis/MiracastPlayerPlugin.md)
- [MiracastService](apis/MiracastServicePlugin.md)
- [Monitor](apis/MonitorPlugin.md)
- [MotionDetection](apis/MotionDetectionPlugin.md)
- [Netflix](apis/NetflixPlugin.md)
- [OCIContainer](apis/OCIContainerPlugin.md)
- [OpenCDMi](apis/OpenCDMiPlugin.md)
- [Packager](apis/PackagerPlugin.md)
Expand Down
98 changes: 98 additions & 0 deletions docs/apis/DeviceIdentificationPlugin.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,98 @@
<!-- Generated automatically, DO NOT EDIT! -->
<a name="DeviceIdentification_Plugin"></a>
# DeviceIdentification Plugin

**Version: [1.0.6](https://github.com/rdkcentral/rdkservices/blob/main/DeviceIdentification/CHANGELOG.md)**

A DeviceIdentification plugin for Thunder framework.

### Table of Contents

- [Abbreviation, Acronyms and Terms](#Abbreviation,_Acronyms_and_Terms)
- [Description](#Description)
- [Configuration](#Configuration)
- [Properties](#Properties)

<a name="Abbreviation,_Acronyms_and_Terms"></a>
# Abbreviation, Acronyms and Terms

[[Refer to this link](userguide/aat.md)]

<a name="Description"></a>
# Description

The `DeviceIdentification` plugin allows you to retrieve 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](#Thunder)].

<a name="Configuration"></a>
# Configuration

The table below lists configuration options of the plugin.

| Name | Type | Description |
| :-------- | :-------- | :-------- |
| callsign | string | Plugin instance name (default: *DeviceIdentification*) |
| classname | string | Class name: *DeviceIdentification* |
| locator | string | Library name: *libWPEFrameworkDeviceIdentification.so* |
| autostart | boolean | Determines if the plugin shall be started automatically along with the framework |

<a name="Properties"></a>
# Properties

The following properties are provided by the DeviceIdentification plugin:

DeviceIdentification interface properties:

| Property | Description |
| :-------- | :-------- |
| [deviceidentification](#deviceidentification) <sup>RO</sup> | Device platform specific information |


<a name="deviceidentification"></a>
## *deviceidentification*

Provides access to the device platform specific information.

> This property is **read-only**.

### Events

No Events

### Value

| Name | Type | Description |
| :-------- | :-------- | :-------- |
| (property) | object | Device platform specific information |
| (property).firmwareversion | string | Version of the device firmware |
| (property).chipset | string | Chipset used for this device |
| (property)?.identifier | string | <sup>*(optional)*</sup> Device unique identifier |

### Example

#### Get Request

```json
{
"jsonrpc": "2.0",
"id": 42,
"method": "DeviceIdentification.deviceidentification"
}
```

#### Get Response

```json
{
"jsonrpc": "2.0",
"id": 42,
"result": {
"firmwareversion": "1.0.0",
"chipset": "BCM2711",
"identifier": "WPEuCfrLF45"
}
}
```


Loading
Loading