jeans/home-assistant.io
jeans/home-assistant.io
1
0
Fork 0
mirror of https://github.com/home-assistant/home-assistant.io.git synced 2025-07-23 09:17:06 +00:00
Code Issues Packages Projects Releases Wiki Activity

Fix configuration description and heading (#12815)

Browse Source
This commit is contained in:
Fabian Affolter 2020-04-11 15:24:49 +02:00 committed by GitHub
parent 3498de5f99
commit 3560641b65
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 17 additions and 13 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

30
source/_integrations/doods.markdown
View File

@ -8,16 +8,15 @@ ha_release: '0.100'
ha_domain: doods ha_domain: doods
--- ---
The `doods` image processing platform allows you to detect and recognize objects in a camera image using [DOODS](https://github.com/snowzach/doods/). The state of the entity is the number of objects detected, and recognized objects are listed in the `summary` attribute along with quantity. The `matches` attribute provides the confidence `score` for recognition and the bounding `box` of the object for each detection category. The `doods` image processing integration allows you to detect and recognize objects in a camera image using [DOODS](https://github.com/snowzach/doods/). The state of the entity is the number of objects detected and recognized objects are listed in the `summary` attribute along with quantity. The `matches` attribute provides the confidence `score` for recognition and the bounding `box` of the object for each detection category.
## Setup ## Setup
You need to have DOODS running somewhere. It's easiest to run as a Docker container and deployment is described on Docker Hub You need to have DOODS running somewhere. It's easiest to run as a [Docker](https://hub.docker.com/r/snowzach/doods) container.
[DOODS - Docker](https://hub.docker.com/r/snowzach/doods)
## Configuration ## Configuration
The configuration loosely follows the TensorFlow configuration. To enable this platform in your installation, add the following to your `configuration.yaml` file: To enable this integration in your installation, add the following to your `configuration.yaml` file:
```yaml ```yaml
# Example configuration.yaml entry # Example configuration.yaml entry
@ -44,20 +43,20 @@ source:
required: false required: false
type: string type: string
url: url:
description: The URL of the DOODS server description: The URL of the DOODS server.
required: true required: true
type: string type: string
timeout: timeout:
description: Timeout for requests (in seconds) description: Timeout for requests (in seconds).
required: false required: false
type: integer type: integer
default: 90 default: 90
detector: detector:
description: The DOODS detector to use description: The DOODS detector to use.
required: true required: true
type: string type: string
confidence: confidence:
description: The default confidence for any detected objects where not explicitly set description: The default confidence for any detected objects where not explicitly set.
required: false required: false
type: float type: float
area: area:
@ -104,7 +103,7 @@ labels:
required: true required: true
type: string type: string
confidence: confidence:
description: The minimum confidence for the selected label description: The minimum confidence for the selected label.
required: false required: false
type: float type: float
area: area:
@ -140,9 +139,12 @@ labels:
{% endconfiguration %} {% endconfiguration %}
## Sample configuration
{% raw %}
```yaml ```yaml
# Example advanced configuration.yaml entry # Example advanced configuration.yaml entry
# Example configuration.yaml entry
image_processing: image_processing:
- platform: doods - platform: doods
scan_interval: 1000 scan_interval: 1000
@ -152,8 +154,8 @@ image_processing:
source: source:
- entity_id: camera.front_yard - entity_id: camera.front_yard
file_out: file_out:
- "/tmp/{% raw %}{{ camera_entity.split('.')[1] }}{% endraw %}_latest.jpg" - "/tmp/{{ camera_entity.split('.')[1] }}_latest.jpg"
- "/tmp/{% raw %}{{ camera_entity.split('.')[1] }}_{{ now().strftime('%Y%m%d_%H%M%S') }}{% endraw %}.jpg" - "/tmp/{{ camera_entity.split('.')[1] }}_{{ now().strftime('%Y%m%d_%H%M%S') }}.jpg"
confidence: 50 confidence: 50
# This global detection area is required for all labels # This global detection area is required for all labels
area: area:
@ -177,9 +179,11 @@ image_processing:
- truck - truck
``` ```
{% endraw %}
## Optimizing resources ## Optimizing resources
[Image processing components](/components/image_processing/) process the image from a camera at a fixed period given by the `scan_interval`. This leads to excessive processing if the image on the camera hasn't changed, as the default `scan_interval` is 10 seconds. You can override this by adding to your configuration `scan_interval: 10000` (setting the interval to 10,000 seconds), and then call the `image_processing.scan` service when you actually want to perform processing. The [Image processing integration](/components/image_processing/) process the image from a camera at a fixed period given by the `scan_interval`. This leads to excessive processing if the image on the camera hasn't changed, as the default `scan_interval` is 10 seconds. You can override this by adding to your configuration `scan_interval: 10000` (setting the interval to 10,000 seconds) and then call the `image_processing.scan` service when you actually want to perform processing.
```yaml ```yaml
# Example advanced configuration.yaml entry # Example advanced configuration.yaml entry