Skip to content

Commit b01f700

Browse files
fabafffabaff
committed
Address comments from home-assistant#1742 
1 parent 052aa9f commit b01f700

File tree

4 files changed

+35
-33
lines changed

4 files changed

+35
-33
lines changed

‎source/_components/image_processing.markdown

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -10,16 +10,16 @@ footer: true
1010
ha_release: 0.36
1111
---
1212

13-
Image processing enables Home Assistant to process image from cameras.
14-
As source is only supported camera entities.
13+
Image processing enables Home Assistant to process image from [cameras][/components/#camera]. Only camera entities are supported as sources.
1514

16-
For interval controll, use `scan_interval` in platform.
15+
For interval control, use `scan_interval` in platform.
1716

18-
## {% linkable_title Alpr %}
17+
## {% linkable_title ALPR %}
1918

2019
Alpr entities attribute have a vehicle counter `vehicles` and all found plates as `plates`.
2120

22-
This event is trigger after openalpr found a new licence plate.
21+
This event is trigger after OpenALPR found a new licence plate.
22+
2323
```yaml
2424
# Example configuration.yaml automation entry
2525
automation:
@@ -33,4 +33,4 @@ automation:
3333
...
3434
```
3535

36-
follow event data while be present: `entity_id`, `plate`, `confidence`
36+
The following event attributes will be present: `entity_id`, `plate`, `confidence`

‎source/_components/image_processing.openalpr_cloud.markdown

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
layout: page
3-
title: "OpenAlpr Cloud"
4-
description: "Instructions how to integrate licences plates with OpenAlpr cloud into Home Assistant."
3+
title: "OpenALPR Cloud"
4+
description: "Instructions how to integrate licences plates with OpenALPR cloud into Home Assistant."
55
date: 2017-01-09 00:00
66
sidebar: true
77
comments: false
@@ -13,7 +13,7 @@ featured: false
1313
ha_release: 0.36
1414
---
1515

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/).
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/).
1717

1818
### {% linkable_title Configuration Home Assistant %}
1919

@@ -27,9 +27,9 @@ image_processing:
2727
```
2828
Configuration variables:
2929
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.
30+
- **region** (*Required*): Country or region. List of supported [values](https://github.com/openalpr/openalpr/tree/master/runtime_data/config).
31+
- **alpr_bin** (*Optional*): The command line tool alpr from OpenALPR software for local processing. Defaults to `alpr`.
32+
- **confidence** (*Optional*): The minimum of confidence in percent to process with Home Assistant. Defaults to 80.
33+
- **source** array (*Required*): List of image sources.
34+
- **entities** (*Required*): A list of devices 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: 16 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
layout: page
3-
title: "OpenAlpr Local"
4-
description: "Instructions how to integrate licences plates with OpenAlpr local into Home Assistant."
3+
title: "OpenALPR Local"
4+
description: "Instructions how to integrate licences plates with OpenALPR local into Home Assistant."
55
date: 2017-01-09 00:00
66
sidebar: true
77
comments: false
@@ -13,22 +13,24 @@ featured: false
1313
ha_release: 0.36
1414
---
1515

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/).
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/).
1717

1818
### {% linkable_title Local installation %}
1919

20-
If you want process all data local you need the command line tool `alpr` in version > 2.3.1
20+
If you want process all data locally, you need version 2.3.1 or higher of the `alpr` commandline tool.
2121

2222
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).
2323

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+):
24+
On a Debian system you can use this `cmake` command to build only the command line tool:
25+
2526
```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+
$ cmake -DWITH_TEST=FALSE -DWITH_BINDING_JAVA=FALSE --DWITH_BINDING_PYTHON=FALSE --DWITH_BINDING_GO=FALSE -DWITH_DAEMON=FALSE -DCMAKE_INSTALL_PREFIX:PATH=/usr ..
2728
```
2829

29-
Verify your alpr installation with:
30+
Verify your `alpr` installation with:
31+
3032
```
31-
wget -O- -q http://plates.openalpr.com/h786poj.jpg | alpr -
33+
$ wget -O- -q http://plates.openalpr.com/h786poj.jpg | alpr -
3234
```
3335

3436
### {% linkable_title Configuration Home Assistant %}
@@ -44,9 +46,9 @@ image_processing:
4446
```
4547
Configuration variables:
4648
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.
49+
- **region** (*Required*): Country or region. List of supported [values](https://github.com/openalpr/openalpr/tree/master/runtime_data/config).
50+
- **api_key** (*Required*): You need an API key from [OpenALPR Cloud](https://cloud.openalpr.com/).
51+
- **confidence** (*Optional*): The minimum of confidence in percent to process with Home Assistant. Defaults to 80.
52+
- **source** array (*Required*): List of image sources.
53+
- **entities** (*Required*): A list of devices to add in Home Assistant.
54+
- **name** (*Optional*): This parameter allows you to override the name of your OpenALPR entity.

‎source/_components/openalpr.markdown

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -22,17 +22,17 @@ If you want use a video stream. You need setup the [ffmpeg](/components/ffmpeg)
2222

2323
### {% linkable_title Local installation %}
2424

25-
If you want process all data local you need the commandline tool `alpr` in version > 2.3.1
25+
If you want process all data locally, you need version 2.3.1 or higher of the `alpr` commandline tool.
2626

2727
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).
2828

29-
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+):
29+
On a Debian system you can use this `cmake` command to build only the command line tool:
3030

3131
```bash
3232
$ cmake -DWITH_TEST=FALSE -DWITH_BINDING_JAVA=FALSE --DWITH_BINDING_PYTHON=FALSE --DWITH_BINDING_GO=FALSE -DWITH_DAEMON=FALSE -DCMAKE_INSTALL_PREFIX:PATH=/usr ..
3333
```
3434

35-
Verify your alpr installation with:
35+
Verify your `alpr` installation with:
3636

3737
```
3838
$ wget -O- -q http://plates.openalpr.com/h786poj.jpg | alpr -
@@ -63,7 +63,7 @@ openalpr:
6363
Configuration variables:
6464
6565
- **engine** (*Required*): `local` or `cloud` for processing
66-
- **region** (*Required*): Country or region. List of supported [value](https://github.com/openalpr/openalpr/tree/master/runtime_data/config).
66+
- **region** (*Required*): Country or region. List of supported [values](https://github.com/openalpr/openalpr/tree/master/runtime_data/config).
6767
- **confidence** (*Optional*): The minimum of confidence in percent to process with Home Assistant. Defaults to 80.
6868
- **entities** (*Required*): A list of device to add in Home Assistant.
6969
- **name** (*Optional*): This parameter allows you to override the name of your OpenALPR entity.

0 commit comments

Comments
 (0)