Site updated at 2017-03-17 23:29:49 UTC

This commit is contained in:
Travis CI 2017-03-17 23:29:50 +00:00
parent 4678fc9759
commit af3d708fbe
26 changed files with 280 additions and 60 deletions

View file

@ -4,7 +4,7 @@
<title><![CDATA[Home Assistant]]></title> <title><![CDATA[Home Assistant]]></title>
<link href="https://home-assistant.io/atom.xml" rel="self"/> <link href="https://home-assistant.io/atom.xml" rel="self"/>
<link href="https://home-assistant.io/"/> <link href="https://home-assistant.io/"/>
<updated>2017-03-17T19:47:07+00:00</updated> <updated>2017-03-17T23:26:50+00:00</updated>
<id>https://home-assistant.io/</id> <id>https://home-assistant.io/</id>
<author> <author>
<name><![CDATA[Home Assistant]]></name> <name><![CDATA[Home Assistant]]></name>

View file

@ -4,7 +4,7 @@
<title><![CDATA[Category: Community | Home Assistant]]></title> <title><![CDATA[Category: Community | Home Assistant]]></title>
<link href="https://home-assistant.io/blog/categories/community/atom.xml" rel="self"/> <link href="https://home-assistant.io/blog/categories/community/atom.xml" rel="self"/>
<link href="https://home-assistant.io/"/> <link href="https://home-assistant.io/"/>
<updated>2017-03-17T19:47:07+00:00</updated> <updated>2017-03-17T23:26:50+00:00</updated>
<id>https://home-assistant.io/</id> <id>https://home-assistant.io/</id>
<author> <author>
<name><![CDATA[Home Assistant]]></name> <name><![CDATA[Home Assistant]]></name>

View file

@ -4,7 +4,7 @@
<title><![CDATA[Category: Device-Tracking | Home Assistant]]></title> <title><![CDATA[Category: Device-Tracking | Home Assistant]]></title>
<link href="https://home-assistant.io/blog/categories/device-tracking/atom.xml" rel="self"/> <link href="https://home-assistant.io/blog/categories/device-tracking/atom.xml" rel="self"/>
<link href="https://home-assistant.io/"/> <link href="https://home-assistant.io/"/>
<updated>2017-03-17T19:47:07+00:00</updated> <updated>2017-03-17T23:26:50+00:00</updated>
<id>https://home-assistant.io/</id> <id>https://home-assistant.io/</id>
<author> <author>
<name><![CDATA[Home Assistant]]></name> <name><![CDATA[Home Assistant]]></name>

View file

@ -4,7 +4,7 @@
<title><![CDATA[Category: ESP8266 | Home Assistant]]></title> <title><![CDATA[Category: ESP8266 | Home Assistant]]></title>
<link href="https://home-assistant.io/blog/categories/esp8266/atom.xml" rel="self"/> <link href="https://home-assistant.io/blog/categories/esp8266/atom.xml" rel="self"/>
<link href="https://home-assistant.io/"/> <link href="https://home-assistant.io/"/>
<updated>2017-03-17T19:47:07+00:00</updated> <updated>2017-03-17T23:26:50+00:00</updated>
<id>https://home-assistant.io/</id> <id>https://home-assistant.io/</id>
<author> <author>
<name><![CDATA[Home Assistant]]></name> <name><![CDATA[Home Assistant]]></name>

View file

@ -4,7 +4,7 @@
<title><![CDATA[Category: How-To | Home Assistant]]></title> <title><![CDATA[Category: How-To | Home Assistant]]></title>
<link href="https://home-assistant.io/blog/categories/how-to/atom.xml" rel="self"/> <link href="https://home-assistant.io/blog/categories/how-to/atom.xml" rel="self"/>
<link href="https://home-assistant.io/"/> <link href="https://home-assistant.io/"/>
<updated>2017-03-17T19:47:07+00:00</updated> <updated>2017-03-17T23:26:50+00:00</updated>
<id>https://home-assistant.io/</id> <id>https://home-assistant.io/</id>
<author> <author>
<name><![CDATA[Home Assistant]]></name> <name><![CDATA[Home Assistant]]></name>

View file

@ -4,7 +4,7 @@
<title><![CDATA[Category: iBeacons | Home Assistant]]></title> <title><![CDATA[Category: iBeacons | Home Assistant]]></title>
<link href="https://home-assistant.io/blog/categories/ibeacons/atom.xml" rel="self"/> <link href="https://home-assistant.io/blog/categories/ibeacons/atom.xml" rel="self"/>
<link href="https://home-assistant.io/"/> <link href="https://home-assistant.io/"/>
<updated>2017-03-17T19:47:07+00:00</updated> <updated>2017-03-17T23:26:50+00:00</updated>
<id>https://home-assistant.io/</id> <id>https://home-assistant.io/</id>
<author> <author>
<name><![CDATA[Home Assistant]]></name> <name><![CDATA[Home Assistant]]></name>

View file

@ -4,7 +4,7 @@
<title><![CDATA[Category: Internet-of-Things | Home Assistant]]></title> <title><![CDATA[Category: Internet-of-Things | Home Assistant]]></title>
<link href="https://home-assistant.io/blog/categories/internet-of-things/atom.xml" rel="self"/> <link href="https://home-assistant.io/blog/categories/internet-of-things/atom.xml" rel="self"/>
<link href="https://home-assistant.io/"/> <link href="https://home-assistant.io/"/>
<updated>2017-03-17T19:47:07+00:00</updated> <updated>2017-03-17T23:26:50+00:00</updated>
<id>https://home-assistant.io/</id> <id>https://home-assistant.io/</id>
<author> <author>
<name><![CDATA[Home Assistant]]></name> <name><![CDATA[Home Assistant]]></name>

View file

