home-assistant.github.io/components/image_processing.openalpr_local/index.html
2017-09-26 07:14:23 +00:00

210 lines
11 KiB
HTML
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

<!doctype html>
<!--[if lt IE 7]> <html class="no-js lt-ie9 lt-ie8 lt-ie7"> <![endif]-->
<!--[if IE 7]> <html class="no-js lt-ie9 lt-ie8"> <![endif]-->
<!--[if IE 8]> <html class="no-js lt-ie9"> <![endif]-->
<!--[if gt IE 8]><!--> <html> <!--<![endif]-->
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1">
<title>OpenALPR Local - Home Assistant</title>
<meta name="author" content="Home Assistant">
<meta name="description" content="Instructions how to integrate licences plates with OpenALPR local into Home Assistant.">
<meta name="viewport" content="width=device-width">
<link rel="canonical" href="https://home-assistant.io/components/image_processing.openalpr_local/">
<meta property="fb:app_id" content="338291289691179">
<meta property="og:title" content="OpenALPR Local">
<meta property="og:site_name" content="Home Assistant">
<meta property="og:url" content="https://home-assistant.io/components/image_processing.openalpr_local/">
<meta property="og:type" content="article">
<meta property="og:description" content="Instructions how to integrate licences plates with OpenALPR local into Home Assistant.">
<meta property="og:image" content="https://home-assistant.io/images/default-social.png">
<meta name="twitter:card" content="summary_large_image">
<meta name="twitter:site" content="@home_assistant">
<meta name="twitter:title" content="OpenALPR Local">
<meta name="twitter:description" content="Instructions how to integrate licences plates with OpenALPR local into Home Assistant.">
<meta name="twitter:image" content="https://home-assistant.io/images/default-social.png">
<link href="/stylesheets/screen.css" media="screen, projection" rel="stylesheet">
<link href="/atom.xml" rel="alternate" title="Home Assistant" type="application/atom+xml">
<link rel='shortcut icon' href='/images/favicon.ico' />
<link rel='icon' type='image/png' href='/images/favicon-192x192.png' sizes='192x192' />
</head>
<body >
<header class='site-header'>
<div class="grid-wrapper">
<div class="grid">
<div class="grid__item three-tenths lap-two-sixths palm-one-whole ha-title">
<a href="/" class="site-title">
<img width='40' src='/demo/favicon-192x192.png'>
<span>Home Assistant</span>
</a>
</div>
<div class="grid__item seven-tenths lap-four-sixths palm-one-whole">
<nav>
<input type="checkbox" id="toggle">
<label for="toggle" class="toggle" data-open="Main Menu" data-close="Close Menu"></label>
<ul class="menu pull-right">
<li><a href="/getting-started/">Getting started</a></li>
<li><a href="/components/">Components</a></li>
<li><a href="/docs/">Docs</a></li>
<li><a href="/cookbook/">Examples</a></li>
<li><a href="/developers/">Developers</a></li>
<li><a href="/blog/">Blog</a></li>
<li><a href="/help/">Need help?</a></li>
<li><a href='#' class='show-search'><i class="icon-search"></i></a></li>
</ul>
</nav>
<div class='search-container' style='display: none'>
<div class='search'>
<i class="icon-search"></i>
<input id='search' placeholder='Search the docs…'>
<a href='#' class='close'><i class="icon-remove-sign"></i></a>
</div>
</div>
</div>
</div>
</div>
</header>
<div class="grid-wrapper">
<div class="grid grid-center">
<div class="grid__item two-thirds lap-one-whole palm-one-whole">
<article class="page">
<header>
<h1 class="title indent">
OpenALPR Local
</h1>
</header>
<hr class="divider">
<p><a href="http://www.openalpr.com/">OpenALPR</a> 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 <a href="https://home-assistant.io/components/automation/">automation</a>.</p>
<p>For using inside automation look on <a href="/components/image_processing">component</a> page.</p>
<h3><a class="title-link" name="local-installation" href="#local-installation"></a> Local installation</h3>
<p>If you want process all data locally, you need version 2.3.1 or higher of the <code class="highlighter-rouge">alpr</code> commandline tool.</p>
<p>If you dont find binaries for your distribution you can compile from source. Documentation of how to build OpenALPR is found <a href="https://github.com/openalpr/openalpr/wiki">here</a>.</p>
<p>On a Debian system you can use this <code class="highlighter-rouge">cmake</code> command to build only the command line tool:</p>
<div class="language-bash highlighter-rouge"><pre class="highlight"><code><span class="gp">$ </span>cmake -DWITH_TEST<span class="o">=</span>FALSE -DWITH_BINDING_JAVA<span class="o">=</span>FALSE --DWITH_BINDING_PYTHON<span class="o">=</span>FALSE <span class="se">\</span>
--DWITH_BINDING_GO<span class="o">=</span>FALSE -DWITH_DAEMON<span class="o">=</span>FALSE -DCMAKE_INSTALL_PREFIX:PATH<span class="o">=</span>/usr ..
</code></pre>
</div>
<p>For other operating system please refer to the <a href="https://github.com/openalpr/openalpr/wiki">OpenALPR wiki</a>.</p>
<p>Verify your <code class="highlighter-rouge">alpr</code> installation with:</p>
<div class="language-bash highlighter-rouge"><pre class="highlight"><code><span class="gp">$ </span>wget -O- -q http://plates.openalpr.com/h786poj.jpg | alpr -
</code></pre>
</div>
<h3><a class="title-link" name="configuration-home-assistant" href="#configuration-home-assistant"></a> Configuration Home Assistant</h3>
<div class="language-yaml highlighter-rouge"><pre class="highlight"><code><span class="c1"># Example configuration.yaml entry</span>
<span class="s">image_processing</span><span class="pi">:</span>
<span class="pi">-</span> <span class="s">platform</span><span class="pi">:</span> <span class="s">openalpr_local</span>
<span class="s">region</span><span class="pi">:</span> <span class="s">eu</span>
<span class="s">source</span><span class="pi">:</span>
<span class="pi">-</span> <span class="s">entity_id</span><span class="pi">:</span> <span class="s">camera.garage</span>
</code></pre>
</div>
<p>Configuration variables:</p>
<ul>
<li><strong>region</strong> (<em>Required</em>): Country or region. List of supported <a href="https://github.com/openalpr/openalpr/tree/master/runtime_data/config">values</a>.</li>
<li><strong>alpr_bin</strong> (<em>Optional</em>): The command line tool alpr from OpenALPR software for local processing. Defaults to <code class="highlighter-rouge">alpr</code>.</li>
<li><strong>confidence</strong> (<em>Optional</em>): The minimum of confidence in percent to process with Home Assistant. Defaults to 80.</li>
<li><strong>source</strong> array (<em>Required</em>): List of image sources.
<ul>
<li><strong>entities</strong> (<em>Required</em>): A list of devices to add in Home Assistant.</li>
<li><strong>name</strong> (<em>Optional</em>): This parameter allows you to override the name of your OpenALPR entity.</li>
</ul>
</li>
</ul>
</article>
</div>
<aside id="sidebar" class="grid__item one-third lap-one-whole palm-one-whole">
<div class="grid">
<section class="aside-module grid__item one-whole lap-one-half">
<div class='edit-github'><a href='https://github.com/home-assistant/home-assistant.github.io/tree/current/source/_components/image_processing.openalpr_local.markdown'>Edit this page on GitHub</a></div>
<div class='brand-logo-container section'>
<img src='/images/supported_brands/openalpr.png' />
</div>
<div class='section'>
Introduced in release: 0.36
</div>
<div class='section'>
This is a platform for
<a href='/components/image_processing/'>the Image Processing component</a>.
</div>
<div class='section'>
<h1 class="title delta">Category Image Processing</h1>
<ul class='divided'>
<li>
<a href='/components/image_processing.dlib_face_detect/'>Dlib Face Detect</a>
</li>
<li>
<a href='/components/image_processing.dlib_face_identify/'>Dlib Face Identify</a>
</li>
<li>
<a href='/components/image_processing.microsoft_face_detect/'>Microsoft Face Detect</a>
</li>
<li>
<a href='/components/image_processing.microsoft_face_identify/'>Microsoft Face Identify</a>
</li>
<li>
<a href='/components/image_processing.openalpr_cloud/'>OpenALPR Cloud</a>
</li>
<li>
OpenALPR Local
</li>
<li>
<a href='/components/image_processing.opencv/'>OpenCV</a>
</li>
<li>
<a href='/components/image_processing.seven_segments/'>Seven segments display</a>
</li>
</ul>
</div>
</section>
</div>
</aside>
</div>
</div>
<footer>
<div class="grid-wrapper">
<div class="grid">
<div class="grid__item">
<div class="copyright">
<a rel="me" href='https://twitter.com/home_assistant'><i class="icon-twitter"></i></a>
<a rel="me" href='https://facebook.com/homeassistantio'><i class="icon-facebook"></i></a>
<a rel="me" href='https://plus.google.com/110560654828510104551'><i class="icon-google-plus"></i></a>
<a rel="me" href='https://github.com/home-assistant/home-assistant'><i class="icon-github"></i></a>
<div class="credit">
Contact us at <a href='mailto:hello@home-assistant.io'>hello@home-assistant.io</a> (no support!).<br>
Website powered by <a href='http://jekyllrb.com/'>Jekyll</a> and the <a href='https://github.com/coogie/oscailte'>Oscalite theme</a>.<br />
Hosted by <a href='https://pages.github.com/'>GitHub</a> and served by <a href='https://cloudflare.com'>CloudFlare</a>.
</div>
<a rel="license" href="http://creativecommons.org/licenses/by-nc-sa/4.0/"><img alt="Creative Commons License" style="border-width:0" src="https://i.creativecommons.org/l/by-nc-sa/4.0/88x31.png" /></a><br /><span xmlns:dct="http://purl.org/dc/terms/" property="dct:title">home-assistant.io</span> is licensed under a <a rel="license" href="http://creativecommons.org/licenses/by-nc-sa/4.0/">Creative Commons Attribution-NonCommercial-ShareAlike 4.0 International License</a>.
</div>
</div>
</div>
</div>
</footer>
<script>
var _gaq=[['_setAccount','UA-57927901-1'],['_trackPageview']];
(function(d,t){var g=d.createElement(t),s=d.getElementsByTagName(t)[0];
g.src=('https:'==location.protocol?'//ssl':'//www')+'.google-analytics.com/ga.js';
s.parentNode.insertBefore(g,s)}(document,'script'));
</script>
<link rel="stylesheet" href="https://cdn.jsdelivr.net/docsearch.js/2/docsearch.min.css" />
<script type="text/javascript" src="https://cdn.jsdelivr.net/docsearch.js/2/docsearch.min.js"></script>
<script type="text/javascript">
docsearch({
apiKey: 'ae96d94b201c5444c8a443093edf3efb',
indexName: 'home-assistant',
inputSelector: '#search',
debug: false // Set debug to true if you want to inspect the dropdown
});
document.querySelector('.search .close').addEventListener('click', function(ev) {
ev.preventDefault();
document.querySelector('.search-container').style.display = 'none';
});
document.querySelector('.show-search').addEventListener('click', function(ev) {
ev.preventDefault();
document.querySelector('.search-container').style.display = 'block';
document.getElementById('toggle').checked = false;
document.querySelector('.search-container input').focus();
});
</script>
</body>
</html>