home-assistant.github.io/components/camera.dispatcher/index.html
2017-03-25 23:02:21 +00:00

198 lines
9.1 KiB
HTML
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

<!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>Dispatcher IP Camera - Home Assistant</title>
<meta name="author" content="Home Assistant">
<meta name="description" content="Instructions how to integrate internal dispatcher cameras within Home Assistant.">
<meta name="viewport" content="width=device-width">
<link rel="canonical" href="https://home-assistant.io/components/camera.dispatcher/">
<meta property="fb:app_id" content="338291289691179">
<meta property="og:title" content="Dispatcher IP Camera">
<meta property="og:site_name" content="Home Assistant">
<meta property="og:url" content="https://home-assistant.io/components/camera.dispatcher/">
<meta property="og:type" content="article">
<meta property="og:description" content="Instructions how to integrate internal dispatcher 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="Dispatcher IP Camera">
<meta name="twitter:description" content="Instructions how to integrate internal dispatcher 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" 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">
Dispatcher IP Camera
</h1>
</header>
<hr class="divider">
<p class="note">
This platform is meant for developers only.
</p>
<p>The <code class="highlighter-rouge">dispatcher</code> camera platform allows developers to create virtual cameras.</p>
<p>You would normally not add this camera to your configuration directly but have it be discovered by one of the components that uses it.</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">dispatcher</span>
<span class="s">signal</span><span class="pi">:</span> <span class="s">name_of_dispatcher_signal</span>
</code></pre>
</div>
<p>To update the image from another piece of code, run this from an async context:</p>
<div class="language-python highlighter-rouge"><pre class="highlight"><code><span class="kn">from</span> <span class="nn">homeassistant.helpers.dispatcher</span> <span class="kn">import</span> <span class="n">async_dispatcher_send</span>
<span class="n">async_dispatcher_send</span><span class="p">(</span><span class="n">hass</span><span class="p">,</span> <span class="s">'name_of_dispatcher_signal'</span><span class="p">,</span> <span class="n">image_data</span><span class="p">)</span>
</code></pre>
</div>
<p>Configuration variables:</p>
<ul>
<li><strong>signal</strong> (<em>Required</em>): The signal name of dispatcher signal they send image data to this camera.</li>
<li><strong>name</strong> (<em>Optional</em>): This parameter allows you to override the name of your camera.</li>
</ul>
</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.dispatcher.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: 0.4
</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.amcrest/'>Amcrest IP Camera</a>
</li>
<li>
<a href='/components/camera.blink/'>Blink Camera</a>
</li>
<li>
<a href='/components/camera.bloomsky/'>BloomSky Camera</a>
</li>
<li>
Dispatcher IP Camera
</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/ifttt.manything/'>ManyThing</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.rpi_camera/'>Raspberry Pi Camera</a>
</li>
<li>
<a href='/components/camera.synology/'>Synology 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.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>.<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>