301 lines
14 KiB
HTML
301 lines
14 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>ONVIF Camera - Home Assistant</title>
|
||
<meta name="author" content="Home Assistant">
|
||
<meta name="description" content="Instructions on how to integrate a ONVIF camera within Home Assistant.">
|
||
<meta name="viewport" content="width=device-width">
|
||
<link rel="canonical" href="https://home-assistant.io/components/camera.onvif/">
|
||
<meta property="fb:app_id" content="338291289691179">
|
||
<meta property="og:title" content="ONVIF Camera">
|
||
<meta property="og:site_name" content="Home Assistant">
|
||
<meta property="og:url" content="https://home-assistant.io/components/camera.onvif/">
|
||
<meta property="og:type" content="article">
|
||
<meta property="og:description" content="Instructions on how to integrate a ONVIF camera 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="ONVIF Camera">
|
||
<meta name="twitter:description" content="Instructions on how to integrate a ONVIF camera 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">
|
||
ONVIF Camera
|
||
</h1>
|
||
</header>
|
||
<hr class="divider">
|
||
<p>The <code class="highlighter-rouge">onvif</code> camera platform allows you to use an ONVIF camera in Home Assistant. This requires the <a href="/components/ffmpeg/"><code class="highlighter-rouge">ffmpeg</code> component</a> to be already configured.</p>
|
||
<p>To enable your ONVIF camera 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">camera</span><span class="pi">:</span>
|
||
<span class="pi">-</span> <span class="s">platform</span><span class="pi">:</span> <span class="s">onvif</span>
|
||
<span class="s">host</span><span class="pi">:</span> <span class="s">192.168.1.111</span>
|
||
</code></pre>
|
||
</div>
|
||
<p>Configuration variables:</p>
|
||
<ul>
|
||
<li><strong>host</strong> (<em>Required</em>): An IP or hostname of the camera.</li>
|
||
<li><strong>name</strong> (<em>Optional</em>): Override the name of your camera.</li>
|
||
<li><strong>username</strong> (<em>Optional</em>): The username for the camera.</li>
|
||
<li><strong>password</strong> (<em>Optional</em>): The password for the camera.</li>
|
||
<li><strong>port</strong> (<em>Optional</em>): The port for the camera. This defaults to 5000.</li>
|
||
<li><strong>profile</strong> (<em>Optional</em>): Video profile that will be used to obtain the stream. This defaults to 0. More details below.</li>
|
||
<li><strong>extra_arguments</strong> (<em>Optional</em>): Extra options to pass to <code class="highlighter-rouge">ffmpeg</code>, e.g. image quality or video filter options. More details in <a href="/components/ffmpeg">FFmpeg component</a>.</li>
|
||
</ul>
|
||
<p>Most of the Onvif cameras support more than one audio/video Profile. Each profile provides different image quality. Usually, the first profile has the highest quality, and it is the profile used by default. However, you may want to use a lower quality image. One of the reasons may be that your hardware isn’t able to render the highest quality image in real-time - especially when running on Raspberry Pi. Therefore you can choose which profile do you want to use by setting in config <code class="highlighter-rouge">profile</code> variable.</p>
|
||
<h3><a class="title-link" name="service-cameraonvif_ptz" href="#service-cameraonvif_ptz"></a> Service <code class="highlighter-rouge">camera.onvif_ptz</code></h3>
|
||
<p>If your ONVIF camera supports PTZ, you will be able to pan, tilt or zoom your camera.</p>
|
||
<table>
|
||
<thead>
|
||
<tr>
|
||
<th>Service data attribute</th>
|
||
<th>Description</th>
|
||
</tr>
|
||
</thead>
|
||
<tbody>
|
||
<tr>
|
||
<td><code class="highlighter-rouge">entity_id</code></td>
|
||
<td>String or list of strings that point at <code class="highlighter-rouge">entity_id</code>s of cameras. Else targets all.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><code class="highlighter-rouge">tilt</code></td>
|
||
<td>Tilt direction. Allowed values: <code class="highlighter-rouge">UP</code>, <code class="highlighter-rouge">DOWN</code></td>
|
||
</tr>
|
||
<tr>
|
||
<td><code class="highlighter-rouge">pan</code></td>
|
||
<td>Pan direction. Allowed values: <code class="highlighter-rouge">RIGHT</code>, <code class="highlighter-rouge">LEFT</code></td>
|
||
</tr>
|
||
<tr>
|
||
<td><code class="highlighter-rouge">zoom</code></td>
|
||
<td>Zoom. Allowed values: <code class="highlighter-rouge">ZOOM_IN</code>, <code class="highlighter-rouge">ZOOM_OUT</code></td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
<p>If you are running into trouble with this sensor, please refer to the <a href="/components/ffmpeg/#troubleshooting">Troubleshooting section</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/camera.onvif.markdown'>Edit this page on GitHub</a></div>
|
||
<div class='brand-logo-container section'>
|
||
<img src='/images/supported_brands/onvif.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/camera/onvif.py'>camera/onvif.py</a>
|
||
</div>
|
||
<div class='section'>
|
||
This is a platform for
|
||
<a href='/components/camera/'>the Camera component</a>.
|
||
</div>
|
||
<div class='section'>
|
||
<h1 class="title delta">Category Camera</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.august/'>August 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.proxy/'>Camera Proxy</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/camera.canary/'>Canary 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/ifttt.manything/'>ManyThing</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>
|
||
ONVIF Camera
|
||
</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.xeoma/'>Xeoma 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>
|
||
</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>
|