Skip to content

Commit bf49d34

Browse files
pvizelipvizeli
committed
Add image_processing
1 parent 505d550 commit bf49d34

File tree

3 files changed

+123
-0
lines changed

3 files changed

+123
-0
lines changed

‎source/_components/image_processing.markdown

Lines changed: 36 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,36 @@
1+
---
2+
layout: page
3+
title: "Image Processing"
4+
description: "Instructions how to setup image processing with Home Assistant."
5+
date: 2017-01-09 00:00
6+
sidebar: true
7+
comments: false
8+
sharing: true
9+
footer: true
10+
ha_release: 0.36
11+
---
12+
13+
Image processing enables Home Assistant to process image from cameras.
14+
As source is only supported camera entities.
15+
16+
For interval controll, use `scan_interval` in platform.
17+
18+
## {% linkable_title Alpr %}
19+
20+
Alpr entities attribute have a vehicle counter `vehicles` and all found plates as `plates`.
21+
22+
This event is trigger after openalpr found a new licence plate.
23+
```yaml
24+
# Example configuration.yaml automation entry
25+
automation:
26+
- alias: Open garage door
27+
trigger:
28+
platform: event
29+
event_type: openalpr.found
30+
event_data:
31+
entity_id: openalpr.camera_garage_1
32+
plate: BE2183423
33+
...
34+
```
35+
36+
follow event data while be present: `entity_id`, `plate`, `confidence`

‎source/_components/image_processing.openalpr_cloud.markdown

Lines changed: 35 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
1+
---
2+
layout: page
3+
title: "OpenAlpr Cloud"
4+
description: "Instructions how to integrate licences plates with OpenAlpr cloud into Home Assistant."
5+
date: 2017-01-09 00:00
6+
sidebar: true
7+
comments: false
8+
sharing: true
9+
footer: true
10+
logo: openalpr.png
11+
ha_category: Image_Processing
12+
featured: false
13+
ha_release: 0.36
14+
---
15+
16+
[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/).
17+
18+
### {% linkable_title Configuration Home Assistant %}
19+
20+
```yaml
21+
# Example configuration.yaml entry
22+
image_processing:
23+
- platform: openalpr_cloud
24+
region: eu
25+
source:
26+
- entity_id: camera.garage
27+
```
28+
Configuration variables:
29+
30+
- **region** (*Required*): Country or region. List of Supported [value](https://github.com/openalpr/openalpr/tree/master/runtime_data/config).
31+
- **alpr_bin** (*Optional*): Default `alpr`. The command line tool alpr from OpenAlpr software for local processing.
32+
- **confidence** (*Optional*): Default 80. The minimum of confidence in percent to process with Home-Assistant.
33+
- **source** (*Required*):
34+
- **entities** (*Required*): A list of device to add in Home-Assistant.
35+
- **name** (*Optional*): This parameter allows you to override the name of your openalpr entity.

‎source/_components/image_processing.openalpr_local.markdown

Lines changed: 52 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,52 @@
1+
---
2+
layout: page
3+
title: "OpenAlpr Local"
4+
description: "Instructions how to integrate licences plates with OpenAlpr local into Home Assistant."
5+
date: 2017-01-09 00:00
6+
sidebar: true
7+
comments: false
8+
sharing: true
9+
footer: true
10+
logo: openalpr.png
11+
ha_category: Image_Processing
12+
featured: false
13+
ha_release: 0.36
14+
---
15+
16+
[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/).
17+
18+
### {% linkable_title Local installation %}
19+
20+
If you want process all data local you need the command line tool `alpr` in version > 2.3.1
21+
22+
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).
23+
24+
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+):
25+
```bash
26+
cmake -DWITH_TEST=FALSE -DWITH_BINDING_JAVA=FALSE --DWITH_BINDING_PYTHON=FALSE --DWITH_BINDING_GO=FALSE -DWITH_DAEMON=FALSE -DCMAKE_INSTALL_PREFIX:PATH=/usr ..
27+
```
28+
29+
Verify your alpr installation with:
30+
```
31+
wget -O- -q http://plates.openalpr.com/h786poj.jpg | alpr -
32+
```
33+
34+
### {% linkable_title Configuration Home Assistant %}
35+
36+
```yaml
37+
# Example configuration.yaml entry
38+
image_processing:
39+
- platform: openalpr_cloud
40+
api_key: 'sk_abcxyz123456'
41+
region: eu
42+
source:
43+
- entity_id: camera.garage
44+
```
45+
Configuration variables:
46+
47+
- **region** (*Required*): Country or region. List of Supported [value](https://github.com/openalpr/openalpr/tree/master/runtime_data/config).
48+
- **api_key** (*Required*): You need a api key from [OpenAlpr Cloud](https://cloud.openalpr.com/).
49+
- **confidence** (*Optional*): Default 80. The minimum of confidence in percent to process with Home-Assistant.
50+
- **source** (*Required*):
51+
- **entities** (*Required*): A list of device to add in Home-Assistant.
52+
- **name** (*Optional*): This parameter allows you to override the name of your openalpr entity.

0 commit comments

Comments
 (0)