327 lines
16 KiB
HTML
327 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>Xeoma Camera - Home Assistant</title>
|
||
<meta name="author" content="Home Assistant">
|
||
<meta name="description" content="Instructions on how to integrate camera video feeds from a Xeoma server in Home Assistant">
|
||
<meta name="viewport" content="width=device-width">
|
||
<link rel="canonical" href="https://home-assistant.io/components/camera.xeoma/">
|
||
<meta property="fb:app_id" content="338291289691179">
|
||
<meta property="og:title" content="Xeoma Camera">
|
||
<meta property="og:site_name" content="Home Assistant">
|
||
<meta property="og:url" content="https://home-assistant.io/components/camera.xeoma/">
|
||
<meta property="og:type" content="article">
|
||
<meta property="og:description" content="Instructions on how to integrate camera video feeds from a Xeoma server in 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="Xeoma Camera">
|
||
<meta name="twitter:description" content="Instructions on how to integrate camera video feeds from a Xeoma server in 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">
|
||
Xeoma Camera
|
||
</h1>
|
||
</header>
|
||
<hr class="divider">
|
||
<p>The <code class="highlighter-rouge">Xeoma</code> camera platform allows you to view the video feeds from a <a href="http://felenasoft.com/xeoma">Xeoma</a> video surveillance server.</p>
|
||
<p>To enable Xeoma camera feeds, add the following lines to your <code class="highlighter-rouge">configuration.yaml</code>:</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">xeoma</span>
|
||
<span class="s">host</span><span class="pi">:</span> <span class="s">http://localhost:10090</span>
|
||
</code></pre>
|
||
</div>
|
||
<div class="config-vars">
|
||
<h3><a class="title-link" name="configuration-variables" href="#configuration-variables"></a> Configuration Variables</h3>
|
||
<dl class="">
|
||
<dt><a class="title-link" name="host" href="#host"></a> host</dt>
|
||
<dd>
|
||
<p class="desc"><span class="type">(<span class="string">string</span>)</span><span class="required">(Required)</span><span class="description">The URL of the Xeoma server’s web interface.</span></p>
|
||
</dd>
|
||
<dt><a class="title-link" name="username" href="#username"></a> username</dt>
|
||
<dd>
|
||
<p class="desc"><span class="type">(<span class="string">string</span>)</span><span class="required">(Optional)</span><span class="description">The username used to access the Xeoma server’s web interface.</span></p>
|
||
</dd>
|
||
<dt><a class="title-link" name="password" href="#password"></a> password</dt>
|
||
<dd>
|
||
<p class="desc"><span class="type">(<span class="string">string</span>)</span><span class="required">(Optional)</span><span class="description">The password used to access the Xeoma server’s web interface.</span></p>
|
||
</dd>
|
||
<dt><a class="title-link" name="new_version" href="#new_version"></a> new_version</dt>
|
||
<dd>
|
||
<p class="desc"><span class="type">(<span class="boolean">boolean</span>)</span><span class="required">(Optional)</span><span class="description">Set to false if the Xeoma server version is 17.5 or earlier.</span></p>
|
||
<p class="default">Default value: true</p>
|
||
</dd>
|
||
<dt><a class="title-link" name="cameras" href="#cameras"></a> cameras</dt>
|
||
<dd>
|
||
<p class="desc"><span class="type">(<span class="list">list</span>)</span><span class="required">(Optional)</span><span class="description">List of customizations for individual Xeoma cameras.</span></p>
|
||
</dd>
|
||
<dd>
|
||
<dl class="nested">
|
||
<dt><a class="title-link" name="image_name" href="#image_name"></a> image_name</dt>
|
||
<dd>
|
||
<p class="desc"><span class="type">(<span class="string">string</span>)</span><span class="required">(Required)</span><span class="description">The name of the JPEG image for this camera as configured in Xeoma (without .jpg extension).</span></p>
|
||
</dd>
|
||
<dt><a class="title-link" name="name" href="#name"></a> name</dt>
|
||
<dd>
|
||
<p class="desc"><span class="type">(<span class="string">string</span>)</span><span class="required">(Optional)</span><span class="description">The name to display in the frontend for this camera.</span></p>
|
||
<p class="default">Default value: The <code class="highlighter-rouge">image_name</code> for this camera.</p>
|
||
</dd>
|
||
<dt><a class="title-link" name="hide" href="#hide"></a> hide</dt>
|
||
<dd>
|
||
<p class="desc"><span class="type">(<span class="boolean">boolean</span>)</span><span class="required">(Optional)</span><span class="description">Don’t show this camera in Home Assistant.</span></p>
|
||
<p class="default">Default value: false</p>
|
||
</dd>
|
||
</dl>
|
||
</dd>
|
||
</dl>
|
||
</div>
|
||
<h2><a class="title-link" name="full-examples" href="#full-examples"></a> Full examples</h2>
|
||
<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">xeoma</span>
|
||
<span class="s">host</span><span class="pi">:</span> <span class="s">http://localhost:10090</span>
|
||
<span class="s">username</span><span class="pi">:</span> <span class="s">user</span>
|
||
<span class="s">password</span><span class="pi">:</span> <span class="s">secretpassword</span>
|
||
<span class="s">new_version</span><span class="pi">:</span> <span class="s">false</span>
|
||
<span class="s">cameras</span><span class="pi">:</span>
|
||
<span class="pi">-</span> <span class="s">image_name</span><span class="pi">:</span> <span class="s">front_porch</span>
|
||
<span class="s">name</span><span class="pi">:</span> <span class="s">Front Porch</span>
|
||
<span class="pi">-</span> <span class="s">image_name</span><span class="pi">:</span> <span class="s">back_patio</span>
|
||
<span class="s">hide</span><span class="pi">:</span> <span class="s">true</span>
|
||
</code></pre>
|
||
</div>
|
||
<p>To use this platform, you must have the Xeoma Web Server module enabled in at least one of your camera chains.</p>
|
||
<p>This platform will parse the Xeoma web interface to find all enabled cameras and add them all to Home Assistant. You can
|
||
hide individual cameras using the platform configuration.</p>
|
||
<p>The <code class="highlighter-rouge">image_name</code> configuration value for each camera should match the name supplied to the Xeoma Web Server configuration (under <em>Path to access images</em>) with the <em>.jpg</em> extension removed.</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.xeoma.markdown'>Edit this page on GitHub</a></div>
|
||
<div class='brand-logo-container section'>
|
||
<img src='/images/supported_brands/xeoma.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>: Local Polling
|
||
</div>
|
||
<div class='section'>
|
||
Introduced in release: 0.62
|
||
</div>
|
||
<div class='section'>
|
||
Source:
|
||
<a href='https://github.com/home-assistant/home-assistant/blob/master/homeassistant/components/camera/xeoma.py'>camera/xeoma.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>
|
||
<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>
|
||
Xeoma Camera
|
||
</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>
|