Home Assistant Home Assistant

OpenALPR Local

This integration is pending removal from Home Assistant and will be no longer available as of Home Assistant 2022.10.

The OpenALPR integration for Home Assistant allows you to process vehicle license plates from a camera. You can use this information to trigger automations like opening a garage door.

For using the result inside an automation rule, take a look at the image processing integration page.

Local installation

If you want process all data locally, you will 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 the tool from source. Documentation of how to build OpenALPR is found here.

On a Debian system you can use the following cmake command to build only the command line tool:

cmake -DWITH_TEST=FALSE -DWITH_BINDING_JAVA=FALSE --DWITH_BINDING_PYTHON=FALSE \
  --DWITH_BINDING_GO=FALSE -DWITH_DAEMON=FALSE -DCMAKE_INSTALL_PREFIX:PATH=/usr ..

For other operating systems, please refer to the OpenALPR wiki.

Verify your alpr installation with a command like the following:

wget -O- -q http://plates.openalpr.com/h786poj.jpg | alpr -

Configuration

# Example configuration.yaml entry
image_processing:
  - platform: openalpr_local
    region: eu
    source:
    - entity_id: camera.garage

Configuration Variables

Looking for your configuration file?
region string Required

Country or region. List of supported values.

alpr_bin string (Optional, default: alpr)

The command line tool alpr from OpenALPR software for local processing.

confidence integer (Optional, default: 80)

The minimum confidence in percent to process with Home Assistant.

source list Required

List of image sources.

entity_id string Required

A camera entity id to get the picture from.

name string (Optional)

This parameter allows you to override the name of your OpenALPR entity.