Skip to content

Commit ca4891d

Browse files
RDKEMW-2565 Add deviceIdentification plugin details into deviceinfo (#281)
* RDKEMW-2565 Add deviceIdentification plugin details into deviceinfo Reason for change: Add chipset and ReleaseVersion property to DeviceInfo Plugin Test Procedure: verify build success and basic test Risks: Low Priority: P1 Signed-off-by: [email protected] * RDKEMW-2565 Add deviceIdentification plugin details into deviceinfo Reason for change: Add chipset and ReleaseVersion property to DeviceInfo Plugin Test Procedure: verify build success and basic test Risks: Low Priority: P1 Signed-off-by: [email protected] --------- Signed-off-by: [email protected]
1 parent 0daf44d commit ca4891d

File tree

3 files changed

+146
-2
lines changed

3 files changed

+146
-2
lines changed

apis/DeviceInfo/DeviceInfo.json

Lines changed: 44 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -446,6 +446,50 @@
446446
}
447447
]
448448
},
449+
"releaseversion": {
450+
"summary": "Release version of Image",
451+
"readonly": true,
452+
"params": {
453+
"type": "object",
454+
"properties": {
455+
"releaseversion": {
456+
"type": "string",
457+
"example": "8.2.0.0"
458+
}
459+
},
460+
"required": [
461+
"releaseversion"
462+
]
463+
},
464+
"errors": [
465+
{
466+
"description": "General error",
467+
"$ref": "#/common/errors/general"
468+
}
469+
]
470+
},
471+
"chipset": {
472+
"summary": "Chipset used for this device",
473+
"readonly": true,
474+
"params": {
475+
"type": "object",
476+
"properties": {
477+
"chipset": {
478+
"type": "string",
479+
"example": "T962X3"
480+
}
481+
},
482+
"required": [
483+
"chipset"
484+
]
485+
},
486+
"errors": [
487+
{
488+
"description": "General error",
489+
"$ref": "#/common/errors/general"
490+
}
491+
]
492+
},
449493
"modelid": {
450494
"summary": "Device model number or SKU",
451495
"readonly": true,

apis/DeviceInfo/IDeviceInfo.h

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -39,6 +39,8 @@ namespace Exchange {
3939
virtual uint32_t SocName(string& socName /* @out */) const = 0;
4040
virtual uint32_t DistributorId(string& distributorId /* @out */) const = 0;
4141
virtual uint32_t Brand(string& brand /* @out */) const = 0;
42+
virtual Core::hresult ReleaseVersion(string& releaseVersion /* @out */) const = 0;
43+
virtual Core::hresult ChipSet(string& chipSet /* @out */) const = 0;
4244
};
4345

4446
struct EXTERNAL IDeviceAudioCapabilities : virtual public Core::IUnknown {

docs/apis/DeviceInfoPlugin.md

Lines changed: 100 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
<a name="DeviceInfo_Plugin"></a>
33
# DeviceInfo Plugin
44

5-
**Version: [1.0.0]()**
5+
**Version: [1.1.0](https://github.com/rdkcentral/rdkservices/blob/main/DeviceInfo/CHANGELOG.md)**
66

77
A DeviceInfo plugin for Thunder framework.
88

@@ -17,7 +17,7 @@ A DeviceInfo plugin for Thunder framework.
1717
<a name="Abbreviation,_Acronyms_and_Terms"></a>
1818
# Abbreviation, Acronyms and Terms
1919

20-
[[Refer to this link](overview/aat.md)]
20+
[[Refer to this link](userguide/aat.md)]
2121

2222
<a name="Description"></a>
2323
# Description
@@ -417,6 +417,8 @@ DeviceInfo interface properties:
417417
| [socketinfo](#socketinfo) <sup>RO</sup> | Socket information |
418418
| [firmwareversion](#firmwareversion) <sup>RO</sup> | Versions maintained in version |
419419
| [serialnumber](#serialnumber) <sup>RO</sup> | Serial number set by manufacturer |
420+
| [releaseversion](#releaseversion) <sup>RO</sup> | Release version of Image |
421+
| [chipset](#chipset) <sup>RO</sup> | Chipset used for this device |
420422
| [modelid](#modelid) <sup>RO</sup> | Device model number or SKU |
421423
| [make](#make) <sup>RO</sup> | Device manufacturer |
422424
| [modelname](#modelname) <sup>RO</sup> | Friendly device model name |
@@ -703,6 +705,102 @@ No Events
703705
}
704706
```
705707

708+
<a name="releaseversion"></a>
709+
## *releaseversion*
710+
711+
Provides access to the release version of Image. If unable to find the Release version default value is 99.99.0.0.
712+
713+
> This property is **read-only**.
714+
715+
### Events
716+
717+
No Events
718+
719+
### Value
720+
721+
| Name | Type | Description |
722+
| :-------- | :-------- | :-------- |
723+
| (property) | object | Release version of Image. If unable to find the Release version default value is 99.99.0.0 |
724+
| (property).releaseversion | string | |
725+
726+
### Errors
727+
728+
| Code | Message | Description |
729+
| :-------- | :-------- | :-------- |
730+
| 1 | ```ERROR_GENERAL``` | General error |
731+
732+
### Example
733+
734+
#### Get Request
735+
736+
```json
737+
{
738+
"jsonrpc": "2.0",
739+
"id": 42,
740+
"method": "DeviceInfo.releaseversion"
741+
}
742+
```
743+
744+
#### Get Response
745+
746+
```json
747+
{
748+
"jsonrpc": "2.0",
749+
"id": 42,
750+
"result": {
751+
"releaseversion": "8.2.0.0"
752+
}
753+
}
754+
```
755+
756+
<a name="chipset"></a>
757+
## *chipset*
758+
759+
Provides access to the chipset used for this device.
760+
761+
> This property is **read-only**.
762+
763+
### Events
764+
765+
No Events
766+
767+
### Value
768+
769+
| Name | Type | Description |
770+
| :-------- | :-------- | :-------- |
771+
| (property) | object | Chipset used for this device |
772+
| (property).chipset | string | |
773+
774+
### Errors
775+
776+
| Code | Message | Description |
777+
| :-------- | :-------- | :-------- |
778+
| 1 | ```ERROR_GENERAL``` | General error |
779+
780+
### Example
781+
782+
#### Get Request
783+
784+
```json
785+
{
786+
"jsonrpc": "2.0",
787+
"id": 42,
788+
"method": "DeviceInfo.chipset"
789+
}
790+
```
791+
792+
#### Get Response
793+
794+
```json
795+
{
796+
"jsonrpc": "2.0",
797+
"id": 42,
798+
"result": {
799+
"chipset": "T962X3"
800+
}
801+
}
802+
```
803+
706804
<a name="modelid"></a>
707805
## *modelid*
708806

0 commit comments

Comments
 (0)