Update configuration for Sure Petcare integration and add a ne… (home…

…-assistant#11962) * update configuration and add new way to get the IDs * Update source/_integrations/surepetcare.markdown Co-Authored-By: Franck Nijhof <[email protected]> * Update source/_integrations/surepetcare.markdown Co-Authored-By: Franck Nijhof <[email protected]> * Update source/_integrations/surepetcare.markdown Co-Authored-By: Franck Nijhof <[email protected]> * implement suggestions from @frenck & add screenshot * ✏️ Change the way the image is embeded Co-authored-by: Franck Nijhof <[email protected]>
benlumley · Feb 11, 2020 · a40ef03 · a40ef03
1 parent 0cfc373
commit a40ef03
Show file tree

Hide file tree

Showing 2 changed files with 28 additions and 11 deletions.
diff --git a/source/_integrations/surepetcare.markdown b/source/_integrations/surepetcare.markdown
@@ -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: [email protected]
-  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,10 +36,6 @@ surepetcare:
     description: The Sure Petcare Password
     required: true
     type: string
-  household_id:
-    description: The Sure Petcare household_id
-    required: true
-    type: integer
   flaps:
     description: The Sure Petcare flaps
     required: true
@@ -53,6 +49,19 @@ surepetcare:
         description: A name for the flap
         required: true
         type: string
+  feeders:
+    description: The Sure Petcare flaps
+    required: true
+    type: map
+    keys:
+      id:
+        description: The Sure Petcare id of a flap
+        required: true
+        type: integer
+      name:
+        description: A name for the flap
+        required: true
+        type: string
   pets:
     description: Pets managed by Sure Petcare flap(s)
     required: true
@@ -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
+
+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.
 
-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`.
+<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>
diff --git a/source/images/integrations/surepetcare/spc_ids.png b/source/images/integrations/surepetcare/spc_ids.png