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

Site updated at 2017-10-07 19:25:24 UTC

Browse source
This commit is contained in:
Travis CI 2017-10-07 19:25:24 +00:00
parent 8bbc40b5d1
commit ef6d3b2ec0
678 changed files with 10476 additions and 2128 deletions
Download patch file Download diff file Expand all files Collapse all files

8
components/abode/index.html
View file

@ -107,7 +107,7 @@
<li><strong>password</strong> (<em>Required</em>): Password for your Abode account.</li>
<li><strong>name</strong> (<em>Optional</em>): The name for your alarm controller.</li>
<li><strong>polling</strong> (<em>Optional</em>): Enable polling if cloud push updating is less reliable. Will update the devices once every 30 seconds. Defaults to False.</li>
<li><strong>exclude</strong> (<em>Optional</em>): A list of devices to exclude from Home Assistant by their Abode <code class="highlighter-rouge">device_id</code>, found within the component attributes.</li>
<li><strong>exclude</strong> (<em>Optional</em>): A list of devices to exclude from Home Assistant by their Abode <code class="highlighter-rouge">device_id</code> or <code class="highlighter-rouge">automation_id</code>, found within the component attributes.</li>
<li><strong>lights</strong> (<em>Optional</em>): A list of switch devices that Home Assistant should treat as lights by the switches Abode <code class="highlighter-rouge">device_id</code>, found within the component attributes.</li>
</ul>
<h2><a class="title-link" name="events" href="#events"></a> Events</h2>
@ -374,6 +374,9 @@
<li>
<a href='/components/mqtt/'>MQTT</a>
</li>
<li>
<a href='/components/raincloud/'>Melnor Raincloud</a>
</li>
<li>
<a href='/components/microsoft_face/'>Microsoft Face</a>
</li>
@ -443,6 +446,9 @@
<li>
<a href='/components/tesla/'>Tesla</a>
</li>
<li>
<a href='/components/thethingsnetwork/'>The Things Network</a>
</li>
<li>
<a href='/components/twilio/'>Twilio</a>
</li>

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

@ -112,14 +112,14 @@ You can change this, however, using the following procedure. This is a more adva
<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 (85 as per the instructions above)</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</span>
<span class="s">disarm</span><span class="pi">:</span> <span class="s">XXXXXXXXXXXXXXXX</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">armhome</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">standby</span><span class="pi">:</span> <span class="s">XXXXXXXXXXXXXXXX</span>
<span class="s">ignore</span><span class="pi">:</span> <span class="s">XXXXXXXXXXXXXXXX</span>
</code></pre>
</div>
<p>Note that you can have more than one code for triggered since every sensor generates its own code. arm, disarm, armhome and standby will all be one code.</p>
<p>Note that for triggered, arm and disarm multiple codes can be entered since each sensor triggers with a different code and each user of the system has its own arm and disarm codes. Also note that your system will do regular system checks which will be reported as well. Since Home Assistant provides no way of handling them properly, you can enter those codes as ignore (again, multiple codes can be used here). The egardia component will ignore these codes and continue returning the old status if it receives any of the codes that are listed as ignore. This is useful for example when you have armed your alarm at night: normally a system check will occur at least once during the night and if that code is not specified anywhere Home Assistant will set the status of the alarm to its default, which is unarmed. This is in fact wrong. Listing the code as ignore changes this behavior and Home Assistant will continue to show the status the alarm is in (disarm, arm, armhome, triggered) even when system checks occur.</p>
</li>
<li>Start the <code class="highlighter-rouge">egardiaserver.py</code> script on boot of your Home Assistant machine, for example by using systemd. To use this method, create a shell script named <code class="highlighter-rouge">egardiaserver.sh</code> that contains the following:
<div class="language-bash highlighter-rouge"><pre class="highlight"><code><span class="nb">source</span> /srv/homeassistant/homeassistant_venv/bin/activate

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

@ -143,6 +143,9 @@
<li><a href='/components/fan.mqtt/'>
MQTT Fan
</a></li>
<li><a href='/components/climate.mqtt/'>
MQTT HVAC
</a></li>
<li><a href='/components/light.mqtt/'>
MQTT Light
</a></li>

6
components/alarm_control_panel.wink/index.html
View file

@ -109,6 +109,9 @@ The above devices are confirmed to work, but others may work as well.
<li><a href='/components/binary_sensor.wink/'>
Wink Binary Sensor
</a></li>
<li><a href='/components/climate.wink/'>
Wink Climate
</a></li>
<li><a href='/components/cover.wink/'>
Wink Cover
</a></li>
@ -130,9 +133,6 @@ The above devices are confirmed to work, but others may work as well.
<li><a href='/components/switch.wink/'>
Wink Switch
</a></li>
<li><a href='/components/climate.wink/'>
Wink Thermostat
</a></li>
</ul>
</div>
<div class='section'>

6
components/alarmdecoder/index.html
View file

@ -241,6 +241,9 @@
<li>
<a href='/components/mqtt/'>MQTT</a>
</li>
<li>
<a href='/components/raincloud/'>Melnor Raincloud</a>
</li>
<li>
<a href='/components/microsoft_face/'>Microsoft Face</a>
</li>
@ -310,6 +313,9 @@
<li>
<a href='/components/tesla/'>Tesla</a>
</li>
<li>
<a href='/components/thethingsnetwork/'>The Things Network</a>
</li>
<li>
<a href='/components/twilio/'>Twilio</a>
</li>

3
components/alert/index.html
View file

@ -202,6 +202,9 @@
<li>
<a href='/components/input_boolean/'>Input Boolean</a>
</li>
<li>
<a href='/components/input_datetime/'>Input Datetime</a>
</li>
<li>
<a href='/components/input_select/'>Input Select</a>
</li>

6
components/amcrest/index.html
View file

@ -247,6 +247,9 @@
<li>
<a href='/components/mqtt/'>MQTT</a>
</li>
<li>
<a href='/components/raincloud/'>Melnor Raincloud</a>
</li>
<li>
<a href='/components/microsoft_face/'>Microsoft Face</a>
</li>
@ -316,6 +319,9 @@
<li>
<a href='/components/tesla/'>Tesla</a>
</li>
<li>
<a href='/components/thethingsnetwork/'>The Things Network</a>
</li>
<li>
<a href='/components/twilio/'>Twilio</a>
</li>

6
components/android_ip_webcam/index.html
View file

@ -248,6 +248,9 @@
<li>
<a href='/components/mqtt/'>MQTT</a>
</li>
<li>
<a href='/components/raincloud/'>Melnor Raincloud</a>
</li>
<li>
<a href='/components/microsoft_face/'>Microsoft Face</a>
</li>
@ -317,6 +320,9 @@
<li>
<a href='/components/tesla/'>Tesla</a>
</li>
<li>
<a href='/components/thethingsnetwork/'>The Things Network</a>
</li>
<li>
<a href='/components/twilio/'>Twilio</a>
</li>

6
components/apcupsd/index.html
View file

@ -210,6 +210,9 @@
<li>
<a href='/components/mqtt/'>MQTT</a>
</li>
<li>
<a href='/components/raincloud/'>Melnor Raincloud</a>
</li>
<li>
<a href='/components/microsoft_face/'>Microsoft Face</a>
</li>
@ -279,6 +282,9 @@
<li>
<a href='/components/tesla/'>Tesla</a>
</li>
<li>
<a href='/components/thethingsnetwork/'>The Things Network</a>
</li>
<li>
<a href='/components/twilio/'>Twilio</a>
</li>

6
components/apple_tv/index.html
View file

@ -303,6 +303,9 @@ Turning the device on/off in the user interface will <em>not</em> turn the physi
<li>
<a href='/components/mqtt/'>MQTT</a>
</li>
<li>
<a href='/components/raincloud/'>Melnor Raincloud</a>
</li>
<li>
<a href='/components/microsoft_face/'>Microsoft Face</a>
</li>
@ -372,6 +375,9 @@ Turning the device on/off in the user interface will <em>not</em> turn the physi
<li>
<a href='/components/tesla/'>Tesla</a>
</li>
<li>
<a href='/components/thethingsnetwork/'>The Things Network</a>
</li>
<li>
<a href='/components/twilio/'>Twilio</a>
</li>

6
components/arlo/index.html
View file

@ -229,6 +229,9 @@
<li>
<a href='/components/mqtt/'>MQTT</a>
</li>
<li>
<a href='/components/raincloud/'>Melnor Raincloud</a>
</li>
<li>
<a href='/components/microsoft_face/'>Microsoft Face</a>
</li>
@ -298,6 +301,9 @@
<li>
<a href='/components/tesla/'>Tesla</a>
</li>
<li>
<a href='/components/thethingsnetwork/'>The Things Network</a>
</li>
<li>
<a href='/components/twilio/'>Twilio</a>
</li>

3
components/automation/index.html
View file

@ -122,6 +122,9 @@
<li>
<a href='/components/input_boolean/'>Input Boolean</a>
</li>
<li>
<a href='/components/input_datetime/'>Input Datetime</a>
</li>
<li>
<a href='/components/input_select/'>Input Select</a>
</li>

6
components/axis/index.html
View file

@ -318,6 +318,9 @@ Any specific levels for triggers needs to be configured on the device.
<li>
<a href='/components/mqtt/'>MQTT</a>
</li>
<li>
<a href='/components/raincloud/'>Melnor Raincloud</a>
</li>
<li>
<a href='/components/microsoft_face/'>Microsoft Face</a>
</li>
@ -387,6 +390,9 @@ Any specific levels for triggers needs to be configured on the device.
<li>
<a href='/components/tesla/'>Tesla</a>
</li>
<li>
<a href='/components/thethingsnetwork/'>The Things Network</a>
</li>
<li>
<a href='/components/twilio/'>Twilio</a>
</li>

3
components/binary_sensor.abode/index.html
View file

@ -210,6 +210,9 @@
<li>
<a href='/components/binary_sensor.mqtt/'>MQTT Binary Sensor</a>
</li>
<li>
<a href='/components/binary_sensor.raincloud/'>Melnor Raincloud Binary Sensor</a>
</li>
<li>
<a href='/components/binary_sensor.modbus/'>Modbus Binary Sensor</a>
</li>

3
components/binary_sensor.alarmdecoder/index.html
View file

@ -197,6 +197,9 @@
<li>
<a href='/components/binary_sensor.mqtt/'>MQTT Binary Sensor</a>
</li>
<li>
<a href='/components/binary_sensor.raincloud/'>Melnor Raincloud Binary Sensor</a>
</li>
<li>
<a href='/components/binary_sensor.modbus/'>Modbus Binary Sensor</a>
</li>

3
components/binary_sensor.android_ip_webcam/index.html
View file

@ -206,6 +206,9 @@
<li>
<a href='/components/binary_sensor.mqtt/'>MQTT Binary Sensor</a>
</li>
<li>
<a href='/components/binary_sensor.raincloud/'>Melnor Raincloud Binary Sensor</a>
</li>
<li>
<a href='/components/binary_sensor.modbus/'>Modbus Binary Sensor</a>
</li>