@ -4,7 +4,7 @@
<title><![CDATA[Category: IoT-Data | Home Assistant]]></title> <title><![CDATA[Category: IoT-Data | Home Assistant]]></title>
<link href="https://home-assistant.io/blog/categories/iot-data/atom.xml" rel="self"/> <link href="https://home-assistant.io/blog/categories/iot-data/atom.xml" rel="self"/>
<link href="https://home-assistant.io/"/> <link href="https://home-assistant.io/"/>
<updated>2017-03-17T19:47:07+00:00</updated> <updated>2017-03-17T23:26:50+00:00</updated>
<id>https://home-assistant.io/</id> <id>https://home-assistant.io/</id>
<author> <author>
<name><![CDATA[Home Assistant]]></name> <name><![CDATA[Home Assistant]]></name>

View file

@ -4,7 +4,7 @@
<title><![CDATA[Category: Merchandise | Home Assistant]]></title> <title><![CDATA[Category: Merchandise | Home Assistant]]></title>
<link href="https://home-assistant.io/blog/categories/merchandise/atom.xml" rel="self"/> <link href="https://home-assistant.io/blog/categories/merchandise/atom.xml" rel="self"/>
<link href="https://home-assistant.io/"/> <link href="https://home-assistant.io/"/>
<updated>2017-03-17T19:47:07+00:00</updated> <updated>2017-03-17T23:26:50+00:00</updated>
<id>https://home-assistant.io/</id> <id>https://home-assistant.io/</id>
<author> <author>
<name><![CDATA[Home Assistant]]></name> <name><![CDATA[Home Assistant]]></name>

View file

@ -4,7 +4,7 @@
<title><![CDATA[Category: Micropython | Home Assistant]]></title> <title><![CDATA[Category: Micropython | Home Assistant]]></title>
<link href="https://home-assistant.io/blog/categories/micropython/atom.xml" rel="self"/> <link href="https://home-assistant.io/blog/categories/micropython/atom.xml" rel="self"/>
<link href="https://home-assistant.io/"/> <link href="https://home-assistant.io/"/>
<updated>2017-03-17T19:47:07+00:00</updated> <updated>2017-03-17T23:26:50+00:00</updated>
<id>https://home-assistant.io/</id> <id>https://home-assistant.io/</id>
<author> <author>
<name><![CDATA[Home Assistant]]></name> <name><![CDATA[Home Assistant]]></name>

View file

@ -4,7 +4,7 @@
<title><![CDATA[Category: MQTT | Home Assistant]]></title> <title><![CDATA[Category: MQTT | Home Assistant]]></title>
<link href="https://home-assistant.io/blog/categories/mqtt/atom.xml" rel="self"/> <link href="https://home-assistant.io/blog/categories/mqtt/atom.xml" rel="self"/>
<link href="https://home-assistant.io/"/> <link href="https://home-assistant.io/"/>
<updated>2017-03-17T19:47:07+00:00</updated> <updated>2017-03-17T23:26:50+00:00</updated>
<id>https://home-assistant.io/</id> <id>https://home-assistant.io/</id>
<author> <author>
<name><![CDATA[Home Assistant]]></name> <name><![CDATA[Home Assistant]]></name>

View file

@ -4,7 +4,7 @@
<title><![CDATA[Category: Organisation | Home Assistant]]></title> <title><![CDATA[Category: Organisation | Home Assistant]]></title>
<link href="https://home-assistant.io/blog/categories/organisation/atom.xml" rel="self"/> <link href="https://home-assistant.io/blog/categories/organisation/atom.xml" rel="self"/>
<link href="https://home-assistant.io/"/> <link href="https://home-assistant.io/"/>
<updated>2017-03-17T19:47:07+00:00</updated> <updated>2017-03-17T23:26:50+00:00</updated>
<id>https://home-assistant.io/</id> <id>https://home-assistant.io/</id>
<author> <author>
<name><![CDATA[Home Assistant]]></name> <name><![CDATA[Home Assistant]]></name>

View file

@ -4,7 +4,7 @@
<title><![CDATA[Category: OwnTracks | Home Assistant]]></title> <title><![CDATA[Category: OwnTracks | Home Assistant]]></title>
<link href="https://home-assistant.io/blog/categories/owntracks/atom.xml" rel="self"/> <link href="https://home-assistant.io/blog/categories/owntracks/atom.xml" rel="self"/>
<link href="https://home-assistant.io/"/> <link href="https://home-assistant.io/"/>
<updated>2017-03-17T19:47:07+00:00</updated> <updated>2017-03-17T23:26:50+00:00</updated>
<id>https://home-assistant.io/</id> <id>https://home-assistant.io/</id>
<author> <author>
<name><![CDATA[Home Assistant]]></name> <name><![CDATA[Home Assistant]]></name>

View file

@ -4,7 +4,7 @@
<title><![CDATA[Category: Presence-Detection | Home Assistant]]></title> <title><![CDATA[Category: Presence-Detection | Home Assistant]]></title>
<link href="https://home-assistant.io/blog/categories/presence-detection/atom.xml" rel="self"/> <link href="https://home-assistant.io/blog/categories/presence-detection/atom.xml" rel="self"/>
<link href="https://home-assistant.io/"/> <link href="https://home-assistant.io/"/>
<updated>2017-03-17T19:47:07+00:00</updated> <updated>2017-03-17T23:26:50+00:00</updated>
<id>https://home-assistant.io/</id> <id>https://home-assistant.io/</id>
<author> <author>
<name><![CDATA[Home Assistant]]></name> <name><![CDATA[Home Assistant]]></name>

View file

