You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: source/_components/openalpr.markdown
+25-21Lines changed: 25 additions & 21 deletions
Original file line number
Diff line number
Diff line change
@@ -1,7 +1,7 @@
1
1
---
2
2
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."
5
5
date: 2016-09-22 00:00
6
6
sidebar: true
7
7
comments: false
@@ -14,26 +14,28 @@ ha_release: 0.29
14
14
ha_iot_class: "Local Push"
15
15
---
16
16
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/).
18
18
19
19
<pclass='note'>
20
20
If you want use a video stream. You need setup the [ffmpeg](/components/ffmpeg) component. See also there for troubleshooting local ffmpeg installation.
21
21
</p>
22
22
23
23
### {% linkable_title Local installation %}
24
24
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
26
26
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+):
28
30
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+):
### {% linkable_title Configuration Home Assistant %}
@@ -57,19 +59,20 @@ openalpr:
57
59
username: admin
58
60
password: bla
59
61
```
62
+
60
63
Configuration variables:
61
64
62
65
- **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 HomeAssistant. Defaults to 80.
68
+
- **entities** (*Required*): A list of device to add in HomeAssistant.
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 HomeAssistant 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.
73
76
74
77
### {% linkable_title Configuration Home Assistant local processing %}
75
78
@@ -84,7 +87,7 @@ openalpr:
84
87
```
85
88
Configuration variables:
86
89
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.
88
91
89
92
### {% linkable_title Configuration Home Assistant cloud processing %}
90
93
@@ -97,9 +100,10 @@ openalpr:
97
100
entities:
98
101
...
99
102
```
103
+
100
104
Configuration variables:
101
105
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/).
103
107
104
108
#### {% linkable_title Service %}
105
109
@@ -121,4 +125,4 @@ automation:
121
125
...
122
126
```
123
127
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