Image processing scan_interval doc updates (#7097)

* Use the correct bear. An incredibly picky edit. I'm sorry.

* Move scan_interval documentation from the facebox bage up to the main image_processing page, as it it useful to all image processing entities

* Add explicit example for setting scan_interval

* Be explicit about which components are being referred to

* Add notes on microsoft face detect and microsoft face identify pages that scan_interval should be applied
This commit is contained in:
Neil Crosby 2018-10-26 09:18:00 +01:00 committed by Fabian Affolter
parent 2196485a0f
commit 3a499af278
4 changed files with 38 additions and 12 deletions

View File

@ -24,7 +24,7 @@ MB_KEY="INSERT-YOUR-KEY-HERE"
sudo docker run --name=facebox --restart=always -p 8080:8080 -e "MB_KEY=$MB_KEY" machinebox/facebox
```
You can run Facebox with a username and password by adding `-e "MB_BASICAUTH_USER=my_username" -e "MB_BASICAUTH_PASS=my_password"` but bare in mind that the component does not encrypt these credentials and this approach does not guarantee security on an unsecured network.
You can run Facebox with a username and password by adding `-e "MB_BASICAUTH_USER=my_username" -e "MB_BASICAUTH_PASS=my_password"` but bear in mind that the component does not encrypt these credentials and this approach does not guarantee security on an unsecured network.
If you only require face detection (number of faces) you can disable face recognition by adding `-e "MB_FACEBOX_DISABLE_RECOGNITION=true"` to the `docker run` command.
@ -166,6 +166,3 @@ you can create an automation to receive notifications on Facebox errors:
```
{% endraw %}
## {% linkable_title Optimising resources %}
[Image processing components](https://www.home-assistant.io/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 config `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.

View File

@ -12,8 +12,6 @@ ha_release: 0.36
Image processing enables Home Assistant to process images from [cameras](/components/#camera). Only camera entities are supported as sources.
For interval control, use `scan_interval` in platform.
<p class='note'>
If you are running Home Assistant over SSL or from within a container, you will have to setup a base URL (`base_url`) inside the [http component](/components/http/).
</p>
@ -59,3 +57,26 @@ automation:
```
The following event attributes will be present (platform-dependent): `entity_id`, `name`, `confidence`, `age`, `gender`, `motion`, `glasses`
## {% linkable_title scan_interval and Optimising Resources %}
Image processing components 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 config `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
# Example configuration.yaml
sensor:
- platform: _AN_IMAGE_PROCESSING_PLATFORM_
scan_interval: 10000
...
automation:
- alias: Scan for faces when motion detected
trigger:
- platform: state
entity_id: sensor.door_motion_sensor
to: 'on'
action:
- service: image_processing.scan
data:
entity_id: image_processing.door
...
```

View File

@ -18,11 +18,15 @@ The `microsoft_face_detect` image processing platform allows you to use the
API through Home Assistant. This platform enables you do detect face on camera
and fire an event with attributes.
Please refer to the [component](/components/microsoft_face/) configuration on
Please refer to the [Microsoft Face component](/components/microsoft_face/) configuration on
how to setup the API key.
For using the result inside an automation rule,
take a look at the [component](/components/image_processing/) page.
take a look at the [Image Processing component](/components/image_processing/) page.
<p class='note'>
The free version of the Microsoft Face identify API limits the number of requests possible per month. Therefore, it is strongly recommended that you limit the `scan_interval` when setting up an instance of this entity as detailed on the main [Image Processing component](/components/image_processing/) page.
</p>
### {% linkable_title Configuration %}

View File

@ -18,11 +18,15 @@ The `microsoft_face_identify` image processing platform lets you use
API through Home Assistant. This platform allow you do identify persons on
camera and fire an event with attributes.
Please refer to the [component](/components/microsoft_face/) configuration on
Please refer to the [Microsoft Face component](/components/microsoft_face/) configuration on
how to setup the API key.
For using the result inside an automation rule,
take a look at the [component](/components/image_processing/) page.
take a look at the [Image Processing component](/components/image_processing/) page.
<p class='note'>
The free version of the Microsoft Face identify API limits the number of requests possible per month. Therefore, it is strongly recommended that you limit the `scan_interval` when setting up an instance of this entity as detailed on the main [Image Processing component](/components/image_processing/) page.
</p>
### {% linkable_title Configuration %}