307 lines
16 KiB
HTML
307 lines
16 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>Generic IP Camera - Home Assistant</title>
|
||
<meta name="author" content="Home Assistant">
|
||
<meta name="description" content="Instructions how to integrate IP cameras within Home Assistant.">
|
||
<meta name="viewport" content="width=device-width">
|
||
<link rel="canonical" href="https://home-assistant.io/components/camera.generic/">
|
||
<meta property="fb:app_id" content="338291289691179">
|
||
<meta property="og:title" content="Generic IP Camera">
|
||
<meta property="og:site_name" content="Home Assistant">
|
||
<meta property="og:url" content="https://home-assistant.io/components/camera.generic/">
|
||
<meta property="og:type" content="article">
|
||
<meta property="og:description" content="Instructions how to integrate IP 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="Generic IP Camera">
|
||
<meta name="twitter:description" content="Instructions how to integrate IP 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">
|
||
Generic IP Camera
|
||
</h1>
|
||
</header>
|
||
<hr class="divider">
|
||
<p>The <code class="highlighter-rouge">generic</code> camera platform allows you to integrate any IP camera or other URL into Home Assistant. Templates can be used to generate the URLs on the fly.</p>
|
||
<p>Home Assistant will serve the images via its server, making it possible to view your IP cameras while outside of your network. The endpoint is <code class="highlighter-rouge">/api/camera_proxy/camera.[name]</code>.</p>
|
||
<p>To enable this 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">generic</span>
|
||
<span class="s">still_image_url</span><span class="pi">:</span> <span class="s">http://194.218.96.92/jpg/image.jpg</span>
|
||
</code></pre>
|
||
</div>
|
||
<p>Configuration variables:</p>
|
||
<ul>
|
||
<li><strong>still_image_url</strong> (<em>Required</em>): The URL your camera serves the image on, eg. http://192.168.1.21:2112/. Can be a <a href="/topics/templating/">template</a>.</li>
|
||
<li><strong>name</strong> (<em>Optional</em>): This parameter allows you to override the name of your camera.</li>
|
||
<li><strong>username</strong> (<em>Optional</em>): The username for accessing your camera.</li>
|
||
<li><strong>password</strong> (<em>Optional</em>): The password for accessing your camera.</li>
|
||
<li><strong>authentication</strong> (<em>Optional</em>): Type for authenticating the requests <code class="highlighter-rouge">basic</code> (default) or <code class="highlighter-rouge">digest</code>.</li>
|
||
<li><strong>limit_refetch_to_url_change</strong> (<em>Optional</em>): True/false value (default: false). Limits re-fetching of the remote image to when the URL changes. Only relevant if using a template to fetch the remote image.</li>
|
||
<li><strong>content_type</strong> (<em>Optional</em>): Set the content type for the IP camera if it is not a jpg file (default: <code class="highlighter-rouge">image/jpeg</code>). Use <code class="highlighter-rouge">image/svg+xml</code> to add a dynamic svg file.</li>
|
||
</ul>
|
||
<p class="img">
|
||
<a href="/cookbook/google_maps_card/">
|
||
<img src="/images/components/camera/generic-google-maps.png" alt="Screenshot showing Google Maps integration in Home Assistant front end." />
|
||
Example showing the Generic camera platform pointing at a dynamic Google Map image.
|
||
</a>
|
||
</p>
|
||
<h2><a class="title-link" name="examples" href="#examples"></a> Examples</h2>
|
||
<p>In this section you find some real life examples of how to use this camera platform.</p>
|
||
<h3><a class="title-link" name="weather-graph-from-yrno" href="#weather-graph-from-yrno"></a> Weather graph from yr.no</h3>
|
||
<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">generic</span>
|
||
<span class="s">name</span><span class="pi">:</span> <span class="s">Weather</span>
|
||
<span class="s">still_image_url</span><span class="pi">:</span> <span class="s">https://www.yr.no/place/Norway/Oslo/Oslo/Oslo/meteogram.svg</span>
|
||
<span class="s">content_type</span><span class="pi">:</span> <span class="s1">'</span><span class="s">image/svg+xml'</span>
|
||
</code></pre>
|
||
</div>
|
||
<h3><a class="title-link" name="local-image-with-hassio" href="#local-image-with-hassio"></a> Local image with Hass.io</h3>
|
||
<p>You can show a static image with this platform. Just place the image here: <code class="highlighter-rouge">/config/www/your_image.png</code></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">generic</span>
|
||
<span class="s">name</span><span class="pi">:</span> <span class="s">Some Image</span>
|
||
<span class="s">still_image_url</span><span class="pi">:</span> <span class="s">https://127.0.0.1:8123/local/your_image.png</span>
|
||
</code></pre>
|
||
</div>
|
||
<h3><a class="title-link" name="sharing-a-camera-feed-from-one-home-assistant-instance-to-another" href="#sharing-a-camera-feed-from-one-home-assistant-instance-to-another"></a> Sharing a camera feed from one Home Assistant instance to another</h3>
|
||
<p>If you are running more than one Home Assistant instance (let’s call them the ‘host’ and ‘receiver’ instances) you may wish to display the camera feed from the host instance on the receiver instance. You can use the <a href="/developers/rest_api/#get-apicamera_proxycameraltentity_id">REST API</a> to access the camera feed on the host (IP address 127.0.0.5) and display it on the receiver instance by configuring the receiver with the the following:</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">generic</span>
|
||
<span class="s">name</span><span class="pi">:</span> <span class="s">Host instance camera feed</span>
|
||
<span class="s">still_image_url</span><span class="pi">:</span> <span class="s">https://127.0.0.5:8123/api/camera_proxy/camera.live_view</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.generic.markdown'>Edit this page on GitHub</a></div>
|
||
<div class='brand-logo-container section'>
|
||
<img src='/images/supported_brands/camcorder.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>: depends
|
||
</div>
|
||
<div class='section'>
|
||
Introduced in release: pre 0.7
|
||
</div>
|
||
<div class='section'>
|
||
Source:
|
||
<a href='https://github.com/home-assistant/home-assistant/blob/master/homeassistant/components/camera/generic.py'>camera/generic.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>
|
||
Generic IP Camera
|
||
</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>
|
||
<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.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>
|