Skip to content
This repository has been archived by the owner on Mar 19, 2023. It is now read-only.

Commit

Permalink
Merge pull request #98 from tjntomas/update-docs-save_file_folder
Browse files Browse the repository at this point in the history
Updated documentation for save file folder
  • Loading branch information
robmarkcole authored Feb 10, 2020
2 parents a9c5fa7 + 9585398 commit 751d8f9
Showing 1 changed file with 5 additions and 3 deletions.
8 changes: 5 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -37,6 +37,8 @@ The `deepstack_object` component adds an `image_processing` entity where the sta
## Home Assistant setup
Place the `custom_components` folder in your configuration directory (or add its contents to an existing `custom_components` folder). Then configure object detection. **Important:** It is necessary to configure only a single camera per `deepstack_object` entity. If you want to process multiple cameras, you will therefore need multiple `deepstack_object` `image_processing` entities.

The component can optionally save snapshots of the processed images. If you would like to use this option, you need to create a folder where the snapshots will be stored. The folder should be in the same folder where your `configuration.yaml` file is located. In the example below, we have named the folder `snapshots`.

Add to your Home-Assistant config:

```yaml
Expand All @@ -46,7 +48,7 @@ image_processing:
port: 5000
api_key: Mysecretkey
# scan_interval: 30 # Optional, in seconds
save_file_folder: /config/www/
save_file_folder: /config/snapshots/
save_timestamped_file: True
source:
- entity_id: camera.local_file
Expand Down Expand Up @@ -133,7 +135,7 @@ It easy to display the `deepstack_object_{source name}_latest_{target}.jpg` imag
```yaml
camera:
- platform: local_file
file_path: /config/www/deepstack_object_local_file_latest_person.jpg
file_path: /config/snapshots/deepstack_object_local_file_latest_person.jpg
name: deepstack_latest_person
```

Expand Down Expand Up @@ -194,4 +196,4 @@ A5: This can happen when you are running in Docker/Hassio, and indicates that on

https://github.com/sponsors/robmarkcole

If you or your business find this work useful please consider becoming a sponsor at the link above, this really helps justify the time I invest in maintaining this repo. As we say in England, 'every little helps' - thanks in advance!
If you or your business find this work useful please consider becoming a sponsor at the link above, this really helps justify the time I invest in maintaining this repo. As we say in England, 'every little helps' - thanks in advance!

0 comments on commit 751d8f9

Please sign in to comment.