Site updated at 2017-12-17 16:27:07 UTC

components/alarm_control_panel.manual_mqtt/index.html

@@ -100,29 +100,24 @@
 </code></pre>
 </div>
 <p>Configuration variables:</p>
-<p>All configuration variables from the base manual alarm platform are available:</p>
+<p>The following 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>code_template</strong> (<em>Optional</em>): If defined, returns a code to enable or disable the alarm in the frontend; an empty string disables checking the code.  Inside the template, the variables <strong>from_state</strong> and <strong>to_state</strong> identify the current and desired state.  Only one of <strong>code</strong> and <strong>code_template</strong> can be specified.</li>
+  <li><strong>delay_time</strong> (<em>Optional</em>): The time in seconds of the pending time before triggering the alarm. Default is 0 seconds.</li>
+  <li><strong>pending_time</strong> (<em>Optional</em>): The time in seconds of the pending time before effecting a state change. 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>
+  <li><strong>armed_home/armed_away/armed_night/disarmed/triggered</strong> (<em>Optional</em>): State specific settings
     <ul>
-      <li><strong>pending_time</strong>: State specific pending time override.</li>
+      <li><strong>delay_time</strong> (<em>Optional</em>): State specific setting for <strong>delay_time</strong> (all states except <strong>triggered</strong>)</li>
+      <li><strong>pending_time</strong> (<em>Optional</em>): State specific setting for <strong>pending_time</strong> (all states except <strong>disarmed</strong>)</li>
+      <li><strong>trigger_time</strong> (<em>Optional</em>): State specific setting for <strong>trigger_time</strong> (all states except <strong>triggered</strong>)</li>
     </ul>
   </li>
 </ul>
+<p>See the documentation for the <a href="../alarm_control_panel.manual/">manual alarm platform</a> for a description.</p>
 <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>
@@ -133,18 +128,31 @@
   <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>
+<p>In the config example below:</p>
+<ul>
+  <li>
+    <p>the disarmed state never triggers the alarm;</p>
+  </li>
+  <li>
+    <p>the armed_home state will leave no time to leave the building or disarm the alarm;</p>
+  </li>
+  <li>
+    <p>while other states state will give 30 seconds to leave the building before triggering the alarm, and 20 seconds to disarm the alarm when coming back.</p>
+  </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>
     <span class="s">pending_time</span><span class="pi">:</span> <span class="s">30</span>
+    <span class="s">delay_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>
+    <span class="s">disarmed</span><span class="pi">:</span>
+      <span class="s">trigger_time</span><span class="pi">:</span> <span class="s">0</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> 
+      <span class="s">delay_time</span><span class="pi">:</span> <span class="s">0</span>
 </code></pre>
 </div>
 <h2><a class="title-link" name="examples" href="#examples"></a> Examples</h2>
@@ -199,9 +207,15 @@
         <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>
             <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>