HASS-Deepstack-object | Home Assistant custom component

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.
ip_address: the ip address of your deepstack instance.
port: the port of your deepstack instance.
api_key: (Optional) Any API key you have set.
timeout: (Optional, default 10 seconds) The timeout for requests to deepstack.
custom_model: (Optional) The name of a custom model if you are using one. Don't forget to add the targets from the custom model below
confidence: (Optional) The confidence (in %) above which detected targets are counted in the sensor state. Default value: 80
save_file_folder: (Optional) The folder to save processed images to. Note that folder path should be added to whitelist_external_dirs
save_file_format: (Optional, default jpg, alternatively png) The file format to save images as. png generally results in easier to read annotations.
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.
always_save_latest_file: (Optional, default False, requires save_file_folder to be configured) Always save the last processed image, even if there were no detections.
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.
show_boxes: (optional, default True), if False bounding boxes are not shown on saved images
roi_x_min: (optional, default 0), range 0-1, must be less than roi_x_max
roi_x_max: (optional, default 1), range 0-1, must be more than roi_x_min
roi_y_min: (optional, default 0), range 0-1, must be less than roi_y_max
roi_y_max: (optional, default 1), range 0-1, must be more than roi_y_min
source: Must be a camera.
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%.
entity_id : the entity id responsible for the event
name : the name of the object detected
object_type : the type of the object, from person, vehicle, animal or other
confidence : the confidence in detection in the range 0 - 100%
box : the bounding box of the object
centroid : the centre point of the object
saved_file : the path to the saved annotated image, which is the timestamped file if save_timestamped_file is True, or the default saved image if False