Update configuration for Sure Petcare integration and add a ne… (#11962)

* update configuration and add new way to get the IDs

* Update source/_integrations/surepetcare.markdown

Co-Authored-By: Franck Nijhof <frenck@frenck.nl>

* Update source/_integrations/surepetcare.markdown

Co-Authored-By: Franck Nijhof <frenck@frenck.nl>

* Update source/_integrations/surepetcare.markdown

Co-Authored-By: Franck Nijhof <frenck@frenck.nl>

* implement suggestions from @frenck & add screenshot

* ✏️ Change the way the image is embeded

Co-authored-by: Franck Nijhof <frenck@frenck.nl>
This commit is contained in:
Ben 2020-02-11 11:53:48 +01:00 committed by GitHub
parent 0cfc373ede
commit a40ef039ad
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 28 additions and 11 deletions

View File

@ -20,11 +20,11 @@ To add a flap and pet, add the following to your `configuration.yaml` file:
```yaml
# Example configuration.yaml entry
surepetcare:
username: x@y.com
password: v3rys3cr3t!
household_id: 1337
flaps: [{id: 2337, name: Flap}]
pets: [{id: 3337, name: Pet}]
username: YOUR_SURE_PETCARE_LOGIN
password: YOUR_SURE_PETCARE_PASSWORD
feeders: [12345, 67890]
flaps: [13579]
pets: [24680]
```
{% configuration %}
@ -36,11 +36,20 @@ surepetcare:
description: The Sure Petcare Password
required: true
type: string
household_id:
description: The Sure Petcare household_id
flaps:
description: The Sure Petcare flaps
required: true
type: map
keys:
id:
description: The Sure Petcare id of a flap
required: true
type: integer
flaps:
name:
description: A name for the flap
required: true
type: string
feeders:
description: The Sure Petcare flaps
required: true
type: map
@ -83,6 +92,14 @@ surepetcare:
type: device_class
{% endconfiguration %}
## Getting the IDs of your household, flaps and pets
## Getting the IDs of your flaps, feeders and pets
For now, please use the [sp_cli.py](https://github.com/rcastberg/sure_petcare/blob/master/sp_cli.py) from [@rcastberg](https://github.com/rcastberg) to fetch the IDs from the Sure Petcare API. With default setting, the IDs will be written as JSON to `~/.surepet.cache`.
There are (at least) two ways:
- Use the [sp_cli.py](https://github.com/rcastberg/sure_petcare/blob/master/sp_cli.py) from [@rcastberg](https://github.com/rcastberg) to fetch the IDs from the Sure Petcare API. With the default setting, the IDs will be written as JSON to `~/.surepet.cache`.
- Visit [surepetcare.io](https://surepetcare.io) and log in with your Sure Petcare credentials. Open the developer tools in Chrome/Firefox, switch to the "Network" tab and refresh the page. Now look for calls to `start` (`pets`, `<household id>` and others are also possible, but `start` shows you all information at once). Click on this call and in the JSON displayed you will find all the needed IDs.
<p class='img'>
<a href='/images/integrations/surepetcare/spc_ids.png' target='_blank'>
<img src='/images/integrations/surepetcare/spc_ids.png' alt='Where to find the IDs vie Browser developer console' /></a>
</p>

Binary file not shown.

After

Width:  |  Height:  |  Size: 200 KiB