-
-
Notifications
You must be signed in to change notification settings - Fork 7.9k
Add sighthound docs #11203
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Add sighthound docs #11203
Changes from all commits
Commits
Show all changes
3 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,52 @@ | ||
--- | ||
title: "Sighthound" | ||
description: "Detect people with Sighthound Cloud." | ||
logo: sighthound-logo.png | ||
ha_category: | ||
- Image Processing | ||
ha_release: 0.105 | ||
ha_iot_class: Cloud Polling | ||
--- | ||
|
||
Adds integration for person detection with [Sighthound Cloud](https://www.sighthound.com/products/cloud). The Sighthound Developer tier (free for non-commercial use) allows 5000 requests per month. If you need more requests per month you will need to sign up for a production account (i.e., Basic or Pro account). | ||
|
||
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 `image_processing.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 in order to prevent accidentally using up your requets to Sighthound, 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. Alternativley, periodic scanning can be enabled by configuring a `scan_interval`. | ||
|
||
## Configuration | ||
|
||
To enable this platform in your installation, add the following to your `configuration.yaml` file: | ||
|
||
```yaml | ||
# Example configuration.yaml entry | ||
image_processing: | ||
- platform: sighthound | ||
api_key: some_key | ||
source: | ||
- entity_id: camera.my_cam | ||
``` | ||
|
||
{% configuration %} | ||
api_key: | ||
description: Your Sighthound Cloud API key. | ||
required: true | ||
type: string | ||
account_type: | ||
description: If you have a paid account, used `prod`. | ||
required: false | ||
type: string | ||
source: | ||
description: The list of image sources. | ||
required: true | ||
type: map | ||
keys: | ||
entity_id: | ||
description: A camera entity id to get a picture from. | ||
required: true | ||
type: string | ||
name: | ||
description: This parameter allows you to override the name of your `image_processing` entity. | ||
required: false | ||
type: string | ||
{% endconfiguration %} |
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.