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

Commit 463bde4

Browse files
committed
tidy readme
1 parent df9765f commit 463bde4

File tree

1 file changed

+2
-1
lines changed

1 file changed

+2
-1
lines changed

README.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -30,6 +30,7 @@ image_processing:
3030
# confidence: 80
3131
save_file_folder: /config/snapshots/
3232
save_timestamped_file: True
33+
scale: 0.75
3334
# roi_x_min: 0.35
3435
roi_x_max: 0.8
3536
#roi_y_min: 0.4
@@ -53,12 +54,12 @@ Configuration variables:
5354
- **confidence**: (Optional) The confidence (in %) above which detected targets are counted in the sensor state. Default value: 80
5455
- **save_file_folder**: (Optional) The folder to save processed images to. Note that folder path should be added to [whitelist_external_dirs](https://www.home-assistant.io/docs/configuration/basic/)
5556
- **save_timestamped_file**: (Optional, default `False`, requires `save_file_folder` to be configured) Save the processed image with the time of detection in the filename.
57+
- **scale**: (optional, default 1.0), range 0.1-1.0, applies a scaling factor to the images that are saved. This reduces the disk space used by saved images, and is especially beneficial when using high resolution cameras.
5658
- **show_boxes**: (optional, default `True`), if `False` bounding boxes are not shown on saved images
5759
- **roi_x_min**: (optional, default 0), range 0-1, must be less than roi_x_max
5860
- **roi_x_max**: (optional, default 1), range 0-1, must be more than roi_x_min
5961
- **roi_y_min**: (optional, default 0), range 0-1, must be less than roi_y_max
6062
- **roi_y_max**: (optional, default 1), range 0-1, must be more than roi_y_min
61-
- **scale**: (optional, default 1.0), range 0.1-1.0, scaling factor for the images that are pulled from the camera stream. This results in smaller images files, especially when using hires-cameras.
6263
- **source**: Must be a camera.
6364
- **targets**: The list of target object names and/or `object_type`, default `person`. Optionally a `confidence` can be set for this target, if not the default confidence is used. Note the minimum possible confidence is 10%.
6465

0 commit comments

Comments
 (0)