@ -4,7 +4,7 @@
<title><![CDATA[Category: Public-Service-Announcement | Home Assistant]]></title> <title><![CDATA[Category: Public-Service-Announcement | Home Assistant]]></title>
<link href="https://home-assistant.io/blog/categories/public-service-announcement/atom.xml" rel="self"/> <link href="https://home-assistant.io/blog/categories/public-service-announcement/atom.xml" rel="self"/>
<link href="https://home-assistant.io/"/> <link href="https://home-assistant.io/"/>
<updated>2017-03-17T19:47:07+00:00</updated> <updated>2017-03-17T23:26:50+00:00</updated>
<id>https://home-assistant.io/</id> <id>https://home-assistant.io/</id>
<author> <author>
<name><![CDATA[Home Assistant]]></name> <name><![CDATA[Home Assistant]]></name>

View file

@ -4,7 +4,7 @@
<title><![CDATA[Category: Release-Notes | Home Assistant]]></title> <title><![CDATA[Category: Release-Notes | Home Assistant]]></title>
<link href="https://home-assistant.io/blog/categories/release-notes/atom.xml" rel="self"/> <link href="https://home-assistant.io/blog/categories/release-notes/atom.xml" rel="self"/>
<link href="https://home-assistant.io/"/> <link href="https://home-assistant.io/"/>
<updated>2017-03-17T19:47:07+00:00</updated> <updated>2017-03-17T23:26:50+00:00</updated>
<id>https://home-assistant.io/</id> <id>https://home-assistant.io/</id>
<author> <author>
<name><![CDATA[Home Assistant]]></name> <name><![CDATA[Home Assistant]]></name>

View file

@ -4,7 +4,7 @@
<title><![CDATA[Category: Survey | Home Assistant]]></title> <title><![CDATA[Category: Survey | Home Assistant]]></title>
<link href="https://home-assistant.io/blog/categories/survey/atom.xml" rel="self"/> <link href="https://home-assistant.io/blog/categories/survey/atom.xml" rel="self"/>
<link href="https://home-assistant.io/"/> <link href="https://home-assistant.io/"/>
<updated>2017-03-17T19:47:07+00:00</updated> <updated>2017-03-17T23:26:50+00:00</updated>
<id>https://home-assistant.io/</id> <id>https://home-assistant.io/</id>
<author> <author>
<name><![CDATA[Home Assistant]]></name> <name><![CDATA[Home Assistant]]></name>

View file

@ -4,7 +4,7 @@
<title><![CDATA[Category: Talks | Home Assistant]]></title> <title><![CDATA[Category: Talks | Home Assistant]]></title>
<link href="https://home-assistant.io/blog/categories/talks/atom.xml" rel="self"/> <link href="https://home-assistant.io/blog/categories/talks/atom.xml" rel="self"/>
<link href="https://home-assistant.io/"/> <link href="https://home-assistant.io/"/>
<updated>2017-03-17T19:47:07+00:00</updated> <updated>2017-03-17T23:26:50+00:00</updated>
<id>https://home-assistant.io/</id> <id>https://home-assistant.io/</id>
<author> <author>
<name><![CDATA[Home Assistant]]></name> <name><![CDATA[Home Assistant]]></name>

View file

@ -4,7 +4,7 @@
<title><![CDATA[Category: Technology | Home Assistant]]></title> <title><![CDATA[Category: Technology | Home Assistant]]></title>
<link href="https://home-assistant.io/blog/categories/technology/atom.xml" rel="self"/> <link href="https://home-assistant.io/blog/categories/technology/atom.xml" rel="self"/>
<link href="https://home-assistant.io/"/> <link href="https://home-assistant.io/"/>
<updated>2017-03-17T19:47:07+00:00</updated> <updated>2017-03-17T23:26:50+00:00</updated>
<id>https://home-assistant.io/</id> <id>https://home-assistant.io/</id>
<author> <author>
<name><![CDATA[Home Assistant]]></name> <name><![CDATA[Home Assistant]]></name>

View file

@ -4,7 +4,7 @@
<title><![CDATA[Category: User-Stories | Home Assistant]]></title> <title><![CDATA[Category: User-Stories | Home Assistant]]></title>
<link href="https://home-assistant.io/blog/categories/user-stories/atom.xml" rel="self"/> <link href="https://home-assistant.io/blog/categories/user-stories/atom.xml" rel="self"/>
<link href="https://home-assistant.io/"/> <link href="https://home-assistant.io/"/>
<updated>2017-03-17T19:47:07+00:00</updated> <updated>2017-03-17T23:26:50+00:00</updated>
<id>https://home-assistant.io/</id> <id>https://home-assistant.io/</id>
<author> <author>
<name><![CDATA[Home Assistant]]></name> <name><![CDATA[Home Assistant]]></name>

View file

@ -4,7 +4,7 @@
<title><![CDATA[Category: Video | Home Assistant]]></title> <title><![CDATA[Category: Video | Home Assistant]]></title>
<link href="https://home-assistant.io/blog/categories/video/atom.xml" rel="self"/> <link href="https://home-assistant.io/blog/categories/video/atom.xml" rel="self"/>
<link href="https://home-assistant.io/"/> <link href="https://home-assistant.io/"/>
<updated>2017-03-17T19:47:07+00:00</updated> <updated>2017-03-17T23:26:50+00:00</updated>
<id>https://home-assistant.io/</id> <id>https://home-assistant.io/</id>
<author> <author>
<name><![CDATA[Home Assistant]]></name> <name><![CDATA[Home Assistant]]></name>

View file

@ -4,7 +4,7 @@
<title><![CDATA[Category: Website | Home Assistant]]></title> <title><![CDATA[Category: Website | Home Assistant]]></title>
<link href="https://home-assistant.io/blog/categories/website/atom.xml" rel="self"/> <link href="https://home-assistant.io/blog/categories/website/atom.xml" rel="self"/>
<link href="https://home-assistant.io/"/> <link href="https://home-assistant.io/"/>
<updated>2017-03-17T19:47:07+00:00</updated> <updated>2017-03-17T23:26:50+00:00</updated>
<id>https://home-assistant.io/</id> <id>https://home-assistant.io/</id>
<author> <author>
<name><![CDATA[Home Assistant]]></name> <name><![CDATA[Home Assistant]]></name>

