Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions source/_components/demo.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,7 @@ Available demo platforms:
- [Climate](/components/climate/) (`climate`)
- [Cover](/components/cover/) (`cover`)
- [Fan](/components/fan/) (`fan`)
- [Image Processing](/components/image_processing/) (`image_processing`)
- [Light](/components/light/) (`light`)
- [Lock](/components/lock/) (`lock`)
- [Notification](/components/notify/) (`notify`)
Expand Down
36 changes: 36 additions & 0 deletions source/_components/image_processing.markdown
Original file line number Diff line number Diff line change
@@ -0,0 +1,36 @@
---
layout: page
title: "Image Processing"
description: "Instructions how to setup image processing with Home Assistant."
date: 2017-01-09 00:00
sidebar: true
comments: false
sharing: true
footer: true
ha_release: 0.36
---

Image processing enables Home Assistant to process image from cameras.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can you provide example YAML to setup this platform.

As source is only supported camera entities.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think you're trying to say:
"Only camera entities are supported as sources."


For interval controll, use `scan_interval` in platform.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Typo: "control"


## {% 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.
```yaml
# Example configuration.yaml automation entry
automation:
- alias: Open garage door
trigger:
platform: event
event_type: openalpr.found
event_data:
entity_id: openalpr.camera_garage_1
plate: BE2183423
...
```

follow event data while be present: `entity_id`, `plate`, `confidence`
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

"The following event attributes will be present:"

35 changes: 35 additions & 0 deletions source/_components/image_processing.openalpr_cloud.markdown
Original file line number Diff line number Diff line change
@@ -0,0 +1,35 @@
---
layout: page
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
sharing: true
footer: true
logo: openalpr.png
ha_category: Image_Processing
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/).

### {% linkable_title Configuration Home Assistant %}

```yaml
# Example configuration.yaml entry
image_processing:
- platform: openalpr_cloud
region: eu
source:
- entity_id: camera.garage
```
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.
52 changes: 52 additions & 0 deletions source/_components/image_processing.openalpr_local.markdown
Original file line number Diff line number Diff line change
@@ -0,0 +1,52 @@
---
layout: page
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
sharing: true
footer: true
logo: openalpr.png
ha_category: Image_Processing
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/).
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

"licences plates" should be "licence plates"


### {% linkable_title Local installation %}

If you want process all data local you need the command line tool `alpr` in version > 2.3.1
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

s/local/locally/

"…you need version 2.3.1 or higher of the alpr command line 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+):
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nit: Add backticks around cmake

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

"(which second part on linux build instruction - ubuntu 14.04+)" doesn't make sense to me

```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:
```
wget -O- -q http://plates.openalpr.com/h786poj.jpg | alpr -
```

### {% linkable_title Configuration Home Assistant %}

```yaml
# Example configuration.yaml entry
image_processing:
- platform: openalpr_cloud
api_key: 'sk_abcxyz123456'
region: eu
source:
- entity_id: camera.garage
```
Configuration variables:

- **region** (*Required*): Country or region. List of Supported [value](https://github.com/openalpr/openalpr/tree/master/runtime_data/config).
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

s/value/values/

- **api_key** (*Required*): You need a api key from [OpenAlpr Cloud](https://cloud.openalpr.com/).
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nit: there is an extra space before OpenAlpr

- **confidence** (*Optional*): Default 80. The minimum of confidence in percent to process with Home-Assistant.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Remove the hyphen in "Home-Assistant"

- **source** (*Required*):
- **entities** (*Required*): A list of device to add in Home-Assistant.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

s/device/devices/

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Remove the hyphen in "Home-Assistant"

- **name** (*Optional*): This parameter allows you to override the name of your openalpr entity.