Add sighthound save image (home-assistant#11887)

* Update sighthound.markdown * Update sighthound.markdown * ✏️ Tweaks * ✏️ Tweak Co-authored-by: Franck Nijhof <[email protected]>
Thrilleratplay · Feb 25, 2020 · c3badda · c3badda
1 parent c64f5ef
commit c3badda
Showing 1 changed file with 8 additions and 1 deletion.
diff --git a/source/_integrations/sighthound.markdown b/source/_integrations/sighthound.markdown
@@ -14,7 +14,9 @@ Detect people in camera images using [Sighthound Cloud](https://www.sighthound.c
 
 This integration adds an image processing entity where the state of the entity is the number of people detected in an image. For each person detected, an `sighthound.person_detected` event is fired. The event data includes the entity_id of the image processing entity firing the event, and the bounding box around the detected person. 
 
-**Note** that by default the component will not automatically scan images, but requires you to call the `image_processing.scan` service e.g. using an automation triggered by motion.
+If `save_file_folder` is configured, on each new detection of a person, an annotated image with the name `sighthound_{camera_name}_latest.jpg` is saved in the configured folder if it doesn't already exist, and overwritten if it does exist. The saved image shows the bounding box around detected people and can be displayed on the Home Assistant front end using a [Local File](/integrations/local_file/) camera, and used in notifications.
+
+**Note** that by default the component will not automatically scan images, but requires you to call the `image_processing.scan` service, e.g., using an automation triggered by motion.
 
 ## Configuration
 
@@ -25,6 +27,7 @@ To enable this platform in your installation, add the following to your `configu
 image_processing:
   - platform: sighthound
     api_key: some_key
+    save_file_folder: /my_dir/
     source:
       - entity_id: camera.my_cam
 ```
@@ -38,6 +41,10 @@ account_type:
   description: If you have a paid account, used `prod`.
   required: false
   type: string
+save_file_folder:
+  description: The folder to save annotated images to.
+  required: false
+  type: string
 source:
   description: The list of image sources.
   required: true