diff --git a/source/_components/demo.markdown b/source/_components/demo.markdown index 1fd904862af..5210b128839 100644 --- a/source/_components/demo.markdown +++ b/source/_components/demo.markdown @@ -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`) diff --git a/source/_components/image_processing.markdown b/source/_components/image_processing.markdown new file mode 100644 index 00000000000..4da68663f4f --- /dev/null +++ b/source/_components/image_processing.markdown @@ -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. +As source is only supported camera entities. + +For interval controll, use `scan_interval` in platform. + +## {% 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` diff --git a/source/_components/image_processing.openalpr_cloud.markdown b/source/_components/image_processing.openalpr_cloud.markdown new file mode 100644 index 00000000000..b7147a65368 --- /dev/null +++ b/source/_components/image_processing.openalpr_cloud.markdown @@ -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. diff --git a/source/_components/image_processing.openalpr_local.markdown b/source/_components/image_processing.openalpr_local.markdown new file mode 100644 index 00000000000..8102ac0c851 --- /dev/null +++ b/source/_components/image_processing.openalpr_local.markdown @@ -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/). + +### {% linkable_title Local installation %} + +If you want process all data local you need the command line tool `alpr` in version > 2.3.1 + +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+): +```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). +- **api_key** (*Required*): You need a api key from [OpenAlpr Cloud](https://cloud.openalpr.com/). +- **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.