Add doc to sys/panel endpoint #85
Conversation
rafaeldantaas
requested review from
marciogranzotto,
chrismerck and
RubensHardt
| - If `true` device operate as keypad, streaming out bond sync actions that | ||
| controls another device. A new sidekick named bondid and same location is implicity | ||
| created under sidekicks endpoint. After reboot `devices/1` is no longer available. | ||
| - If set to `false` implicit delete the sidekick created and behave as a regular switch, |
There was a problem hiding this comment.
Preferably this info goes in the description in the schema.
There was a problem hiding this comment.
Better here to have a paragraph description more of the why than the what & how.
| example: true | ||
| type: boolean | ||
| decription: | | ||
| If true set switch to keypad mode. |
There was a problem hiding this comment.
You can add some more detail here on the true/false cases.
| description: | | ||
| Get current panel information. | ||
|
|
||
| **NOTE:** The endpoint `sys/panel` is available only for Smart by bond with ID |
There was a problem hiding this comment.
Here's an attempt at a paragraph for the GET endpoint. Nothing special needed for PATCH. Ideally there would be a description for the endpoint as a whole but I don't see how to do it, so I've just put this kind of background in the GET section. --- Alternatively it could go up in the preliminary chapters.
The panel endpoint is used to adjust the behavior of the front-panel on certain Smart by Bond products. In particular, in-wall fan and light switch products can be set to "Keypad Mode" where key presses send BondSync messages (similar to a Sidekick keypad) rather than directly controlling the attached light or fan device. This is intended to be used in multiway switch configurations. To set up "3-way", enable Keypad Mode on the switch which does not directly control the device. The switch will then appear as a Sidekick and can be channel-linked to the main switch which does directly control the appliance.
New API for setting the in wall switches to keypad mode operation...