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-24 01:37:23 +00:00
Code Issues Packages Projects Releases Wiki Activity

Adds facebox teach service (#5553)

Browse Source 
* Update image_processing.facebox.markdown

* Remove ref to particular image file types

* ✏️ Minor tweaks
This commit is contained in:
Robin 2018-07-13 13:07:07 +01:00 committed by Franck Nijhof
parent 97b30a9a2b
commit 7e5da3ab3f
1 changed files with 42 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

43
source/_components/image_processing.facebox.markdown
View File

@ -87,6 +87,47 @@ Use the `image_processing.detect_face` events to trigger automations, and breako
```
{% endraw %}
## {% linkable_title Service `facebox_teach_face` %}
The service `facebox_teach_face` can be used to teach Facebox faces.
| Service data attribute | Optional | Description |
| ---------------------- | -------- | ----------- |
| `entity_id` | no | Entity ID of Facebox entity.
| `name` | no | The name to associate with a face.
| `file_path` | no | The path to the image file.
A valid service data example:
{% raw %}
```yaml
{
"entity_id": "image_processing.facebox_local_file",
"name": "superman",
"file_path": "/images/superman_1.jpeg"
}
```
{% endraw %}
An `image_processing.teach_classifier` event is fired for each service call, providing feedback on whether teaching has been successful or unsuccessful. In the unsuccessful case, the `message` field of the `event_data` will contain information on the cause of failure, and a warning is also published in the logs. An automation can be used to receive alerts on teaching, for example, the following automation will send a notification with the teaching image and a message describing the status of the teaching:
```yaml
- id: '11200961111'
alias: Send facebox teaching result
trigger:
platform: event
event_type: image_processing.teach_classifier
event_data:
classifier: facebox
action:
service: notify.platform
data_template:
title: Facebox teaching
message: Name {{ trigger.event.data.name }} teaching was successful? {{ trigger.event.data.success }}
data:
file: ' {{trigger.event.data.file_path}} '
```
## {% 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.
[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.