3
components/binary_sensor.arest/index.html
View file

@ -223,6 +223,9 @@ This sensor is not suitable for fast state changes because there is a high possi
<li>
<a href='/components/binary_sensor.mqtt/'>MQTT Binary Sensor</a>
</li>
<li>
<a href='/components/binary_sensor.raincloud/'>Melnor Raincloud Binary Sensor</a>
</li>
<li>
<a href='/components/binary_sensor.modbus/'>Modbus Binary Sensor</a>
</li>

3
components/binary_sensor.aurora/index.html
View file

@ -196,6 +196,9 @@
<li>
<a href='/components/binary_sensor.mqtt/'>MQTT Binary Sensor</a>
</li>
<li>
<a href='/components/binary_sensor.raincloud/'>Melnor Raincloud Binary Sensor</a>
</li>
<li>
<a href='/components/binary_sensor.modbus/'>Modbus Binary Sensor</a>
</li>

3
components/binary_sensor.axis/index.html
View file

@ -202,6 +202,9 @@
<li>
<a href='/components/binary_sensor.mqtt/'>MQTT Binary Sensor</a>
</li>
<li>
<a href='/components/binary_sensor.raincloud/'>Melnor Raincloud Binary Sensor</a>
</li>
<li>
<a href='/components/binary_sensor.modbus/'>Modbus Binary Sensor</a>
</li>

3
components/binary_sensor.bayesian/index.html
View file

@ -238,6 +238,9 @@
<li>
<a href='/components/binary_sensor.mqtt/'>MQTT Binary Sensor</a>
</li>
<li>
<a href='/components/binary_sensor.raincloud/'>Melnor Raincloud Binary Sensor</a>
</li>
<li>
<a href='/components/binary_sensor.modbus/'>Modbus Binary Sensor</a>
</li>

3
components/binary_sensor.bbb_gpio/index.html
View file

@ -219,6 +219,9 @@
<li>
<a href='/components/binary_sensor.mqtt/'>MQTT Binary Sensor</a>
</li>
<li>
<a href='/components/binary_sensor.raincloud/'>Melnor Raincloud Binary Sensor</a>
</li>
<li>
<a href='/components/binary_sensor.modbus/'>Modbus Binary Sensor</a>
</li>

3
components/binary_sensor.blink/index.html
View file

@ -194,6 +194,9 @@ To get your Blink binary sensors working with Home Assistant, follow the instruc
<li>
<a href='/components/binary_sensor.mqtt/'>MQTT Binary Sensor</a>
</li>
<li>
<a href='/components/binary_sensor.raincloud/'>Melnor Raincloud Binary Sensor</a>
</li>
<li>
<a href='/components/binary_sensor.modbus/'>Modbus Binary Sensor</a>
</li>

3
components/binary_sensor.bloomsky/index.html
View file

@ -214,6 +214,9 @@
<li>
<a href='/components/binary_sensor.mqtt/'>MQTT Binary Sensor</a>
</li>
<li>
<a href='/components/binary_sensor.raincloud/'>Melnor Raincloud Binary Sensor</a>
</li>
<li>
<a href='/components/binary_sensor.modbus/'>Modbus Binary Sensor</a>
</li>

3
components/binary_sensor.command_line/index.html
View file

@ -251,6 +251,9 @@
<li>
<a href='/components/binary_sensor.mqtt/'>MQTT Binary Sensor</a>
</li>
<li>
<a href='/components/binary_sensor.raincloud/'>Melnor Raincloud Binary Sensor</a>
</li>
<li>
<a href='/components/binary_sensor.modbus/'>Modbus Binary Sensor</a>
</li>

3
components/binary_sensor.concord232/index.html
View file

@ -197,6 +197,9 @@
<li>
<a href='/components/binary_sensor.mqtt/'>MQTT Binary Sensor</a>
</li>
<li>
<a href='/components/binary_sensor.raincloud/'>Melnor Raincloud Binary Sensor</a>
</li>
<li>
<a href='/components/binary_sensor.modbus/'>Modbus Binary Sensor</a>
</li>

3
components/binary_sensor.doorbird/index.html
View file

@ -204,6 +204,9 @@
<li>
<a href='/components/binary_sensor.mqtt/'>MQTT Binary Sensor</a>
</li>
<li>
<a href='/components/binary_sensor.raincloud/'>Melnor Raincloud Binary Sensor</a>
</li>
<li>
<a href='/components/binary_sensor.modbus/'>Modbus Binary Sensor</a>
</li>

3
components/binary_sensor.ecobee/index.html
View file

@ -198,6 +198,9 @@
<li>
<a href='/components/binary_sensor.mqtt/'>MQTT Binary Sensor</a>
</li>
<li>
<a href='/components/binary_sensor.raincloud/'>Melnor Raincloud Binary Sensor</a>
</li>
<li>
<a href='/components/binary_sensor.modbus/'>Modbus Binary Sensor</a>
</li>

3
components/binary_sensor.eight_sleep/index.html
View file

@ -193,6 +193,9 @@
<li>
<a href='/components/binary_sensor.mqtt/'>MQTT Binary Sensor</a>
</li>
<li>
<a href='/components/binary_sensor.raincloud/'>Melnor Raincloud Binary Sensor</a>
</li>
<li>
<a href='/components/binary_sensor.modbus/'>Modbus Binary Sensor</a>
</li>

3
components/binary_sensor.enocean/index.html
View file

@ -234,6 +234,9 @@
<li>
<a href='/components/binary_sensor.mqtt/'>MQTT Binary Sensor</a>
</li>
<li>
<a href='/components/binary_sensor.raincloud/'>Melnor Raincloud Binary Sensor</a>
</li>
<li>
<a href='/components/binary_sensor.modbus/'>Modbus Binary Sensor</a>
</li>

3
components/binary_sensor.envisalink/index.html
View file

@ -197,6 +197,9 @@
<li>
<a href='/components/binary_sensor.mqtt/'>MQTT Binary Sensor</a>
</li>
<li>
<a href='/components/binary_sensor.raincloud/'>Melnor Raincloud Binary Sensor</a>
</li>
<li>
<a href='/components/binary_sensor.modbus/'>Modbus Binary Sensor</a>
</li>

7
components/binary_sensor.ffmpeg_motion/index.html
View file

@ -103,9 +103,9 @@ If the <code class="highlighter-rouge">ffmpeg</code> process is broken, the sens
</code></pre>
</div>
<p>If you are running into trouble with this sensor, please refer to the <a href="/components/ffmpeg/#troubleshooting">troubleshooting section</a>.</p>
<h4><a class="title-link" name="tipps" href="#tipps"></a> Tipps</h4>
<h4><a class="title-link" name="tips" href="#tips"></a> Tips</h4>
<ul>
<li>Use motion only in a customer area with <a href="https://ffmpeg.org/ffmpeg-filters.html#crop">crop filter</a>:</li>
<li>Use motion only in a custom area with <a href="https://ffmpeg.org/ffmpeg-filters.html#crop">crop filter</a>:</li>
</ul>
<div class="language-yaml highlighter-rouge"><pre class="highlight"><code><span class="s">extra_arguments</span><span class="pi">:</span> <span class="s">-filter:v "crop=100:100:12:34"</span>
</code></pre>
@ -213,6 +213,9 @@ If the <code class="highlighter-rouge">ffmpeg</code> process is broken, the sens
<li>
<a href='/components/binary_sensor.mqtt/'>MQTT Binary Sensor</a>
</li>
<li>
<a href='/components/binary_sensor.raincloud/'>Melnor Raincloud Binary Sensor</a>
</li>
<li>
<a href='/components/binary_sensor.modbus/'>Modbus Binary Sensor</a>
</li>

3
components/binary_sensor.ffmpeg_noise/index.html
View file

@ -204,6 +204,9 @@ If the <code class="highlighter-rouge">ffmpeg</code> process is broken, the sens
<li>
<a href='/components/binary_sensor.mqtt/'>MQTT Binary Sensor</a>
</li>
<li>
<a href='/components/binary_sensor.raincloud/'>Melnor Raincloud Binary Sensor</a>
</li>
<li>
<a href='/components/binary_sensor.modbus/'>Modbus Binary Sensor</a>
</li>

3
components/binary_sensor.flic/index.html
View file

@ -225,6 +225,9 @@
<li>
<a href='/components/binary_sensor.mqtt/'>MQTT Binary Sensor</a>
</li>
<li>
<a href='/components/binary_sensor.raincloud/'>Melnor Raincloud Binary Sensor</a>
</li>
<li>
<a href='/components/binary_sensor.modbus/'>Modbus Binary Sensor</a>
</li>

3
components/binary_sensor.hikvision/index.html
View file

@ -282,6 +282,9 @@ binary_sensor.home_line_crossing_2
<li>
<a href='/components/binary_sensor.mqtt/'>MQTT Binary Sensor</a>
</li>
<li>
<a href='/components/binary_sensor.raincloud/'>Melnor Raincloud Binary Sensor</a>
</li>
<li>
<a href='/components/binary_sensor.modbus/'>Modbus Binary Sensor</a>
</li>

3
components/binary_sensor.homematic/index.html
View file

@ -205,6 +205,9 @@
<li>
<a href='/components/binary_sensor.mqtt/'>MQTT Binary Sensor</a>
</li>
<li>
<a href='/components/binary_sensor.raincloud/'>Melnor Raincloud Binary Sensor</a>
</li>
<li>
<a href='/components/binary_sensor.modbus/'>Modbus Binary Sensor</a>
</li>

3
components/binary_sensor.http/index.html
View file

@ -239,6 +239,9 @@ You should choose a unique device name (DEVICE_NAME) to avoid clashes with other
<li>
<a href='/components/binary_sensor.mqtt/'>MQTT Binary Sensor</a>
</li>
<li>
<a href='/components/binary_sensor.raincloud/'>Melnor Raincloud Binary Sensor</a>
</li>
<li>
<a href='/components/binary_sensor.modbus/'>Modbus Binary Sensor</a>
</li>

3
components/binary_sensor.insteon_plm/index.html
View file

@ -195,6 +195,9 @@ component.</p>
<li>
<a href='/components/binary_sensor.mqtt/'>MQTT Binary Sensor</a>
</li>
<li>
<a href='/components/binary_sensor.raincloud/'>Melnor Raincloud Binary Sensor</a>
</li>
<li>
<a href='/components/binary_sensor.modbus/'>Modbus Binary Sensor</a>
</li>

3
components/binary_sensor.iss/index.html
View file

@ -202,6 +202,9 @@ If you set <code class="highlighter-rouge">show_on_map</code> <code class="highl
<li>
<a href='/components/binary_sensor.mqtt/'>MQTT Binary Sensor</a>
</li>
<li>
<a href='/components/binary_sensor.raincloud/'>Melnor Raincloud Binary Sensor</a>
</li>
<li>
<a href='/components/binary_sensor.modbus/'>Modbus Binary Sensor</a>
</li>

