jeans/home-assistant.io
jeans/home-assistant.io
1
0
Fork 0
mirror of https://github.com/home-assistant/home-assistant.io.git synced 2025-07-24 01:37:23 +00:00
Code Issues Packages Projects Releases Wiki Activity

Add sighthound save image (#11887)

Browse Source 
* Update sighthound.markdown

* Update sighthound.markdown

* ✏️ Tweaks

* ✏️ Tweak

Co-authored-by: Franck Nijhof <frenck@frenck.nl>
This commit is contained in:
Robin 2020-02-25 01:13:41 +00:00 committed by GitHub
parent c64f5ef0da
commit c3badda072
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 8 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

9
source/_integrations/sighthound.markdown
View File

@ -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