Skip to content

Commit f3620a2

Browse files
skamathskamath
committed
review rework
1 parent 1e6b621 commit f3620a2

File tree

2 files changed

+5
-59
lines changed

2 files changed

+5
-59
lines changed

‎docs/apis/PowerManagerPlugin.md‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -45,7 +45,7 @@ org.rdk.PowerManager interface methods:
4545

4646
| Method | Description |
4747
| :-------- | :-------- |
48-
| [addPowerModePreChangeClient](#addPowerModePreChangeClient) | Register a client to engage in power mode state changes |
48+
| [addPowerModePreChangeClient](#addPowerModePreChangeClient) | Register a client to engage in power mode pre-change operations |
4949
| [removePowerModePreChangeClient](#removePowerModePreChangeClient) | Removes a registered client from participating in power mode pre-change operations |
5050
| [powerModePreChangeComplete](#powerModePreChangeComplete) | Pre power mode handling complete for given client and transation id |
5151
| [delayPowerModeChangeBy](#delayPowerModeChangeBy) | Delay Powermode change by given time |
@@ -73,7 +73,7 @@ org.rdk.PowerManager interface methods:
7373
<a name="addPowerModePreChangeClient"></a>
7474
## *addPowerModePreChangeClient*
7575

76-
Register a client to engage in power mode state changes.
76+
Register a client to engage in power mode pre-change operations.
7777
Added client should call either
7878
- `PowerModePreChangeComplete` API to inform power manager that this client has completed its pre-change operation.
7979
- Or `DelayPowerModeChangeBy` API to delay the power mode change.
@@ -132,7 +132,7 @@ No Events
132132
## *removePowerModePreChangeClient*
133133

134134
Removes a registered client from participating in power mode pre-change operations.
135-
NOTE client will still continue to receive pre-change notifications.
135+
NOTE client will still continue to receive pre-change notifications. Always `Unregister` from `IModePreChangeNotification` after invoking `removePowerModePreChangeClient`.
136136

137137
### Events
138138

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

Lines changed: 2 additions & 56 deletions
Original file line numberDiff line numberDiff line change
@@ -35,60 +35,6 @@
3535
"type": "string",
3636
"example": "SystemPlugin"
3737
},
38-
"wakeupSources": {
39-
"summary": "Array of Key value pair with wake up sources and its configurations",
40-
"type": "array",
41-
"items": {
42-
"type": "object",
43-
"properties": {
44-
"WAKEUPSRC_VOICE": {
45-
"description": "Voice Wake up",
46-
"type":"boolean",
47-
"example": true
48-
},
49-
"WAKEUPSRC_PRESENCE_DETECTION": {
50-
"description": "Presense detection wake up",
51-
"type":"boolean",
52-
"example": true
53-
},
54-
"WAKEUPSRC_BLUETOOTH": {
55-
"description": "Bluetooth Wakeup",
56-
"type":"boolean",
57-
"example": true
58-
},
59-
"WAKEUPSRC_WIFI": {
60-
"description": "WiFi Wake up",
61-
"type":"boolean",
62-
"example": true
63-
},
64-
"WAKEUPSRC_IR": {
65-
"description": "IR Remote Wake up",
66-
"type":"boolean",
67-
"example": true
68-
},
69-
"WAKEUPSRC_POWER_KEY": {
70-
"description": "Power Button Wake up - GPIO",
71-
"type":"boolean",
72-
"example": true
73-
},
74-
"WAKEUPSRC_CEC": {
75-
"description": "HDMI CEC commadn Wake up",
76-
"type":"boolean",
77-
"example": true
78-
},
79-
"WAKEUPSRC_LAN": {
80-
"description": "LAN wake up",
81-
"type":"boolean",
82-
"example": true
83-
},
84-
"WAKEUPSRC_TIMER": {
85-
"description": "TImer Wake up",
86-
"type":"boolean",
87-
"example": true
88-
}
89-
}
90-
}
91-
},
9238
"powerState": {
9339
"summary": "The power state",
9440
"enum": [
@@ -136,7 +82,7 @@
13682
},
13783
"methods": {
13884
"addPowerModePreChangeClient": {
139-
"summary": "Register a client to engage in power mode state changes.\nAdded client should call either\n - `PowerModePreChangeComplete` API to inform power manager that this client has completed its pre-change operation.\n - Or `DelayPowerModeChangeBy` API to delay the power mode change.\nIf the client does not call `PowerModePreChangeComplete` API, the power mode change will complete\nafter the maximum delay `stateChangeAfter` seconds (as received in `OnPowerModePreChange` event).\n\nIMPORTANT: ** IT'S A BUG IF CLIENT `Unregister` FROM `IModePreChangeNotification` BEFORE DISENGAGING ITSELF **\n always make sure to call `RemovePowerModePreChangeClient` before calling `Unregister` from `IModePreChangeNotification`.",
85+
"summary": "Register a client to engage in power mode pre-change operations.\nAdded client should call either\n - `PowerModePreChangeComplete` API to inform power manager that this client has completed its pre-change operation.\n - Or `DelayPowerModeChangeBy` API to delay the power mode change.\nIf the client does not call `PowerModePreChangeComplete` API, the power mode change will complete\nafter the maximum delay `stateChangeAfter` seconds (as received in `OnPowerModePreChange` event).\n\nIMPORTANT: ** IT'S A BUG IF CLIENT `Unregister` FROM `IModePreChangeNotification` BEFORE DISENGAGING ITSELF **\n always make sure to call `RemovePowerModePreChangeClient` before calling `Unregister` from `IModePreChangeNotification`.",
14086
"params": {
14187
"type": "object",
14288
"properties": {
@@ -161,7 +107,7 @@
161107
}
162108
},
163109
"removePowerModePreChangeClient": {
164-
"summary": "Removes a registered client from participating in power mode pre-change operations.\nNOTE client will still continue to receive pre-change notifications.",
110+
"summary": "Removes a registered client from participating in power mode pre-change operations.\nNOTE client will still continue to receive pre-change notifications. Always `Unregister` from `IModePreChangeNotification` after invoking `removePowerModePreChangeClient`.",
165111
"params": {
166112
"type": "object",
167113
"properties": {

0 commit comments

Comments
 (0)