Skip to content

Commit 512c6f2

Browse files
skamathskamath
committed
remove old SetWakeupSrcConfig & GetWakeupSrcConfig APIs
1 parent 2de1a4d commit 512c6f2

File tree

3 files changed

+6
-233
lines changed

3 files changed

+6
-233
lines changed

‎apis/PowerManager/IPowerManager.h‎

Lines changed: 0 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -292,28 +292,12 @@ namespace WPEFramework
292292
virtual Core::hresult GetNetworkStandbyMode(bool &standbyMode /* @out */) = 0;
293293

294294
/** Set Wakeup source configuration */
295-
// @text setWakeupSrcConfig
296-
// @brief Set the source configuration for device wakeup
297-
// @param powerMode: power mode
298-
// @param wakeSrcType: source type
299-
// @param config: config
300-
virtual Core::hresult SetWakeupSrcConfig(const int powerMode /* @in */, const int wakeSrcType /* @in */, int config /* @in */ ) = 0;
301-
302-
/** Set Wakeup source configuration - Iterator way */
303295
// @text setWakeupSourceConfig
304296
// @brief Set the source configuration for device wakeup
305297
// @param wakeupSources: Wake up sources array
306298
virtual Core::hresult SetWakeupSourceConfig(IWakeupSrcConfigIterator* wakeupSources /* @in */ ) = 0;
307299

308300
/** Get Wakeup source configuration */
309-
// @text getWakeupSrcConfig
310-
// @brief Get the source configuration for device wakeup
311-
// @param powerMode: power mode
312-
// @param srcType: source type
313-
// @param config: config
314-
virtual Core::hresult GetWakeupSrcConfig(int &powerMode /* @out */, int &srcType /* @out */, int &config /* @out */) const = 0;
315-
316-
/** Get Wakeup source configuration - Iterator way */
317301
// @text getWakeupSourceConfig
318302
// @brief Get the source configuration for device wakeup
319303
// @param wakeupSources: Wake up sources array

‎docs/apis/PowerManagerPlugin.md‎

