jeena/home-assistant.github.io
1
0
Fork 0
Code Issues Pull requests Projects Packages Wiki Activity Actions

Site updated at 2018-01-15 11:59:29 UTC

Browse source
This commit is contained in:
Travis CI 2018-01-15 11:59:30 +00:00
parent bd22e4b200
commit bf18f14fe7
772 changed files with 16363 additions and 3384 deletions
Download patch file Download diff file Expand all files Collapse all files

67
components/alarm_control_panel.mqtt/index.html
View file

@ -92,17 +92,62 @@
<span class="s">command_topic</span><span class="pi">:</span> <span class="s2">"</span><span class="s">home/alarm/set"</span>
</code></pre>
</div>
<p>Configuration variables:</p>
<ul>
<li><strong>state_topic</strong> (<em>Required</em>): The MQTT topic subscribed to receive state updates.</li>
<li><strong>command_topic</strong> (<em>Required</em>): The MQTT topic to publish commands to change the alarm state.</li>
<li><strong>name</strong> (<em>Optional</em>): The name of the alarm. Default is ‘MQTT Alarm’.</li>
<li><strong>qos</strong> (<em>Optional</em>): The maximum QoS level of the state topic. Default is 0. This QoS will also be used to publishing messages.</li>
<li><strong>payload_disarm</strong> (<em>Optional</em>): The payload to disarm your Alarm Panel. Default is “DISARM”.</li>
<li><strong>payload_arm_home</strong> (<em>Optional</em>): The payload to set armed-home mode on your Alarm Panel. Default is “ARM_HOME”.</li>
<li><strong>payload_arm_away</strong> (<em>Optional</em>): The payload to set armed-away mode on your Alarm Panel. Default is “ARM_AWAY”.</li>
<li><strong>code</strong> (<em>Optional</em>): If defined, specifies a code to enable or disable the alarm in the frontend.</li>
</ul>
<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="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 of the alarm.</span></p>
<p class="default">Default value: MQTT Alarm</p>
</dd>
<dt><a class="title-link" name="state_topic" href="#state_topic"></a> state_topic</dt>
<dd>
<p class="desc"><span class="type">(<span class="string">string</span>)</span><span class="required">(Required)</span><span class="description">The MQTT topic subscribed to receive state updates.</span></p>
</dd>
<dt><a class="title-link" name="command_topic" href="#command_topic"></a> command_topic</dt>
<dd>
<p class="desc"><span class="type">(<span class="string">string</span>)</span><span class="required">(Required)</span><span class="description">The MQTT topic to publish commands to change the alarm state.</span></p>
</dd>
<dt><a class="title-link" name="qos" href="#qos"></a> qos</dt>
<dd>
<p class="desc"><span class="type">(<span class="integer">integer</span>)</span><span class="required">(Optional)</span><span class="description">The maximum QoS level of the state topic.</span></p>
<p class="default">Default value: 0</p>
</dd>
<dt><a class="title-link" name="payload_disarm" href="#payload_disarm"></a> payload_disarm</dt>
<dd>
<p class="desc"><span class="type">(<span class="string">string</span>)</span><span class="required">(Optional)</span><span class="description">The payload to disarm your Alarm Panel.</span></p>
<p class="default">Default value: DISARM</p>
</dd>
<dt><a class="title-link" name="payload_arm_home" href="#payload_arm_home"></a> payload_arm_home</dt>
<dd>
<p class="desc"><span class="type">(<span class="string">string</span>)</span><span class="required">(Optional)</span><span class="description">The payload to set armed-home mode on your Alarm Panel.</span></p>
<p class="default">Default value: ARM_HOME</p>
</dd>
<dt><a class="title-link" name="payload_arm_away" href="#payload_arm_away"></a> payload_arm_away</dt>
<dd>
<p class="desc"><span class="type">(<span class="string">string</span>)</span><span class="required">(Optional)</span><span class="description">The payload to set armed-away mode on your Alarm Panel.</span></p>
<p class="default">Default value: ARM_AWAY</p>
</dd>
<dt><a class="title-link" name="code" href="#code"></a> code</dt>
<dd>
<p class="desc"><span class="type">(<span class="string">string</span>)</span><span class="required">(Optional)</span><span class="description">If defined, specifies a code to enable or disable the alarm in the frontend.</span></p>
</dd>
<dt><a class="title-link" name="availability_topic" href="#availability_topic"></a> availability_topic</dt>
<dd>
<p class="desc"><span class="type">(<span class="string">string</span>)</span><span class="required">(Optional)</span><span class="description">The MQTT topic subscribed to receive availability (online/offline) updates.</span></p>
</dd>
<dt><a class="title-link" name="payload_available" href="#payload_available"></a> payload_available</dt>
<dd>
<p class="desc"><span class="type">(<span class="string">string</span>)</span><span class="required">(Optional)</span><span class="description">The payload that represents the available state.</span></p>
<p class="default">Default value: online</p>
</dd>
<dt><a class="title-link" name="payload_not_available" href="#payload_not_available"></a> payload_not_available</dt>
<dd>
<p class="desc"><span class="type">(<span class="string">string</span>)</span><span class="required">(Optional)</span><span class="description">The payload that represents the unavailable state.</span></p>
<p class="default">Default value: offline</p>
</dd>
</dl>
</div>
</article>
</div>
<aside id="sidebar" class="grid__item one-third lap-one-whole palm-one-whole">