View file

@ -90,7 +90,7 @@
<hr class="divider"> <hr class="divider">
<p>The <code class="highlighter-rouge">mqtt</code> light platform let you control your MQTT enabled light.</p> <p>The <code class="highlighter-rouge">mqtt</code> light platform lets you control your MQTT enabled light. It supports setting brightness, color temperature, effects, flashing, on/off, RGB colors, transitions, XY colors and white values.</p>
<p>In an ideal scenario, the MQTT device will have a state topic to publish state changes. If these messages are published with RETAIN flag, the MQTT switch will receive an instant state update after subscription and will start with correct state. Otherwise, the initial state of the switch will be false/off.</p> <p>In an ideal scenario, the MQTT device will have a state topic to publish state changes. If these messages are published with RETAIN flag, the MQTT switch will receive an instant state update after subscription and will start with correct state. Otherwise, the initial state of the switch will be false/off.</p>
@ -109,29 +109,106 @@
<ul> <ul>
<li><strong>command_topic</strong> (<em>Required</em>): The MQTT topic to publish commands to change the switch state.</li> <li><strong>command_topic</strong> (<em>Required</em>): The MQTT topic to publish commands to change the switch state.</li>
<li><strong>name</strong> (<em>Optional</em>): The name of the switch. Default is MQTT Switch.</li>
<li><strong>state_topic</strong> (<em>Optional</em>): The MQTT topic subscribed to receive state updates.</li>
<li><strong>brightness_state_topic</strong> (<em>Optional</em>): The MQTT topic subscribed to receive brightness state updates.</li>
<li><strong>brightness_command_topic</strong> (<em>Optional</em>): The MQTT topic to publish commands to change the lights brightness.</li> <li><strong>brightness_command_topic</strong> (<em>Optional</em>): The MQTT topic to publish commands to change the lights brightness.</li>
<li><strong>rgb_state_topic</strong> (<em>Optional</em>): The MQTT topic subscribed to receive RGB state updates.</li>
<li><strong>rgb_command_topic</strong> (<em>Optional</em>): The MQTT topic to publish commands to change the lights RGB state.</li>
<li><strong>color_temp_state_topic</strong> (<em>Optional</em>): The MQTT topic subscribed to receive color temperature state updates.</li>
<li><strong>color_temp_command_topic</strong> (<em>Optional</em>): The MQTT topic to publish commands to change the lights color temperature state.</li>
<li><strong>state_value_template</strong> (<em>Optional</em>): Defines a <a href="/topics/templating/">template</a> to extract the state value.</li>
<li><strong>brightness_value_template</strong> (<em>Optional</em>): Defines a <a href="/topics/templating/">template</a> to extract the brightness value.</li>
<li><strong>rgb_value_template</strong> (<em>Optional</em>): Defines a <a href="/topics/templating/">template</a> to extract the RGB value.</li>
<li><strong>color_temp_value_template</strong> (<em>Optional</em>): Defines a <a href="/topics/templating/">template</a> to extract the color temperature value.</li>
<li><strong>brightness_scale</strong> (<em>Optional</em>): Defines the maximum brightness value (i.e. 100%) of the MQTT device (defaults to 255).</li> <li><strong>brightness_scale</strong> (<em>Optional</em>): Defines the maximum brightness value (i.e. 100%) of the MQTT device (defaults to 255).</li>
<li><strong>qos</strong> (<em>Optional</em>): The maximum QoS level of the state topic. Default is 0 and will also be used to publishing messages.</li> <li><strong>brightness_state_topic</strong> (<em>Optional</em>): The MQTT topic subscribed to receive brightness state updates.</li>
<li><strong>payload_on</strong> (<em>Optional</em>): The payload that represents enabled state. Default is “ON”.</li> <li><strong>brightness_value_template</strong> (<em>Optional</em>): Defines a <a href="/topics/templating/">template</a> to extract the brightness value.</li>
<li><strong>payload_off</strong> (<em>Optional</em>): The payload that represents disabled state. Default is “OFF”.</li> <li><strong>color_temp_command_topic</strong> (<em>Optional</em>): The MQTT topic to publish commands to change the lights color temperature state.</li>
<li><strong>color_temp_state_topic</strong> (<em>Optional</em>): The MQTT topic subscribed to receive color temperature state updates.</li>
<li><strong>color_temp_value_template</strong> (<em>Optional</em>): Defines a <a href="/topics/templating/">template</a> to extract the color temperature value.</li>
<li><strong>effect_command_topic</strong> (<em>Optional</em>): The MQTT topic to publish commands to change the lights effect state.</li>
<li><strong>effect_state_topic</strong> (<em>Optional</em>): The MQTT topic subscribed to receive effect state updates.</li>
<li><strong>effect_value_template</strong> (<em>Optional</em>): Defines a <a href="/topics/templating/">template</a> to extract the effect value.</li>
<li><strong>effect_list</strong> (<em>Optional</em>): The list of effects the light supports.</li>
<li><strong>name</strong> (<em>Optional</em>): The name of the switch. Default is MQTT Switch.</li>
<li><strong>optimistic</strong> (<em>Optional</em>): Flag that defines if switch works in optimistic mode. Default is true if no state topic defined, else false.</li> <li><strong>optimistic</strong> (<em>Optional</em>): Flag that defines if switch works in optimistic mode. Default is true if no state topic defined, else false.</li>
<li><strong>payload_off</strong> (<em>Optional</em>): The payload that represents disabled state. Default is “OFF”.</li>
<li><strong>payload_on</strong> (<em>Optional</em>): The payload that represents enabled state. Default is “ON”.</li>
<li><strong>qos</strong> (<em>Optional</em>): The maximum QoS level of the state topic. Default is 0 and will also be used to publishing messages.</li>
<li><strong>rgb_command_topic</strong> (<em>Optional</em>): The MQTT topic to publish commands to change the lights RGB state.</li>
<li><strong>rgb_state_topic</strong> (<em>Optional</em>): The MQTT topic subscribed to receive RGB state updates.</li>
<li><strong>rgb_value_template</strong> (<em>Optional</em>): Defines a <a href="/topics/templating/">template</a> to extract the RGB value.</li>
<li><strong>state_topic</strong> (<em>Optional</em>): The MQTT topic subscribed to receive state updates.</li>
<li><strong>state_value_template</strong> (<em>Optional</em>): Defines a <a href="/topics/templating/">template</a> to extract the state value.</li>
<li><strong>white_value_command_topic</strong> (<em>Optional</em>): The MQTT topic to publish commands to change the lights white value.</li>
<li><strong>white_value_state_topic</strong> (<em>Optional</em>): The MQTT topic subscribed to receive white value updates.</li>
<li><strong>white_value_value_template</strong> (<em>Optional</em>): Defines a <a href="/topics/templating/">template</a> to extract the white value.</li>
<li><strong>xy_command_topic</strong> (<em>Optional</em>): The MQTT topic to publish commands to change the lights XY state.</li>
<li><strong>xy_state_topic</strong> (<em>Optional</em>): The MQTT topic subscribed to receive XY state updates.</li>
<li><strong>xy_value_template</strong> (<em>Optional</em>): Defines a <a href="/topics/templating/">template</a> to extract the XY value.</li>
</ul> </ul>
<p class="note warning"> <p class="note warning">
Make sure that your topics match exact. <code class="highlighter-rouge">some-topic/</code> and <code class="highlighter-rouge">some-topic</code> are different topics. Make sure that your topics match exact. <code class="highlighter-rouge">some-topic/</code> and <code class="highlighter-rouge">some-topic</code> are different topics.
</p> </p>
<p class="note warning">
XY and RGB can not be used at the same time. If both are provided, XY overrides RGB.
</p>
<h2><a class="title-link" name="comparison-of-light-mqtt-platforms" href="#comparison-of-light-mqtt-platforms"></a> Comparison of light MQTT platforms</h2>
<table>
<thead>
<tr>
<th>Function</th>
<th><a href="https://home-assistant.io/components/light.mqtt/"><code class="highlighter-rouge">mqtt</code></a></th>
<th><a href="https://home-assistant.io/components/light.mqtt_json/"><code class="highlighter-rouge">mqtt_json</code></a></th>
<th><a href="https://home-assistant.io/components/light.mqtt_template/"><code class="highlighter-rouge">mqtt_template</code></a></th>
</tr>
</thead>
<tbody>
<tr>
<td>Brightness</td>
<td></td>
<td></td>
<td></td>
</tr>
<tr>
<td>Color temperature</td>
<td></td>
<td></td>
<td></td>
</tr>
<tr>
<td>Effects</td>
<td></td>
<td></td>
<td></td>
</tr>
<tr>
<td>Flashing</td>
<td></td>
<td></td>
<td></td>
</tr>
<tr>
<td>RGB Color</td>
<td></td>
<td></td>
<td></td>
</tr>
<tr>
<td>Transitions</td>
<td></td>
<td></td>
<td></td>
</tr>
<tr>
<td>XY Color</td>
<td></td>
<td></td>
<td></td>
</tr>
<tr>
<td>White Value</td>
<td></td>
<td></td>
<td></td>
</tr>
</tbody>
</table>
<h2><a class="title-link" name="examples" href="#examples"></a> Examples</h2> <h2><a class="title-link" name="examples" href="#examples"></a> Examples</h2>
<p>In this section you find some real life examples of how to use this sensor.</p> <p>In this section you find some real life examples of how to use this sensor.</p>

