Address comments from #1742

This commit is contained in:
Fabian Affolter 2017-01-14 19:28:24 +01:00
parent 052aa9f1a3
commit b01f70083a
No known key found for this signature in database
GPG Key ID: E23CD2DD36A4397F
4 changed files with 35 additions and 33 deletions

View File

@ -10,16 +10,16 @@ footer: true
ha_release: 0.36
---
Image processing enables Home Assistant to process image from cameras.
As source is only supported camera entities.
Image processing enables Home Assistant to process image from [cameras][/components/#camera]. Only camera entities are supported as sources.
For interval controll, use `scan_interval` in platform.
For interval control, use `scan_interval` in platform.
## {% linkable_title Alpr %}
## {% linkable_title ALPR %}
Alpr entities attribute have a vehicle counter `vehicles` and all found plates as `plates`.
This event is trigger after openalpr found a new licence plate.
This event is trigger after OpenALPR found a new licence plate.
```yaml
# Example configuration.yaml automation entry
automation:
@ -33,4 +33,4 @@ automation:
...
```
follow event data while be present: `entity_id`, `plate`, `confidence`
The following event attributes will be present: `entity_id`, `plate`, `confidence`

View File

@ -1,7 +1,7 @@
---
layout: page
title: "OpenAlpr Cloud"
description: "Instructions how to integrate licences plates with OpenAlpr cloud into Home Assistant."
title: "OpenALPR Cloud"
description: "Instructions how to integrate licences plates with OpenALPR cloud into Home Assistant."
date: 2017-01-09 00:00
sidebar: true
comments: false
@ -13,7 +13,7 @@ featured: false
ha_release: 0.36
---
[OpenAlpr](http://www.openalpr.com/) integration for Home Assistant allows you to process licences plates from a camera. You can use them to open a garage door or trigger any other [automation](https://home-assistant.io/components/automation/).
[OpenALPR](http://www.openalpr.com/) integration for Home Assistant allows you to process licences plates from a camera. You can use them to open a garage door or trigger any other [automation](https://home-assistant.io/components/automation/).
### {% linkable_title Configuration Home Assistant %}
@ -27,9 +27,9 @@ image_processing:
```
Configuration variables:
- **region** (*Required*): Country or region. List of Supported [value](https://github.com/openalpr/openalpr/tree/master/runtime_data/config).
- **alpr_bin** (*Optional*): Default `alpr`. The command line tool alpr from OpenAlpr software for local processing.
- **confidence** (*Optional*): Default 80. The minimum of confidence in percent to process with Home-Assistant.
- **source** (*Required*):
- **entities** (*Required*): A list of device to add in Home-Assistant.
- **name** (*Optional*): This parameter allows you to override the name of your openalpr entity.
- **region** (*Required*): Country or region. List of supported [values](https://github.com/openalpr/openalpr/tree/master/runtime_data/config).
- **alpr_bin** (*Optional*): The command line tool alpr from OpenALPR software for local processing. Defaults to `alpr`.
- **confidence** (*Optional*): The minimum of confidence in percent to process with Home Assistant. Defaults to 80.
- **source** array (*Required*): List of image sources.
- **entities** (*Required*): A list of devices to add in Home Assistant.
- **name** (*Optional*): This parameter allows you to override the name of your OpenALPR entity.

View File

@ -1,7 +1,7 @@
---
layout: page
title: "OpenAlpr Local"
description: "Instructions how to integrate licences plates with OpenAlpr local into Home Assistant."
title: "OpenALPR Local"
description: "Instructions how to integrate licences plates with OpenALPR local into Home Assistant."
date: 2017-01-09 00:00
sidebar: true
comments: false
@ -13,22 +13,24 @@ featured: false
ha_release: 0.36
---
[OpenAlpr](http://www.openalpr.com/) integration for Home Assistant allows you to process licences plates from a camera. You can use them to open a garage door or trigger any other [automation](https://home-assistant.io/components/automation/).
[OpenALPR](http://www.openalpr.com/) integration for Home Assistant allows you to process licences plates from a camera. You can use them to open a garage door or trigger any other [automation](https://home-assistant.io/components/automation/).
### {% linkable_title Local installation %}
If you want process all data local you need the command line tool `alpr` in version > 2.3.1
If you want process all data locally, you need version 2.3.1 or higher of the `alpr` commandline tool.
If you don't find binaries for your distribution you can compile from source. Documention of how to build openalpr is found [here](https://github.com/openalpr/openalpr/wiki).
On a debian system you can use this cmake command to build only the command line tool (which second part on linux build instruction - ubuntu 14.04+):
On a Debian system you can use this `cmake` command to build only the command line tool:
```bash
cmake -DWITH_TEST=FALSE -DWITH_BINDING_JAVA=FALSE --DWITH_BINDING_PYTHON=FALSE --DWITH_BINDING_GO=FALSE -DWITH_DAEMON=FALSE -DCMAKE_INSTALL_PREFIX:PATH=/usr ..
$ cmake -DWITH_TEST=FALSE -DWITH_BINDING_JAVA=FALSE --DWITH_BINDING_PYTHON=FALSE --DWITH_BINDING_GO=FALSE -DWITH_DAEMON=FALSE -DCMAKE_INSTALL_PREFIX:PATH=/usr ..
```
Verify your alpr installation with:
Verify your `alpr` installation with:
```
wget -O- -q http://plates.openalpr.com/h786poj.jpg | alpr -
$ wget -O- -q http://plates.openalpr.com/h786poj.jpg | alpr -
```
### {% linkable_title Configuration Home Assistant %}
@ -44,9 +46,9 @@ image_processing:
```
Configuration variables:
- **region** (*Required*): Country or region. List of Supported [value](https://github.com/openalpr/openalpr/tree/master/runtime_data/config).
- **api_key** (*Required*): You need a api key from [OpenAlpr Cloud](https://cloud.openalpr.com/).
- **confidence** (*Optional*): Default 80. The minimum of confidence in percent to process with Home-Assistant.
- **source** (*Required*):
- **entities** (*Required*): A list of device to add in Home-Assistant.
- **name** (*Optional*): This parameter allows you to override the name of your openalpr entity.
- **region** (*Required*): Country or region. List of supported [values](https://github.com/openalpr/openalpr/tree/master/runtime_data/config).
- **api_key** (*Required*): You need an API key from [OpenALPR Cloud](https://cloud.openalpr.com/).
- **confidence** (*Optional*): The minimum of confidence in percent to process with Home Assistant. Defaults to 80.
- **source** array (*Required*): List of image sources.
- **entities** (*Required*): A list of devices to add in Home Assistant.
- **name** (*Optional*): This parameter allows you to override the name of your OpenALPR entity.

View File

@ -22,17 +22,17 @@ If you want use a video stream. You need setup the [ffmpeg](/components/ffmpeg)
### {% linkable_title Local installation %}
If you want process all data local you need the commandline tool `alpr` in version > 2.3.1
If you want process all data locally, you need version 2.3.1 or higher of the `alpr` commandline tool.
If you don't find binaries for your distribution you can compile from source. Documention of how to build OpenALPR is found [here](https://github.com/openalpr/openalpr/wiki).
On a Debian system you can use this `cmake` command to build only the command line tool (which second part on linux build instruction - ubuntu 14.04+):
On a Debian system you can use this `cmake` command to build only the command line tool:
```bash
$ cmake -DWITH_TEST=FALSE -DWITH_BINDING_JAVA=FALSE --DWITH_BINDING_PYTHON=FALSE --DWITH_BINDING_GO=FALSE -DWITH_DAEMON=FALSE -DCMAKE_INSTALL_PREFIX:PATH=/usr ..
```
Verify your alpr installation with:
Verify your `alpr` installation with:
```
$ wget -O- -q http://plates.openalpr.com/h786poj.jpg | alpr -
@ -63,7 +63,7 @@ openalpr:
Configuration variables:
- **engine** (*Required*): `local` or `cloud` for processing
- **region** (*Required*): Country or region. List of supported [value](https://github.com/openalpr/openalpr/tree/master/runtime_data/config).
- **region** (*Required*): Country or region. List of supported [values](https://github.com/openalpr/openalpr/tree/master/runtime_data/config).
- **confidence** (*Optional*): The minimum of confidence in percent to process with Home Assistant. Defaults to 80.
- **entities** (*Required*): A list of device to add in Home Assistant.
- **name** (*Optional*): This parameter allows you to override the name of your OpenALPR entity.