Skip to content

Commit 52ecbc7

Browse files
committed
Minor changes
1 parent 7f0c26f commit 52ecbc7

File tree

1 file changed

+25
-21
lines changed

1 file changed

+25
-21
lines changed

source/_components/openalpr.markdown

Lines changed: 25 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
layout: page
3-
title: "OpenAlpr"
4-
description: "Instructions how to integrate licences plates with OpenAlpr into Home Assistant."
3+
title: "OpenALPR"
4+
description: "Instructions how to integrate licences plates with OpenALPR into Home Assistant."
55
date: 2016-09-22 00:00
66
sidebar: true
77
comments: false
@@ -14,26 +14,28 @@ ha_release: 0.29
1414
ha_iot_class: "Local Push"
1515
---
1616

17-
[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+
[OpenALPR](http://www.openalpr.com/) integration for Home Assistant allows you to process licences plates recorded with a camera. You can use them to open a garage door or trigger any other [automation](https://home-assistant.io/components/automation/).
1818

1919
<p class='note'>
2020
If you want use a video stream. You need setup the [ffmpeg](/components/ffmpeg) component. See also there for troubleshooting local ffmpeg installation.
2121
</p>
2222

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

25-
If you want process all data local you need the command line tool `alpr` in version > 2.3.1
25+
If you want process all data local you need the commandline tool `alpr` in version > 2.3.1
2626

27-
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).
27+
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).
28+
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+):
2830

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+):
3031
```bash
31-
cmake -DWITH_TEST=FALSE -DWITH_BINDING_JAVA=FALSE --DWITH_BINDING_PYTHON=FALSE --DWITH_BINDING_GO=FALSE -DWITH_DAEMON=FALSE -DCMAKE_INSTALL_PREFIX:PATH=/usr ..
32+
$ cmake -DWITH_TEST=FALSE -DWITH_BINDING_JAVA=FALSE --DWITH_BINDING_PYTHON=FALSE --DWITH_BINDING_GO=FALSE -DWITH_DAEMON=FALSE -DCMAKE_INSTALL_PREFIX:PATH=/usr ..
3233
```
3334

3435
Verify your alpr installation with:
36+
3537
```
36-
wget -O- -q http://plates.openalpr.com/h786poj.jpg | alpr -
38+
$ wget -O- -q http://plates.openalpr.com/h786poj.jpg | alpr -
3739
```
3840

3941
### {% linkable_title Configuration Home Assistant %}
@@ -57,19 +59,20 @@ openalpr:
5759
username: admin
5860
password: bla
5961
```
62+
6063
Configuration variables:
6164
6265
- **engine** (*Required*): `local` or `cloud` for processing
63-
- **region** (*Required*): Country or region. List of Supported [value](https://github.com/openalpr/openalpr/tree/master/runtime_data/config).
64-
- **confidence** (*Optional*): Default 80. The minimum of confidence in percent to process with Home-Assistant.
65-
- **entities** (*Required*): A list of device to add in Home-Assistant.
66-
- **name** (*Optional*): This parameter allows you to override the name of your openalpr entity.
67-
- **interval** (*Optional*): Default 2. Time in seconds to poll a picture. If the interval is 0 It don't poll and it only process data with `openalpr.scan` service.
68-
- **render** (*Optional*): default is with ffmpeg. How is Home-Assistant to get a picture from. It support `ffmpeg` for video streams and `image` for a still image.
69-
- **input** (*Required*): The source from getting pictures. With ffmpeg it could by all supported input. Image only support a url.
70-
- **extra_arguments** (*Optional*): Only available with ffmpeg.
71-
- **username** (*Optional*): Only available with image for http authentification.
72-
- **password** (*Optional*): Only available with image for http authentification.
66+
- **region** (*Required*): Country or region. List of supported [value](https://github.com/openalpr/openalpr/tree/master/runtime_data/config).
67+
- **confidence** (*Optional*): The minimum of confidence in percent to process with Home Assistant. Defaults to 80.
68+
- **entities** (*Required*): A list of device to add in Home Assistant.
69+
- **name** (*Optional*): This parameter allows you to override the name of your OpenALPR entity.
70+
- **interval** (*Optional*): Time in seconds to poll a picture. If the interval is 0 It don't poll and it only process data with `openalpr.scan` service. Default is 2 seconds.
71+
- **render** (*Optional*): How is Home Assistant to get a picture from. It support `ffmpeg` for video streams and `image` for a still image. Default is with `ffmpeg`.
72+
- **input** (*Required*): The source from getting pictures. With `ffmpeg` it could by all supported input. Image only support an URL.
73+
- **extra_arguments** (*Optional*): Only available with `ffmpeg`.
74+
- **username** (*Optional*): Only available with image for HTTP authentification.
75+
- **password** (*Optional*): Only available with image for HTTP authentification.
7376

7477
### {% linkable_title Configuration Home Assistant local processing %}
7578

@@ -84,7 +87,7 @@ openalpr:
8487
```
8588
Configuration variables:
8689

87-
- **alpr_binary** (*Optional*): Default `alpr`. The command line tool alpr from OpenAlpr software for local processing.
90+
- **alpr_binary** (*Optional*): Default `alpr`. The command line tool `alpr` from OpenALPR software for local processing.
8891

8992
### {% linkable_title Configuration Home Assistant cloud processing %}
9093

@@ -97,9 +100,10 @@ openalpr:
97100
entities:
98101
...
99102
```
103+
100104
Configuration variables:
101105

102-
- **api_key** (*Required*): You need a api key from [OpenAlpr Cloud](https://cloud.openalpr.com/).
106+
- **api_key** (*Required*): You need an API key from [OpenALPR Cloud](https://cloud.openalpr.com/).
103107

104108
#### {% linkable_title Service %}
105109

@@ -121,4 +125,4 @@ automation:
121125
...
122126
```
123127

124-
This event is trigger after openalpr found a new licence plate.
128+
This event is trigger after OpenALPR found a new licence plate.

0 commit comments

Comments
 (0)