View file

@ -92,17 +92,22 @@
<p>The <code class="highlighter-rouge">mqtt_json</code> light platform lets you control a MQTT-enabled light that can receive <a href="https://en.wikipedia.org/wiki/JSON">JSON</a> messages.</p> <p>The <code class="highlighter-rouge">mqtt_json</code> light platform lets you control a MQTT-enabled light that can receive <a href="https://en.wikipedia.org/wiki/JSON">JSON</a> messages.</p>
<p>This platform supports on/off, brightness, RGB colors, transitions, and short/long flashing. The messages sent to/from the lights look similar to this, omitting fields when they arent needed:</p> <p>This platform supports on/off, brightness, RGB colors, XY colors, color temperature, transitions, short/long flashing and white values. The messages sent to/from the lights look similar to this, omitting fields when they arent needed:</p>
<div class="language-json highlighter-rouge"><pre class="highlight"><code><span class="p">{</span><span class="w"> <div class="language-json highlighter-rouge"><pre class="highlight"><code><span class="p">{</span><span class="w">
</span><span class="nt">"brightness"</span><span class="p">:</span><span class="w"> </span><span class="mi">255</span><span class="p">,</span><span class="w"> </span><span class="nt">"brightness"</span><span class="p">:</span><span class="w"> </span><span class="mi">255</span><span class="p">,</span><span class="w">
</span><span class="nt">"color_temp"</span><span class="p">:</span><span class="w"> </span><span class="mi">155</span><span class="p">,</span><span class="w">
</span><span class="nt">"color"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w"> </span><span class="nt">"color"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
</span><span class="nt">"r"</span><span class="p">:</span><span class="w"> </span><span class="mi">255</span><span class="p">,</span><span class="w">
</span><span class="nt">"g"</span><span class="p">:</span><span class="w"> </span><span class="mi">255</span><span class="p">,</span><span class="w"> </span><span class="nt">"g"</span><span class="p">:</span><span class="w"> </span><span class="mi">255</span><span class="p">,</span><span class="w">
</span><span class="nt">"b"</span><span class="p">:</span><span class="w"> </span><span class="mi">255</span><span class="p">,</span><span class="w"> </span><span class="nt">"b"</span><span class="p">:</span><span class="w"> </span><span class="mi">255</span><span class="p">,</span><span class="w">
</span><span class="nt">"r"</span><span class="p">:</span><span class="w"> </span><span class="mi">255</span><span class="w"> </span><span class="nt">"x"</span><span class="p">:</span><span class="w"> </span><span class="mf">0.123</span><span class="p">,</span><span class="w">
</span><span class="nt">"y"</span><span class="p">:</span><span class="w"> </span><span class="mf">0.123</span><span class="w">
</span><span class="p">},</span><span class="w"> </span><span class="p">},</span><span class="w">
</span><span class="nt">"effect"</span><span class="p">:</span><span class="w"> </span><span class="s2">"colorloop"</span><span class="p">,</span><span class="w">
</span><span class="nt">"state"</span><span class="p">:</span><span class="w"> </span><span class="s2">"ON"</span><span class="p">,</span><span class="w">
</span><span class="nt">"transition"</span><span class="p">:</span><span class="w"> </span><span class="mi">2</span><span class="p">,</span><span class="w"> </span><span class="nt">"transition"</span><span class="p">:</span><span class="w"> </span><span class="mi">2</span><span class="p">,</span><span class="w">
</span><span class="nt">"state"</span><span class="p">:</span><span class="w"> </span><span class="s2">"ON"</span><span class="w"> </span><span class="nt">"white_value"</span><span class="p">:</span><span class="w"> </span><span class="mi">150</span><span class="w">
</span><span class="p">}</span><span class="w"> </span><span class="p">}</span><span class="w">
</span></code></pre> </span></code></pre>
</div> </div>
@ -124,20 +129,93 @@
<ul> <ul>
<li><strong>command_topic</strong> (<em>Required</em>): The MQTT topic to publish commands to change the lights state.</li> <li><strong>command_topic</strong> (<em>Required</em>): The MQTT topic to publish commands to change the lights state.</li>
<li><strong>name</strong> (<em>Optional</em>): The name of the light. Default is “MQTT JSON Light.”</li>
<li><strong>state_topic</strong> (<em>Optional</em>): The MQTT topic subscribed to receive state updates.</li>
<li><strong>brightness</strong> (<em>Optional</em>): Flag that defines if the light supports brightness. Default is false.</li> <li><strong>brightness</strong> (<em>Optional</em>): Flag that defines if the light supports brightness. Default is false.</li>
<li><strong>rgb</strong> (<em>Optional</em>): Flag that defines if the light supports RGB colors. Default is false.</li> <li><strong>color_temperature</strong> (<em>Optional</em>): Flag that defines if the light supports color temperature. Default is false.</li>
<li><strong>flash_time_short</strong> (<em>Optional</em>): The duration, in seconds, of a “short” flash. Default is 2.</li> <li><strong>effect</strong> (<em>Optional</em>): Flag that defines if the light supports effects. Default is false.</li>
<li><strong>effect</strong> (<em>Optional</em>): Flag that defines if the light supports effects. Default is false.</li>
<li><strong>effect_list</strong> (<em>Optional</em>): The list of effects the light supports.</li>
<li><strong>flash_time_long</strong> (<em>Optional</em>): The duration, in seconds, of a “long” flash. Default is 10.</li> <li><strong>flash_time_long</strong> (<em>Optional</em>): The duration, in seconds, of a “long” flash. Default is 10.</li>
<li><strong>flash_time_short</strong> (<em>Optional</em>): The duration, in seconds, of a “short” flash. Default is 2.</li>
<li><strong>name</strong> (<em>Optional</em>): The name of the light. Default is “MQTT JSON Light.”</li>
<li><strong>optimistic</strong> (<em>Optional</em>): Flag that defines if the light works in optimistic mode. Default is true if no state topic defined, else false.</li> <li><strong>optimistic</strong> (<em>Optional</em>): Flag that defines if the light works in optimistic mode. Default is true if no state topic defined, else false.</li>
<li><strong>qos</strong> (<em>Optional</em>): The maximum QoS level of the state topic. Default is 0 and will also be used to publishing messages.</li> <li><strong>qos</strong> (<em>Optional</em>): The maximum QoS level of the state topic. Default is 0 and will also be used to publishing messages.</li>
<li><strong>rgb</strong> (<em>Optional</em>): Flag that defines if the light supports RGB colors. Default is false.</li>
<li><strong>state_topic</strong> (<em>Optional</em>): The MQTT topic subscribed to receive state updates.</li>
<li><strong>white_value</strong> (<em>Optional</em>): Flag that defines if the light supports white values. Default is false.</li>
<li><strong>xy</strong> (<em>Optional</em>): Flag that defines if the light supports XY colors. Default is false.</li>
</ul> </ul>
<p class="note warning"> <p class="note warning">
Make sure that your topics match exact. <code class="highlighter-rouge">some-topic/</code> and <code class="highlighter-rouge">some-topic</code> are different topics. Make sure that your topics match exact. <code class="highlighter-rouge">some-topic/</code> and <code class="highlighter-rouge">some-topic</code> are different topics.
</p> </p>
<p class="note warning">
XY and RGB can not be used at the same time. If both are provided, XY overrides RGB.
</p>
<h2><a class="title-link" name="comparison-of-light-mqtt-platforms" href="#comparison-of-light-mqtt-platforms"></a> Comparison of light MQTT platforms</h2>
<table>
<thead>
<tr>
<th>Function</th>
<th><a href="https://home-assistant.io/components/light.mqtt/"><code class="highlighter-rouge">mqtt</code></a></th>
<th><a href="https://home-assistant.io/components/light.mqtt_json/"><code class="highlighter-rouge">mqtt_json</code></a></th>
<th><a href="https://home-assistant.io/components/light.mqtt_template/"><code class="highlighter-rouge">mqtt_template</code></a></th>
</tr>
</thead>
<tbody>
<tr>
<td>Brightness</td>
<td></td>
<td></td>
<td></td>
</tr>
<tr>
<td>Color temperature</td>
<td></td>
<td></td>
<td></td>
</tr>
<tr>
<td>Effects</td>
<td></td>
<td></td>
<td></td>
</tr>
<tr>
<td>Flashing</td>
<td></td>
<td></td>
<td></td>
</tr>
<tr>
<td>RGB Color</td>
<td></td>
<td></td>
<td></td>
</tr>
<tr>
<td>Transitions</td>
<td></td>
<td></td>
<td></td>
</tr>
<tr>
<td>XY Color</td>
<td></td>
<td></td>
<td></td>
</tr>
<tr>
<td>White Value</td>
<td></td>
<td></td>
<td></td>
</tr>
</tbody>
</table>
<h2><a class="title-link" name="examples" href="#examples"></a> Examples</h2> <h2><a class="title-link" name="examples" href="#examples"></a> Examples</h2>
<p>In this section you find some real life examples of how to use this sensor.</p> <p>In this section you find some real life examples of how to use this sensor.</p>