Lines changed: 4 additions & 107 deletions
Original file line numberDiff line numberDiff line change
@@ -61,10 +61,8 @@ org.rdk.PowerManager interface methods:
6161
| [reboot](#reboot) | Requests that the system performs a reboot of the set-top box |
6262
| [getNetworkStandbyMode](#getNetworkStandbyMode) | Returns the network standby mode of the device |
6363
| [setNetworkStandbyMode](#setNetworkStandbyMode) | This API will be deprecated in the future |
64-
| [setWakeupSrcConfig](#setWakeupSrcConfig) | Sets the wakeup source configuration for the input powerState |
65-
| [getWakeupSrcConfig](#getWakeupSrcConfig) | Returns all the supported wakeup configurations and powerState |
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) |
64+
| [setWakeupSourceConfig](#setWakeupSourceConfig) | Set the source configuration for device wakeup |
65+
| [getWakeupSourceConfig](#getWakeupSourceConfig) | Get the source configuration for device wakeup |
6866
| [setSystemMode](#setSystemMode) | Sets the mode of the set-top box for a specific duration before returning to normal mode |
6967
| [getPowerStateBeforeReboot](#getPowerStateBeforeReboot) | Returns the power state before reboot |
7068
| [setTemperatureThresholds](#setTemperatureThresholds) | Sets the temperature threshold values |
@@ -860,111 +858,10 @@ No Events
860858
}
861859
```
862860

863-
<a name="setWakeupSrcConfig"></a>
864-
## *setWakeupSrcConfig*
865-
866-
Sets the wakeup source configuration for the input powerState. if you are using setNetworkStandbyMode API, Please do not use this API to set LAN and WIFI wakeup. Please migrate to setWakeupSrcConfiguration API to control all wakeup source settings. This API does not persist. Please call this API on Every bootup to set the values.
867-
868-
### Events
869-
870-
No Events
871-
872-
### Parameters
873-
874-
| Name | Type | Description |
875-
| :-------- | :-------- | :-------- |
876-
| params | object | |
877-
| params?.powerState | integer | <sup>*(optional)*</sup> Enum indicating bit position, If the reason is STANDBY, the value is 4(bit counting starts at 1) (must be one of the following: *OFF*, *STANDBY*, *ON*, *LIGHT_SLEEP*, *DEEP_SLEEP*) |
878-
| params.wakeupSources | integer | Enum indicating bit position, If the reason is LAN, the value is 32(bit counting starts at 1) (must be one of the following: *WAKEUP_REASON_IR*, *WAKEUP_REASON_RCU_BT*, *WAKEUP_REASON_RCU_RF4CE*, *WAKEUP_REASON_GPIO*, *WAKEUP_REASON_LAN*, *WAKEUP_REASON_WLAN*, *WAKEUP_REASON_TIMER*, *WAKEUP_REASON_FRONT_PANEL*, *WAKEUP_REASON_WATCHDOG*, *WAKEUP_REASON_SOFTWARE_RESET*, *WAKEUP_REASON_THERMAL_RESET*, *WAKEUP_REASON_WARM_RESET*, *WAKEUP_REASON_COLDBOOT*, *WAKEUP_REASON_STR_AUTH_FAILURE*, *WAKEUP_REASON_CEC*, *WAKEUP_REASON_PRESENCE*, *WAKEUP_REASON_VOICE*, *WAKEUP_REASON_UNKNOWN*) |
879-
880-
### Result
881-
882-
| Name | Type | Description |
883-
| :-------- | :-------- | :-------- |
884-
| result | string | On success null will be returned |
885-
886-
### Errors
887-
888-
| Code | Message | Description |
889-
| :-------- | :-------- | :-------- |
890-
| 1 | ```ERROR_GENERAL``` | General error |
891-
892-
### Example
893-
894-
#### Request
895-
896-
```json
897-
{
898-
"jsonrpc": "2.0",
899-
"id": 42,
900-
"method": "org.rdk.PowerManager.setWakeupSrcConfig",
901-
"params": {
902-
"powerState": 4,
903-
"wakeupSources": 6
904-
}
905-
}
906-
```
907-
908-
#### Response
909-
910-
```json
911-
{
912-
"jsonrpc": "2.0",
913-
"id": 42,
914-
"result": "null"
915-
}
916-
```
917-
918-
<a name="getWakeupSrcConfig"></a>
919-
## *getWakeupSrcConfig*
920-
921-
Returns all the supported wakeup configurations and powerState.
922-
923-
### Events
924-
925-
No Events
926-
927-
### Parameters
928-
929-
This method takes no parameters.
930-
931-
### Result
932-
933-
| Name | Type | Description |
934-
| :-------- | :-------- | :-------- |
935-
| result | object | |
936-
| result.powerState | integer | Enum indicating bit position, If the reason is STANDBY, the value is 4(bit counting starts at 1) (must be one of the following: *OFF*, *STANDBY*, *ON*, *LIGHT_SLEEP*, *DEEP_SLEEP*) |
937-
| result.wakeupSources | integer | Enum indicating bit position, If the reason is LAN, the value is 32(bit counting starts at 1) (must be one of the following: *WAKEUP_REASON_IR*, *WAKEUP_REASON_RCU_BT*, *WAKEUP_REASON_RCU_RF4CE*, *WAKEUP_REASON_GPIO*, *WAKEUP_REASON_LAN*, *WAKEUP_REASON_WLAN*, *WAKEUP_REASON_TIMER*, *WAKEUP_REASON_FRONT_PANEL*, *WAKEUP_REASON_WATCHDOG*, *WAKEUP_REASON_SOFTWARE_RESET*, *WAKEUP_REASON_THERMAL_RESET*, *WAKEUP_REASON_WARM_RESET*, *WAKEUP_REASON_COLDBOOT*, *WAKEUP_REASON_STR_AUTH_FAILURE*, *WAKEUP_REASON_CEC*, *WAKEUP_REASON_PRESENCE*, *WAKEUP_REASON_VOICE*, *WAKEUP_REASON_UNKNOWN*) |
938-
939-
### Example
940-
941-
#### Request
942-
943-
```json
944-
{
945-
"jsonrpc": "2.0",
946-
"id": 42,
947-
"method": "org.rdk.PowerManager.getWakeupSrcConfig"
948-
}
949-
```
950-
951-
#### Response
952-
953-
```json
954-
{
955-
"jsonrpc": "2.0",
956-
"id": 42,
957-
"result": {
958-
"powerState": 4,
959-
"wakeupSources": 6
960-
}
961-
}
962-
```
963-
964861
<a name="setWakeupSourceConfig"></a>
965862
## *setWakeupSourceConfig*
966863

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.
864+
Set the source configuration for device wakeup. This API does not persist. Please call this API on Every bootup to set the values.
968865

969866
### Events
970867

@@ -1019,7 +916,7 @@ No Events
1019916
<a name="getWakeupSourceConfig"></a>
1020917
## *getWakeupSourceConfig*
1021918

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

1024921
### Events
1025922

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

Lines changed: 2 additions & 110 deletions
Original file line numberDiff line numberDiff line change
@@ -477,116 +477,8 @@
477477
}
478478
]
479479
},
480-
"setWakeupSrcConfig":{
481-
"summary": "Sets the wakeup source configuration for the input powerState. if you are using setNetworkStandbyMode API, Please do not use this API to set LAN and WIFI wakeup. Please migrate to setWakeupSrcConfiguration API to control all wakeup source settings. This API does not persist. Please call this API on Every bootup to set the values.",
482-
"params": {
483-
"type": "object",
484-
"properties": {
485-
"powerState": {
486-
"summary": "Enum indicating bit position, If the reason is STANDBY, the value is 4(bit counting starts at 1)",
487-
"enum": [
488-
"OFF",
489-
"STANDBY",
490-
"ON",
491-
"LIGHT_SLEEP",
492-
"DEEP_SLEEP"
493-
],
494-
"type": "integer",
495-
"example": 4
496-
},
497-
"wakeupSources": {
498-
"summary": "Enum indicating bit position, If the reason is LAN, the value is 32(bit counting starts at 1)",
499-
"enum": [
500-
"WAKEUP_REASON_IR",
501-
"WAKEUP_REASON_RCU_BT",
502-
"WAKEUP_REASON_RCU_RF4CE",
503-
"WAKEUP_REASON_GPIO",
504-
"WAKEUP_REASON_LAN",
505-
"WAKEUP_REASON_WLAN",
506-
"WAKEUP_REASON_TIMER",
507-
"WAKEUP_REASON_FRONT_PANEL",
508-
"WAKEUP_REASON_WATCHDOG",
509-
"WAKEUP_REASON_SOFTWARE_RESET",
510-
"WAKEUP_REASON_THERMAL_RESET",
511-
"WAKEUP_REASON_WARM_RESET",
512-
"WAKEUP_REASON_COLDBOOT",
513-
"WAKEUP_REASON_STR_AUTH_FAILURE",
514-
"WAKEUP_REASON_CEC",
515-
"WAKEUP_REASON_PRESENCE",
516-
"WAKEUP_REASON_VOICE",
517-
"WAKEUP_REASON_UNKNOWN"
518-
],
519-
"type": "integer",
520-
"example": 6
521-
}
522-
},
523-
"required": [
524-
"wakeupSources"
525-
]
526-
},
527-
"result": {
528-
"summary": "On success null will be returned",
529-
"type": "string",
530-
"example": "null"
531-
},
532-
"errors": [
533-
{
534-
"description": "General error",
535-
"$ref": "#/common/errors/general"
536-
}
537-
]
538-
},
539-
"getWakeupSrcConfig":{
540-
"summary": "Returns all the supported wakeup configurations and powerState",
541-
"result": {
542-
"type": "object",
543-
"properties": {
544-
"powerState": {
545-
"summary": "Enum indicating bit position, If the reason is STANDBY, the value is 4(bit counting starts at 1)",
546-
"enum": [
547-
"OFF",
548-
"STANDBY",
549-
"ON",
550-
"LIGHT_SLEEP",
551-
"DEEP_SLEEP"
552-
],
553-
"type": "integer",
554-
"example": 4
555-
},
556-
"wakeupSources": {
557-
"summary": "Enum indicating bit position, If the reason is LAN, the value is 32(bit counting starts at 1)",
558-
"enum": [
559-
"WAKEUP_REASON_IR",
560-
"WAKEUP_REASON_RCU_BT",
561-
"WAKEUP_REASON_RCU_RF4CE",
562-
"WAKEUP_REASON_GPIO",
563-
"WAKEUP_REASON_LAN",
564-
"WAKEUP_REASON_WLAN",
565-
"WAKEUP_REASON_TIMER",
566-
"WAKEUP_REASON_FRONT_PANEL",
567-
"WAKEUP_REASON_WATCHDOG",
568-
"WAKEUP_REASON_SOFTWARE_RESET",
569-
"WAKEUP_REASON_THERMAL_RESET",
570-
"WAKEUP_REASON_WARM_RESET",
571-
"WAKEUP_REASON_COLDBOOT",
572-
"WAKEUP_REASON_STR_AUTH_FAILURE",
573-
"WAKEUP_REASON_CEC",
574-
"WAKEUP_REASON_PRESENCE",
575-
"WAKEUP_REASON_VOICE",
576-
"WAKEUP_REASON_UNKNOWN"
577-
],
578-
"type": "integer",
579-
"example": 6
580-
}
581-
},
582-
"required": [
583-
"powerState",
584-
"wakeupSources"
585-
]
586-
}
587-
},
588480
"setWakeupSourceConfig": {
589-
"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.",
481+
"summary": "Set the source configuration for device wakeup. This API does not persist. Please call this API on Every bootup to set the values.",
590482
"params": {
591483
"type": "object",
592484
"properties": {
@@ -617,7 +509,7 @@
617509
}
618510
},
619511
"getWakeupSourceConfig": {
620-
"summary": "Get the source configuration for device wakeup (Application friendly API)",
512+
"summary": "Get the source configuration for device wakeup",
621513
"result": {
622514
"type": "array",
623515
"items": {

0 commit comments

Comments
 (0)