3
components/binary_sensor.isy994/index.html
View file

@ -208,6 +208,9 @@
<li>
<a href='/components/binary_sensor.mqtt/'>MQTT Binary Sensor</a>
</li>
<li>
<a href='/components/binary_sensor.raincloud/'>Melnor Raincloud Binary Sensor</a>
</li>
<li>
<a href='/components/binary_sensor.modbus/'>Modbus Binary Sensor</a>
</li>

3
components/binary_sensor.knx/index.html
View file

@ -248,6 +248,9 @@
<li>
<a href='/components/binary_sensor.mqtt/'>MQTT Binary Sensor</a>
</li>
<li>
<a href='/components/binary_sensor.raincloud/'>Melnor Raincloud Binary Sensor</a>
</li>
<li>
<a href='/components/binary_sensor.modbus/'>Modbus Binary Sensor</a>
</li>

5
components/binary_sensor.maxcube/index.html
View file

@ -132,6 +132,9 @@
<li>
<a href='/components/climate.knx/'>KNX Climate</a>
</li>
<li>
<a href='/components/climate.mqtt/'>MQTT HVAC</a>
</li>
<li>
<a href='/components/climate.mysensors/'>MySensors HVAC</a>
</li>
@ -163,7 +166,7 @@
<a href='/components/climate.vera/'>Vera Thermostat</a>
</li>
<li>
<a href='/components/climate.wink/'>Wink Thermostat</a>
<a href='/components/climate.wink/'>Wink Climate</a>
</li>
<li>
<a href='/components/climate.zwave/'>Z-Wave Climate</a>

3
components/binary_sensor.modbus/index.html
View file

@ -218,6 +218,9 @@
<li>
<a href='/components/binary_sensor.mqtt/'>MQTT Binary Sensor</a>
</li>
<li>
<a href='/components/binary_sensor.raincloud/'>Melnor Raincloud Binary Sensor</a>
</li>
<li>
Modbus Binary Sensor
</li>

36
components/binary_sensor.mqtt/index.html
View file

@ -74,8 +74,10 @@
</h1>
</header>
<hr class="divider">
<p>The <code class="highlighter-rouge">mqtt</code> binary sensor platform uses the MQTT message payload as the sensor value. If messages in this <code class="highlighter-rouge">state_topic</code> are published with <em>RETAIN</em> flag, the sensor will receive an instant update with the last known value. Otherwise, the initial state will be off.</p>
<p>To use your MQTT binary sensor in your installation, add the following to your <code class="highlighter-rouge">configuration.yaml</code> file:</p>
<p>The <code class="highlighter-rouge">mqtt</code> binary sensor platform uses an MQTT message payload to set the binary sensor to one of two states: <code class="highlighter-rouge">on</code> or <code class="highlighter-rouge">off</code>.</p>
<p>The binary sensor state will be updated only after a new message is published on <code class="highlighter-rouge">state_topic</code> matching <code class="highlighter-rouge">payload_on</code> or <code class="highlighter-rouge">payload_off</code>. If these messages are published with the <code class="highlighter-rouge">retain</code> flag set, the binary sensor will receive an instant state update after subscription and Home Assistant will display the correct state on startup. Otherwise, the initial state displayed in Home Assistant will be <code class="highlighter-rouge">unknown</code>.</p>
<p>The <code class="highlighter-rouge">mqtt</code> binary sensor platform optionally supports an <code class="highlighter-rouge">availability_topic</code> to receive online and offline messages (birth and LWT messages) from the MQTT device. During normal operation, if the MQTT cover device goes offline (i.e. publishes <code class="highlighter-rouge">payload_not_available</code> to <code class="highlighter-rouge">availability_topic</code>), Home Assistant will display the binary sensor as <code class="highlighter-rouge">unavailable</code>. If these messages are published with the <code class="highlighter-rouge">retain</code> flag set, the binary sensor will receive an instant update after subscription and Home Assistant will display the correct availability state of the binary sensor when Home Assistant starts up. If the <code class="highlighter-rouge">retain</code> flag is not set, Home Assistant will display the binary sensor as <code class="highlighter-rouge">unavailable</code> when Home Assistant starts up. If no <code class="highlighter-rouge">availability_topic</code> is defined, Home Assistant will consider the MQTT device to be available.</p>
<p>To use an MQTT binary sensor in your installation, add the following to your <code class="highlighter-rouge">configuration.yaml</code> file:</p>
<div class="language-yaml highlighter-rouge"><pre class="highlight"><code><span class="c1"># Example configuration.yaml entry</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">mqtt</span>
@ -84,27 +86,33 @@
</div>
<p>Configuration variables:</p>
<ul>
<li><strong>name</strong> (<em>Optional</em>): The name of the binary sensor. Default is <code class="highlighter-rouge">MQTT Binary Sensor</code>.</li>
<li><strong>state_topic</strong> (<em>Required</em>): The MQTT topic subscribed to receive sensor values.</li>
<li><strong>name</strong> (<em>Optional</em>): The name of the sensor. Default is ‘MQTT Sensor’.</li>
<li><strong>qos</strong> (<em>Optional</em>): The maximum QoS level of the state topic. Default is 0.</li>
<li><strong>payload_on</strong> (<em>Optional</em>): The payload that represents on state. Default is “ON”.</li>
<li><strong>payload_off</strong> (<em>Optional</em>): The payload that represents state. Default is “OFF”.</li>
<li><strong>payload_on</strong> (<em>Optional</em>): The payload that represents the on state. Default is <code class="highlighter-rouge">ON</code>.</li>
<li><strong>payload_off</strong> (<em>Optional</em>): The payload that represents the off state. Default is <code class="highlighter-rouge">OFF</code>.</li>
<li><strong>availability_topic</strong> (<em>Optional</em>): The MQTT topic subscribed to receive birth and LWT messages from the MQTT device. If <code class="highlighter-rouge">availability_topic</code> is not defined, the binary sensor availability state will always be <code class="highlighter-rouge">available</code>. If <code class="highlighter-rouge">availability_topic</code> is defined, the binary sensor availability state will be <code class="highlighter-rouge">unavailable</code> by default.</li>
<li><strong>payload_available</strong> (<em>Optional</em>): The payload that represents the online state. Default is <code class="highlighter-rouge">online</code>.</li>
<li><strong>payload_not_available</strong> (<em>Optional</em>): The payload that represents the offline state. Default is <code class="highlighter-rouge">offline</code>.</li>
<li><strong>qos</strong> (<em>Optional</em>): The maximum QoS level to be used when receiving messages. Default is <code class="highlighter-rouge">0</code>.</li>
<li><strong>device_class</strong> (<em>Optional</em>): The <a href="/components/binary_sensor/">type/class</a> of the sensor to set the icon in the frontend.</li>
<li><strong>value_template</strong> (<em>Optional</em>): Defines a <a href="/docs/configuration/templating/#processing-incoming-data">template</a> to extract a value from the payload.</li>
</ul>
<p>For a quick check you can use the command line tools shipped with <code class="highlighter-rouge">mosquitto</code> to send MQTT messages. Set the state of a sensor manually:</p>
<p>To test, you can use the command line tool <code class="highlighter-rouge">mosquitto_pub</code> shipped with <code class="highlighter-rouge">mosquitto</code> or the <code class="highlighter-rouge">mosquitto-clients</code> package to send MQTT messages. To set the state of the binary sensor manually:</p>
<div class="language-bash highlighter-rouge"><pre class="highlight"><code><span class="gp">$ </span>mosquitto_pub -h 127.0.0.1 -t home-assistant/window/contact -m <span class="s2">"OFF"</span>
</code></pre>
</div>
<p>An extended configuration for the same sensor could look like this if you want/need to be more specific.</p>
<p>The example below shows a full configuration for a binary sensor:</p>
<div class="language-yaml highlighter-rouge"><pre class="highlight"><code><span class="c1"># Example configuration.yaml entry</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">mqtt</span>
<span class="s">name</span><span class="pi">:</span> <span class="s2">"</span><span class="s">Window</span><span class="nv"> </span><span class="s">Contact</span><span class="nv"> </span><span class="s">Sensor"</span>
<span class="s">state_topic</span><span class="pi">:</span> <span class="s2">"</span><span class="s">home-assistant/window/contact"</span>
<span class="s">name</span><span class="pi">:</span> <span class="s2">"</span><span class="s">Windows</span><span class="nv"> </span><span class="s">contact"</span>
<span class="s">payload_on</span><span class="pi">:</span> <span class="s2">"</span><span class="s">ON"</span>
<span class="s">payload_off</span><span class="pi">:</span> <span class="s2">"</span><span class="s">OFF"</span>
<span class="s">availability_topic</span><span class="pi">:</span> <span class="s2">"</span><span class="s">home-assistant/window/availability"</span>
<span class="s">payload_available</span><span class="pi">:</span> <span class="s2">"</span><span class="s">online"</span>
<span class="s">payload_not_available</span><span class="pi">:</span> <span class="s2">"</span><span class="s">offline"</span>
<span class="s">qos</span><span class="pi">:</span> <span class="s">0</span>
<span class="s">payload_on</span><span class="pi">:</span> <span class="s2">"</span><span class="s">1"</span>
<span class="s">payload_off</span><span class="pi">:</span> <span class="s2">"</span><span class="s">0"</span>
<span class="s">device_class</span><span class="pi">:</span> <span class="s">opening</span>
<span class="s">value_template</span><span class="pi">:</span> <span class="s1">'</span><span class="s">{{</span><span class="nv"> </span><span class="s">value.x</span><span class="nv"> </span><span class="s">}}'</span>
</code></pre>
@ -149,6 +157,9 @@
<li><a href='/components/fan.mqtt/'>
MQTT Fan
</a></li>
<li><a href='/components/climate.mqtt/'>
MQTT HVAC
</a></li>
<li><a href='/components/light.mqtt/'>
MQTT Light
</a></li>
@ -256,6 +267,9 @@
<li>
MQTT Binary Sensor
</li>
<li>
<a href='/components/binary_sensor.raincloud/'>Melnor Raincloud Binary Sensor</a>
</li>
<li>
<a href='/components/binary_sensor.modbus/'>Modbus Binary Sensor</a>
</li>

3
components/binary_sensor.mysensors/index.html
View file

@ -312,6 +312,9 @@
<li>
<a href='/components/binary_sensor.mqtt/'>MQTT Binary Sensor</a>
</li>
<li>
<a href='/components/binary_sensor.raincloud/'>Melnor Raincloud Binary Sensor</a>
</li>
<li>
<a href='/components/binary_sensor.modbus/'>Modbus Binary Sensor</a>
</li>

3
components/binary_sensor.mystrom/index.html
View file

