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

Site updated at 2018-01-24 07:52:15 UTC

Browse source
This commit is contained in:
Travis CI 2018-01-24 07:52:15 +00:00
parent 8e774be069
commit e21db9325c
63 changed files with 162 additions and 955 deletions
Download patch file Download diff file Expand all files Collapse all files

3
components/ads/index.html
View file

@ -110,8 +110,7 @@
</div>
<p>Service parameters:</p>
<ul>
<li><strong>adsvar</strong>: Name of the variable on the ADS device. To access global variables on <em>TwinCAT2</em> use a prepending dot <code class="highlighter-rouge">.myvariable</code>, for TwinCAT3 use
<code class="highlighter-rouge">GBL.myvariable</code>.</li>
<li><strong>adsvar</strong>: Name of the variable on the ADS device. To access global variables on <em>TwinCAT2</em> use a prepending dot <code class="highlighter-rouge">.myvariable</code>, for TwinCAT3 use <code class="highlighter-rouge">GBL.myvariable</code>.</li>
<li><strong>adstype</strong>: Specify the type of the variable. Use one of the following: <code class="highlighter-rouge">int</code>, <code class="highlighter-rouge">byte</code>, <code class="highlighter-rouge">uint</code>, <code class="highlighter-rouge">bool</code></li>
<li><strong>value</strong>: The value that will be written in the variable.</li>
</ul>

2
components/alarm_control_panel.concord232/index.html
View file

@ -75,7 +75,7 @@
</header>
<hr class="divider">
<p>The <code class="highlighter-rouge">concord232</code> platform provides integration with GE, Interlogix (and other brands) alarm panels that support the RS-232 Automation Control Panel interface module (or have it built in). Supported panels include Concord 4.</p>
<p>To use this platform, you will need to have the external concord232 client and server installed. The server must be running on the device which is connected to the automation module’s serial port. The client must be installed on the machine running Home Assistant. These may often be the same machine, but do not have to be. For additional details in setting up and testing the client and server, see https://github.com/JasonCarter80/concord232.</p>
<p>To use this platform, you will need to have the external concord232 client and server installed. The server must be running on the device which is connected to the automation module’s serial port. The client must be installed on the machine running Home Assistant. These may often be the same machine, but do not have to be. For additional details in setting up and testing the client and server, see <a href="https://github.com/JasonCarter80/concord232">https://github.com/JasonCarter80/concord232</a></p>
<p>To enable this platform in home assistant, add the following lines to your <code class="highlighter-rouge">configuration.yaml</code>:</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>

20
components/alarm_control_panel.egardia/index.html
View file