View file

@ -93,7 +93,7 @@
<p>The <code class="highlighter-rouge">mqtt_template</code> light platform lets you control a MQTT-enabled light that receive commands on a command topic and optionally sends status update on a state topic. <p>The <code class="highlighter-rouge">mqtt_template</code> light platform lets you control a MQTT-enabled light that receive commands on a command topic and optionally sends status update on a state topic.
It is format-agnostic so you can use any data format you want (i.e. string, JSON), just configure it with templating.</p> It is format-agnostic so you can use any data format you want (i.e. string, JSON), just configure it with templating.</p>
<p>This platform supports on/off, brightness, RGB colors, transitions, short/long flashing and effects.</p> <p>This platform supports on/off, brightness, RGB colors, XY colors, color temperature, transitions, short/long flashing, effects and white values.</p>
<p>In an ideal scenario, the MQTT device will have a state topic to publish state changes. If these messages are published with the RETAIN flag, the MQTT light will receive an instant state update after subscription and will start with the correct state. Otherwise, the initial state of the light will be off.</p> <p>In an ideal scenario, the MQTT device will have a state topic to publish state changes. If these messages are published with the RETAIN flag, the MQTT light will receive an instant state update after subscription and will start with the correct state. Otherwise, the initial state of the light will be off.</p>
@ -124,7 +124,9 @@ It is format-agnostic so you can use any data format you want (i.e. string, JSON
<li><strong>red_template</strong> (<em>Optional</em>): Template to extract red color from the state payload value.</li> <li><strong>red_template</strong> (<em>Optional</em>): Template to extract red color from the state payload value.</li>
<li><strong>green_template</strong> (<em>Optional</em>): Template to extract green color from the state payload value.</li> <li><strong>green_template</strong> (<em>Optional</em>): Template to extract green color from the state payload value.</li>
<li><strong>blue_template</strong> (<em>Optional</em>): Template to extract blue color from the state payload value.</li> <li><strong>blue_template</strong> (<em>Optional</em>): Template to extract blue color from the state payload value.</li>
<li><strong>color_temp_template</strong> (<em>Optional</em>): Template to extract color temperature from the state payload value.</li>
<li><strong>effect_template</strong> (<em>Optional</em>): Template to extract effect from the state payload value.</li> <li><strong>effect_template</strong> (<em>Optional</em>): Template to extract effect from the state payload value.</li>
<li><strong>white_value_template</strong> (<em>Optional</em>): Template to extract white value from the state payload value.</li>
<li><strong>optimistic</strong> (<em>Optional</em>): Flag that defines if the light works in optimistic mode. Default is true if no state topic or state template is defined, else false.</li> <li><strong>optimistic</strong> (<em>Optional</em>): Flag that defines if the light works in optimistic mode. Default is true if no state topic or state template is defined, else false.</li>
<li><strong>qos</strong> (<em>Optional</em>): The maximum QoS level of the state topic. Default is 0 and will also be used to publishing messages.</li> <li><strong>qos</strong> (<em>Optional</em>): The maximum QoS level of the state topic. Default is 0 and will also be used to publishing messages.</li>
</ul> </ul>
@ -133,6 +135,69 @@ It is format-agnostic so you can use any data format you want (i.e. string, JSON
Make sure that your topics match exact. <code class="highlighter-rouge">some-topic/</code> and <code class="highlighter-rouge">some-topic</code> are different topics. Make sure that your topics match exact. <code class="highlighter-rouge">some-topic/</code> and <code class="highlighter-rouge">some-topic</code> are different topics.
</p> </p>
<h2><a class="title-link" name="comparison-of-light-mqtt-platforms" href="#comparison-of-light-mqtt-platforms"></a> Comparison of light MQTT platforms</h2>
<table>
<thead>
<tr>
<th>Function</th>
<th><a href="https://home-assistant.io/components/light.mqtt/"><code class="highlighter-rouge">mqtt</code></a></th>
<th><a href="https://home-assistant.io/components/light.mqtt_json/"><code class="highlighter-rouge">mqtt_json</code></a></th>
<th><a href="https://home-assistant.io/components/light.mqtt_template/"><code class="highlighter-rouge">mqtt_template</code></a></th>
</tr>
</thead>
<tbody>
<tr>
<td>Brightness</td>
<td></td>
<td></td>
<td></td>
</tr>
<tr>
<td>Color temperature</td>
<td></td>
<td></td>
<td></td>
</tr>
<tr>
<td>Effects</td>
<td></td>
<td></td>
<td></td>
</tr>
<tr>
<td>Flashing</td>
<td></td>
<td></td>
<td></td>
</tr>
<tr>
<td>RGB Color</td>
<td></td>
<td></td>
<td></td>
</tr>
<tr>
<td>Transitions</td>
<td></td>
<td></td>
<td></td>
</tr>
<tr>
<td>XY Color</td>
<td></td>
<td></td>
<td></td>
</tr>
<tr>
<td>White Value</td>
<td></td>
<td></td>
<td></td>
</tr>
</tbody>
</table>
<h2><a class="title-link" name="examples" href="#examples"></a> Examples</h2> <h2><a class="title-link" name="examples" href="#examples"></a> Examples</h2>
<p>In this section you find some real life examples of how to use this light.</p> <p>In this section you find some real life examples of how to use this light.</p>

View file

@ -3021,62 +3021,62 @@
</url> </url>
<url> <url>
<loc>https://home-assistant.io/demo/frontend.html</loc> <loc>https://home-assistant.io/demo/frontend.html</loc>
<lastmod>2017-03-17T19:46:23+00:00</lastmod> <lastmod>2017-03-17T23:26:03+00:00</lastmod>
</url> </url>
<url> <url>
<loc>https://home-assistant.io/demo/index.html</loc> <loc>https://home-assistant.io/demo/index.html</loc>
<lastmod>2017-03-17T19:46:23+00:00</lastmod> <lastmod>2017-03-17T23:26:03+00:00</lastmod>
</url> </url>
<url> <url>
<loc>https://home-assistant.io/demo/panels/ha-panel-dev-event.html</loc> <loc>https://home-assistant.io/demo/panels/ha-panel-dev-event.html</loc>
<lastmod>2017-03-17T19:46:23+00:00</lastmod> <lastmod>2017-03-17T23:26:03+00:00</lastmod>
</url> </url>
<url> <url>
<loc>https://home-assistant.io/demo/panels/ha-panel-dev-info.html</loc> <loc>https://home-assistant.io/demo/panels/ha-panel-dev-info.html</loc>
<lastmod>2017-03-17T19:46:23+00:00</lastmod> <lastmod>2017-03-17T23:26:03+00:00</lastmod>
</url> </url>
<url> <url>
<loc>https://home-assistant.io/demo/panels/ha-panel-dev-service.html</loc> <loc>https://home-assistant.io/demo/panels/ha-panel-dev-service.html</loc>
<lastmod>2017-03-17T19:46:23+00:00</lastmod> <lastmod>2017-03-17T23:26:03+00:00</lastmod>
</url> </url>
<url> <url>
<loc>https://home-assistant.io/demo/panels/ha-panel-dev-state.html</loc> <loc>https://home-assistant.io/demo/panels/ha-panel-dev-state.html</loc>
<lastmod>2017-03-17T19:46:23+00:00</lastmod> <lastmod>2017-03-17T23:26:03+00:00</lastmod>
</url> </url>
<url> <url>
<loc>https://home-assistant.io/demo/panels/ha-panel-dev-template.html</loc> <loc>https://home-assistant.io/demo/panels/ha-panel-dev-template.html</loc>
<lastmod>2017-03-17T19:46:23+00:00</lastmod> <lastmod>2017-03-17T23:26:03+00:00</lastmod>
</url> </url>
<url> <url>
<loc>https://home-assistant.io/demo/panels/ha-panel-history.html</loc> <loc>https://home-assistant.io/demo/panels/ha-panel-history.html</loc>
<lastmod>2017-03-17T19:46:23+00:00</lastmod> <lastmod>2017-03-17T23:26:03+00:00</lastmod>
</url> </url>
<url> <url>
<loc>https://home-assistant.io/demo/panels/ha-panel-iframe.html</loc> <loc>https://home-assistant.io/demo/panels/ha-panel-iframe.html</loc>
<lastmod>2017-03-17T19:46:23+00:00</lastmod> <lastmod>2017-03-17T23:26:03+00:00</lastmod>
</url> </url>
<url> <url>
<loc>https://home-assistant.io/demo/panels/ha-panel-logbook.html</loc> <loc>https://home-assistant.io/demo/panels/ha-panel-logbook.html</loc>
<lastmod>2017-03-17T19:46:23+00:00</lastmod> <lastmod>2017-03-17T23:26:03+00:00</lastmod>
</url> </url>
<url> <url>
<loc>https://home-assistant.io/demo/panels/ha-panel-map.html</loc> <loc>https://home-assistant.io/demo/panels/ha-panel-map.html</loc>
<lastmod>2017-03-17T19:46:23+00:00</lastmod> <lastmod>2017-03-17T23:26:03+00:00</lastmod>
</url> </url>
<url> <url>
<loc>https://home-assistant.io/googlef4f3693c209fe788.html</loc> <loc>https://home-assistant.io/googlef4f3693c209fe788.html</loc>
<lastmod>2017-03-17T19:46:23+00:00</lastmod> <lastmod>2017-03-17T23:26:03+00:00</lastmod>
</url> </url>
<url> <url>
<loc>https://home-assistant.io/static/fonts/roboto/DESCRIPTION.en_us.html</loc> <loc>https://home-assistant.io/static/fonts/roboto/DESCRIPTION.en_us.html</loc>
<lastmod>2017-03-17T19:46:23+00:00</lastmod> <lastmod>2017-03-17T23:26:03+00:00</lastmod>
</url> </url>
<url> <url>
<loc>https://home-assistant.io/static/fonts/robotomono/DESCRIPTION.en_us.html</loc> <loc>https://home-assistant.io/static/fonts/robotomono/DESCRIPTION.en_us.html</loc>
<lastmod>2017-03-17T19:46:23+00:00</lastmod> <lastmod>2017-03-17T23:26:03+00:00</lastmod>
</url> </url>
<url> <url>
<loc>https://home-assistant.io/static/mdi-demo.html</loc> <loc>https://home-assistant.io/static/mdi-demo.html</loc>
<lastmod>2017-03-17T19:46:23+00:00</lastmod> <lastmod>2017-03-17T23:26:03+00:00</lastmod>
</url> </url>
</urlset> </urlset>