jeena/home-assistant.github.io
1
0
Fork 0
Code Issues Pull requests Projects Packages Wiki Activity Actions
home-assistant.github.io/components/opencv/index.html
Travis CI 4464ad280b Site updated at 2017-05-19 01:17:20 UTC
2017-05-19 01:17:20 +00:00

337 lines
16 KiB
HTML
Raw Blame History

<!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>OpenCV - Home Assistant</title>
<meta name="author" content="Home Assistant">
<meta name="description" content="Instructions how to setup OpenCV within Home Assistant.">
<meta name="viewport" content="width=device-width">
<link rel="canonical" href="https://home-assistant.io/components/opencv/">
<meta property="fb:app_id" content="338291289691179">
<meta property="og:title" content="OpenCV">
<meta property="og:site_name" content="Home Assistant">
<meta property="og:url" content="https://home-assistant.io/components/opencv/">
<meta property="og:type" content="article">
<meta property="og:description" content="Instructions how to setup OpenCV within 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="OpenCV">
<meta name="twitter:description" content="Instructions how to setup OpenCV within 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>
<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>
</ul>
</nav>
</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">
OpenCV
</h1>
</header>
<hr class="divider">
<p><a href="http://www.opencv.org">OpenCV</a> is an open source computer vision image and video processing library.</p>
<p>Some pre-defined classifiers can be found here: https://github.com/opencv/opencv/tree/master/data</p>
<h3><a class="title-link" name="configuration" href="#configuration"></a> Configuration</h3>
<p>To setup OpenCV with Home Assistant, add the following section 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">opencv</span><span class="pi">:</span>
<span class="s">classifier_group</span><span class="pi">:</span>
<span class="pi">-</span> <span class="s">name</span><span class="pi">:</span> <span class="s">Family</span>
<span class="s">add_camera</span><span class="pi">:</span> <span class="s">True</span>
<span class="s">entity_id</span><span class="pi">:</span>
<span class="pi">-</span> <span class="s">camera.front_door</span>
<span class="pi">-</span> <span class="s">camera.living_room</span>
<span class="s">classifier</span><span class="pi">:</span>
<span class="pi">-</span> <span class="s">file_path</span><span class="pi">:</span> <span class="s">/path/to/classifier/face.xml</span>
<span class="s">name</span><span class="pi">:</span> <span class="s">Bob</span>
<span class="pi">-</span> <span class="s">file_path</span><span class="pi">:</span> <span class="s">/path/to/classifier/face_profile.xml</span>
<span class="s">name</span><span class="pi">:</span> <span class="s">Jill</span>
<span class="s">min_size</span><span class="pi">:</span> <span class="s">(20, 20)</span>
<span class="s">color</span><span class="pi">:</span> <span class="s">(255, 0, 0)</span>
<span class="s">scale</span><span class="pi">:</span> <span class="s">1.6</span>
<span class="s">neighbors</span><span class="pi">:</span> <span class="s">5</span>
<span class="pi">-</span> <span class="s">file_path</span><span class="pi">:</span> <span class="s">/path/to/classifier/kid_face.xml</span>
<span class="s">name</span><span class="pi">:</span> <span class="s">Little Jimmy</span>
</code></pre>
</div>
<p>Configuration variables:</p>
<ul>
<li><strong>name</strong> (<em>Required</em>): The name of the OpenCV image processor.</li>
<li><strong>entity_id</strong> (<em>Required</em>): The camera entity or list of camera entities that this classification group will be applied to.</li>
<li><strong>classifier</strong> (<em>Required</em>): The classification configuration for to be applied:
<ul>
<li><strong>file_path</strong> (<em>Required</em>): The path to the HAARS or LBP classification file (xml).</li>
<li><strong>name</strong> (<em>Optional</em>): The classification name, the default is <code class="highlighter-rouge">Face</code>.</li>
<li><strong>min_size</strong> (<em>Optional</em>): The minimum size for detection as a tuple <code class="highlighter-rouge">(width, height)</code>, the default is <code class="highlighter-rouge">(30, 30)</code>.</li>
<li><strong>color</strong> (<em>Optional</em>): The color, as a tuple <code class="highlighter-rouge">(Blue, Green, Red)</code> to draw the rectangle when linked to a dispatcher camera, the default is <code class="highlighter-rouge">(255, 255, 0)</code>.</li>
<li><strong>scale</strong> (<em>Optional</em>): The scale to perform when processing, this is a <code class="highlighter-rouge">float</code> value that must be greater than or equal to <code class="highlighter-rouge">1.0</code>, default is <code class="highlighter-rouge">1.1</code>.</li>
<li><strong>neighbors</strong> (<em>Optional</em>): The minimum number of neighbors required for a match, default is <code class="highlighter-rouge">4</code>. The higher this number, the more picky the matching will be; lower the number, the more false positives you may experience.</li>
</ul>
</li>
</ul>
<p>Once OpenCV is configured, it will create an <code class="highlighter-rouge">image_processing</code> entity for each classification group/camera entity combination as well as a camera so you can see what Home Assistant sees.</p>
<p>The attributes on the <code class="highlighter-rouge">image_processing</code> entity will be:</p>
<div class="language-json highlighter-rouge"><pre class="highlight"><code><span class="err">'matches':</span><span class="w"> </span><span class="p">{</span><span class="w">
</span><span class="err">'Bob':</span><span class="w"> </span><span class="err">[</span><span class="w">
</span><span class="err">(x,</span><span class="w"> </span><span class="err">y,</span><span class="w"> </span><span class="err">w,</span><span class="w"> </span><span class="err">h)</span><span class="w">
</span><span class="err">],</span><span class="w">
</span><span class="err">'Jill':</span><span class="w"> </span><span class="err">[</span><span class="w">
</span><span class="err">(x,</span><span class="w"> </span><span class="err">y,</span><span class="w"> </span><span class="err">w,</span><span class="w"> </span><span class="err">h)</span><span class="w">
</span><span class="err">],</span><span class="w">
</span><span class="err">'Little</span><span class="w"> </span><span class="err">Jimmy':</span><span class="w"> </span><span class="err">[</span><span class="w">
</span><span class="err">(x,</span><span class="w"> </span><span class="err">y,</span><span class="w"> </span><span class="err">w,</span><span class="w"> </span><span class="err">h)</span><span class="w">
</span><span class="err">]</span><span class="w">
</span><span class="p">}</span><span class="w">
</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/opencv.markdown'>Edit this page on GitHub</a></div>
<div class='brand-logo-container section'>
<img src='/images/supported_brands/opencv.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 Push
</div>
<div class='section'>
Introduced in release: 0.44
</div>
<div class='section'>
<h1 class='title delta'>Related components</h1>
<ul class='divided'>
<li><a href='/components/image_processing.opencv/'>
OpenCV
</a></li>
</ul>
</div>
<div class='section'>
<h1 class="title delta">Category Hub</h1>
<ul class='divided'>
<li>
<a href='/components/apcupsd/'>APCUPSd</a>
</li>
<li>
<a href='/components/alarmdecoder/'>AlarmDecoder Alarm</a>
</li>
<li>
<a href='/components/android_ip_webcam/'>Android IP Webcam</a>
</li>
<li>
<a href='/components/wemo/'>Belkin WeMo</a>
</li>
<li>
<a href='/components/blink/'>Blink</a>
</li>
<li>
<a href='/components/bloomsky/'>BloomSky</a>
</li>
<li>
<a href='/components/digital_ocean/'>Digital Ocean</a>
</li>
<li>
<a href='/components/eight_sleep/'>Eight Sleep</a>
</li>
<li>
<a href='/components/emulated_hue/'>Emulated Hue Bridge</a>
</li>
<li>
<a href='/components/enocean/'>EnOcean</a>
</li>
<li>
<a href='/components/ffmpeg/'>FFmpeg</a>
</li>
<li>
<a href='/components/homematic/'>Homematic</a>
</li>
<li>
<a href='/components/tradfri/'>IKEA Trådfri (Tradfri)</a>
</li>
<li>
<a href='/components/isy994/'>ISY994 Controller</a>
</li>
<li>
<a href='/components/insteon_local/'>Insteon (local)</a>
</li>
<li>
<a href='/components/insteon_hub/'>Insteon Hub</a>
</li>
<li>
<a href='/components/insteon_plm/'>Insteon PLM</a>
</li>
<li>
<a href='/components/joaoapps_join/'>Joaoapps Join</a>
</li>
<li>
<a href='/components/litejet/'>LiteJet</a>
</li>
<li>
<a href='/components/lutron/'>Lutron</a>
</li>
<li>
<a href='/components/lutron_caseta/'>Lutron Caseta</a>
</li>
<li>
<a href='/components/mqtt/'>MQTT</a>
</li>
<li>
<a href='/components/microsoft_face/'>Microsoft Face</a>
</li>
<li>
<a href='/components/mochad/'>Mochad</a>
</li>
<li>
<a href='/components/modbus/'>Modbus</a>
</li>
<li>
<a href='/components/mysensors/'>MySensors</a>
</li>
<li>
<a href='/components/neato/'>Neato Robotics</a>
</li>
<li>
<a href='/components/nest/'>Nest</a>
</li>
<li>
<a href='/components/netatmo/'>Netatmo</a>
</li>
<li>
<a href='/components/nuimo_controller/'>Nuimo controller</a>
</li>
<li>
<a href='/components/octoprint/'>OctoPrint</a>
</li>
<li>
OpenCV
</li>
<li>
<a href='/components/pilight/'>Pilight</a>
</li>
<li>
<a href='/components/qwikswitch/'>QwikSwitch QSUSB Hub</a>
</li>
<li>
<a href='/components/rflink/'>RFLink</a>
</li>
<li>
<a href='/components/rfxtrx/'>RFXtrx</a>
</li>
<li>
<a href='/components/ring/'>Ring</a>
</li>
<li>
<a href='/components/scsgate/'>SCSGate</a>
</li>
<li>
<a href='/components/sleepiq/'>SleepIQ</a>
</li>
<li>
<a href='/components/tado/'>Tado</a>
</li>
<li>
<a href='/components/tellstick/'>TellStick</a>
</li>
<li>
<a href='/components/tellduslive/'>Telldus Live</a>
</li>
<li>
<a href='/components/twilio/'>Twilio</a>
</li>
<li>
<a href='/components/vera/'>Vera</a>
</li>
<li>
<a href='/components/verisure/'>Verisure</a>
</li>
<li>
<a href='/components/volvooncall/'>Volvo On Call</a>
</li>
<li>
<a href='/components/wink/'>Wink</a>
</li>
<li>
<a href='/components/zwave/'>Z-Wave</a>
</li>
<li>
<a href='/components/zha/'>Zigbee Home Automation</a>
</li>
<li>
<a href='/components/zoneminder/'>ZoneMinder</a>
</li>
<li>
<a href='/components/ecobee/'>ecobee</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>
</body>
</html>
Reference in a new issue View git blame Copy permalink