@ -238,6 +238,9 @@ The firmware version 2.26 doesn’t support TLS/SSL. This means that you are onl
<li>
<a href='/components/binary_sensor.mqtt/'>MQTT Binary Sensor</a>
</li>
<li>
<a href='/components/binary_sensor.raincloud/'>Melnor Raincloud Binary Sensor</a>
</li>
<li>
<a href='/components/binary_sensor.modbus/'>Modbus Binary Sensor</a>
</li>

3
components/binary_sensor.nest/index.html
View file

@ -240,6 +240,9 @@ You must have the <a href="/components/nest/">Nest component</a> configured to u
<li>
<a href='/components/binary_sensor.mqtt/'>MQTT Binary Sensor</a>
</li>
<li>
<a href='/components/binary_sensor.raincloud/'>Melnor Raincloud Binary Sensor</a>
</li>
<li>
<a href='/components/binary_sensor.modbus/'>Modbus Binary Sensor</a>
</li>

3
components/binary_sensor.netatmo/index.html
View file

@ -245,6 +245,9 @@
<li>
<a href='/components/binary_sensor.mqtt/'>MQTT Binary Sensor</a>
</li>
<li>
<a href='/components/binary_sensor.raincloud/'>Melnor Raincloud Binary Sensor</a>
</li>
<li>
<a href='/components/binary_sensor.modbus/'>Modbus Binary Sensor</a>
</li>

3
components/binary_sensor.nx584/index.html
View file

@ -219,6 +219,9 @@
<li>
<a href='/components/binary_sensor.mqtt/'>MQTT Binary Sensor</a>
</li>
<li>
<a href='/components/binary_sensor.raincloud/'>Melnor Raincloud Binary Sensor</a>
</li>
<li>
<a href='/components/binary_sensor.modbus/'>Modbus Binary Sensor</a>
</li>

3
components/binary_sensor.octoprint/index.html
View file

@ -213,6 +213,9 @@ You must have the <a href="/components/octoprint/">OctoPrint component</a> confi
<li>
<a href='/components/binary_sensor.mqtt/'>MQTT Binary Sensor</a>
</li>
<li>
<a href='/components/binary_sensor.raincloud/'>Melnor Raincloud Binary Sensor</a>
</li>
<li>
<a href='/components/binary_sensor.modbus/'>Modbus Binary Sensor</a>
</li>

3
components/binary_sensor.pilight/index.html
View file

@ -225,6 +225,9 @@
<li>
<a href='/components/binary_sensor.mqtt/'>MQTT Binary Sensor</a>
</li>
<li>
<a href='/components/binary_sensor.raincloud/'>Melnor Raincloud Binary Sensor</a>
</li>
<li>
<a href='/components/binary_sensor.modbus/'>Modbus Binary Sensor</a>
</li>

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

@ -209,6 +209,9 @@ When run on Windows systems, the round trip time attributes are rounded to the n
<li>
<a href='/components/binary_sensor.mqtt/'>MQTT Binary Sensor</a>
</li>
<li>
<a href='/components/binary_sensor.raincloud/'>Melnor Raincloud Binary Sensor</a>
</li>
<li>
<a href='/components/binary_sensor.modbus/'>Modbus Binary Sensor</a>
</li>

369
components/binary_sensor.raincloud/index.html Normal file
View file

@ -0,0 +1,369 @@
<!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>Melnor Raincloud Binary Sensor - Home Assistant</title>
<meta name="author" content="Home Assistant">
<meta name="description" content="Instructions on how to integrate your Melnor Raincloud sprinkler system within Home Assistant.">
<meta name="viewport" content="width=device-width">
<link rel="canonical" href="https://home-assistant.io/components/binary_sensor.raincloud/">
<meta property="fb:app_id" content="338291289691179">
<meta property="og:title" content="Melnor Raincloud Binary Sensor">
<meta property="og:site_name" content="Home Assistant">
<meta property="og:url" content="https://home-assistant.io/components/binary_sensor.raincloud/">
<meta property="og:type" content="article">
<meta property="og:description" content="Instructions on how to integrate your Melnor Raincloud sprinkler system 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="Melnor Raincloud Binary Sensor">
<meta name="twitter:description" content="Instructions on how to integrate your Melnor Raincloud sprinkler system within Home Assistant.">
<meta name="twitter:image" content="https://home-assistant.io/images/default-social.png">
<link href="/stylesheets/screen.css" media="screen, projection" 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">
Melnor Raincloud Binary Sensor
</h1>
</header>
<hr class="divider">
<p>To get your <a href="https://wifiaquatimer.com">Melnor RainCloud</a> binary sensors working within Home Assistant, please follow the instructions for the general <a href="/components/raincloud">Raincloud component</a>.</p>
<p>Once you have enabled the <a href="/components/raincloud">Raincloud component</a>, add the following to your <code class="highlighter-rouge">configuration.yaml</code> file:</p>
<div class="language-yaml highlighter-rouge"><pre class="highlight"><code><span class="c1"># Example configuration.yaml entry</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">raincloud</span>
</code></pre>
</div>
<p>Configuration variables:</p>
<ul>
<li><strong>monitored_conditions</strong> array (<em>Optional</em>): Conditions to display in the frontend. If not specified, all conditions below will be enabled by default. The following conditions can be monitored.
<ul>
<li><strong>is_watering</strong>: Return if is currently watering per zone.</li>
<li><strong>status</strong>: Return status from the Melnor RainCloud Controller and Melnor RainCloud Faucet.</li>
</ul>
</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/binary_sensor.raincloud.markdown'>Edit this page on GitHub</a></div>
<div class='brand-logo-container section'>
<img src='/images/supported_brands/raincloud.jpg' />
</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>: Cloud Polling
</div>
<div class='section'>
Introduced in release: 0.55
</div>
<div class='section'>
This is a platform for
<a href='/components/binary_sensor/'>the Binary Sensor component</a>.
</div>
<div class='section'>
<h1 class='title delta'>Related components</h1>
<ul class='divided'>
<li><a href='/components/raincloud/'>
Melnor Raincloud
</a></li>
<li><a href='/components/sensor.raincloud/'>
Melnor Raincloud Sensor
</a></li>
<li><a href='/components/switch.raincloud/'>
Melnor Raincloud Switch
</a></li>
</ul>
</div>
<div class='section'>
<h1 class="title delta">Category Binary Sensor</h1>
<ul class='divided'>
<li>
<a href='/components/binary_sensor.abode/'>Abode Binary Sensor</a>
</li>
<li>
<a href='/components/binary_sensor.alarmdecoder/'>AlarmDecoder Binary Sensor</a>
</li>
<li>
<a href='/components/binary_sensor.android_ip_webcam/'>Android IP Webcam Binary Sensor</a>
</li>
<li>
<a href='/components/binary_sensor.aurora/'>Aurora sensor</a>
</li>
<li>
<a href='/components/binary_sensor.axis/'>Axis Binary Sensor</a>
</li>
<li>
<a href='/components/binary_sensor.bayesian/'>Bayesian Binary Sensor</a>
</li>
<li>
<a href='/components/binary_sensor.bbb_gpio/'>BeagleBone Black GPIO Binary Sensor</a>
</li>
<li>
<a href='/components/binary_sensor.blink/'>Blink Binary Sensor</a>
</li>
<li>
<a href='/components/binary_sensor.bloomsky/'>BloomSky Binary Sensor</a>
</li>
<li>
<a href='/components/binary_sensor.command_line/'>Command line Binary Sensor</a>
</li>
<li>
<a href='/components/binary_sensor.concord232/'>Concord232 Binary Sensor</a>
</li>
<li>
<a href='/components/binary_sensor.doorbird/'>DoorBird Binary Sensor</a>
</li>
<li>
<a href='/components/binary_sensor.ecobee/'>Ecobee Binary Sensor</a>
</li>
<li>
<a href='/components/sensor.ecobee/'>Ecobee Sensor</a>
</li>
<li>
<a href='/components/binary_sensor.eight_sleep/'>Eight Sleep Binary Sensor</a>
</li>
<li>
<a href='/components/binary_sensor.enocean/'>EnOcean Binary Sensor</a>
</li>
<li>
<a href='/components/binary_sensor.envisalink/'>Envisalink Binary Sensor</a>
</li>
<li>
<a href='/components/binary_sensor.ffmpeg_motion/'>FFmpeg Motion Binary Sensor</a>
</li>
<li>
<a href='/components/binary_sensor.ffmpeg_noise/'>FFmpeg Noise Binary Sensor</a>
</li>
<li>
<a href='/components/binary_sensor.flic/'>Flic Smart Button</a>
</li>
<li>
<a href='/components/binary_sensor.http/'>HTTP Binary Sensor</a>
</li>
<li>
<a href='/components/binary_sensor.hikvision/'>Hikvision Binary Sensor</a>
</li>
<li>
<a href='/components/binary_sensor.homematic/'>Homematic Binary Sensor</a>
</li>
<li>
<a href='/components/binary_sensor.isy994/'>ISY994 Binary Sensor</a>
</li>
<li>
<a href='/components/binary_sensor.insteon_plm/'>Insteon PLM Binary Sensor</a>
</li>
<li>
<a href='/components/binary_sensor.iss/'>International Space Station</a>
</li>
<li>
<a href='/components/binary_sensor.knx/'>KNX Binary Sensor</a>
</li>
<li>
<a href='/components/binary_sensor.mqtt/'>MQTT Binary Sensor</a>
</li>
<li>
Melnor Raincloud Binary Sensor
</li>
<li>
<a href='/components/binary_sensor.modbus/'>Modbus Binary Sensor</a>
</li>
<li>
<a href='/components/binary_sensor.mysensors/'>MySensors Binary Sensor</a>
</li>
<li>
<a href='/components/binary_sensor.nx584/'>NX584 zones</a>
</li>
<li>
<a href='/components/binary_sensor.nest/'>Nest Binary Sensor</a>
</li>
<li>
<a href='/components/binary_sensor.netatmo/'>Netatmo Binary Sensor</a>
</li>
<li>
<a href='/components/binary_sensor.octoprint/'>OctoPrint Binary Sensor</a>
</li>
<li>
<a href='/components/binary_sensor.rpi_pfio/'>PiFace Digital I/O Binary Sensor</a>
</li>
<li>
<a href='/components/binary_sensor.pilight/'>Pilight Binary Sensor</a>
</li>
<li>
<a href='/components/binary_sensor.ping/'>Ping (ICMP) Binary sensor</a>
</li>
<li>
<a href='/components/binary_sensor.rest/'>RESTful Binary Sensor</a>
</li>
<li>
<a href='/components/binary_sensor.rfxtrx/'>RFXtrx Binary Sensor</a>
</li>
<li>
<a href='/components/binary_sensor.rpi_gpio/'>Raspberry PI GPIO Binary Sensor</a>
</li>
<li>
<a href='/components/binary_sensor.raspihats/'>Raspihats Binary Sensor</a>
</li>
<li>
<a href='/components/binary_sensor.ring/'>Ring Binary Sensor</a>
</li>
<li>
<a href='/components/binary_sensor.spc/'>SPC Binary Sensor</a>
</li>
<li>
<a href='/components/binary_sensor.satel_integra/'>Satel Integra Binary Sensor</a>
</li>
<li>
<a href='/components/binary_sensor.sleepiq/'>SleepIQ Binary Sensor</a>
</li>
<li>
<a href='/components/binary_sensor.tcp/'>TCP Binary Sensor</a>
</li>
<li>
<a href='/components/binary_sensor.template/'>Template Binary Sensor</a>
</li>
<li>
<a href='/components/binary_sensor.tesla/'>Tesla Binary Sensor</a>
</li>
<li>
<a href='/components/binary_sensor.threshold/'>Threshold Binary Sensor</a>
</li>
<li>
<a href='/components/binary_sensor.trend/'>Trend Binary Sensor</a>
</li>
<li>
<a href='/components/binary_sensor.velbus/'>Velbus sensors</a>
</li>
<li>
<a href='/components/binary_sensor.vera/'>Vera Binary Sensor</a>
</li>
<li>
<a href='/components/binary_sensor.verisure/'>Verisure Binary Sensor</a>
</li>
<li>
<a href='/components/binary_sensor.wink/'>Wink Binary Sensor</a>
</li>
<li>
<a href='/components/binary_sensor.workday/'>Workday Binary Sensor</a>
</li>
<li>
<a href='/components/binary_sensor.xiaomi_aqara/'>Xiaomi Binary Sensor</a>
</li>
<li>
<a href='/components/binary_sensor.zwave/'>Z-Wave Binary Sensor</a>
</li>
<li>
<a href='/components/binary_sensor.zigbee/'>ZigBee Binary Sensor</a>
</li>
<li>
<a href='/components/binary_sensor.zha/'>ZigBee Home Automation Binary Sensor</a>
</li>
<li>
<a href='/components/binary_sensor.arest/'>aREST Binary Sensor</a>
</li>
<li>
<a href='/components/binary_sensor.mystrom/'>myStrom Binary Sensor</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>

