297 lines
16 KiB
HTML
297 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>Manual Alarm Control Panel with MQTT Support - Home Assistant</title>
|
||
<meta name="author" content="Home Assistant">
|
||
<meta name="description" content="Instructions how to integrate manual alarms into Home Assistant with MQTT support.">
|
||
<meta name="viewport" content="width=device-width">
|
||
<link rel="canonical" href="https://home-assistant.io/components/alarm_control_panel.manual_mqtt/">
|
||
<meta property="fb:app_id" content="338291289691179">
|
||
<meta property="og:title" content="Manual Alarm Control Panel with MQTT Support">
|
||
<meta property="og:site_name" content="Home Assistant">
|
||
<meta property="og:url" content="https://home-assistant.io/components/alarm_control_panel.manual_mqtt/">
|
||
<meta property="og:type" content="article">
|
||
<meta property="og:description" content="Instructions how to integrate manual alarms into Home Assistant with MQTT support.">
|
||
<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="Manual Alarm Control Panel with MQTT Support">
|
||
<meta name="twitter:description" content="Instructions how to integrate manual alarms into Home Assistant with MQTT support.">
|
||
<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">
|
||
Manual Alarm Control Panel with MQTT Support
|
||
</h1>
|
||
</header>
|
||
<hr class="divider">
|
||
<p>This platform extends the <a href="/components/alarm_control_panel.manual/">manual alarm</a> by adding support for MQTT control of the alarm by a remote device. It can be used to create external keypads which simply change the state of the manual alarm in Home Assistant.</p>
|
||
<p>It’s essentially the opposite of the <a href="/components/alarm_control_panel.mqtt/">MQTT Alarm Panel</a> which allows Home Assistant to observe an existing, fully-featured alarm where all of the alarm logic is embedded in that physical device.</p>
|
||
<p>The component will accept the following commands from your Alarm Panel via the <code class="highlighter-rouge">command_topic</code>:</p>
|
||
<ul>
|
||
<li><code class="highlighter-rouge">DISARM</code></li>
|
||
<li><code class="highlighter-rouge">ARM_HOME</code></li>
|
||
<li><code class="highlighter-rouge">ARM_AWAY</code></li>
|
||
<li><code class="highlighter-rouge">ARM_NIGHT</code></li>
|
||
</ul>
|
||
<p>When the state of the manual alarm changes, Home Assistant will publish one of the following states to the <code class="highlighter-rouge">state_topic</code>:</p>
|
||
<ul>
|
||
<li>‘disarmed’</li>
|
||
<li>‘armed_home’</li>
|
||
<li>‘armed_away’</li>
|
||
<li>‘armed_night’</li>
|
||
<li>‘pending’</li>
|
||
<li>‘triggered’</li>
|
||
</ul>
|
||
<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">manual_mqtt</span>
|
||
<span class="s">state_topic</span><span class="pi">:</span> <span class="s">home/alarm</span>
|
||
<span class="s">command_topic</span><span class="pi">:</span> <span class="s">home/alarm/set</span>
|
||
</code></pre>
|
||
</div>
|
||
<p>Configuration variables:</p>
|
||
<p>All configuration variables from the base manual alarm platform are available:</p>
|
||
<ul>
|
||
<li><strong>name</strong> (<em>Optional</em>): The name of the alarm. Default is “HA Alarm”.</li>
|
||
<li><strong>code</strong> (<em>Optional</em>): If defined, specifies a code to enable or disable the alarm in the frontend. This code is not required for MQTT interactions.</li>
|
||
<li><strong>pending_time</strong> (<em>Optional</em>): The time in seconds of the pending time before arming the alarm. Default is 60 seconds.</li>
|
||
<li><strong>trigger_time</strong> (<em>Optional</em>): The time in seconds of the trigger time in which the alarm is firing. Default is 120 seconds.</li>
|
||
<li><strong>disarm_after_trigger</strong> (<em>Optional</em>): If true, the alarm will automatically disarm after it has been triggered instead of returning to the previous state.</li>
|
||
<li>
|
||
<table>
|
||
<tbody>
|
||
<tr>
|
||
<td>**armed_home</td>
|
||
<td>armed_away</td>
|
||
<td>armed_night</td>
|
||
<td>triggered** (<em>Optional</em>): State specific settings</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
<ul>
|
||
<li><strong>pending_time</strong>: State specific pending time override.</li>
|
||
</ul>
|
||
</li>
|
||
</ul>
|
||
<p>Additionally, the following MQTT configuration variables are also available:</p>
|
||
<ul>
|
||
<li><strong>state_topic</strong> (<em>Required</em>): The MQTT topic HA will publish state updates to.</li>
|
||
<li><strong>command_topic</strong> (<em>Required</em>): The MQTT topic HA will subscribe to, to receive commands from a remote device to change the alarm state.</li>
|
||
<li><strong>qos</strong> (<em>Optional</em>): The maximum QoS level for subscribing and publishing to MQTT messages. Default is 0.</li>
|
||
<li><strong>payload_disarm</strong> (<em>Optional</em>): The payload to disarm this Alarm Panel. Default is “DISARM”.</li>
|
||
<li><strong>payload_arm_home</strong> (<em>Optional</em>): The payload to set armed-home mode on this Alarm Panel. Default is “ARM_HOME”.</li>
|
||
<li><strong>payload_arm_away</strong> (<em>Optional</em>): The payload to set armed-away mode on this Alarm Panel. Default is “ARM_AWAY”.</li>
|
||
<li><strong>payload_arm_night</strong> (<em>Optional</em>): The payload to set armed-night mode on this Alarm Panel. Default is “ARM_NIGHT”.</li>
|
||
</ul>
|
||
<p>In the config example below, armed_home state will have no pending time and triggered state will have a pending time of 20 seconds whereas armed_away state will have a default pending time of 30 seconds.</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">manual_mqtt</span>
|
||
<span class="s">state_topic</span><span class="pi">:</span> <span class="s">home/alarm</span>
|
||
<span class="s">command_topic</span><span class="pi">:</span> <span class="s">home/alarm/set</span>
|
||
<span class="s">pending_time</span><span class="pi">:</span> <span class="s">30</span>
|
||
<span class="s">armed_home</span><span class="pi">:</span>
|
||
<span class="s">pending_time</span><span class="pi">:</span> <span class="s">0</span>
|
||
<span class="s">triggered</span><span class="pi">:</span>
|
||
<span class="s">pending_time</span><span class="pi">:</span> <span class="s">20</span>
|
||
<span class="s">trigger_time</span><span class="pi">:</span> <span class="s">4</span>
|
||
</code></pre>
|
||
</div>
|
||
<h2><a class="title-link" name="examples" href="#examples"></a> Examples</h2>
|
||
<p>Refer to the <a href="/components/alarm_control_panel.manual/#examples">Manual Alarm Control page</a> for some real life examples of how to use this panel.</p>
|
||
<h2><a class="title-link" name="mqtt-control" href="#mqtt-control"></a> MQTT Control</h2>
|
||
<p>The state of this alarm can be controlled using <a href="/components/mqtt/">MQTT</a>. Ensure you’ve configured that before adding this component.</p>
|
||
<p>To change the state of the alarm, publish one of the following messages to the <code class="highlighter-rouge">command_topic</code>:</p>
|
||
<ul>
|
||
<li><code class="highlighter-rouge">DISARM</code></li>
|
||
<li><code class="highlighter-rouge">ARM_HOME</code></li>
|
||
<li><code class="highlighter-rouge">ARM_AWAY</code></li>
|
||
<li><code class="highlighter-rouge">ARM_NIGHT</code></li>
|
||
</ul>
|
||
<p>To receive state updates from HA, subscribe to the <code class="highlighter-rouge">state_topic</code>. Home Assistant will publish a new message whenever the state changes:</p>
|
||
<ul>
|
||
<li><code class="highlighter-rouge">disarmed</code></li>
|
||
<li><code class="highlighter-rouge">armed_home</code></li>
|
||
<li><code class="highlighter-rouge">armed_away</code></li>
|
||
<li><code class="highlighter-rouge">armed_night</code></li>
|
||
<li><code class="highlighter-rouge">pending</code></li>
|
||
<li><code class="highlighter-rouge">triggered</code></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/alarm_control_panel.manual_mqtt.markdown'>Edit this page on GitHub</a></div>
|
||
<div class='brand-logo-container section'>
|
||
<img src='/images/supported_brands/home-assistant.png' />
|
||
</div>
|
||
<div class='section'>
|
||
Introduced in release: 0.5
|
||
</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">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.arlo/'>Arlo 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>
|
||
Manual Alarm Control Panel with MQTT Support
|
||
</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>
|