home-assistant.github.io/components/abode/index.html
2017-11-05 14:24:39 +00:00

567 lines
23 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>Abode Home Security - Home Assistant</title>
<meta name="author" content="Home Assistant">
<meta name="description" content="Instructions on integrating Abode home security with Home Assistant.">
<meta name="viewport" content="width=device-width">
<link rel="canonical" href="https://home-assistant.io/components/abode/">
<meta property="fb:app_id" content="338291289691179">
<meta property="og:title" content="Abode Home Security">
<meta property="og:site_name" content="Home Assistant">
<meta property="og:url" content="https://home-assistant.io/components/abode/">
<meta property="og:type" content="article">
<meta property="og:description" content="Instructions on integrating Abode home security with 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="Abode Home Security">
<meta name="twitter:description" content="Instructions on integrating Abode home security with 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">
Abode Home Security
</h1>
</header>
<hr class="divider">
<p>The <code class="highlighter-rouge">abode</code> component will allow users to integrate their Abode Home Security systems into Home Assistant and use its alarm system and sensors to automate their homes.</p>
<p>Please visit the <a href="https://goabode.com/">Abode website</a> for further information about Abode Security.</p>
<p>There is currently support for the following device types within Home Assistant:</p>
<ul>
<li><a href="/components/alarm_control_panel.abode/">Alarm Control Panel</a>: Reports on the current alarm status and can be used to arm and disarm the system.</li>
<li><a href="/components/binary_sensor.abode/">Binary Sensor</a>: Reports on <code class="highlighter-rouge">Quick Actions</code>, <code class="highlighter-rouge">Door Contacts</code>, <code class="highlighter-rouge">Connectivity</code> sensors (remotes, keypads, and status indicators), <code class="highlighter-rouge">Moisture</code> sensors, and <code class="highlighter-rouge">Motion</code> or <code class="highlighter-rouge">Occupancy</code> sensors.</li>
<li><a href="/components/camera.abode/">Camera</a>: Reports on <code class="highlighter-rouge">Camera</code> devices and will download and show the latest captured still image.</li>
<li><a href="/components/cover.abode/">Cover</a>: Reports on <code class="highlighter-rouge">Secure Barriers</code> and can be used to open and close the cover.</li>
<li><a href="/components/cover.abode/">Lock</a>: Reports on <code class="highlighter-rouge">Door Locks</code> and can be used to lock and unlock the door.</li>
<li><a href="/components/light.abode/">Light</a>: Reports on <code class="highlighter-rouge">Dimmer</code> lights and can be used to dim, change color, or turn the light on and off.</li>
<li><a href="/components/switch.abode/">Switch</a>: Reports on <code class="highlighter-rouge">Power Switch</code> devices and can be used to turn the power switch on and off. Also reports on <code class="highlighter-rouge">Automations</code> set up in the Abode system and allows you to activate or deactivate them.</li>
<li><a href="/components/sensor.abode/">Sensor</a>: Reports on <code class="highlighter-rouge">Temperature</code>, <code class="highlighter-rouge">Humidity</code>, and <code class="highlighter-rouge">Light</code> sensors.</li>
</ul>
<h2><a class="title-link" name="configuration" href="#configuration"></a> Configuration</h2>
<p>To use Abode devices in your installation, add the following <code class="highlighter-rouge">abode</code> section 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">abode</span><span class="pi">:</span>
<span class="s">username</span><span class="pi">:</span> <span class="s">abode_username</span>
<span class="s">password</span><span class="pi">:</span> <span class="s">abode_password</span>
<span class="s">name</span><span class="pi">:</span> <span class="s">Abode Alarm System</span>
<span class="s">polling</span><span class="pi">:</span> <span class="s">False</span>
<span class="s">exclude</span><span class="pi">:</span>
<span class="pi">-</span> <span class="s1">'</span><span class="s">ZW:0000000034'</span>
<span class="pi">-</span> <span class="s1">'</span><span class="s">RF:00000011'</span>
<span class="s">lights</span><span class="pi">:</span>
<span class="pi">-</span> <span class="s1">'</span><span class="s">ZW:0000000022'</span>
</code></pre>
</div>
<p>Configuration variables:</p>
<ul>
<li><strong>username</strong> (<em>Required</em>): Username for your Abode account.</li>
<li><strong>password</strong> (<em>Required</em>): Password for your Abode account.</li>
<li><strong>name</strong> (<em>Optional</em>): The name for your alarm controller.</li>
<li><strong>polling</strong> (<em>Optional</em>): Enable polling if cloud push updating is less reliable. Will update the devices once every 30 seconds. Defaults to False.</li>
<li><strong>exclude</strong> (<em>Optional</em>): A list of devices to exclude from Home Assistant by their Abode <code class="highlighter-rouge">device_id</code> or <code class="highlighter-rouge">automation_id</code>, found within the component attributes.</li>
<li><strong>lights</strong> (<em>Optional</em>): A list of switch devices that Home Assistant should treat as lights by the switches Abode <code class="highlighter-rouge">device_id</code>, found within the component attributes.</li>
</ul>
<h2><a class="title-link" name="events" href="#events"></a> Events</h2>
<p>There are a number of events that can be triggered from Abode. They are grouped into the below events:</p>
<ul>
<li><strong>abode_alarm</strong>: Fired when an alarm event is triggered from Abode. This includes Smoke, CO, Panic, and Burglar alarms.</li>
<li><strong>abode_alarm_end</strong>: Fired when an alarm end event is triggered from Abode.</li>
<li><strong>abode_automation</strong>: Fired when an Automation is triggered from Abode.</li>
<li><strong>abode_panel_fault</strong>: Fired when there is a fault with the Abode hub. This includes events like loss of power, low battery, tamper switches, polling failures, and signal interference.</li>
<li><strong>abode_panel_restore</strong>: Fired when the panel fault is restored.</li>
</ul>
<p>All events have the fields:</p>
<table>
<thead>
<tr>
<th>Field</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><code class="highlighter-rouge">device_id</code></td>
<td>The Abode device ID of the event.</td>
</tr>
<tr>
<td><code class="highlighter-rouge">device_name</code></td>
<td>The Abode device name of the event.</td>
</tr>
<tr>
<td><code class="highlighter-rouge">device_type</code></td>
<td>The Abode device type of the event.</td>
</tr>
<tr>
<td><code class="highlighter-rouge">event_code</code></td>
<td>The event code of the event.</td>
</tr>
<tr>
<td><code class="highlighter-rouge">event_name</code></td>
<td>The name of the event.</td>
</tr>
<tr>
<td><code class="highlighter-rouge">event_type</code></td>
<td>The type of the event.</td>
</tr>
<tr>
<td><code class="highlighter-rouge">event_utc</code></td>
<td>The UTC timestamp of the event.</td>
</tr>
<tr>
<td><code class="highlighter-rouge">user_name</code></td>
<td>The Abode user that triggered the event, if applicable.</td>
</tr>
<tr>
<td><code class="highlighter-rouge">date</code></td>
<td>The date of the event in the format <code class="highlighter-rouge">MM/DD/YYYY</code>.</td>
</tr>
<tr>
<td><code class="highlighter-rouge">time</code></td>
<td>The time of the event in the format <code class="highlighter-rouge">HH:MM AM</code>.</td>
</tr>
</tbody>
</table>
<p>There is a unique list of known event_codes that can be found <a href="https://github.com/MisterWil/abodepy/files/1262019/timeline_events.txt">here</a>.</p>
<h2><a class="title-link" name="services" href="#services"></a> Services</h2>
<h3><a class="title-link" name="service-change_setting" href="#service-change_setting"></a> Service <code class="highlighter-rouge">change_setting</code></h3>
<p>Change settings on your Abode system. For a full list of settings and valid values, consult the <a href="https://github.com/MisterWil/abodepy/blob/master/README.rst#settings">AbodePy settings section</a>.</p>
<table>
<thead>
<tr>
<th>Service data attribute</th>
<th>Optional</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><code class="highlighter-rouge">setting</code></td>
<td>No</td>
<td>The setting you wish to change.</td>
</tr>
<tr>
<td><code class="highlighter-rouge">value</code></td>
<td>No</td>
<td>The value you wish to change the setting to.</td>
</tr>
</tbody>
</table>
<h3><a class="title-link" name="service-capture_image" href="#service-capture_image"></a> Service <code class="highlighter-rouge">capture_image</code></h3>
<p>Request a new still image from your Abode IR camera.</p>
<table>
<thead>
<tr>
<th>Service data attribute</th>
<th>Optional</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><code class="highlighter-rouge">entity_id</code></td>
<td>No</td>
<td>String or list of strings that point at <code class="highlighter-rouge">entity_id</code>s of Abode cameras.</td>
</tr>
</tbody>
</table>
<h3><a class="title-link" name="service-trigger_quick_action" href="#service-trigger_quick_action"></a> Service <code class="highlighter-rouge">trigger_quick_action</code></h3>
<p>Trigger a quick action automation on your Abode system.</p>
<table>
<thead>
<tr>
<th>Service data attribute</th>
<th>Optional</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><code class="highlighter-rouge">entity_id</code></td>
<td>No</td>
<td>String or list of strings that point at <code class="highlighter-rouge">entity_id</code>s of binary_sensors that represent your Abode quick actions.</td>
</tr>
</tbody>
</table>
</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/abode.markdown'>Edit this page on GitHub</a></div>
<div class='brand-logo-container section'>
<img src='/images/supported_brands/abode.jpg' />
</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 Push
</div>
<div class='section'>
Introduced in release: 0.52
</div>
<div class='section'>
<h1 class='title delta'>Related components</h1>
<ul class='divided'>
<li><a href='/components/alarm_control_panel.abode/'>
Abode Alarm Control Panel
</a></li>
<li><a href='/components/binary_sensor.abode/'>
Abode Binary Sensor
</a></li>
<li><a href='/components/camera.abode/'>
Abode Camera
</a></li>
<li><a href='/components/cover.abode/'>
Abode Cover
</a></li>
<li><a href='/components/light.abode/'>
Abode Light
</a></li>
<li><a href='/components/lock.abode/'>
Abode Lock
</a></li>
<li><a href='/components/sensor.abode/'>
Abode Sensor
</a></li>
<li><a href='/components/switch.abode/'>
Abode Switch
</a></li>
</ul>
</div>
<div class='section'>
<h1 class="title delta">Category Hub</h1>
<ul class='divided'>
<li>
<a href='/components/apcupsd/'>APCUPSd</a>
</li>
<li>
Abode Home Security
</li>
<li>
<a href='/components/alarmdecoder/'>AlarmDecoder Alarm</a>
</li>
<li>
<a href='/components/amcrest/'>Amcrest IP Camera</a>
</li>
<li>
<a href='/components/android_ip_webcam/'>Android IP Webcam</a>
</li>
<li>
<a href='/components/apple_tv/'>Apple TV</a>
</li>
<li>
<a href='/components/arlo/'>Arlo</a>
</li>
<li>
<a href='/components/axis/'>Axis</a>
</li>
<li>
<a href='/components/wemo/'>Belkin WeMo</a>
</li>
<li>
<a href='/components/blink/'>Blink</a>
</li>
<li>
<a href='/components/bloomsky/'>BloomSky</a>
</li>
<li>
<a href='/components/digital_ocean/'>Digital Ocean</a>
</li>
<li>
<a href='/components/doorbird/'>DoorBird</a>
</li>
<li>
<a href='/components/dyson/'>Dyson</a>
</li>
<li>
<a href='/components/eight_sleep/'>Eight Sleep</a>
</li>
<li>
<a href='/components/emulated_hue/'>Emulated Hue Bridge</a>
</li>
<li>
<a href='/components/enocean/'>EnOcean</a>
</li>
<li>
<a href='/components/ffmpeg/'>FFmpeg</a>
</li>
<li>
<a href='/components/homematic/'>Homematic</a>
</li>
<li>
<a href='/components/tradfri/'>IKEA Trådfri (Tradfri)</a>
</li>
<li>
<a href='/components/isy994/'>ISY994 Controller</a>
</li>
<li>
<a href='/components/insteon_local/'>Insteon (local)</a>
</li>
<li>
<a href='/components/insteon_hub/'>Insteon Hub</a>
</li>
<li>
<a href='/components/insteon_plm/'>Insteon PLM</a>
</li>
<li>
<a href='/components/joaoapps_join/'>Joaoapps Join</a>
</li>
<li>
<a href='/components/juicenet/'>Juicenet</a>
</li>
<li>
<a href='/components/knx/'>KNX</a>
</li>
<li>
<a href='/components/kira/'>Kira</a>
</li>
<li>
<a href='/components/lametric/'>LaMetric</a>
</li>
<li>
<a href='/components/linode/'>Linode</a>
</li>
<li>
<a href='/components/litejet/'>LiteJet</a>
</li>
<li>
<a href='/components/lutron/'>Lutron</a>
</li>
<li>
<a href='/components/lutron_caseta/'>Lutron Caseta</a>
</li>
<li>
<a href='/components/mqtt/'>MQTT</a>
</li>
<li>
<a href='/components/raincloud/'>Melnor Raincloud</a>
</li>
<li>
<a href='/components/microsoft_face/'>Microsoft Face</a>
</li>
<li>
<a href='/components/mochad/'>Mochad</a>
</li>
<li>
<a href='/components/modbus/'>Modbus</a>
</li>
<li>
<a href='/components/mysensors/'>MySensors</a>
</li>
<li>
<a href='/components/neato/'>Neato Robotics</a>
</li>
<li>
<a href='/components/nest/'>Nest</a>
</li>
<li>
<a href='/components/netatmo/'>Netatmo</a>
</li>
<li>
<a href='/components/nuimo_controller/'>Nuimo controller</a>
</li>
<li>
<a href='/components/octoprint/'>OctoPrint</a>
</li>
<li>
<a href='/components/pilight/'>Pilight</a>
</li>
<li>
<a href='/components/qwikswitch/'>QwikSwitch QSUSB Hub</a>
</li>
<li>
<a href='/components/rflink/'>RFLink</a>
</li>
<li>
<a href='/components/rfxtrx/'>RFXtrx</a>
</li>
<li>
<a href='/components/switch.rainbird/'>Rain Bird Switch</a>
</li>
<li>
<a href='/components/ring/'>Ring</a>
</li>
<li>
<a href='/components/scsgate/'>SCSGate</a>
</li>
<li>
<a href='/components/spc/'>SPC</a>
</li>
<li>
<a href='/components/satel_integra/'>Satel Integra Alarm</a>
</li>
<li>
<a href='/components/skybell/'>Skybell</a>
</li>
<li>
<a href='/components/sleepiq/'>SleepIQ</a>
</li>
<li>
<a href='/components/tado/'>Tado</a>
</li>
<li>
<a href='/components/telegram_bot/'>Telegram chatbot</a>
</li>
<li>
<a href='/components/tellstick/'>TellStick</a>
</li>
<li>
<a href='/components/tellduslive/'>Telldus Live</a>
</li>
<li>
<a href='/components/tesla/'>Tesla</a>
</li>
<li>
<a href='/components/thethingsnetwork/'>The Things Network</a>
</li>
<li>
<a href='/components/toon/'>Toon</a>
</li>
<li>
<a href='/components/twilio/'>Twilio</a>
</li>
<li>
<a href='/components/usps/'>USPS</a>
</li>
<li>
<a href='/components/velbus/'>Velbus</a>
</li>
<li>
<a href='/components/velux/'>Velux</a>
</li>
<li>
<a href='/components/vera/'>Vera</a>
</li>
<li>
<a href='/components/verisure/'>Verisure</a>
</li>
<li>
<a href='/components/volvooncall/'>Volvo On Call</a>
</li>
<li>
<a href='/components/wink/'>Wink</a>
</li>
<li>
<a href='/components/xiaomi_aqara/'>Xiaomi Gateway (Aqara)</a>
</li>
<li>
<a href='/components/zwave/'>Z-Wave</a>
</li>
<li>
<a href='/components/comfoconnect/'>Zehnder ComfoAir Q Ventilation</a>
</li>
<li>
<a href='/components/zha/'>Zigbee Home Automation</a>
</li>
<li>
<a href='/components/zoneminder/'>ZoneMinder</a>
</li>
<li>
<a href='/components/ecobee/'>ecobee</a>
</li>
<li>
<a href='/components/gc100/'>gc100</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>