Add docs for Guardian paired sensors (#14025)

This commit is contained in:
Aaron Bach 2020-10-13 02:45:55 -06:00 committed by GitHub
parent 8bca1b357c
commit 20721d849a
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23

View File

@ -38,6 +38,14 @@ Disable the device's onboard access point.
Enable the device's onboard access point.
### `guardian.pair_sensor`
Add a new paired sensor to the valve controller.
| Service Data Attribute | Optional | Description |
| ---------------------- | -------- | ------------------------------------------------ |
| `uid` | yes | The unique device ID on the bottom of the sensor.|
### `guardian.reboot`
Reboot the device.
@ -46,6 +54,14 @@ Reboot the device.
Fully (and irrecoverably) reset all valve diagnostics.
### `guardian.unpair_sensor`
Remove a paired sensor from the valve controller.
| Service Data Attribute | Optional | Description |
| ---------------------- | -------- | ------------------------------------------------ |
| `uid` | yes | The unique device ID on the bottom of the sensor.|
### `guardian.upgrade_firmware`
Upgrade the device firmware.
@ -55,3 +71,15 @@ Upgrade the device firmware.
| `url` | yes | The URL of the server hosting the firmware file. |
| `port` | yes | The port on which the firmware file is served. |
| `filename` | yes | The firmware filename. |
*Note:* not all service calls are available on all Guardian valve controller firmwares.
Please ensure you upgrade your valve controller to the latest firmware before opening
bugs related to non-working service calls.
## Paired Sensor Notes
When a paired sensor is first added to the valve controller, it may return inaccurate or
nonsensical values for several of its attributes, such as `battery` and `temperature`. This
is due to the sensor never having communicated its data to the valve controller and can
be fixed by moving the sensor around (so that it beeps, indicating that data has been
sent to the valve controller).