@ -104,20 +104,20 @@ You can change this, however, using the following procedure. This is a more adva
<li>Once logged in, go to <em>System Settings</em>, <em>Report</em> and change the Server Address for your primary server to the IP or hostname of your Home Assistant machine. You can leave the port number set to 52010 or change it to anything you like. <strong>Make sure to change the settings of the primary server otherwise the messages will not come through. Note that this will limit (or fully stop) the number of alarm messages you will get through Egardia’s / Woonveilig services.</strong> Maybe, that is just what you want. Make sure to save your settings by selecting ‘OK’.</li>
<li>On your Home Assistant machine run <code class="highlighter-rouge">$ sudo python3 egardiaserver.py</code>. Refer to the <a href="https://github.com/jeroenterheerdt/python-egardia">python-egardia repository</a> for detailed documentation on parameters. This will receive status codes from your alarm control panel and display them. You will need the codes to include in your configuration.yaml. Make sure to change the status of your alarm to all states (disarm, arm, home) by all means possible (all users, remotes, web login, app) as well as trigger the alarm in all ways possible to get 100% coverage. <strong>Before triggering the alarm it might be good to disable the siren temporarily (can be done in Panel Settings).</strong></li>
<li>Once you have the codes, update your <code class="highlighter-rouge">configuration.yaml</code>:
<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>
<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="s"> - platform</span><span class="pi">:</span> <span class="s">egardia</span>
<span class="s">  host</span><span class="pi">:</span> <span class="s">YOUR_HOST</span>
<span class="s">  username</span><span class="pi">:</span> <span class="s">YOUR_USERNAME</span>
<span class="s">  password</span><span class="pi">:</span> <span class="s">YOUR_PASSWORD</span>
<span class="s">report_server_enabled</span><span class="pi">:</span> <span class="s">True</span>
<span class="s">report_server_port</span><span class="pi">:</span> <span class="s">PORT_OF_EGARDIASERVER (optional, defaults to 52010)</span>
<span class="s">report_server_codes</span><span class="pi">:</span>
<span class="s">arm</span><span class="pi">:</span> <span class="s">XXXXXXXXXXXXXXXX, XXXXXXXXXXXXXXXX</span>
<span class="s">disarm</span><span class="pi">:</span> <span class="s">XXXXXXXXXXXXXXXX, XXXXXXXXXXXXXXXX</span>
<span class="s">home</span><span class="pi">:</span> <span class="s">XXXXXXXXXXXXXXXX</span>
<span class="s">triggered</span><span class="pi">:</span> <span class="s">XXXXXXXXXXXXXXXX, XXXXXXXXXXXXXXXX, XXXXXXXXXXXXXXXX</span>
<span class="s">ignore</span><span class="pi">:</span> <span class="s">XXXXXXXXXXXXXXXX</span>
<span class="s">report_server_enabled</span><span class="pi">:</span> <span class="s">True</span>
<span class="s">report_server_port</span><span class="pi">:</span> <span class="s">PORT_OF_EGARDIASERVER (optional, defaults to 52010)</span>
<span class="s">report_server_codes</span><span class="pi">:</span>
<span class="s">arm</span><span class="pi">:</span> <span class="s">XXXXXXXXXXXXXXXX, XXXXXXXXXXXXXXXX</span>
<span class="s">disarm</span><span class="pi">:</span> <span class="s">XXXXXXXXXXXXXXXX, XXXXXXXXXXXXXXXX</span>
<span class="s">home</span><span class="pi">:</span> <span class="s">XXXXXXXXXXXXXXXX</span>
<span class="s">triggered</span><span class="pi">:</span> <span class="s">XXXXXXXXXXXXXXXX, XXXXXXXXXXXXXXXX, XXXXXXXXXXXXXXXX</span>
<span class="s">ignore</span><span class="pi">:</span> <span class="s">XXXXXXXXXXXXXXXX</span>
</code></pre>
</div>
</li>

9
components/binary_sensor.ping/index.html
View file

@ -95,6 +95,15 @@
<li><code class="highlighter-rouge">round trip time min</code></li>
<li><code class="highlighter-rouge">round trip time max</code></li>
</ul>
<p>The default polling interval is 5 minutes. As many components <a href="/docs/configuration/platform_options">based on the entity class</a>, it is possible to overwrite this scan interval by specifying a <code class="highlighter-rouge">scan_interval</code> configuration key (value in seconds). In the example below we setup the <code class="highlighter-rouge">ping</code> binary sensor to poll the devices every 30 seconds.</p>
<div class="language-yaml highlighter-rouge"><pre class="highlight"><code><span class="c1"># Example configuration.yaml entry to ping host 192.168.0.1 with 2 packets every 30 seconds.</span>
<span class="s">binary_sensor</span><span class="pi">:</span>
<span class="pi">-</span> <span class="s">platform</span><span class="pi">:</span> <span class="s">ping</span>
<span class="s">host</span><span class="pi">:</span> <span class="s">192.168.0.1</span>
<span class="s">count</span><span class="pi">:</span> <span class="s">2</span>
<span class="s">scan_interval</span><span class="pi">:</span> <span class="s">30</span>
</code></pre>
</div>
<p class="note">
When run on Windows systems, the round trip time attributes are rounded to the nearest millisecond and the mdev value is unavailable.
</p>