Skip to content

Commit 1f502af

Browse files
anand-kyanand-ky
authored
Merge pull request rdkcentral#5858 from ramkumarpraba/sprint/24Q4_RDK-54523
RDK-54523 SystemMode thunderplugin documenation
2 parents b87a8b7 + 4bf3fa4 commit 1f502af

File tree

2 files changed

+152
-0
lines changed

2 files changed

+152
-0
lines changed

‎docs/_sidebar.md‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -49,6 +49,7 @@
4949
- [StateObserver](api/StateObserverPlugin.md)
5050
- [SystemAudioPlayer](api/SystemAudioPlayerPlugin.md)
5151
- [System](api/SystemPlugin.md)
52+
- [SystemMode](api/SystemModePlugin.md)
5253
- [Telemetry](api/TelemetryPlugin.md)
5354
- [TextToSpeech](api/TextToSpeechPlugin.md)
5455
- [Timer](api/TimerPlugin.md)

‎docs/api/SystemModePlugin.md‎

Lines changed: 151 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,151 @@
1+
<!-- Generated automatically, DO NOT EDIT! -->
2+
<a name="System_Mode_Plugin"></a>
3+
# System Mode Plugin
4+
5+
**Version: [1.0.0](https://github.com/rdkcentral/rdkservices/blob/main/SystemMode/CHANGELOG.md)**
6+
7+
A org.rdk.SystemMode 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+
- [Methods](#Methods)
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 `SystemMode` plugin coordinates state changes that take effect across multiple components in the system.
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: *org.rdk.SystemMode*) |
36+
| classname | string | Class name: *org.rdk.SystemMode* |
37+
| locator | string | Library name: *libWPEFrameworkSystemMode.so* |
38+
| autostart | boolean | Determines if the plugin shall be started automatically along with the framework |
39+
40+
<a name="Methods"></a>
41+
# Methods
42+
43+
The following methods are provided by the org.rdk.SystemMode plugin:
44+
45+
org.rdk.SystemMode interface methods:
46+
47+
| Method | Description |
48+
| :-------- | :-------- |
49+
| [requestState](#requestState) | Requests a new system mode state in the device |
50+
| [getState](#getState) | Gets the current state for a given system property |
51+
52+
53+
<a name="requestState"></a>
54+
## *requestState*
55+
56+
Requests a new system mode state in the device. Thunder components asynchronously reconfigure themselves so the caller cannot be guaranteed a full state transition upon return.
57+
58+
### Events
59+
60+
No Events
61+
62+
### Parameters
63+
64+
| Name | Type | Description |
65+
| :-------- | :-------- | :-------- |
66+
| params | object | |
67+
| params.systemMode | string | System mode (must be one of the following: device_optimize) |
68+
| params.state | string | The target state (must be one of the following: video, game) |
69+
70+
### Result
71+
72+
| Name | Type | Description |
73+
| :-------- | :-------- | :-------- |
74+
| result | null | Always null |
75+
76+
### Example
77+
78+
#### Request
79+
80+
```json
81+
{
82+
"jsonrpc": "2.0",
83+
"id": 42,
84+
"method": "org.rdk.SystemMode.requestState",
85+
"params": {
86+
"systemMode": "device_optimize",
87+
"state": "game"
88+
}
89+
}
90+
```
91+
92+
#### Response
93+
94+
```json
95+
{
96+
"jsonrpc": "2.0",
97+
"id": 42,
98+
"result": null
99+
}
100+
```
101+
102+
<a name="getState"></a>
103+
## *getState*
104+
105+
Gets the current state for a given system
106+
107+
### Events
108+
109+
No Events
110+
111+
### Parameters
112+
113+
| Name | Type | Description |
114+
| :-------- | :-------- | :-------- |
115+
| params | object | |
116+
| params.systemMode | string | System mode (must be one of the following: device_optimize) |
117+
118+
### Result
119+
120+
| Name | Type | Description |
121+
| :-------- | :-------- | :-------- |
122+
| result | object | |
123+
| result.state | string | The target state (must be one of the following: video, game) |
124+
125+
### Example
126+
127+
#### Request
128+
129+
```json
130+
{
131+
"jsonrpc": "2.0",
132+
"id": 42,
133+
"method": "org.rdk.SystemMode.getState",
134+
"params": {
135+
"systemMode": "device_optimize"
136+
}
137+
}
138+
```
139+
140+
#### Response
141+
142+
```json
143+
{
144+
"jsonrpc": "2.0",
145+
"id": 42,
146+
"result": {
147+
"state": "game"
148+
}
149+
}
150+
```
151+

0 commit comments

Comments
 (0)