jeena/home-assistant.github.io
1
0
Fork 0
Code Issues Pull requests Projects Packages Wiki Activity Actions
home-assistant.github.io/components/image_processing.seven_segments/index.html
Travis CI d783d674cb Site updated at 2018-01-20 15:29:30 UTC
2018-01-20 15:29:30 +00:00

257 lines
16 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>Seven segments display - Home Assistant</title>
<meta name="author" content="Home Assistant">
<meta name="description" content="Instructions how to use OCR for seven segments displays into Home Assistant.">
<meta name="viewport" content="width=device-width">
<link rel="canonical" href="https://home-assistant.io/components/image_processing.seven_segments/">
<meta property="fb:app_id" content="338291289691179">
<meta property="og:title" content="Seven segments display">
<meta property="og:site_name" content="Home Assistant">
<meta property="og:url" content="https://home-assistant.io/components/image_processing.seven_segments/">
<meta property="og:type" content="article">
<meta property="og:description" content="Instructions how to use OCR for seven segments displays into Home Assistant.">
<meta property="og:image" content="https://home-assistant.io/images/screenshots/ssocr.png">
<meta name="twitter:card" content="summary_large_image">
<meta name="twitter:site" content="@home_assistant">
<meta name="twitter:title" content="Seven segments display">
<meta name="twitter:description" content="Instructions how to use OCR for seven segments displays into Home Assistant.">
<meta name="twitter:image" content="https://home-assistant.io/images/screenshots/ssocr.png">
<link href="/stylesheets/screen.css" media="screen, projection, print" 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">
Seven segments display
</h1>
</header>
<hr class="divider">
<p>The <code class="highlighter-rouge">seven_segments</code> image processing platform allows you to read physical seven segments displays through Home Assistant. <a href="https://www.unix-ag.uni-kl.de/~auerswal/ssocr/"><code class="highlighter-rouge">ssocr</code></a> is used to extract the value shown on the display which is observed by a <a href="/components/camera/">camera</a>.</p>
<p class="note">
If you are using <a href="/hassio/">Hass.io</a> then just move forward to the configuration as all requirements are already fulfilled.
</p>
<p><code class="highlighter-rouge">ssocr</code> needs to be available on your system. Check the installation instruction below:</p>
<div class="language-bash highlighter-rouge"><pre class="highlight"><code><span class="gp">$ </span>sudo dnf -y install imlib2-devel <span class="c"># Fedora</span>
<span class="gp">$ </span>sudo apt install libimlib2-dev <span class="c"># Ubuntu</span>
<span class="gp">$ </span>brew install imlib2 <span class="c"># macOS</span>
<span class="gp">$ </span>git clone https://github.com/auerswal/ssocr.git
<span class="gp">$ </span><span class="nb">cd </span>ssocr
<span class="gp">$ </span>make
<span class="gp">$ </span>sudo make <span class="nv">PREFIX</span><span class="o">=</span>/usr install <span class="c"># On most systems</span>
<span class="gp">$ </span>make deb <span class="c"># (Optional) This allows you to make a deb so that you apt is aware of ssocr</span>
</code></pre>
</div>
<p>To enable the OCR of a seven segment display in your installation, add the following to your <code class="highlighter-rouge">configuration.yaml</code> file:</p>
<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">seven_segments</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.seven_segments</span>
</code></pre>
</div>
<p>Configuration variables:</p>
<ul>
<li><strong>ssocr_bin</strong> (<em>Optional</em>): The command line tool <code class="highlighter-rouge">ssocr</code>. Set it if you use a different name for the executable. Defaults to <code class="highlighter-rouge">ssocr</code>.</li>
<li><strong>x_position</strong> (<em>Optional</em>): X coordinate of the upper left corner of the area to crop. Defaults to <code class="highlighter-rouge">0</code>.</li>
<li><strong>y_position</strong> (<em>Optional</em>): Y coordinate of the upper left corner of the area to crop. Defaults to <code class="highlighter-rouge">0</code>.</li>
<li><strong>height</strong> (<em>Optional</em>): Height of the area to crop. Defaults to <code class="highlighter-rouge">0</code>.</li>
<li><strong>width</strong> (<em>Optional</em>): Width of the area to crop. Defaults to <code class="highlighter-rouge">0</code>.</li>
<li><strong>rotate</strong> (<em>Optional</em>): Rotation of the image. Defaults to <code class="highlighter-rouge">0</code>.</li>
<li><strong>threshold</strong> (<em>Optional</em>): Threshold for the difference between the digits and the background. Defaults to <code class="highlighter-rouge">0</code>.</li>
<li><strong>digits</strong> (<em>Optional</em>): Number of digits in the display. Defaults to <code class="highlighter-rouge">-1</code>.</li>
<li><strong>extra_arguments</strong> (<em>Optional</em>): Other arguments to use. Like <code class="highlighter-rouge">-D</code>, <code class="highlighter-rouge">dilation</code>, <code class="highlighter-rouge">erosion</code>, <code class="highlighter-rouge">greyscale</code>, <code class="highlighter-rouge">make_mono</code>, etc.</li>
<li><strong>source</strong> array (<em>Required</em>): List of image sources.
<ul>
<li><strong>entity_id</strong> (<em>Required</em>): A camera entity id to get picture from.</li>
<li><strong>name</strong> (<em>Optional</em>): This parameter allows you to override the name of your <code class="highlighter-rouge">image_processing</code> entity.</li>
</ul>
</li>
</ul>
<h3><a class="title-link" name="setup-process" href="#setup-process"></a> Setup process</h3>
<p>It’s suggested that the first attempt to determine the needed parameters is using <code class="highlighter-rouge">ssocr</code> directly. This may require a couple of iterations to get the result</p>
<div class="language-bash highlighter-rouge"><pre class="highlight"><code><span class="gp">$ </span>ssocr -D erosion crop 390 250 490 280 -t 20 -d 4 seven-seg.png
</code></pre>
</div>
<p>This would lead to the following entry for the <code class="highlighter-rouge">configuration.yaml</code> file:</p>
<div class="language-yaml highlighter-rouge"><pre class="highlight"><code><span class="s">camera</span><span class="pi">:</span>
<span class="pi">-</span> <span class="s">platform</span><span class="pi">:</span> <span class="s">local_file</span>
<span class="s">file_path</span><span class="pi">:</span> <span class="s">/home/homeassistant/.homeassistant/seven-seg.png</span>
<span class="s">name</span><span class="pi">:</span> <span class="s">seven_segments</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">seven_segments</span>
<span class="s">x_position</span><span class="pi">:</span> <span class="s">390</span>
<span class="s">y_position</span><span class="pi">:</span> <span class="s">250</span>
<span class="s">height</span><span class="pi">:</span> <span class="s">280</span>
<span class="s">width</span><span class="pi">:</span> <span class="s">490</span>
<span class="s">threshold</span><span class="pi">:</span> <span class="s">20</span>
<span class="s">digits</span><span class="pi">:</span> <span class="s">4</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.seven_segments</span>
</code></pre>
</div>
<p class="img">
<img src="/images/screenshots/ssocr.png" />
</p>
<p>With the help of a <a href="/components/sensor.template/">template sensor</a>, the value can be shown as badge.</p>
<div class="language-yaml highlighter-rouge"><pre class="highlight"><code><span class="s">sensor</span><span class="pi">:</span>
<span class="pi">-</span> <span class="s">platform</span><span class="pi">:</span> <span class="s">template</span>
<span class="s">sensors</span><span class="pi">:</span>
<span class="s">power_meter</span><span class="pi">:</span>
<span class="s">value_template</span><span class="pi">:</span> <span class="s1">'</span><span class="s">{{</span><span class="nv"> </span><span class="s">states.image_processing.sevensegment_ocr_seven_segments.state</span><span class="nv"> </span><span class="s">}}'</span>
<span class="s">friendly_name</span><span class="pi">:</span> <span class="s1">'</span><span class="s">Ampere'</span>
<span class="s">unit_of_measurement</span><span class="pi">:</span> <span class="s1">'</span><span class="s">A'</span>
</code></pre>
</div>
</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.seven_segments.markdown'>Edit this page on GitHub</a></div>
<div class='brand-logo-container section'>
<img src='/images/supported_brands/home-assistant.png' />
</div>
<div class='section'>
IoT class<sup><a href='/blog/2016/02/12/classifying-the-internet-of-things/#classifiers'><i class="icon-info-sign"></i></a></sup>: Local Polling
</div>
<div class='section'>
Introduced in release: 0.45
</div>
<div class='section'>
Source:
<a href='https://github.com/home-assistant/home-assistant/blob/master/homeassistant/components/image_processing/seven_segments.py'>image_processing/seven_segments.py</a>
</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>
<a href='/components/image_processing.openalpr_local/'>OpenALPR Local</a>
</li>
<li>
<a href='/components/image_processing.opencv/'>OpenCV</a>
</li>
<li>
Seven segments display
</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>
Reference in a new issue View git blame Copy permalink