295 lines
13 KiB
HTML
295 lines
13 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>Camera - Home Assistant</title>
|
|
<meta name="author" content="Home Assistant">
|
|
<meta name="description" content="Instructions how to integrate cameras within Home Assistant.">
|
|
<meta name="viewport" content="width=device-width">
|
|
<link rel="canonical" href="https://home-assistant.io/components/camera/">
|
|
<meta property="fb:app_id" content="338291289691179">
|
|
<meta property="og:title" content="Camera">
|
|
<meta property="og:site_name" content="Home Assistant">
|
|
<meta property="og:url" content="https://home-assistant.io/components/camera/">
|
|
<meta property="og:type" content="article">
|
|
<meta property="og:description" content="Instructions how to integrate cameras 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="Camera">
|
|
<meta name="twitter:description" content="Instructions how to integrate cameras within 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">
|
|
Camera
|
|
</h1>
|
|
</header>
|
|
<hr class="divider">
|
|
<p>The camera component allows you to use IP cameras with Home Assistant. With a little additional work you could use <a href="/blog/2016/06/23/usb-webcams-and-home-assistant/">USB cameras</a> as well.</p>
|
|
<h3><a class="title-link" name="service" href="#service"></a> Service</h3>
|
|
<p>Once loaded, the <code class="highlighter-rouge">camera</code> platform will expose services that can be called to perform various actions.</p>
|
|
<p>Available services: <code class="highlighter-rouge">enable_motion_detection</code>, <code class="highlighter-rouge">disable_motion_detection</code>, and <code class="highlighter-rouge">snapshot</code>.</p>
|
|
<h4><a class="title-link" name="service-enable_motion_detection" href="#service-enable_motion_detection"></a> Service <code class="highlighter-rouge">enable_motion_detection</code></h4>
|
|
<p>Enable the motion detection in a camera.</p>
|
|
<table>
|
|
<thead>
|
|
<tr>
|
|
<th>Service data attribute</th>
|
|
<th>Optional</th>
|
|
<th>Description</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td><code class="highlighter-rouge">entity_id</code></td>
|
|
<td>no</td>
|
|
<td>Name(s) of entities to enable motion detection, e.g., <code class="highlighter-rouge">camera.living_room_camera</code>.</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<h4><a class="title-link" name="service-disable_motion_detection" href="#service-disable_motion_detection"></a> Service <code class="highlighter-rouge">disable_motion_detection</code></h4>
|
|
<p>Disable the motion detection in a camera.</p>
|
|
<table>
|
|
<thead>
|
|
<tr>
|
|
<th>Service data attribute</th>
|
|
<th>Optional</th>
|
|
<th>Description</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td><code class="highlighter-rouge">entity_id</code></td>
|
|
<td>no</td>
|
|
<td>Name(s) of entities to disable motion detection, e.g., <code class="highlighter-rouge">camera.living_room_camera</code>.</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<h4><a class="title-link" name="service-snapshot" href="#service-snapshot"></a> Service <code class="highlighter-rouge">snapshot</code></h4>
|
|
<p>Take a snapshot from a camera.</p>
|
|
<table>
|
|
<thead>
|
|
<tr>
|
|
<th>Service data attribute</th>
|
|
<th>Optional</th>
|
|
<th>Description</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td><code class="highlighter-rouge">entity_id</code></td>
|
|
<td>no</td>
|
|
<td>Name(s) of entities to create a snopshot from, e.g., <code class="highlighter-rouge">camera.living_room_camera</code>.</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code class="highlighter-rouge">filename </code></td>
|
|
<td>no</td>
|
|
<td>Template of a file name. Variable is <code class="highlighter-rouge">entity_id</code>, e.g., <code class="highlighter-rouge">/tmp/snapshot_{{ entity_id }}</code>.</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<p>The path part of <code class="highlighter-rouge">filename</code> must be an entry in the <code class="highlighter-rouge">whitelist_external_dirs</code> in your <a href="/docs/configuration/basic/"><code class="highlighter-rouge">homeassistant:</code></a> section of your <code class="highlighter-rouge">configuration.yaml</code> file.</p>
|
|
<h3><a class="title-link" name="test-if-it-works" href="#test-if-it-works"></a> Test if it works</h3>
|
|
<p>A simple way to test if you have set up your <code class="highlighter-rouge">camera</code> platform correctly, is to use <img src="/images/screenshots/developer-tool-services-icon.png" alt="service developer tool icon" class="no-shadow" height="38" /> <strong>Services</strong> from the <strong>Developer Tools</strong>. Choose your service from the dropdown menu <strong>Service</strong>, enter something like the sample below into the <strong>Service Data</strong> field, and hit <strong>CALL SERVICE</strong>.</p>
|
|
<div class="language-json highlighter-rouge"><pre class="highlight"><code><span class="p">{</span><span class="w">
|
|
</span><span class="nt">"entity_id"</span><span class="p">:</span><span class="w"> </span><span class="s2">"camera.living_room_camera"</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/camera.markdown'>Edit this page on GitHub</a></div>
|
|
<div class='brand-logo-container section'>
|
|
</div>
|
|
<h1 class='title delta'>Platforms</h1>
|
|
<ul class='divided'>
|
|
<li><a href='/components/camera.abode/'>
|
|
Abode Camera
|
|
</a></li>
|
|
<li><a href='/components/camera.amcrest/'>
|
|
Amcrest IP Camera
|
|
</a></li>
|
|
<li><a href='/components/camera.android_ip_webcam/'>
|
|
Android IP Webcam Camera
|
|
</a></li>
|
|
<li><a href='/components/camera.arlo/'>
|
|
Arlo Camera
|
|
</a></li>
|
|
<li><a href='/components/camera.axis/'>
|
|
Axis Camera
|
|
</a></li>
|
|
<li><a href='/components/camera.blink/'>
|
|
Blink Camera
|
|
</a></li>
|
|
<li><a href='/components/camera.bloomsky/'>
|
|
BloomSky Camera
|
|
</a></li>
|
|
<li><a href='/components/camera.dispatcher/'>
|
|
Dispatcher IP Camera
|
|
</a></li>
|
|
<li><a href='/components/camera.doorbird/'>
|
|
DoorBird Camera
|
|
</a></li>
|
|
<li><a href='/components/camera.ffmpeg/'>
|
|
FFmpeg Camera
|
|
</a></li>
|
|
<li><a href='/components/camera.foscam/'>
|
|
Foscam IP Camera
|
|
</a></li>
|
|
<li><a href='/components/camera.generic/'>
|
|
Generic IP Camera
|
|
</a></li>
|
|
<li><a href='/components/camera.mjpeg/'>
|
|
Generic MJPEG IP Camera
|
|
</a></li>
|
|
<li><a href='/components/camera.local_file/'>
|
|
Local File
|
|
</a></li>
|
|
<li><a href='/components/camera.mqtt/'>
|
|
MQTT Camera
|
|
</a></li>
|
|
<li><a href='/components/camera.neato/'>
|
|
Neato Camera
|
|
</a></li>
|
|
<li><a href='/components/camera.nest/'>
|
|
Nest Camera
|
|
</a></li>
|
|
<li><a href='/components/camera.netatmo/'>
|
|
Netatmo Camera
|
|
</a></li>
|
|
<li><a href='/components/camera.onvif/'>
|
|
ONVIF Camera
|
|
</a></li>
|
|
<li><a href='/components/camera.rpi_camera/'>
|
|
Raspberry Pi Camera
|
|
</a></li>
|
|
<li><a href='/components/camera.ring/'>
|
|
Ring Camera
|
|
</a></li>
|
|
<li><a href='/components/camera.skybell/'>
|
|
Skybell Camera
|
|
</a></li>
|
|
<li><a href='/components/camera.synology/'>
|
|
Synology Camera
|
|
</a></li>
|
|
<li><a href='/components/camera.usps/'>
|
|
USPS Camera
|
|
</a></li>
|
|
<li><a href='/components/camera.uvc/'>
|
|
UniFi Video Camera
|
|
</a></li>
|
|
<li><a href='/components/camera.verisure/'>
|
|
Verisure Camera
|
|
</a></li>
|
|
<li><a href='/components/camera.yi/'>
|
|
Yi Home Camera
|
|
</a></li>
|
|
<li><a href='/components/camera.zoneminder/'>
|
|
ZoneMinder Camera
|
|
</a></li>
|
|
</ul>
|
|
</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>
|