283 lines
16 KiB
HTML
283 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>Arlo Control Panel - Home Assistant</title>
|
||
<meta name="author" content="Home Assistant">
|
||
<meta name="description" content="Instructions how to setup the Netgear Arlo Base Stations as a control panel within Home Assistant.">
|
||
<meta name="viewport" content="width=device-width">
|
||
<link rel="canonical" href="https://home-assistant.io/components/alarm_control_panel.arlo/">
|
||
<meta property="fb:app_id" content="338291289691179">
|
||
<meta property="og:title" content="Arlo Control Panel">
|
||
<meta property="og:site_name" content="Home Assistant">
|
||
<meta property="og:url" content="https://home-assistant.io/components/alarm_control_panel.arlo/">
|
||
<meta property="og:type" content="article">
|
||
<meta property="og:description" content="Instructions how to setup the Netgear Arlo Base Stations as a control panel 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="Arlo Control Panel">
|
||
<meta name="twitter:description" content="Instructions how to setup the Netgear Arlo Base Stations as a control panel 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">
|
||
Arlo Control Panel
|
||
</h1>
|
||
</header>
|
||
<hr class="divider">
|
||
<p>The <code class="highlighter-rouge">arlo</code> alarm control panel allows you to control your <a href="https://arlo.netgear.com/">Arlo</a> base stations. You can use it to switch modes and trigger alarms from Home Assistant.</p>
|
||
<p>To get your <a href="https://arlo.netgear.com/">Arlo</a> base stations working within Home Assistant, please follow the instructions for the general <a href="/components/arlo">Arlo component</a>.</p>
|
||
<p>Once you have enabled the <a href="/components/arlo">Arlo component</a>, 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">alarm_control_panel</span><span class="pi">:</span>
|
||
<span class="pi">-</span> <span class="s">platform</span><span class="pi">:</span> <span class="s">arlo</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="home_mode_name" href="#home_mode_name"></a> home_mode_name</dt>
|
||
<dd>
|
||
<p class="desc"><span class="type">(<span class="string">string</span>)</span><span class="required">(Optional)</span><span class="description">Arlo base station does not have a built-in home mode. You can map one of your custom modes to home assistant’s home mode by setting the name of the custom mode in this configuration variable. The name of the custom mode should match exactly as you set it up in the Arlo app.</span></p>
|
||
</dd>
|
||
<dt><a class="title-link" name="away_mode_name" href="#away_mode_name"></a> away_mode_name</dt>
|
||
<dd>
|
||
<p class="desc"><span class="type">(<span class="string">string</span>)</span><span class="required">(Optional)</span><span class="description">Arlo base station does not have a built-in away mode. You can map one of your custom modes to home assistant’s away mode by setting the name of the custom mode in this configuration variable. The name of the custom mode should match eactly as you set it up in the Arlo app.</span></p>
|
||
<p class="default">Default value: <code class="highlighter-rouge">Armed</code> mode in Arlo</p>
|
||
</dd>
|
||
</dl>
|
||
</div>
|
||
<h2><a class="title-link" name="examples" href="#examples"></a> Examples</h2>
|
||
<p>These examples are based on an Arlo base station named <code class="highlighter-rouge">my_arlo_base_station</code>. Replace this with the name of your base station’s <code class="highlighter-rouge">entity_id</code>.</p>
|
||
<p>Arming the Arlo Base Station when leaving.</p>
|
||
<div class="language-yaml highlighter-rouge"><pre class="highlight"><code><span class="pi">-</span> <span class="s">id</span><span class="pi">:</span> <span class="s">arm_arlo_when_leaving</span>
|
||
<span class="s">alias</span><span class="pi">:</span> <span class="s">Arm Arlo cameras when leaving</span>
|
||
<span class="s">trigger</span><span class="pi">:</span>
|
||
<span class="s">platform</span><span class="pi">:</span> <span class="s">state</span>
|
||
<span class="s">entity_id</span><span class="pi">:</span> <span class="s">group.family</span>
|
||
<span class="s">from</span><span class="pi">:</span> <span class="s">home</span>
|
||
<span class="s">to</span><span class="pi">:</span> <span class="s">not_home</span>
|
||
<span class="s">action</span><span class="pi">:</span>
|
||
<span class="s">service</span><span class="pi">:</span> <span class="s">alarm_control_panel.alarm_arm_away</span>
|
||
<span class="s">entity_id</span><span class="pi">:</span> <span class="s">alarm_control_panel.my_arlo_base_station</span>
|
||
</code></pre>
|
||
</div>
|
||
<p>Setting Arlo to a custom mode (mapped to <code class="highlighter-rouge">home_mode_name</code> in <code class="highlighter-rouge">configuration.yaml</code>) when arriving.</p>
|
||
<div class="language-yaml highlighter-rouge"><pre class="highlight"><code><span class="pi">-</span> <span class="s">id</span><span class="pi">:</span> <span class="s">disarm_arlo_when_arriving</span>
|
||
<span class="s">alias</span><span class="pi">:</span> <span class="s">Set Arlo cameras to Home mode when arriving</span>
|
||
<span class="s">trigger</span><span class="pi">:</span>
|
||
<span class="s">platform</span><span class="pi">:</span> <span class="s">state</span>
|
||
<span class="s">entity_id</span><span class="pi">:</span> <span class="s">group.family</span>
|
||
<span class="s">from</span><span class="pi">:</span> <span class="s">not_home</span>
|
||
<span class="s">to</span><span class="pi">:</span> <span class="s">home</span>
|
||
<span class="s">action</span><span class="pi">:</span>
|
||
<span class="s">service</span><span class="pi">:</span> <span class="s">alarm_control_panel.alarm_arm_home</span>
|
||
<span class="s">entity_id</span><span class="pi">:</span> <span class="s">alarm_control_panel.my_arlo_base_station</span>
|
||
</code></pre>
|
||
</div>
|
||
<p>You can also completely disarm the Arlo base station by calling the <code class="highlighter-rouge">alarm_control_panel.alarm_disarm</code> service, and trigger the alarm by calling the <code class="highlighter-rouge">alarm_control_panel.alarm_trigger</code> service.</p>
|
||
<p>More examples and configuration options can be found on the <a href="/components/alarm_control_panel.manual/#examples">Manual Alarm Control page</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/alarm_control_panel.arlo.markdown'>Edit this page on GitHub</a></div>
|
||
<div class='brand-logo-container section'>
|
||
<img src='/images/supported_brands/arlo.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>: Cloud Polling
|
||
</div>
|
||
<div class='section'>
|
||
Introduced in release: 0.56
|
||
</div>
|
||
<div class='section'>
|
||
Source:
|
||
<a href='https://github.com/home-assistant/home-assistant/blob/master/homeassistant/components/alarm_control_panel/arlo.py'>alarm_control_panel/arlo.py</a>
|
||
</div>
|
||
<div class='section'>
|
||
This is a platform for
|
||
<a href='/components/alarm_control_panel/'>the Alarm Control Panels component</a>.
|
||
</div>
|
||
<div class='section'>
|
||
<h1 class='title delta'>Related components</h1>
|
||
<ul class='divided'>
|
||
<li><a href='/components/arlo/'>
|
||
Arlo
|
||
</a></li>
|
||
<li><a href='/components/camera.arlo/'>
|
||
Arlo Camera
|
||
</a></li>
|
||
<li><a href='/components/sensor.arlo/'>
|
||
Arlo Sensor
|
||
</a></li>
|
||
</ul>
|
||
</div>
|
||
<div class='section'>
|
||
<h1 class="title delta">Category Alarm</h1>
|
||
<ul class='divided'>
|
||
<li>
|
||
<a href='/components/alarm_control_panel.abode/'>Abode Alarm Control Panel</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/alarm_control_panel.alarmdotcom/'>Alarm.com Alarm Control Panel</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/alarm_control_panel.alarmdecoder/'>AlarmDecoder Alarm Control Panel</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/alarm_control_panel.ialarm/'>Antifurto365 iAlarm Control Panel</a>
|
||
</li>
|
||
<li>
|
||
Arlo Control Panel
|
||
</li>
|
||
<li>
|
||
<a href='/components/alarm_control_panel.canary/'>Canary Alarm Control Panel</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/alarm_control_panel.concord232/'>Concord232 Alarm Control Panel</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/alarm_control_panel.egardia/'>Egardia / Woonveilig Alarm Control Panel</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/alarm_control_panel.envisalink/'>Envisalink Alarm</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/envisalink/'>Envisalink Alarm Control Panel</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/alarm_control_panel.totalconnect/'>Honeywell TotalConnect Alarm Control Panel</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/alarm_control_panel.mqtt/'>MQTT Alarm Control Panel</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/alarm_control_panel.manual/'>Manual Alarm Control Panel</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/alarm_control_panel.manual_mqtt/'>Manual Alarm Control Panel with MQTT Support</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/alarm_control_panel.nx584/'>NX584 Alarm Control Panel</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/alarm_control_panel.satel_integra/'>Satel Integra Alarm Control Panel</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/alarm_control_panel.simplisafe/'>SimpliSafe Alarm Control Panel</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/alarm_control_panel.spc/'>Vanderbilt SPC Alarm</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/alarm_control_panel.verisure/'>Verisure Alarm</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/alarm_control_panel.wink/'>Wink Alarm</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>
|