diff --git a/README.md b/README.md index 2f7e42d..68e2203 100644 --- a/README.md +++ b/README.md @@ -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 @@ -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 @@ -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 ``` @@ -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! \ No newline at end of file +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!