218 lines
12 KiB
HTML
218 lines
12 KiB
HTML
<!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 integrate OpenCV image processing into Home Assistant.">
|
||
<meta name="viewport" content="width=device-width">
|
||
<link rel="canonical" href="https://home-assistant.io/components/image_processing.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/image_processing.opencv/">
|
||
<meta property="og:type" content="article">
|
||
<meta property="og:description" content="Instructions how to integrate OpenCV image processing 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="OpenCV">
|
||
<meta name="twitter:description" content="Instructions how to integrate OpenCV image processing into Home Assistant.">
|
||
<meta name="twitter:image" content="https://home-assistant.io/images/default-social.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">
|
||
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 <a href="https://github.com/opencv/opencv/tree/master/data">here</a>.</p>
|
||
<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">image_processing</span><span class="pi">:</span>
|
||
<span class="pi">-</span> <span class="s">platform</span><span class="pi">:</span> <span class="s">opencv</span>
|
||
<span class="s">name</span><span class="pi">:</span> <span class="s">Front Door Faces</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.front_door</span>
|
||
<span class="s">classifier</span><span class="pi">:</span>
|
||
<span class="s">mom</span><span class="pi">:</span> <span class="s">/path/to/classifier.xml</span>
|
||
</code></pre>
|
||
</div>
|
||
<ul>
|
||
<li><strong>name</strong> (<em>Required</em>): The name of the OpenCV image processor.</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.
|
||
<ul>
|
||
<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>
|
||
</li>
|
||
<li><strong>classifier</strong> (<em>Optional</em>): Dictionary of name to path to the classifier xml file. If this field is not provided, a face classifier will be downloaded from OpenCV’s Github repo.</li>
|
||
</ul>
|
||
<p><strong>classifier</strong> may also be defined as a dictionary of names to classifier configurations:</p>
|
||
<div class="language-yaml highlighter-rouge"><pre class="highlight"><code> <span class="s">mom</span><span class="pi">:</span>
|
||
<span class="s">file</span><span class="pi">:</span> <span class="s">/path/to/classifier/xml</span>
|
||
<span class="s">neighbors</span><span class="pi">:</span> <span class="s">4</span>
|
||
<span class="s">min_size</span><span class="pi">:</span> <span class="s">(40, 40)</span>
|
||
<span class="s">scale</span><span class="pi">:</span> <span class="s">1.1f</span>
|
||
</code></pre>
|
||
</div>
|
||
<ul>
|
||
<li><strong>file</strong> (<em>Required</em>): The path to the classifier xml file.</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>
|
||
<p>If you would like to see the regions that OpenCV has detected, add this OpenCV camera to your config’s <code class="highlighter-rouge">custom_components/camera</code> directory: <a href="https://gist.github.com/Teagan42/bf4b941b34a79a3e184e149ff1efd82f">https://gist.github.com/Teagan42/bf4b941b34a79a3e184e149ff1efd82f</a></p>
|
||
</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.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'>
|
||
Introduced in release: 0.47
|
||
</div>
|
||
<div class='section'>
|
||
Source:
|
||
<a href='https://github.com/home-assistant/home-assistant/blob/master/homeassistant/components/image_processing/opencv.py'>image_processing/opencv.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>
|
||
OpenCV
|
||
</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>
|