280 lines
16 KiB
HTML
280 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>AlarmDecoder Alarm Control Panel - Home Assistant</title>
|
||
<meta name="author" content="Home Assistant">
|
||
<meta name="description" content="Instructions how to setup the AlarmDecoder Alarm control panel within Home Assistant.">
|
||
<meta name="viewport" content="width=device-width">
|
||
<link rel="canonical" href="https://home-assistant.io/components/alarm_control_panel.alarmdecoder/">
|
||
<meta property="fb:app_id" content="338291289691179">
|
||
<meta property="og:title" content="AlarmDecoder Alarm Control Panel">
|
||
<meta property="og:site_name" content="Home Assistant">
|
||
<meta property="og:url" content="https://home-assistant.io/components/alarm_control_panel.alarmdecoder/">
|
||
<meta property="og:type" content="article">
|
||
<meta property="og:description" content="Instructions how to setup the AlarmDecoder Alarm 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="AlarmDecoder Alarm Control Panel">
|
||
<meta name="twitter:description" content="Instructions how to setup the AlarmDecoder Alarm 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">
|
||
AlarmDecoder Alarm Control Panel
|
||
</h1>
|
||
</header>
|
||
<hr class="divider">
|
||
<p>The <code class="highlighter-rouge">alarmdecoder</code> alarm control panel platform allows you to control your <a href="https://www.alarmdecoder.com">AlarmDecoder</a> alarms.</p>
|
||
<p>The requirement is that you have setup your <a href="/components/alarmdecoder/">AlarmDecoder hub</a>.</p>
|
||
<h3><a class="title-link" name="services" href="#services"></a> Services</h3>
|
||
<p>The Alarm Decoder component gives you access to several services for you to control your alarm with.</p>
|
||
<ul>
|
||
<li><code class="highlighter-rouge">alarm_arm_away</code>: Arms the alarm in away mode; all faults will trigger the alarm.</li>
|
||
<li><code class="highlighter-rouge">alarm_arm_home</code>: Arms the alarm in stay mode; faults to the doors or windows will trigger the alarm.</li>
|
||
<li><code class="highlighter-rouge">alarm_arm_night</code>: Arms the alarm in instant mode; all faults will trigger the alarm. Additionally, the entry delay is turned off on the doors.</li>
|
||
<li><code class="highlighter-rouge">alarm_disarm</code>: Disarms the alarm from any state. Also clears a <code class="highlighter-rouge">check_zone</code> flag after an alarm was triggered.</li>
|
||
<li><code class="highlighter-rouge">alarmdecoder_alarm_toggle_chime</code>: Toggles the alarm’s chime state.</li>
|
||
</ul>
|
||
<p><strong>Note</strong>: <code class="highlighter-rouge">alarm_arm_custom_bypass</code> and <code class="highlighter-rouge">alarm_trigger</code>, while available in the services list in Home Assistant, are not currently implemented in the Alarm Decoder component.</p>
|
||
<h3><a class="title-link" name="attributes" href="#attributes"></a> Attributes</h3>
|
||
<p>There are several attributes available on the alarm panel to give you more information about your alarm.</p>
|
||
<ul>
|
||
<li><code class="highlighter-rouge">ac_power</code>: Set to <code class="highlighter-rouge">true</code> if your system has AC power supplying it.</li>
|
||
<li><code class="highlighter-rouge">backlight_on</code>: Set to <code class="highlighter-rouge">true</code> if your keypad’s backlight is on.</li>
|
||
<li><code class="highlighter-rouge">battery_low</code>: Set to <code class="highlighter-rouge">true</code> if your system’s back-up battery is low.</li>
|
||
<li><code class="highlighter-rouge">check_zone</code>: Set to <code class="highlighter-rouge">true</code> if your system was recently triggered. When <code class="highlighter-rouge">check_zone</code> is <code class="highlighter-rouge">true</code>, it must be cleared by entering your code + 1 before attempting to rearm your alarm.</li>
|
||
<li><code class="highlighter-rouge">chime</code>: Set to <code class="highlighter-rouge">true</code> if your system’s chime is activated. When activated, your system will beep anytime a door or window is faulted while the alarm is disarmed.</li>
|
||
<li><code class="highlighter-rouge">entry_delay_off</code>: Set to <code class="highlighter-rouge">true</code> if your system is in “Instant” mode, meaning the alarm will sound on any faults.</li>
|
||
<li><code class="highlighter-rouge">programming_mode</code>: Set to <code class="highlighter-rouge">true</code> if your system is in programming mode.</li>
|
||
<li><code class="highlighter-rouge">ready</code>: Set to <code class="highlighter-rouge">true</code> if your system is ready to be armed. Any faults, including motions sensors, will make this value <code class="highlighter-rouge">false</code>.</li>
|
||
<li><code class="highlighter-rouge">zone_bypassed</code>: Set to <code class="highlighter-rouge">true</code> if your system is currently bypassing a zone.</li>
|
||
</ul>
|
||
<h3><a class="title-link" name="examples" href="#examples"></a> Examples</h3>
|
||
<p>Using a combination of the available services and attributes, you can create switch templates.</p>
|
||
<h4><a class="title-link" name="chime-status-and-control" href="#chime-status-and-control"></a> Chime Status and Control</h4>
|
||
<div class="language-yaml highlighter-rouge"><pre class="highlight"><code><span class="pi">-</span> <span class="s">platform</span><span class="pi">:</span> <span class="s">template</span>
|
||
<span class="s">switches</span><span class="pi">:</span>
|
||
<span class="s">alarm_chime</span><span class="pi">:</span>
|
||
<span class="s">friendly_name</span><span class="pi">:</span> <span class="s">Chime</span>
|
||
<span class="s">value_template</span><span class="pi">:</span> <span class="s2">"</span><span class="s">{{</span><span class="nv"> </span><span class="s">is_state_attr('alarm_control_panel.alarm_panel',</span><span class="nv"> </span><span class="s">'chime',</span><span class="nv"> </span><span class="s">true)</span><span class="nv"> </span><span class="s">}}"</span>
|
||
<span class="s">turn_on</span><span class="pi">:</span>
|
||
<span class="s">service</span><span class="pi">:</span> <span class="s">alarm_control_panel.alarmdecoder_alarm_toggle_chime</span>
|
||
<span class="s">data</span><span class="pi">:</span>
|
||
<span class="s">code</span><span class="pi">:</span> <span class="kt">!secret</span> <span class="s">alarm_code</span>
|
||
<span class="s">turn_off</span><span class="pi">:</span>
|
||
<span class="s">service</span><span class="pi">:</span> <span class="s">alarm_control_panel.alarmdecoder_alarm_toggle_chime</span>
|
||
<span class="s">data</span><span class="pi">:</span>
|
||
<span class="s">code</span><span class="pi">:</span> <span class="kt">!secret</span> <span class="s">alarm_code</span>
|
||
<span class="s">icon_template</span><span class="pi">:</span> <span class="pi">>-</span>
|
||
<span class="no">{% if is_state_attr('alarm_control_panel.alarm_panel', 'chime', true) %}</span>
|
||
<span class="no">mdi:bell-ring</span>
|
||
<span class="no">{% else %}</span>
|
||
<span class="no">mdi:bell-off</span>
|
||
<span class="no">{% endif %}</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/alarm_control_panel.alarmdecoder.markdown'>Edit this page on GitHub</a></div>
|
||
<div class='brand-logo-container section'>
|
||
<img src='/images/supported_brands/alarmdecoder.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 Push
|
||
</div>
|
||
<div class='section'>
|
||
Introduced in release: 0.43
|
||
</div>
|
||
<div class='section'>
|
||
Source:
|
||
<a href='https://github.com/home-assistant/home-assistant/blob/master/homeassistant/components/alarm_control_panel/alarmdecoder.py'>alarm_control_panel/alarmdecoder.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/alarmdecoder/'>
|
||
AlarmDecoder Alarm
|
||
</a></li>
|
||
<li><a href='/components/binary_sensor.alarmdecoder/'>
|
||
AlarmDecoder Binary Sensor
|
||
</a></li>
|
||
<li><a href='/components/sensor.alarmdecoder/'>
|
||
AlarmDecoder 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>
|
||
AlarmDecoder Alarm Control Panel
|
||
</li>
|
||
<li>
|
||
<a href='/components/alarm_control_panel.ialarm/'>Antifurto365 iAlarm Control Panel</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/alarm_control_panel.arlo/'>Arlo Control Panel</a>
|
||
</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>
|