3
components/binary_sensor.raspihats/index.html
View file

@ -229,6 +229,9 @@
<li>
<a href='/components/binary_sensor.mqtt/'>MQTT Binary Sensor</a>
</li>
<li>
<a href='/components/binary_sensor.raincloud/'>Melnor Raincloud Binary Sensor</a>
</li>
<li>
<a href='/components/binary_sensor.modbus/'>Modbus Binary Sensor</a>
</li>

3
components/binary_sensor.rest/index.html
View file

@ -272,6 +272,9 @@ User-Agent: Home Assistant
<li>
<a href='/components/binary_sensor.mqtt/'>MQTT Binary Sensor</a>
</li>
<li>
<a href='/components/binary_sensor.raincloud/'>Melnor Raincloud Binary Sensor</a>
</li>
<li>
<a href='/components/binary_sensor.modbus/'>Modbus Binary Sensor</a>
</li>

3
components/binary_sensor.rfxtrx/index.html
View file

@ -296,6 +296,9 @@ to configure your new devices and leave it off otherwise.</p>
<li>
<a href='/components/binary_sensor.mqtt/'>MQTT Binary Sensor</a>
</li>
<li>
<a href='/components/binary_sensor.raincloud/'>Melnor Raincloud Binary Sensor</a>
</li>
<li>
<a href='/components/binary_sensor.modbus/'>Modbus Binary Sensor</a>
</li>

3
components/binary_sensor.ring/index.html
View file

@ -208,6 +208,9 @@
<li>
<a href='/components/binary_sensor.mqtt/'>MQTT Binary Sensor</a>
</li>
<li>
<a href='/components/binary_sensor.raincloud/'>Melnor Raincloud Binary Sensor</a>
</li>
<li>
<a href='/components/binary_sensor.modbus/'>Modbus Binary Sensor</a>
</li>

3
components/binary_sensor.rpi_gpio/index.html
View file

@ -216,6 +216,9 @@
<li>
<a href='/components/binary_sensor.mqtt/'>MQTT Binary Sensor</a>
</li>
<li>
<a href='/components/binary_sensor.raincloud/'>Melnor Raincloud Binary Sensor</a>
</li>
<li>
<a href='/components/binary_sensor.modbus/'>Modbus Binary Sensor</a>
</li>

3
components/binary_sensor.rpi_pfio/index.html
View file

@ -219,6 +219,9 @@
<li>
<a href='/components/binary_sensor.mqtt/'>MQTT Binary Sensor</a>
</li>
<li>
<a href='/components/binary_sensor.raincloud/'>Melnor Raincloud Binary Sensor</a>
</li>
<li>
<a href='/components/binary_sensor.modbus/'>Modbus Binary Sensor</a>
</li>

3
components/binary_sensor.satel_integra/index.html
View file

@ -194,6 +194,9 @@
<li>
<a href='/components/binary_sensor.mqtt/'>MQTT Binary Sensor</a>
</li>
<li>
<a href='/components/binary_sensor.raincloud/'>Melnor Raincloud Binary Sensor</a>
</li>
<li>
<a href='/components/binary_sensor.modbus/'>Modbus Binary Sensor</a>
</li>

3
components/binary_sensor.sleepiq/index.html
View file

@ -192,6 +192,9 @@
<li>
<a href='/components/binary_sensor.mqtt/'>MQTT Binary Sensor</a>
</li>
<li>
<a href='/components/binary_sensor.raincloud/'>Melnor Raincloud Binary Sensor</a>
</li>
<li>
<a href='/components/binary_sensor.modbus/'>Modbus Binary Sensor</a>
</li>

3
components/binary_sensor.spc/index.html
View file

@ -194,6 +194,9 @@
<li>
<a href='/components/binary_sensor.mqtt/'>MQTT Binary Sensor</a>
</li>
<li>
<a href='/components/binary_sensor.raincloud/'>Melnor Raincloud Binary Sensor</a>
</li>
<li>
<a href='/components/binary_sensor.modbus/'>Modbus Binary Sensor</a>
</li>

3
components/binary_sensor.tcp/index.html
View file

@ -209,6 +209,9 @@
<li>
<a href='/components/binary_sensor.mqtt/'>MQTT Binary Sensor</a>
</li>
<li>
<a href='/components/binary_sensor.raincloud/'>Melnor Raincloud Binary Sensor</a>
</li>
<li>
<a href='/components/binary_sensor.modbus/'>Modbus Binary Sensor</a>
</li>

3
components/binary_sensor.template/index.html
View file

@ -359,6 +359,9 @@ device tracking and Z-Wave multisensor presence sensors.</p>
<li>
<a href='/components/binary_sensor.mqtt/'>MQTT Binary Sensor</a>
</li>
<li>
<a href='/components/binary_sensor.raincloud/'>Melnor Raincloud Binary Sensor</a>
</li>
<li>
<a href='/components/binary_sensor.modbus/'>Modbus Binary Sensor</a>
</li>

3
components/binary_sensor.tesla/index.html
View file

@ -203,6 +203,9 @@
<li>
<a href='/components/binary_sensor.mqtt/'>MQTT Binary Sensor</a>
</li>
<li>
<a href='/components/binary_sensor.raincloud/'>Melnor Raincloud Binary Sensor</a>
</li>
<li>
<a href='/components/binary_sensor.modbus/'>Modbus Binary Sensor</a>
</li>

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

@ -74,7 +74,8 @@
</h1>
</header>
<hr class="divider">
<p>The <code class="highlighter-rouge">threshold</code> binary sensor platform is consuming the state from another sensor. If the value is below (<code class="highlighter-rouge">lower</code>) or higher (<code class="highlighter-rouge">upper</code>) than the given threshold then state of this sensor change..</p>
<p>The <code class="highlighter-rouge">threshold</code> binary sensor platform observes the state of another sensor. If the value is below (<code class="highlighter-rouge">lower</code>) or higher (<code class="highlighter-rouge">upper</code>) than the given threshold then state of the threshold sensor is changed.</p>
<p>If the sensor is configured with no hysteresis and the sensor value is equal to the threshold, the sensor is turned off since it is not <code class="highlighter-rouge">lower</code> or <code class="highlighter-rouge">upper</code> with respect to the threshold.</p>
<p>It’s an alternative to the template binary sensor’s <code class="highlighter-rouge">value_template:</code> to get the abnormal/too high/too low states.</p>
<div class="language-yaml highlighter-rouge"><pre class="highlight"><code><span class="pi">{{</span> <span class="nv">states.sensor.furnace.state &gt; 2.5</span> <span class="pi">}}</span>
</code></pre>
@ -91,8 +92,9 @@
<p>Configuration variables:</p>
<ul>
<li><strong>entity_id</strong> (<em>Required</em>): The entity to monitor. Only <a href="/components/sensor/">sensors</a> are supported.</li>
<li><strong>threshold</strong> (<em>Required</em>): The value which is the threshold.</li>
<li><strong>threshold</strong> (<em>Required</em>): The threshold which the observed value is compared against.</li>
<li><strong>type</strong> (<em>Required</em>): <code class="highlighter-rouge">lower</code> if the value needs to be below the threshold or <code class="highlighter-rouge">upper</code> if higher.</li>
<li><strong>hysteresis</strong> (<em>Optional</em>): The distance the observed value must be from the threshold before the state is changed. Defaults to <code class="highlighter-rouge">0.0</code></li>
<li><strong>name</strong> (<em>Optional</em>): Name of the sensor to use in the frontend. Defaults to <code class="highlighter-rouge">Stats</code>.</li>
</ul>
</article>
@ -201,6 +203,9 @@
<li>
<a href='/components/binary_sensor.mqtt/'>MQTT Binary Sensor</a>
</li>
<li>
<a href='/components/binary_sensor.raincloud/'>Melnor Raincloud Binary Sensor</a>
</li>
<li>
<a href='/components/binary_sensor.modbus/'>Modbus Binary Sensor</a>
</li>

3
components/binary_sensor.trend/index.html
View file

@ -226,6 +226,9 @@
<li>
<a href='/components/binary_sensor.mqtt/'>MQTT Binary Sensor</a>
</li>
<li>
<a href='/components/binary_sensor.raincloud/'>Melnor Raincloud Binary Sensor</a>
</li>
<li>
<a href='/components/binary_sensor.modbus/'>Modbus Binary Sensor</a>
</li>

3
components/binary_sensor.velbus/index.html
View file

@ -225,6 +225,9 @@
<li>
<a href='/components/binary_sensor.mqtt/'>MQTT Binary Sensor</a>
</li>
<li>
<a href='/components/binary_sensor.raincloud/'>Melnor Raincloud Binary Sensor</a>
</li>
<li>
<a href='/components/binary_sensor.modbus/'>Modbus Binary Sensor</a>
</li>

3
components/binary_sensor.vera/index.html
View file

