Change RPCs#153
Conversation
| // If any of the above mentioned actions for a given component has already | ||
| // been performed, then this method call efffectively skips that action. | ||
| rpc ColdStandbyComponent(ColdStandbyComponentRequest) | ||
| rpc StandbyComponent(StandbyComponentRequest) |
There was a problem hiding this comment.
This sounds strange. We are putting a component into standby. So maybe something EnableComponentStandby or something similiar? Here are some suggestions:
-
ToggleComponentStandbyMode
-
SetComponentToStandby
-
EnableStandbyForComponent
-
SwitchToStandbyMode
-
PutComponentInStandby
-
ActivateStandbyMode / DeactivateStandbyMode
-
ActivateComponentStandbyMode / DeactivateComponentStandbyMode
-
ToggleStandbyState
-
ChangeToStandbyMode
My question would be if a user puts an inverter into standby how can he activate it again? I think this we might also want to make clear in the documentation.
There was a problem hiding this comment.
My preference would be to use a verb at the front. SetComponentToStandby or ActivateComponentStandbyMode would be my favourites.
There was a problem hiding this comment.
PutComponentInStandby sounds good. I have updated the new RPC name to PutComponentInStandby.
My question would be if a user puts an inverter into standby how can he activate it again? I think this we might also want to make clear in the documentation.
Good call. I added it to the RPC docs.
There was a problem hiding this comment.
StandbyComponent also sounded a bit weird to me at first, but I think it had a nicer symmetry with StartComponent and StopComponent, IMHO now it is harder to see those 3 methods are related. As a final suggestion, I would put PauseComponent to the table, but I don't have any major complains if you prefer to keep PutComponentInStandby.
There was a problem hiding this comment.
(just unresolved so my last comment is not lost)
Also, not sure if it would be worth clarifying in SetComponentPowerActive docs that this will start the component if it was in standby/paused.
Signed-off-by: Tiyash Basu <tiyash.basu@frequenz.com>
The `HotStandby` RPC has been removed from the `Microgrid` service. This RPC is used only for inverters, and most inverters do not support this functionality. If required, the effect resulting by calling this RPC can be achieved internally upon receiving a charge/discharge command with power 0. Signed-off-by: Tiyash Basu <tiyash.basu@frequenz.com>
Signed-off-by: Tiyash Basu <tiyash.basu@frequenz.com>
Signed-off-by: Tiyash Basu <tiyash.basu@frequenz.com>
f12bcf8 to
2bde063
Compare
This PR includes the following changes:
HotStandbyColdStandbytoStandbySubscribeComponentDatatoReceiveComponentDataStreamSubscribeSensorDatatoReceiveSensorDataStream