Add docs for Sure Petcare set_lock_state service (#16020)

Co-authored-by: Franck Nijhof <frenck@frenck.nl>
This commit is contained in:
Will Hughes 2021-01-04 23:14:41 +13:00 committed by GitHub
parent 55fc68c5dd
commit 022acd885c
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23

View File

@ -55,6 +55,24 @@ surepetcare:
type: time
{% endconfiguration %}
## Services
### Service `surepetcare.set_lock_state`
This service lets you change the locking state of a flap.
| Service data attribute | Required | Type | Description |
| ---------------------- | -------- | -------- | ----------- |
| `flap_id` | `True` | integer | Flap ID to change - see below for instructions on finding device IDs
| `lock_state` | `True` | string | New state to change the flap to
`lock_state` should be one of:
- `unlocked` - flap is unlocked, pets are allowed both in and out.
- `locked_in` - flap is 'in only' - pets can come in but not go back out.
- `locked_out` - flap is 'out only' - pets can go out, but not back in.
- `locked_all` - flap is locked both ways.
## Getting the IDs of your flaps, feeders and pets
There are (at least) three ways, sorted in "descending convenience order":