@ -208,6 +208,9 @@
<li>
<a href='/components/binary_sensor.mqtt/'>MQTT Binary Sensor</a>
</li>
<li>
<a href='/components/binary_sensor.raincloud/'>Melnor Raincloud Binary Sensor</a>
</li>
<li>
<a href='/components/binary_sensor.modbus/'>Modbus Binary Sensor</a>
</li>

3
components/binary_sensor.verisure/index.html
View file

@ -203,6 +203,9 @@
<li>
<a href='/components/binary_sensor.mqtt/'>MQTT Binary Sensor</a>
</li>
<li>
<a href='/components/binary_sensor.raincloud/'>Melnor Raincloud Binary Sensor</a>
</li>
<li>
<a href='/components/binary_sensor.modbus/'>Modbus Binary Sensor</a>
</li>

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

@ -121,6 +121,9 @@ The above devices are confirmed to work, but others may work as well.
<li><a href='/components/alarm_control_panel.wink/'>
Wink Alarm
</a></li>
<li><a href='/components/climate.wink/'>
Wink Climate
</a></li>
<li><a href='/components/cover.wink/'>
Wink Cover
</a></li>
@ -142,9 +145,6 @@ The above devices are confirmed to work, but others may work as well.
<li><a href='/components/switch.wink/'>
Wink Switch
</a></li>
<li><a href='/components/climate.wink/'>
Wink Thermostat
</a></li>
</ul>
</div>
<div class='section'>
@ -234,6 +234,9 @@ The above devices are confirmed to work, but others may work as well.
<li>
<a href='/components/binary_sensor.mqtt/'>MQTT Binary Sensor</a>
</li>
<li>
<a href='/components/binary_sensor.raincloud/'>Melnor Raincloud Binary Sensor</a>
</li>
<li>
<a href='/components/binary_sensor.modbus/'>Modbus Binary Sensor</a>
</li>

3
components/binary_sensor.workday/index.html
View file

@ -215,6 +215,9 @@ If you use the sensor for Canada (<code class="highlighter-rouge">CA</code>) wit
<li>
<a href='/components/binary_sensor.mqtt/'>MQTT Binary Sensor</a>
</li>
<li>
<a href='/components/binary_sensor.raincloud/'>Melnor Raincloud Binary Sensor</a>
</li>
<li>
<a href='/components/binary_sensor.modbus/'>Modbus Binary Sensor</a>
</li>

3
components/binary_sensor.xiaomi_aqara/index.html
View file

@ -581,6 +581,9 @@
<li>
<a href='/components/binary_sensor.mqtt/'>MQTT Binary Sensor</a>
</li>
<li>
<a href='/components/binary_sensor.raincloud/'>Melnor Raincloud Binary Sensor</a>
</li>
<li>
<a href='/components/binary_sensor.modbus/'>Modbus Binary Sensor</a>
</li>

3
components/binary_sensor.zha/index.html
View file

@ -195,6 +195,9 @@
<li>
<a href='/components/binary_sensor.mqtt/'>MQTT Binary Sensor</a>
</li>
<li>
<a href='/components/binary_sensor.raincloud/'>Melnor Raincloud Binary Sensor</a>
</li>
<li>
<a href='/components/binary_sensor.modbus/'>Modbus Binary Sensor</a>
</li>

3
components/binary_sensor.zigbee/index.html
View file

@ -213,6 +213,9 @@
<li>
<a href='/components/binary_sensor.mqtt/'>MQTT Binary Sensor</a>
</li>
<li>
<a href='/components/binary_sensor.raincloud/'>Melnor Raincloud Binary Sensor</a>
</li>
<li>
<a href='/components/binary_sensor.modbus/'>Modbus Binary Sensor</a>
</li>

3
components/binary_sensor.zwave/index.html
View file

@ -210,6 +210,9 @@
<li>
<a href='/components/binary_sensor.mqtt/'>MQTT Binary Sensor</a>
</li>
<li>
<a href='/components/binary_sensor.raincloud/'>Melnor Raincloud Binary Sensor</a>
</li>
<li>
<a href='/components/binary_sensor.modbus/'>Modbus Binary Sensor</a>
</li>

3
components/binary_sensor/index.html
View file

@ -193,6 +193,9 @@
<li><a href='/components/binary_sensor.mqtt/'>
MQTT Binary Sensor
</a></li>
<li><a href='/components/binary_sensor.raincloud/'>
Melnor Raincloud Binary Sensor
</a></li>
<li><a href='/components/binary_sensor.modbus/'>
Modbus Binary Sensor
</a></li>

6
components/blink/index.html
View file

@ -258,6 +258,9 @@
<li>
<a href='/components/mqtt/'>MQTT</a>
</li>
<li>
<a href='/components/raincloud/'>Melnor Raincloud</a>
</li>
<li>
<a href='/components/microsoft_face/'>Microsoft Face</a>
</li>
@ -327,6 +330,9 @@
<li>
<a href='/components/tesla/'>Tesla</a>
</li>
<li>
<a href='/components/thethingsnetwork/'>The Things Network</a>
</li>
<li>
<a href='/components/twilio/'>Twilio</a>
</li>

6
components/bloomsky/index.html
View file

@ -217,6 +217,9 @@
<li>
<a href='/components/mqtt/'>MQTT</a>
</li>
<li>
<a href='/components/raincloud/'>Melnor Raincloud</a>
</li>
<li>
<a href='/components/microsoft_face/'>Microsoft Face</a>
</li>
@ -286,6 +289,9 @@
<li>
<a href='/components/tesla/'>Tesla</a>
</li>
<li>
<a href='/components/thethingsnetwork/'>The Things Network</a>
</li>
<li>
<a href='/components/twilio/'>Twilio</a>
</li>

3
components/browser/index.html
View file

@ -118,6 +118,9 @@
<li>
Browser
</li>
<li>
<a href='/components/duckdns/'>DuckDNS</a>
</li>
<li>
<a href='/components/logger/'>Logger</a>
</li>

3
components/camera.mqtt/index.html
View file

@ -128,6 +128,9 @@
<li><a href='/components/fan.mqtt/'>
MQTT Fan
</a></li>
<li><a href='/components/climate.mqtt/'>
MQTT HVAC
</a></li>
<li><a href='/components/light.mqtt/'>
MQTT Light
</a></li>

5
components/climate.ecobee/index.html
View file

@ -608,6 +608,9 @@ be provided.</p>
<li>
<a href='/components/climate.knx/'>KNX Climate</a>
</li>
<li>
<a href='/components/climate.mqtt/'>MQTT HVAC</a>
</li>
<li>
<a href='/components/climate.mysensors/'>MySensors HVAC</a>
</li>
@ -639,7 +642,7 @@ be provided.</p>
<a href='/components/climate.vera/'>Vera Thermostat</a>
</li>
<li>
<a href='/components/climate.wink/'>Wink Thermostat</a>
<a href='/components/climate.wink/'>Wink Climate</a>
</li>
<li>
<a href='/components/climate.zwave/'>Z-Wave Climate</a>

5
components/climate.eq3btsmart/index.html
View file

@ -156,6 +156,9 @@ Valve: 0
<li>
<a href='/components/climate.knx/'>KNX Climate</a>
</li>
<li>
<a href='/components/climate.mqtt/'>MQTT HVAC</a>
</li>
<li>
<a href='/components/climate.mysensors/'>MySensors HVAC</a>
</li>
@ -187,7 +190,7 @@ Valve: 0
<a href='/components/climate.vera/'>Vera Thermostat</a>
</li>
<li>
<a href='/components/climate.wink/'>Wink Thermostat</a>
<a href='/components/climate.wink/'>Wink Climate</a>
</li>
<li>
<a href='/components/climate.zwave/'>Z-Wave Climate</a>

5
components/climate.flexit/index.html
View file

@ -156,6 +156,9 @@ This component requires the <a href="/components/modbus/">Modbus</a> component t
<li>
<a href='/components/climate.knx/'>KNX Climate</a>
</li>
<li>
<a href='/components/climate.mqtt/'>MQTT HVAC</a>
</li>
<li>
<a href='/components/climate.mysensors/'>MySensors HVAC</a>
</li>
@ -187,7 +190,7 @@ This component requires the <a href="/components/modbus/">Modbus</a> component t
<a href='/components/climate.vera/'>Vera Thermostat</a>
</li>
<li>
<a href='/components/climate.wink/'>Wink Thermostat</a>
<a href='/components/climate.wink/'>Wink Climate</a>
</li>
<li>
<a href='/components/climate.zwave/'>Z-Wave Climate</a>

5
components/climate.generic_thermostat/index.html
View file

@ -159,6 +159,9 @@
<li>
<a href='/components/climate.knx/'>KNX Climate</a>
</li>
<li>
<a href='/components/climate.mqtt/'>MQTT HVAC</a>
</li>
<li>
<a href='/components/climate.mysensors/'>MySensors HVAC</a>
</li>
@ -190,7 +193,7 @@
<a href='/components/climate.vera/'>Vera Thermostat</a>
</li>
<li>
<a href='/components/climate.wink/'>Wink Thermostat</a>
<a href='/components/climate.wink/'>Wink Climate</a>
</li>
<li>
<a href='/components/climate.zwave/'>Z-Wave Climate</a>

5
components/climate.heatmiser/index.html
View file

@ -142,6 +142,9 @@
<li>
<a href='/components/climate.knx/'>KNX Climate</a>
</li>
<li>
<a href='/components/climate.mqtt/'>MQTT HVAC</a>
</li>
<li>
<a href='/components/climate.mysensors/'>MySensors HVAC</a>
</li>
@ -173,7 +176,7 @@
<a href='/components/climate.vera/'>Vera Thermostat</a>
</li>
<li>
<a href='/components/climate.wink/'>Wink Thermostat</a>
<a href='/components/climate.wink/'>Wink Climate</a>
</li>
<li>
<a href='/components/climate.zwave/'>Z-Wave Climate</a>

5
components/climate.homematic/index.html
View file

@ -145,6 +145,9 @@
<li>
<a href='/components/climate.knx/'>KNX Climate</a>
</li>
<li>
<a href='/components/climate.mqtt/'>MQTT HVAC</a>
</li>
<li>
<a href='/components/climate.mysensors/'>MySensors HVAC</a>
</li>
@ -176,7 +179,7 @@
<a href='/components/climate.vera/'>Vera Thermostat</a>
</li>
<li>
<a href='/components/climate.wink/'>Wink Thermostat</a>
<a href='/components/climate.wink/'>Wink Climate</a>
</li>
<li>
<a href='/components/climate.zwave/'>Z-Wave Climate</a>

5
components/climate.honeywell/index.html
View file

