Skip to content

Commit 1d421e9

Browse files
skamathskamath
committed
minor correction to documentation
1 parent 8fde105 commit 1d421e9

File tree

2 files changed

+36
-86
lines changed

2 files changed

+36
-86
lines changed

‎docs/apis/PowerManagerPlugin.md‎

Lines changed: 17 additions & 64 deletions
Original file line numberDiff line numberDiff line change
@@ -63,8 +63,8 @@ org.rdk.PowerManager interface methods:
6363
| [setNetworkStandbyMode](#setNetworkStandbyMode) | This API will be deprecated in the future |
6464
| [setWakeupSrcConfig](#setWakeupSrcConfig) | Sets the wakeup source configuration for the input powerState |
6565
| [getWakeupSrcConfig](#getWakeupSrcConfig) | Returns all the supported wakeup configurations and powerState |
66-
| [setWakeupSourceConfig](#setWakeupSourceConfig) | Set the source configuration for device wakeup |
67-
| [getWakeupSourceConfig](#getWakeupSourceConfig) | Get the source configuration for device wakeup |
66+
| [setWakeupSourceConfig](#setWakeupSourceConfig) | Set the source configuration for device wakeup (Application friendly API) |
67+
| [getWakeupSourceConfig](#getWakeupSourceConfig) | Get the source configuration for device wakeup (Application friendly API) |
6868
| [setSystemMode](#setSystemMode) | Sets the mode of the set-top box for a specific duration before returning to normal mode |
6969
| [getPowerStateBeforeReboot](#getPowerStateBeforeReboot) | Returns the power state before reboot |
7070
| [setTemperatureThresholds](#setTemperatureThresholds) | Sets the temperature threshold values |
@@ -964,7 +964,7 @@ This method takes no parameters.
964964
<a name="setWakeupSourceConfig"></a>
965965
## *setWakeupSourceConfig*
966966

967-
Set the source configuration for device wakeup.
967+
Set the source configuration for device wakeup (Application friendly API). This API does not persist. Please call this API on Every bootup to set the values.
968968

969969
### Events
970970

@@ -977,17 +977,7 @@ No Events
977977
| params | object | |
978978
| params.wakeupSources | array | |
979979
| params.wakeupSources[#] | object | |
980-
| params.wakeupSources[#]?.wakeupSource | array | <sup>*(optional)*</sup> Wake up source |
981-
| params.wakeupSources[#]?.wakeupSource[#] | object | <sup>*(optional)*</sup> |
982-
| params.wakeupSources[#]?.wakeupSource[#]?.WAKEUPSRC_VOICE | boolean | <sup>*(optional)*</sup> Voice Wake up |
983-
| params.wakeupSources[#]?.wakeupSource[#]?.WAKEUPSRC_PRESENCE_DETECTION | boolean | <sup>*(optional)*</sup> Presense detection wake up |
984-
| params.wakeupSources[#]?.wakeupSource[#]?.WAKEUPSRC_BLUETOOTH | boolean | <sup>*(optional)*</sup> Bluetooth Wakeup |
985-
| params.wakeupSources[#]?.wakeupSource[#]?.WAKEUPSRC_WIFI | boolean | <sup>*(optional)*</sup> WiFi Wake up |
986-
| params.wakeupSources[#]?.wakeupSource[#]?.WAKEUPSRC_IR | boolean | <sup>*(optional)*</sup> IR Remote Wake up |
987-
| params.wakeupSources[#]?.wakeupSource[#]?.WAKEUPSRC_POWER_KEY | boolean | <sup>*(optional)*</sup> Power Button Wake up - GPIO |
988-
| params.wakeupSources[#]?.wakeupSource[#]?.WAKEUPSRC_CEC | boolean | <sup>*(optional)*</sup> HDMI CEC commadn Wake up |
989-
| params.wakeupSources[#]?.wakeupSource[#]?.WAKEUPSRC_LAN | boolean | <sup>*(optional)*</sup> LAN wake up |
990-
| params.wakeupSources[#]?.wakeupSource[#]?.WAKEUPSRC_TIMER | boolean | <sup>*(optional)*</sup> TImer Wake up |
980+
| params.wakeupSources[#]?.wakeupSource | string | <sup>*(optional)*</sup> Wake up source (strigified enum value PowerManager::WakeupSrcType) |
991981
| params.wakeupSources[#]?.enabled | boolean | <sup>*(optional)*</sup> Enable or disable the wakeup source |
992982

993983
### Result
@@ -1008,20 +998,8 @@ No Events
1008998
"params": {
1009999
"wakeupSources": [
10101000
{
1011-
"wakeupSource": [
1012-
{
1013-
"WAKEUPSRC_VOICE": true,
1014-
"WAKEUPSRC_PRESENCE_DETECTION": true,
1015-
"WAKEUPSRC_BLUETOOTH": true,
1016-
"WAKEUPSRC_WIFI": true,
1017-
"WAKEUPSRC_IR": true,
1018-
"WAKEUPSRC_POWER_KEY": true,
1019-
"WAKEUPSRC_CEC": true,
1020-
"WAKEUPSRC_LAN": true,
1021-
"WAKEUPSRC_TIMER": true
1022-
}
1023-
],
1024-
"enabled": false
1001+
"wakeupSource": "VOICE",
1002+
"enabled": true
10251003
}
10261004
]
10271005
}
@@ -1041,7 +1019,7 @@ No Events
10411019
<a name="getWakeupSourceConfig"></a>
10421020
## *getWakeupSourceConfig*
10431021

1044-
Get the source configuration for device wakeup.
1022+
Get the source configuration for device wakeup (Application friendly API).
10451023

10461024
### Events
10471025

@@ -1055,21 +1033,10 @@ This method takes no parameters.
10551033

10561034
| Name | Type | Description |
10571035
| :-------- | :-------- | :-------- |
1058-
| result | object | |
1059-
| result.wakeupSources | array | |
1060-
| result.wakeupSources[#] | object | |
1061-
| result.wakeupSources[#]?.wakeupSource | array | <sup>*(optional)*</sup> Wake up source strigified enum value |
1062-
| result.wakeupSources[#]?.wakeupSource[#] | object | <sup>*(optional)*</sup> |
1063-
| result.wakeupSources[#]?.wakeupSource[#]?.WAKEUPSRC_VOICE | boolean | <sup>*(optional)*</sup> Voice Wake up |
1064-
| result.wakeupSources[#]?.wakeupSource[#]?.WAKEUPSRC_PRESENCE_DETECTION | boolean | <sup>*(optional)*</sup> Presense detection wake up |
1065-
| result.wakeupSources[#]?.wakeupSource[#]?.WAKEUPSRC_BLUETOOTH | boolean | <sup>*(optional)*</sup> Bluetooth Wakeup |
1066-
| result.wakeupSources[#]?.wakeupSource[#]?.WAKEUPSRC_WIFI | boolean | <sup>*(optional)*</sup> WiFi Wake up |
1067-
| result.wakeupSources[#]?.wakeupSource[#]?.WAKEUPSRC_IR | boolean | <sup>*(optional)*</sup> IR Remote Wake up |
1068-
| result.wakeupSources[#]?.wakeupSource[#]?.WAKEUPSRC_POWER_KEY | boolean | <sup>*(optional)*</sup> Power Button Wake up - GPIO |
1069-
| result.wakeupSources[#]?.wakeupSource[#]?.WAKEUPSRC_CEC | boolean | <sup>*(optional)*</sup> HDMI CEC commadn Wake up |
1070-
| result.wakeupSources[#]?.wakeupSource[#]?.WAKEUPSRC_LAN | boolean | <sup>*(optional)*</sup> LAN wake up |
1071-
| result.wakeupSources[#]?.wakeupSource[#]?.WAKEUPSRC_TIMER | boolean | <sup>*(optional)*</sup> TImer Wake up |
1072-
| result.wakeupSources[#]?.enabled | boolean | <sup>*(optional)*</sup> Wakeup source is enabled or not |
1036+
| result | array | |
1037+
| result[#] | object | |
1038+
| result[#]?.wakeupSource | string | <sup>*(optional)*</sup> Wake up source strigified enum value (Powermanager::WakeupSrcType) |
1039+
| result[#]?.enabled | boolean | <sup>*(optional)*</sup> Wakeup source is enabled or not |
10731040

10741041
### Example
10751042

@@ -1089,26 +1056,12 @@ This method takes no parameters.
10891056
{
10901057
"jsonrpc": "2.0",
10911058
"id": 42,
1092-
"result": {
1093-
"wakeupSources": [
1094-
{
1095-
"wakeupSource": [
1096-
{
1097-
"WAKEUPSRC_VOICE": true,
1098-
"WAKEUPSRC_PRESENCE_DETECTION": true,
1099-
"WAKEUPSRC_BLUETOOTH": true,
1100-
"WAKEUPSRC_WIFI": true,
1101-
"WAKEUPSRC_IR": true,
1102-
"WAKEUPSRC_POWER_KEY": true,
1103-
"WAKEUPSRC_CEC": true,
1104-
"WAKEUPSRC_LAN": true,
1105-
"WAKEUPSRC_TIMER": true
1106-
}
1107-
],
1108-
"enabled": false
1109-
}
1110-
]
1111-
}
1059+
"result": [
1060+
{
1061+
"wakeupSource": "VOICE",
1062+
"enabled": true
1063+
}
1064+
]
11121065
}
11131066
```
11141067

‎tools/json_generator/output/PowerManager/PowerManager.json‎

Lines changed: 19 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -640,7 +640,7 @@
640640
}
641641
},
642642
"setWakeupSourceConfig": {
643-
"summary": "Set the source configuration for device wakeup",
643+
"summary": "Set the source configuration for device wakeup (Application friendly API). This API does not persist. Please call this API on Every bootup to set the values.",
644644
"params": {
645645
"type": "object",
646646
"properties": {
@@ -651,12 +651,13 @@
651651
"properties": {
652652
"wakeupSource": {
653653
"type": "string",
654-
"description": "Wake up source",
655-
"$ref": "#/definitions/wakeupSources"
654+
"description": "Wake up source (strigified enum value PowerManager::WakeupSrcType)",
655+
"example": "VOICE"
656656
},
657657
"enabled": {
658658
"type": "boolean",
659-
"description": "Enable or disable the wakeup source"
659+
"description": "Enable or disable the wakeup source",
660+
"example": true
660661
}
661662
}
662663
}
@@ -670,28 +671,24 @@
670671
}
671672
},
672673
"getWakeupSourceConfig": {
673-
"summary": "Get the source configuration for device wakeup",
674+
"summary": "Get the source configuration for device wakeup (Application friendly API)",
674675
"result": {
675-
"type": "object",
676-
"properties": {
677-
"wakeupSources": {
678-
"type": "array",
679-
"items": {
680-
"type": "object",
681-
"properties": {
682-
"wakeupSource": {
683-
"type": "string",
684-
"description": "Wake up source strigified enum value",
685-
"$ref": "#/definitions/wakeupSources"
686-
},
687-
"enabled": {
688-
"type": "boolean",
689-
"description": "Wakeup source is enabled or not"
690-
}
676+
"type": "array",
677+
"items": {
678+
"type": "object",
679+
"properties": {
680+
"wakeupSource": {
681+
"type": "string",
682+
"description": "Wake up source strigified enum value (Powermanager::WakeupSrcType)",
683+
"example": "VOICE"
684+
},
685+
"enabled": {
686+
"type": "boolean",
687+
"description": "Wakeup source is enabled or not",
688+
"example": true
691689
}
692690
}
693691
}
694-
}
695692
}
696693
},
697694
"setSystemMode":{

0 commit comments

Comments
 (0)