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-19 15:26:59 +00:00
Code Issues Packages Projects Releases Wiki Activity

Update sighthound.markdown (#12183)

Browse Source 
* Update sighthound.markdown

* Update source/_integrations/sighthound.markdown

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

Co-authored-by: Franck Nijhof <frenck@frenck.nl>
This commit is contained in:
Franck Nijhof 2020-03-05 11:28:16 +01:00 committed by GitHub
parent eb95f2a64c
commit 1a46f8cf3e
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 6 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
source/_integrations/sighthound.markdown
View File

@ -14,7 +14,7 @@ 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. 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.
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. 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. If `save_timestamped_file` is configured as `true`, then the annotated image is saved with a file name that includes the time of detection.
**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. **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.
@ -28,6 +28,7 @@ image_processing:
- platform: sighthound - platform: sighthound
api_key: some_key api_key: some_key
save_file_folder: /my_dir/ save_file_folder: /my_dir/
save_timestamped_file: True
source: source:
- entity_id: camera.my_cam - entity_id: camera.my_cam
``` ```
@ -45,6 +46,10 @@ save_file_folder:
description: The folder to save annotated images to. description: The folder to save annotated images to.
required: false required: false
type: string type: string
save_timestamped_file:
description: Save the processed image with the time of detection in the filename. Requires save_file_folder to be configured.
required: false
type: string
source: source:
description: The list of image sources. description: The list of image sources.
required: true required: true