@ -142,6 +142,9 @@ Scan interval is expressed in seconds. Omitting scan_interval may result in too-
<li>
<a href='/components/climate.knx/'>KNX Climate</a>
</li>
<li>
<a href='/components/climate.mqtt/'>MQTT HVAC</a>
</li>
<li>
<a href='/components/climate.mysensors/'>MySensors HVAC</a>
</li>
@ -173,7 +176,7 @@ Scan interval is expressed in seconds. Omitting scan_interval may result in too-
<a href='/components/climate.vera/'>Vera Thermostat</a>
</li>
<li>
<a href='/components/climate.wink/'>Wink Thermostat</a>
<a href='/components/climate.wink/'>Wink Climate</a>
</li>
<li>
<a href='/components/climate.zwave/'>Z-Wave Climate</a>

5
components/climate.knx/index.html
View file

@ -188,6 +188,9 @@
<li>
KNX Climate
</li>
<li>
<a href='/components/climate.mqtt/'>MQTT HVAC</a>
</li>
<li>
<a href='/components/climate.mysensors/'>MySensors HVAC</a>
</li>
@ -219,7 +222,7 @@
<a href='/components/climate.vera/'>Vera Thermostat</a>
</li>
<li>
<a href='/components/climate.wink/'>Wink Thermostat</a>
<a href='/components/climate.wink/'>Wink Climate</a>
</li>
<li>
<a href='/components/climate.zwave/'>Z-Wave Climate</a>

5
components/climate.maxcube/index.html
View file

@ -132,6 +132,9 @@
<li>
<a href='/components/climate.knx/'>KNX Climate</a>
</li>
<li>
<a href='/components/climate.mqtt/'>MQTT HVAC</a>
</li>
<li>
<a href='/components/climate.mysensors/'>MySensors HVAC</a>
</li>
@ -163,7 +166,7 @@
<a href='/components/climate.vera/'>Vera Thermostat</a>
</li>
<li>
<a href='/components/climate.wink/'>Wink Thermostat</a>
<a href='/components/climate.wink/'>Wink Climate</a>
</li>
<li>
<a href='/components/climate.zwave/'>Z-Wave Climate</a>

336
components/climate.mqtt/index.html Normal file
View file

@ -0,0 +1,336 @@
<!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>MQTT HVAC - Home Assistant</title>
<meta name="author" content="Home Assistant">
<meta name="description" content="Instructions how to integrate MQTT HVAC into Home Assistant.">
<meta name="viewport" content="width=device-width">
<link rel="canonical" href="https://home-assistant.io/components/climate.mqtt/">
<meta property="fb:app_id" content="338291289691179">
<meta property="og:title" content="MQTT HVAC">
<meta property="og:site_name" content="Home Assistant">
<meta property="og:url" content="https://home-assistant.io/components/climate.mqtt/">
<meta property="og:type" content="article">
<meta property="og:description" content="Instructions how to integrate MQTT HVAC into 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="MQTT HVAC">
<meta name="twitter:description" content="Instructions how to integrate MQTT HVAC into Home Assistant.">
<meta name="twitter:image" content="https://home-assistant.io/images/default-social.png">
<link href="/stylesheets/screen.css" media="screen, projection" 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">
MQTT HVAC
</h1>
</header>
<hr class="divider">
<p>The <code class="highlighter-rouge">mqtt</code> climate platform let you control your MQTT enabled HVAC devices.</p>
<p>The platform currently works in optimistic mode, which means it does not obtain states from MQTT topics, but it sends and remembers control commands.</p>
<p>It uses a sensor under the hood to obtain the current temperature.</p>
<div class="language-yaml highlighter-rouge"><pre class="highlight"><code><span class="c1"># Example configuration.yaml entry</span>
<span class="s">climate</span><span class="pi">:</span>
<span class="pi">-</span> <span class="s">platform</span><span class="pi">:</span> <span class="s">mqtt</span>
<span class="s">name</span><span class="pi">:</span> <span class="s">Study</span>
<span class="s">current_temperature_topic</span><span class="pi">:</span> <span class="s">/sensors/hvac_study/current_temp</span>
<span class="s">temperature_command_topic</span><span class="pi">:</span> <span class="s">/sensors/hvac_study/target_temp</span>
</code></pre>
</div>
<p>Configuration variables <em>except</em> for MQTT topics:</p>
<ul>
<li><strong>name</strong> (<em>Required</em>): Name of MQTT HVAC.</li>
<li><strong>qos</strong> (<em>Optional</em>): The maximum QoS level of the state topic. Default is <code class="highlighter-rouge">0</code> and will also be used to publishing messages.</li>
<li><strong>retain</strong> (<em>Optional</em>): If the published message should have the retain flag on or not.</li>
<li><strong>send_if_off</strong> (<em>Optional</em>): Set to <code class="highlighter-rouge">false</code> to suppress sending of all MQTT messages when the current mode is <code class="highlighter-rouge">Off</code>. Defaults to <code class="highlighter-rouge">true</code>.</li>
<li><strong>initial</strong> (<em>Optional</em>): Set the initial target temperature. Defaults to 21 degrees.</li>
<li><strong>payload_on</strong> (<em>Optional</em>): For MQTT topics that control an <code class="highlighter-rouge">on</code> / <code class="highlighter-rouge">off</code> value (e.g., <code class="highlighter-rouge">aux_command_topic</code>), set the value that should be sent for <code class="highlighter-rouge">on</code>. Defaults to ‘ON’.</li>
<li><strong>payload_off</strong> (<em>Optional</em>): For MQTT topics that control an <code class="highlighter-rouge">on</code> / <code class="highlighter-rouge">off</code> value (e.g., <code class="highlighter-rouge">aux_command_topic</code>), set the value that should be sent for <code class="highlighter-rouge">off</code>. Defaults to ‘OFF’.</li>
</ul>
<p>Configuration of the MQTT topics:</p>
<ul>
<li><strong>current_temperature_topic</strong> (<em>Optional</em>): The MQTT topic on which to listen for the current temperature</li>
<li><strong>power_command_topic</strong> (<em>Optional</em>): The MQTT topic to publish commands to change the power state. This is useful if your device has a separate power toggle in addition to mode.</li>
<li><strong>mode_command_topic</strong> (<em>Optional</em>): The MQTT topic to publish commands to change the HVAC operation mode.</li>
<li><strong>mode_state_topic</strong> (<em>Optional</em>): The MQTT topic to subscribe for changes of the HVAC operation mode. If this is not set, the operation mode works in optimistic mode (see below).</li>
<li><strong>temperature_command_topic</strong> (<em>Optional</em>): The MQTT topic to publish commands to change the target temperature.</li>
<li><strong>temperature_state_topic</strong> (<em>Optional</em>): The MQTT topic to subscribe for changes in the target temperature. If this is not set, the target temperature works in optimistic mode (see below).</li>
<li><strong>fan_mode_command_topic</strong> (<em>Optional</em>): The MQTT topic to publish commands to change the fan mode.</li>
<li><strong>fan_mode_state_topic</strong> (<em>Optional</em>): The MQTT topic to subscribe for changes of the HVAC fan mode. If this is not set, the fan mode works in optimistic mode (see below).</li>
<li><strong>swing_mode_command_topic</strong> (<em>Optional</em>): The MQTT topic to publish commands to change the swing mode.</li>
<li><strong>swing_mode_state_topic</strong> (<em>Optional</em>): The MQTT topic to subscribe for changes of the HVAC swing mode. If this is not set, the swing mode works in optimistic mode (see below).</li>
<li><strong>away_mode_command_topic</strong> (<em>Optional</em>): The MQTT topic to publish commands to change the away mode.</li>
<li><strong>away_mode_state_topic</strong> (<em>Optional</em>): The MQTT topic to subscribe for changes of the HVAC away mode. If this is not set, the away mode works in optimistic mode (see below).</li>
<li><strong>hold_command_topic</strong> (<em>Optional</em>): The MQTT topic to publish commands to change the hold mode.</li>
<li><strong>hold_state_topic</strong> (<em>Optional</em>): The MQTT topic to subscribe for changes of the HVAC hold mode. If this is not set, the hold mode works in optimistic mode (see below).</li>
<li><strong>aux_command_topic</strong> (<em>Optional</em>): The MQTT topic to publish commands to switch auxiliary heat.</li>
<li><strong>aux_state_topic</strong> (<em>Optional</em>): The MQTT topic to subscribe for changes of the auxiliary heat mode. If this is not set, the auxiliary heat mode works in optimistic mode (see below).</li>
</ul>
<h4>Optimistic mode</h4>
<p>If a property works in <em>optimistic mode</em> (when the corresponding state topic is not set), home assistant will assume that any state changes published to the command topics did work and change the internal state of the entity immediately after publishing to the command topic. If it does not work in optimistic mode, the internal state of the entity is only updated when the requested update is confirmed by the device through the state topic.</p>
<h3><a class="title-link" name="example" href="#example"></a> Example</h3>
<p>A full configuration example looks like the one below.</p>
<div class="language-yaml highlighter-rouge"><pre class="highlight"><code><span class="c1"># Full example configuration.yaml entry</span>
<span class="s">climate</span><span class="pi">:</span>
<span class="pi">-</span> <span class="s">platform</span><span class="pi">:</span> <span class="s">mqtt</span>
<span class="s">name</span><span class="pi">:</span> <span class="s">Study</span>
<span class="s">target_sensor</span><span class="pi">:</span> <span class="s">sensor.study_temperature</span>
<span class="s">modes</span><span class="pi">:</span>
<span class="pi">-</span> <span class="s">off</span>
<span class="pi">-</span> <span class="s">cool</span>
<span class="pi">-</span> <span class="s">fan_only</span>
<span class="s">swing_modes</span><span class="pi">:</span>
<span class="pi">-</span> <span class="s">on</span>
<span class="pi">-</span> <span class="s">off</span>
<span class="s">fan_modes</span><span class="pi">:</span>
<span class="pi">-</span> <span class="s">high</span>
<span class="pi">-</span> <span class="s">medium</span>
<span class="pi">-</span> <span class="s">low</span>
<span class="s">power_command_topic</span><span class="pi">:</span> <span class="s2">"</span><span class="s">study/ac/power/set"</span>
<span class="s">mode_command_topic</span><span class="pi">:</span> <span class="s2">"</span><span class="s">study/ac/mode/set"</span>
<span class="s">temperature_command_topic</span><span class="pi">:</span> <span class="s2">"</span><span class="s">study/ac/temperature/set"</span>
<span class="s">fan_mode_command_topic</span><span class="pi">:</span> <span class="s2">"</span><span class="s">study/ac/fan/set"</span>
<span class="s">swing_mode_command_topic</span><span class="pi">:</span> <span class="s2">"</span><span class="s">study/ac/swing/set"</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/climate.mqtt.markdown'>Edit this page on GitHub</a></div>
<div class='brand-logo-container section'>
<img src='/images/supported_brands/heat-control.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 Polling
</div>
<div class='section'>
Introduced in release: 0.55
</div>
<div class='section'>
This is a platform for
<a href='/components/climate/'>the Climate component</a>.
</div>
<div class='section'>
<h1 class='title delta'>Related components</h1>
<ul class='divided'>
<li><a href='/components/mqtt/'>
MQTT
</a></li>
<li><a href='/components/alarm_control_panel.mqtt/'>
MQTT Alarm Control Panel
</a></li>
<li><a href='/components/binary_sensor.mqtt/'>
MQTT Binary Sensor
</a></li>
<li><a href='/components/camera.mqtt/'>
MQTT Camera
</a></li>
<li><a href='/components/cover.mqtt/'>
MQTT Cover
</a></li>
<li><a href='/components/device_tracker.mqtt/'>
MQTT Device Tracker
</a></li>
<li><a href='/components/fan.mqtt/'>
MQTT Fan
</a></li>
<li><a href='/components/light.mqtt/'>
MQTT Light
</a></li>
<li><a href='/components/lock.mqtt/'>
MQTT Lock
</a></li>
<li><a href='/components/notify.mqtt/'>
MQTT Notifications
</a></li>
<li><a href='/components/sensor.mqtt/'>
MQTT Sensor
</a></li>
<li><a href='/components/switch.mqtt/'>
MQTT Switch
</a></li>
<li><a href='/components/vacuum.mqtt/'>
MQTT Vacuum
</a></li>
</ul>
</div>
<div class='section'>
<h1 class="title delta">Category Climate</h1>
<ul class='divided'>
<li>
<a href='/components/climate.eq3btsmart/'>EQ3 Bluetooth Smart Thermostats</a>
</li>
<li>
<a href='/components/climate.ecobee/'>Ecobee Thermostat</a>
</li>
<li>
<a href='/components/climate.flexit/'>Flexit A/C controller</a>
</li>
<li>
<a href='/components/climate.generic_thermostat/'>Generic Thermostat</a>
</li>
<li>
<a href='/components/climate.heatmiser/'>Heatmiser Thermostat</a>
</li>
<li>
<a href='/components/climate.homematic/'>Homematic Thermostats</a>
</li>
<li>
<a href='/components/climate.honeywell/'>Honeywell Thermostat</a>
</li>
<li>
<a href='/components/climate.knx/'>KNX Climate</a>
</li>
<li>
MQTT HVAC
</li>
<li>
<a href='/components/climate.mysensors/'>MySensors HVAC</a>
</li>
<li>
<a href='/components/climate.nest/'>Nest Thermostat</a>
</li>
<li>
<a href='/components/climate.netatmo/'>Netatmo Thermostat</a>
</li>
<li>
<a href='/components/climate.oem/'>OpenEnergyMonitor WiFi Thermostat</a>
</li>
<li>
<a href='/components/climate.proliphix/'>Proliphix Thermostat</a>
</li>
<li>
<a href='/components/climate.radiotherm/'>Radio Thermostat (3M Filtrete) Thermostat</a>
</li>
<li>
<a href='/components/climate.sensibo/'>Sensibo A/C controller</a>
</li>
<li>
<a href='/components/climate.tado/'>Tado Thermostat</a>
</li>
<li>
<a href='/components/climate.tesla/'>Tesla HVAC</a>
</li>
<li>
<a href='/components/climate.vera/'>Vera Thermostat</a>
</li>
<li>
<a href='/components/climate.wink/'>Wink Climate</a>
</li>
<li>
<a href='/components/climate.zwave/'>Z-Wave Climate</a>
</li>
<li>
<a href='/components/maxcube/'>eQ-3 MAX! Cube</a>
</li>
<li>
<a href='/components/binary_sensor.maxcube/'>eQ-3 MAX! Cube binary sensors</a>
</li>
<li>
<a href='/components/climate.maxcube/'>eQ-3 MAX! Cube thermostat</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>

