Skip to content

Commit

Permalink
Update sighthound.markdown (home-assistant#12183)
Browse files Browse the repository at this point in the history
* Update sighthound.markdown

* Update source/_integrations/sighthound.markdown

Co-Authored-By: Franck Nijhof <[email protected]>

Co-authored-by: Franck Nijhof <[email protected]>
  • Loading branch information
frenck and frenck authored Mar 5, 2020
1 parent eb95f2a commit 1a46f8c
Showing 1 changed file with 6 additions and 1 deletion.
7 changes: 6 additions & 1 deletion source/_integrations/sighthound.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -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.

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.

Expand All @@ -28,6 +28,7 @@ image_processing:
- platform: sighthound
api_key: some_key
save_file_folder: /my_dir/
save_timestamped_file: True
source:
- entity_id: camera.my_cam
```
Expand All @@ -45,6 +46,10 @@ save_file_folder:
description: The folder to save annotated images to.
required: false
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:
description: The list of image sources.
required: true
Expand Down

0 comments on commit 1a46f8c

Please sign in to comment.