Sighthound
Detect people in camera images using Sighthound Cloud
This integrationIntegrations connect and integrate Home Assistant with your devices, services, and more. [Learn more] 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 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 integrationIntegrations connect and integrate Home Assistant with your devices, services, and more. [Learn more] will not automatically scan images, but requires you to call the image_processing.scan
action, e.g., using an automation triggered by motion.
Configuration
To enable this integrationIntegrations connect and integrate Home Assistant with your devices, services, and more. [Learn more] in your installation, add the following to your configuration.yaml
The configuration.yaml file is the main configuration file for Home Assistant. It lists the integrations to be loaded and their specific configurations. In some cases, the configuration needs to be edited manually directly in the configuration.yaml file. Most integrations can be configured in the UI. [Learn more] file.
After changing the configuration.yaml
The configuration.yaml file is the main configuration file for Home Assistant. It lists the integrations to be loaded and their specific configurations. In some cases, the configuration needs to be edited manually directly in the configuration.yaml file. Most integrations can be configured in the UI. [Learn more] file, restart Home Assistant to apply the changes.
# Example configuration.yaml entry
image_processing:
- platform: sighthound
api_key: "MY_API_KEY"
source:
- entity_id: camera.my_cam
Configuration Variables
Save the processed image with the time of detection in the filename. Requires save_file_folder to be configured.
To verify the integration, check if a new entity is appeared as image_processing.sighthound_my_cam
Process an Image
When you want to process an image, you have to call image_processing.scan
action and listen to the sighthound.person_detected
and/or sighthound.vehicle_detected
events.
An example using two automations:
-
The first automation is triggered, when a motion is detected. It calls the
image_processing.scan
action to send the camera image to the sighthound server for processing. -
The second automation is triggered by a
sighthound.vehicle_detected
event. It sends a notification to a phone.
# Example automations.yaml entry
- alias: "Entrance motion image processing"
description: "Send a camera image to sighthound, when motion is detected at the entrance"
triggers:
- trigger: device
type: motion
device_id: YOUR_DEVICE_ID
entity_id: binary_sensor.my_motion_sensor
domain: binary_sensor
actions:
- action: image_processing.scan
target:
entity_id: image_processing.sighthound_my_cam
- alias: "Arriving vehicle notification"
description: "Send a notification to a phone, when a vehicle is detected at the entrance"
triggers:
- trigger: event
event_type: sighthound.vehicle_detected
actions:
- action: notify.mobile_app_my_iphone
data:
message: "Somebody has just arrived by car."