5
components/climate.mysensors/index.html
View file

@ -403,6 +403,9 @@ new DaikinHeatpumpIR()
<li>
<a href='/components/climate.knx/'>KNX Climate</a>
</li>
<li>
<a href='/components/climate.mqtt/'>MQTT HVAC</a>
</li>
<li>
MySensors HVAC
</li>
@ -434,7 +437,7 @@ new DaikinHeatpumpIR()
<a href='/components/climate.vera/'>Vera Thermostat</a>
</li>
<li>
<a href='/components/climate.wink/'>Wink Thermostat</a>
<a href='/components/climate.wink/'>Wink Climate</a>
</li>
<li>
<a href='/components/climate.zwave/'>Z-Wave Climate</a>

5
components/climate.nest/index.html
View file

@ -141,6 +141,9 @@ You must have the <a href="/components/nest/">Nest component</a> configured to u
<li>
<a href='/components/climate.knx/'>KNX Climate</a>
</li>
<li>
<a href='/components/climate.mqtt/'>MQTT HVAC</a>
</li>
<li>
<a href='/components/climate.mysensors/'>MySensors HVAC</a>
</li>
@ -172,7 +175,7 @@ You must have the <a href="/components/nest/">Nest component</a> configured to u
<a href='/components/climate.vera/'>Vera Thermostat</a>
</li>
<li>
<a href='/components/climate.wink/'>Wink Thermostat</a>
<a href='/components/climate.wink/'>Wink Climate</a>
</li>
<li>
<a href='/components/climate.zwave/'>Z-Wave Climate</a>

5
components/climate.netatmo/index.html
View file

@ -163,6 +163,9 @@
<li>
<a href='/components/climate.knx/'>KNX Climate</a>
</li>
<li>
<a href='/components/climate.mqtt/'>MQTT HVAC</a>
</li>
<li>
<a href='/components/climate.mysensors/'>MySensors HVAC</a>
</li>
@ -194,7 +197,7 @@
<a href='/components/climate.vera/'>Vera Thermostat</a>
</li>
<li>
<a href='/components/climate.wink/'>Wink Thermostat</a>
<a href='/components/climate.wink/'>Wink Climate</a>
</li>
<li>
<a href='/components/climate.zwave/'>Z-Wave Climate</a>

5
components/climate.oem/index.html
View file

@ -138,6 +138,9 @@
<li>
<a href='/components/climate.knx/'>KNX Climate</a>
</li>
<li>
<a href='/components/climate.mqtt/'>MQTT HVAC</a>
</li>
<li>
<a href='/components/climate.mysensors/'>MySensors HVAC</a>
</li>
@ -169,7 +172,7 @@
<a href='/components/climate.vera/'>Vera Thermostat</a>
</li>
<li>
<a href='/components/climate.wink/'>Wink Thermostat</a>
<a href='/components/climate.wink/'>Wink Climate</a>
</li>
<li>
<a href='/components/climate.zwave/'>Z-Wave Climate</a>

5
components/climate.proliphix/index.html
View file

@ -141,6 +141,9 @@ of OID values. A complete collection of the API is available in this <a href="ht
<li>
<a href='/components/climate.knx/'>KNX Climate</a>
</li>
<li>
<a href='/components/climate.mqtt/'>MQTT HVAC</a>
</li>
<li>
<a href='/components/climate.mysensors/'>MySensors HVAC</a>
</li>
@ -172,7 +175,7 @@ of OID values. A complete collection of the API is available in this <a href="ht
<a href='/components/climate.vera/'>Vera Thermostat</a>
</li>
<li>
<a href='/components/climate.wink/'>Wink Thermostat</a>
<a href='/components/climate.wink/'>Wink Climate</a>
</li>
<li>
<a href='/components/climate.zwave/'>Z-Wave Climate</a>

5
components/climate.radiotherm/index.html
View file

@ -148,6 +148,9 @@
<li>
<a href='/components/climate.knx/'>KNX Climate</a>
</li>
<li>
<a href='/components/climate.mqtt/'>MQTT HVAC</a>
</li>
<li>
<a href='/components/climate.mysensors/'>MySensors HVAC</a>
</li>
@ -179,7 +182,7 @@
<a href='/components/climate.vera/'>Vera Thermostat</a>
</li>
<li>
<a href='/components/climate.wink/'>Wink Thermostat</a>
<a href='/components/climate.wink/'>Wink Climate</a>
</li>
<li>
<a href='/components/climate.zwave/'>Z-Wave Climate</a>

5
components/climate.sensibo/index.html
View file

@ -148,6 +148,9 @@ done in the app and actions done by Home Assistant.
<li>
<a href='/components/climate.knx/'>KNX Climate</a>
</li>
<li>
<a href='/components/climate.mqtt/'>MQTT HVAC</a>
</li>
<li>
<a href='/components/climate.mysensors/'>MySensors HVAC</a>
</li>
@ -179,7 +182,7 @@ done in the app and actions done by Home Assistant.
<a href='/components/climate.vera/'>Vera Thermostat</a>
</li>
<li>
<a href='/components/climate.wink/'>Wink Thermostat</a>
<a href='/components/climate.wink/'>Wink Climate</a>
</li>
<li>
<a href='/components/climate.zwave/'>Z-Wave Climate</a>

5
components/climate.tado/index.html
View file

@ -136,6 +136,9 @@
<li>
<a href='/components/climate.knx/'>KNX Climate</a>
</li>
<li>
<a href='/components/climate.mqtt/'>MQTT HVAC</a>
</li>
<li>
<a href='/components/climate.mysensors/'>MySensors HVAC</a>
</li>
@ -167,7 +170,7 @@
<a href='/components/climate.vera/'>Vera Thermostat</a>
</li>
<li>
<a href='/components/climate.wink/'>Wink Thermostat</a>
<a href='/components/climate.wink/'>Wink Climate</a>
</li>
<li>
<a href='/components/climate.zwave/'>Z-Wave Climate</a>

5
components/climate.tesla/index.html
View file

@ -143,6 +143,9 @@
<li>
<a href='/components/climate.knx/'>KNX Climate</a>
</li>
<li>
<a href='/components/climate.mqtt/'>MQTT HVAC</a>
</li>
<li>
<a href='/components/climate.mysensors/'>MySensors HVAC</a>
</li>
@ -174,7 +177,7 @@
<a href='/components/climate.vera/'>Vera Thermostat</a>
</li>
<li>
<a href='/components/climate.wink/'>Wink Thermostat</a>
<a href='/components/climate.wink/'>Wink Climate</a>
</li>
<li>
<a href='/components/climate.zwave/'>Z-Wave Climate</a>

5
components/climate.vera/index.html
View file

@ -149,6 +149,9 @@
<li>
<a href='/components/climate.knx/'>KNX Climate</a>
</li>
<li>
<a href='/components/climate.mqtt/'>MQTT HVAC</a>
</li>
<li>
<a href='/components/climate.mysensors/'>MySensors HVAC</a>
</li>
@ -180,7 +183,7 @@
Vera Thermostat
</li>
<li>
<a href='/components/climate.wink/'>Wink Thermostat</a>
<a href='/components/climate.wink/'>Wink Climate</a>
</li>
<li>
<a href='/components/climate.zwave/'>Z-Wave Climate</a>

Some files were not shown because too many files have changed in this diff Show more