Plate Recognizer SDK

We provide a Docker image with our ALPR technology. It can be used on-premises without an internet connection. It lets you read license plates from a vehicle picture. To use it, you will need to get a SDK license. An internet connection is needed during installation.

Installation

Installation steps:
  1. Sign up and log in.
  2. Subscribe to a SDK plan.
  3. Install Docker on your local machine. See requirements.
  4. Get our SDK image. In a terminal run docker pull platerecognizer/alpr
  5. Install and run the container:

    docker run --rm -t -p 8080:8080 -v license:/license -e TOKEN=MY_TOKEN -e LICENSE_KEY=MY_KEY platerecognizer/alpr

The container exposes a REST interface. To verify that the installation was successful, run those commands in a new terminal.

# Get a picture
curl -o /tmp/car.jpg https://platerecognizer.com/static/demo.jpg
# And read the license plate
curl -F 'file=@/tmp/car.jpg' http://localhost:8080/alpr
                
:: Get a picture
curl -o car.jpg https://platerecognizer.com/static/demo.jpg
:: And read the license plate
curl -F "upload=@car.jpg" http://localhost:8080/alpr
                
Continue to the SDK documentation

Updating the SDK

  1. Stop the running containers using the image. Run docker ps -q --filter ancestor=platerecognizer/alpr to get the container id. And then docker stop CONTAINER_ID to stop it.
  2. Update the image: docker pull platerecognizer/alpr.
  3. Run the container (see last step of Installation).

Uninstalling the SDK

Each license can only be used on a single machine. If you need to move your installation to a new machine, you first have to uninstall it from the initial machine.

  1. Stop the running containers using the image. Run docker ps -q --filter ancestor=platerecognizer/alpr to get the container id. And then docker stop CONTAINER_ID to stop it.
  2. Run the container using this command: docker run --rm -t -v license:/license -e TOKEN=MY_TOKEN -e UNINSTALL=1 platerecognizer/alpr
  3. You can now remove the container using docker rm

Installation on a Raspberry Pi

Follow the steps 1) to 3) of the standard installation instructions.
  1. Get our SDK image. In a terminal run docker pull platerecognizer/alpr-raspberry-pi
  2. Create the container with this command (you may use a different port if 8080 is already used). You may add --network=host to use the host’s networking directly. Initialization can take up to 10-20 seconds.

    Use the command 5) but with image platerecognizer/alpr-raspberry-pi

System Requirements

For best performance, we recommend running the container from a Linux machine. With a recent processor (7-8 gen Intel CPU with 4 cores), inference should take 50-100ms. Minimum requirements are:

  • Use an OS that supports Docker. See the installation guide for how to install on Windows, Mac or Linux.
    • If your system does not meet the requirements to run Docker Desktop, you can install Docker Toolbox.
    • To run the container automatically at startup:

      Make Docker start on boot.

      Run the container using: docker run --restart unless-stopped -t -p 8080:8080 -v license:/license -e TOKEN=MY_TOKEN platerecognizer/alpr

  • Intel CPU 3rd gen or higher. We also support the Raspberry Pi3 (inference speed of 1 second).
  • At least 500MB of free RAM