From af3d708fbef76608ac3eeb01135dabf1fb3a2bf3 Mon Sep 17 00:00:00 2001 From: Travis CI Date: Fri, 17 Mar 2017 23:29:50 +0000 Subject: [PATCH] Site updated at 2017-03-17 23:29:49 UTC --- atom.xml | 2 +- blog/categories/community/atom.xml | 2 +- blog/categories/device-tracking/atom.xml | 2 +- blog/categories/esp8266/atom.xml | 2 +- blog/categories/how-to/atom.xml | 2 +- blog/categories/ibeacons/atom.xml | 2 +- blog/categories/internet-of-things/atom.xml | 2 +- blog/categories/iot-data/atom.xml | 2 +- blog/categories/merchandise/atom.xml | 2 +- blog/categories/micropython/atom.xml | 2 +- blog/categories/mqtt/atom.xml | 2 +- blog/categories/organisation/atom.xml | 2 +- blog/categories/owntracks/atom.xml | 2 +- blog/categories/presence-detection/atom.xml | 2 +- .../public-service-announcement/atom.xml | 2 +- blog/categories/release-notes/atom.xml | 2 +- blog/categories/survey/atom.xml | 2 +- blog/categories/talks/atom.xml | 2 +- blog/categories/technology/atom.xml | 2 +- blog/categories/user-stories/atom.xml | 2 +- blog/categories/video/atom.xml | 2 +- blog/categories/website/atom.xml | 2 +- components/light.mqtt/index.html | 107 +++++++++++++++--- components/light.mqtt_json/index.html | 92 +++++++++++++-- components/light.mqtt_template/index.html | 67 ++++++++++- sitemap.xml | 30 ++--- 26 files changed, 280 insertions(+), 60 deletions(-) diff --git a/atom.xml b/atom.xml index 2157b1a77e..5e75fa2bf3 100644 --- a/atom.xml +++ b/atom.xml @@ -4,7 +4,7 @@ <![CDATA[Home Assistant]]> - 2017-03-17T19:47:07+00:00 + 2017-03-17T23:26:50+00:00 https://home-assistant.io/ diff --git a/blog/categories/community/atom.xml b/blog/categories/community/atom.xml index 3cc36c34b4..ae19c95b12 100644 --- a/blog/categories/community/atom.xml +++ b/blog/categories/community/atom.xml @@ -4,7 +4,7 @@ <![CDATA[Category: Community | Home Assistant]]> - 2017-03-17T19:47:07+00:00 + 2017-03-17T23:26:50+00:00 https://home-assistant.io/ diff --git a/blog/categories/device-tracking/atom.xml b/blog/categories/device-tracking/atom.xml index d70da3b192..a4e1fbe142 100644 --- a/blog/categories/device-tracking/atom.xml +++ b/blog/categories/device-tracking/atom.xml @@ -4,7 +4,7 @@ <![CDATA[Category: Device-Tracking | Home Assistant]]> - 2017-03-17T19:47:07+00:00 + 2017-03-17T23:26:50+00:00 https://home-assistant.io/ diff --git a/blog/categories/esp8266/atom.xml b/blog/categories/esp8266/atom.xml index 04b298da0a..5907b5a56e 100644 --- a/blog/categories/esp8266/atom.xml +++ b/blog/categories/esp8266/atom.xml @@ -4,7 +4,7 @@ <![CDATA[Category: ESP8266 | Home Assistant]]> - 2017-03-17T19:47:07+00:00 + 2017-03-17T23:26:50+00:00 https://home-assistant.io/ diff --git a/blog/categories/how-to/atom.xml b/blog/categories/how-to/atom.xml index e6d2764db9..5e9560583e 100644 --- a/blog/categories/how-to/atom.xml +++ b/blog/categories/how-to/atom.xml @@ -4,7 +4,7 @@ <![CDATA[Category: How-To | Home Assistant]]> - 2017-03-17T19:47:07+00:00 + 2017-03-17T23:26:50+00:00 https://home-assistant.io/ diff --git a/blog/categories/ibeacons/atom.xml b/blog/categories/ibeacons/atom.xml index 41d534954a..1ceb93faf2 100644 --- a/blog/categories/ibeacons/atom.xml +++ b/blog/categories/ibeacons/atom.xml @@ -4,7 +4,7 @@ <![CDATA[Category: iBeacons | Home Assistant]]> - 2017-03-17T19:47:07+00:00 + 2017-03-17T23:26:50+00:00 https://home-assistant.io/ diff --git a/blog/categories/internet-of-things/atom.xml b/blog/categories/internet-of-things/atom.xml index 340306de88..d84e5f8c39 100644 --- a/blog/categories/internet-of-things/atom.xml +++ b/blog/categories/internet-of-things/atom.xml @@ -4,7 +4,7 @@ <![CDATA[Category: Internet-of-Things | Home Assistant]]> - 2017-03-17T19:47:07+00:00 + 2017-03-17T23:26:50+00:00 https://home-assistant.io/ diff --git a/blog/categories/iot-data/atom.xml b/blog/categories/iot-data/atom.xml index 2a495c9d69..8296bff067 100644 --- a/blog/categories/iot-data/atom.xml +++ b/blog/categories/iot-data/atom.xml @@ -4,7 +4,7 @@ <![CDATA[Category: IoT-Data | Home Assistant]]> - 2017-03-17T19:47:07+00:00 + 2017-03-17T23:26:50+00:00 https://home-assistant.io/ diff --git a/blog/categories/merchandise/atom.xml b/blog/categories/merchandise/atom.xml index 4b1c26965d..c1c76e0bcb 100644 --- a/blog/categories/merchandise/atom.xml +++ b/blog/categories/merchandise/atom.xml @@ -4,7 +4,7 @@ <![CDATA[Category: Merchandise | Home Assistant]]> - 2017-03-17T19:47:07+00:00 + 2017-03-17T23:26:50+00:00 https://home-assistant.io/ diff --git a/blog/categories/micropython/atom.xml b/blog/categories/micropython/atom.xml index 6c4879afdd..67a11f43c5 100644 --- a/blog/categories/micropython/atom.xml +++ b/blog/categories/micropython/atom.xml @@ -4,7 +4,7 @@ <![CDATA[Category: Micropython | Home Assistant]]> - 2017-03-17T19:47:07+00:00 + 2017-03-17T23:26:50+00:00 https://home-assistant.io/ diff --git a/blog/categories/mqtt/atom.xml b/blog/categories/mqtt/atom.xml index 45719ebc59..782048a252 100644 --- a/blog/categories/mqtt/atom.xml +++ b/blog/categories/mqtt/atom.xml @@ -4,7 +4,7 @@ <![CDATA[Category: MQTT | Home Assistant]]> - 2017-03-17T19:47:07+00:00 + 2017-03-17T23:26:50+00:00 https://home-assistant.io/ diff --git a/blog/categories/organisation/atom.xml b/blog/categories/organisation/atom.xml index 4769718bbd..884c72460b 100644 --- a/blog/categories/organisation/atom.xml +++ b/blog/categories/organisation/atom.xml @@ -4,7 +4,7 @@ <![CDATA[Category: Organisation | Home Assistant]]> - 2017-03-17T19:47:07+00:00 + 2017-03-17T23:26:50+00:00 https://home-assistant.io/ diff --git a/blog/categories/owntracks/atom.xml b/blog/categories/owntracks/atom.xml index 4c5a798eaa..dd00dca908 100644 --- a/blog/categories/owntracks/atom.xml +++ b/blog/categories/owntracks/atom.xml @@ -4,7 +4,7 @@ <![CDATA[Category: OwnTracks | Home Assistant]]> - 2017-03-17T19:47:07+00:00 + 2017-03-17T23:26:50+00:00 https://home-assistant.io/ diff --git a/blog/categories/presence-detection/atom.xml b/blog/categories/presence-detection/atom.xml index 84bd26e8aa..b6b267dd56 100644 --- a/blog/categories/presence-detection/atom.xml +++ b/blog/categories/presence-detection/atom.xml @@ -4,7 +4,7 @@ <![CDATA[Category: Presence-Detection | Home Assistant]]> - 2017-03-17T19:47:07+00:00 + 2017-03-17T23:26:50+00:00 https://home-assistant.io/ diff --git a/blog/categories/public-service-announcement/atom.xml b/blog/categories/public-service-announcement/atom.xml index 7af30b6876..78aa8af561 100644 --- a/blog/categories/public-service-announcement/atom.xml +++ b/blog/categories/public-service-announcement/atom.xml @@ -4,7 +4,7 @@ <![CDATA[Category: Public-Service-Announcement | Home Assistant]]> - 2017-03-17T19:47:07+00:00 + 2017-03-17T23:26:50+00:00 https://home-assistant.io/ diff --git a/blog/categories/release-notes/atom.xml b/blog/categories/release-notes/atom.xml index e4f32147e8..571b18de40 100644 --- a/blog/categories/release-notes/atom.xml +++ b/blog/categories/release-notes/atom.xml @@ -4,7 +4,7 @@ <![CDATA[Category: Release-Notes | Home Assistant]]> - 2017-03-17T19:47:07+00:00 + 2017-03-17T23:26:50+00:00 https://home-assistant.io/ diff --git a/blog/categories/survey/atom.xml b/blog/categories/survey/atom.xml index b6f332b81d..aea22758b2 100644 --- a/blog/categories/survey/atom.xml +++ b/blog/categories/survey/atom.xml @@ -4,7 +4,7 @@ <![CDATA[Category: Survey | Home Assistant]]> - 2017-03-17T19:47:07+00:00 + 2017-03-17T23:26:50+00:00 https://home-assistant.io/ diff --git a/blog/categories/talks/atom.xml b/blog/categories/talks/atom.xml index 69b134ac1f..e19b79516c 100644 --- a/blog/categories/talks/atom.xml +++ b/blog/categories/talks/atom.xml @@ -4,7 +4,7 @@ <![CDATA[Category: Talks | Home Assistant]]> - 2017-03-17T19:47:07+00:00 + 2017-03-17T23:26:50+00:00 https://home-assistant.io/ diff --git a/blog/categories/technology/atom.xml b/blog/categories/technology/atom.xml index fa0fd0a3a6..af2c4ee493 100644 --- a/blog/categories/technology/atom.xml +++ b/blog/categories/technology/atom.xml @@ -4,7 +4,7 @@ <![CDATA[Category: Technology | Home Assistant]]> - 2017-03-17T19:47:07+00:00 + 2017-03-17T23:26:50+00:00 https://home-assistant.io/ diff --git a/blog/categories/user-stories/atom.xml b/blog/categories/user-stories/atom.xml index 5e45d765ae..bde5e71c4f 100644 --- a/blog/categories/user-stories/atom.xml +++ b/blog/categories/user-stories/atom.xml @@ -4,7 +4,7 @@ <![CDATA[Category: User-Stories | Home Assistant]]> - 2017-03-17T19:47:07+00:00 + 2017-03-17T23:26:50+00:00 https://home-assistant.io/ diff --git a/blog/categories/video/atom.xml b/blog/categories/video/atom.xml index d7021c3687..f3addee7cc 100644 --- a/blog/categories/video/atom.xml +++ b/blog/categories/video/atom.xml @@ -4,7 +4,7 @@ <![CDATA[Category: Video | Home Assistant]]> - 2017-03-17T19:47:07+00:00 + 2017-03-17T23:26:50+00:00 https://home-assistant.io/ diff --git a/blog/categories/website/atom.xml b/blog/categories/website/atom.xml index 69261b8064..21e19c72a2 100644 --- a/blog/categories/website/atom.xml +++ b/blog/categories/website/atom.xml @@ -4,7 +4,7 @@ <![CDATA[Category: Website | Home Assistant]]> - 2017-03-17T19:47:07+00:00 + 2017-03-17T23:26:50+00:00 https://home-assistant.io/ diff --git a/components/light.mqtt/index.html b/components/light.mqtt/index.html index eddf800d06..4f631c1ed1 100644 --- a/components/light.mqtt/index.html +++ b/components/light.mqtt/index.html @@ -90,7 +90,7 @@
-

The mqtt light platform let you control your MQTT enabled light.

+

The mqtt 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.

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.

@@ -109,29 +109,106 @@
  • command_topic (Required): The MQTT topic to publish commands to change the switch state.
  • -
  • name (Optional): The name of the switch. Default is ‘MQTT Switch’.
  • -
  • state_topic (Optional): The MQTT topic subscribed to receive state updates.
  • -
  • brightness_state_topic (Optional): The MQTT topic subscribed to receive brightness state updates.
  • brightness_command_topic (Optional): The MQTT topic to publish commands to change the light’s brightness.
  • -
  • rgb_state_topic (Optional): The MQTT topic subscribed to receive RGB state updates.
  • -
  • rgb_command_topic (Optional): The MQTT topic to publish commands to change the light’s RGB state.
  • -
  • color_temp_state_topic (Optional): The MQTT topic subscribed to receive color temperature state updates.
  • -
  • color_temp_command_topic (Optional): The MQTT topic to publish commands to change the light’s color temperature state.
  • -
  • state_value_template (Optional): Defines a template to extract the state value.
  • -
  • brightness_value_template (Optional): Defines a template to extract the brightness value.
  • -
  • rgb_value_template (Optional): Defines a template to extract the RGB value.
  • -
  • color_temp_value_template (Optional): Defines a template to extract the color temperature value.
  • brightness_scale (Optional): Defines the maximum brightness value (i.e. 100%) of the MQTT device (defaults to 255).
  • -
  • qos (Optional): The maximum QoS level of the state topic. Default is 0 and will also be used to publishing messages.
  • -
  • payload_on (Optional): The payload that represents enabled state. Default is “ON”.
  • -
  • payload_off (Optional): The payload that represents disabled state. Default is “OFF”.
  • +
  • brightness_state_topic (Optional): The MQTT topic subscribed to receive brightness state updates.
  • +
  • brightness_value_template (Optional): Defines a template to extract the brightness value.
  • +
  • color_temp_command_topic (Optional): The MQTT topic to publish commands to change the light’s color temperature state.
  • +
  • color_temp_state_topic (Optional): The MQTT topic subscribed to receive color temperature state updates.
  • +
  • color_temp_value_template (Optional): Defines a template to extract the color temperature value.
  • +
  • effect_command_topic (Optional): The MQTT topic to publish commands to change the light’s effect state.
  • +
  • effect_state_topic (Optional): The MQTT topic subscribed to receive effect state updates.
  • +
  • effect_value_template (Optional): Defines a template to extract the effect value.
  • +
  • effect_list (Optional): The list of effects the light supports.
  • +
  • name (Optional): The name of the switch. Default is ‘MQTT Switch’.
  • optimistic (Optional): Flag that defines if switch works in optimistic mode. Default is true if no state topic defined, else false.
  • +
  • payload_off (Optional): The payload that represents disabled state. Default is “OFF”.
  • +
  • payload_on (Optional): The payload that represents enabled state. Default is “ON”.
  • +
  • qos (Optional): The maximum QoS level of the state topic. Default is 0 and will also be used to publishing messages.
  • +
  • rgb_command_topic (Optional): The MQTT topic to publish commands to change the light’s RGB state.
  • +
  • rgb_state_topic (Optional): The MQTT topic subscribed to receive RGB state updates.
  • +
  • rgb_value_template (Optional): Defines a template to extract the RGB value.
  • +
  • state_topic (Optional): The MQTT topic subscribed to receive state updates.
  • +
  • state_value_template (Optional): Defines a template to extract the state value.
  • +
  • white_value_command_topic (Optional): The MQTT topic to publish commands to change the light’s white value.
  • +
  • white_value_state_topic (Optional): The MQTT topic subscribed to receive white value updates.
  • +
  • white_value_value_template (Optional): Defines a template to extract the white value.
  • +
  • xy_command_topic (Optional): The MQTT topic to publish commands to change the light’s XY state.
  • +
  • xy_state_topic (Optional): The MQTT topic subscribed to receive XY state updates.
  • +
  • xy_value_template (Optional): Defines a template to extract the XY value.

Make sure that your topics match exact. some-topic/ and some-topic are different topics.

+

+ XY and RGB can not be used at the same time. If both are provided, XY overrides RGB. +

+ +

Comparison of light MQTT platforms

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Functionmqttmqtt_jsonmqtt_template
Brightness
Color temperature
Effects
Flashing
RGB Color
Transitions
XY Color
White Value
+

Examples

In this section you find some real life examples of how to use this sensor.

diff --git a/components/light.mqtt_json/index.html b/components/light.mqtt_json/index.html index 28e9a2eff7..17e97d41d8 100644 --- a/components/light.mqtt_json/index.html +++ b/components/light.mqtt_json/index.html @@ -92,17 +92,22 @@

The mqtt_json light platform lets you control a MQTT-enabled light that can receive JSON messages.

-

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 aren’t needed:

+

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 aren’t needed:

{
   "brightness": 255,
+  "color_temp": 155,
   "color": {
+    "r": 255,
     "g": 255,
     "b": 255,
-    "r": 255
+    "x": 0.123,
+    "y": 0.123
   },
+  "effect": "colorloop",
+  "state": "ON",
   "transition": 2,
-  "state": "ON"
+  "white_value": 150
 }
 
@@ -124,20 +129,93 @@
  • command_topic (Required): The MQTT topic to publish commands to change the light’s state.
  • -
  • name (Optional): The name of the light. Default is “MQTT JSON Light.”
  • -
  • state_topic (Optional): The MQTT topic subscribed to receive state updates.
  • brightness (Optional): Flag that defines if the light supports brightness. Default is false.
  • -
  • rgb (Optional): Flag that defines if the light supports RGB colors. Default is false.
  • -
  • flash_time_short (Optional): The duration, in seconds, of a “short” flash. Default is 2.
  • +
  • color_temperature (Optional): Flag that defines if the light supports color temperature. Default is false.
  • +
  • effect (Optional): Flag that defines if the light supports effects. Default is false.
  • +
  • effect (Optional): Flag that defines if the light supports effects. Default is false.
  • +
  • effect_list (Optional): The list of effects the light supports.
  • flash_time_long (Optional): The duration, in seconds, of a “long” flash. Default is 10.
  • +
  • flash_time_short (Optional): The duration, in seconds, of a “short” flash. Default is 2.
  • +
  • name (Optional): The name of the light. Default is “MQTT JSON Light.”
  • optimistic (Optional): Flag that defines if the light works in optimistic mode. Default is true if no state topic defined, else false.
  • qos (Optional): The maximum QoS level of the state topic. Default is 0 and will also be used to publishing messages.
  • +
  • rgb (Optional): Flag that defines if the light supports RGB colors. Default is false.
  • +
  • state_topic (Optional): The MQTT topic subscribed to receive state updates.
  • +
  • white_value (Optional): Flag that defines if the light supports white values. Default is false.
  • +
  • xy (Optional): Flag that defines if the light supports XY colors. Default is false.

Make sure that your topics match exact. some-topic/ and some-topic are different topics.

+

+ XY and RGB can not be used at the same time. If both are provided, XY overrides RGB. +

+ +

Comparison of light MQTT platforms

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Functionmqttmqtt_jsonmqtt_template
Brightness
Color temperature
Effects
Flashing
RGB Color
Transitions
XY Color
White Value
+

Examples

In this section you find some real life examples of how to use this sensor.

diff --git a/components/light.mqtt_template/index.html b/components/light.mqtt_template/index.html index d217d51a27..d6b6c9459b 100644 --- a/components/light.mqtt_template/index.html +++ b/components/light.mqtt_template/index.html @@ -93,7 +93,7 @@

The mqtt_template 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.

-

This platform supports on/off, brightness, RGB colors, transitions, short/long flashing and effects.

+

This platform supports on/off, brightness, RGB colors, XY colors, color temperature, transitions, short/long flashing, effects and white values.

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.

@@ -124,7 +124,9 @@ It is format-agnostic so you can use any data format you want (i.e. string, JSON
  • red_template (Optional): Template to extract red color from the state payload value.
  • green_template (Optional): Template to extract green color from the state payload value.
  • blue_template (Optional): Template to extract blue color from the state payload value.
  • +
  • color_temp_template (Optional): Template to extract color temperature from the state payload value.
  • effect_template (Optional): Template to extract effect from the state payload value.
  • +
  • white_value_template (Optional): Template to extract white value from the state payload value.
  • optimistic (Optional): Flag that defines if the light works in optimistic mode. Default is true if no state topic or state template is defined, else false.
  • qos (Optional): The maximum QoS level of the state topic. Default is 0 and will also be used to publishing messages.
  • @@ -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. some-topic/ and some-topic are different topics.

    +

    Comparison of light MQTT platforms

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Functionmqttmqtt_jsonmqtt_template
    Brightness
    Color temperature
    Effects
    Flashing
    RGB Color
    Transitions
    XY Color
    White Value
    +

    Examples

    In this section you find some real life examples of how to use this light.

    diff --git a/sitemap.xml b/sitemap.xml index f33f887d08..f2f3122fc2 100644 --- a/sitemap.xml +++ b/sitemap.xml @@ -3021,62 +3021,62 @@ https://home-assistant.io/demo/frontend.html -2017-03-17T19:46:23+00:00 +2017-03-17T23:26:03+00:00 https://home-assistant.io/demo/index.html -2017-03-17T19:46:23+00:00 +2017-03-17T23:26:03+00:00 https://home-assistant.io/demo/panels/ha-panel-dev-event.html -2017-03-17T19:46:23+00:00 +2017-03-17T23:26:03+00:00 https://home-assistant.io/demo/panels/ha-panel-dev-info.html -2017-03-17T19:46:23+00:00 +2017-03-17T23:26:03+00:00 https://home-assistant.io/demo/panels/ha-panel-dev-service.html -2017-03-17T19:46:23+00:00 +2017-03-17T23:26:03+00:00 https://home-assistant.io/demo/panels/ha-panel-dev-state.html -2017-03-17T19:46:23+00:00 +2017-03-17T23:26:03+00:00 https://home-assistant.io/demo/panels/ha-panel-dev-template.html -2017-03-17T19:46:23+00:00 +2017-03-17T23:26:03+00:00 https://home-assistant.io/demo/panels/ha-panel-history.html -2017-03-17T19:46:23+00:00 +2017-03-17T23:26:03+00:00 https://home-assistant.io/demo/panels/ha-panel-iframe.html -2017-03-17T19:46:23+00:00 +2017-03-17T23:26:03+00:00 https://home-assistant.io/demo/panels/ha-panel-logbook.html -2017-03-17T19:46:23+00:00 +2017-03-17T23:26:03+00:00 https://home-assistant.io/demo/panels/ha-panel-map.html -2017-03-17T19:46:23+00:00 +2017-03-17T23:26:03+00:00 https://home-assistant.io/googlef4f3693c209fe788.html -2017-03-17T19:46:23+00:00 +2017-03-17T23:26:03+00:00 https://home-assistant.io/static/fonts/roboto/DESCRIPTION.en_us.html -2017-03-17T19:46:23+00:00 +2017-03-17T23:26:03+00:00 https://home-assistant.io/static/fonts/robotomono/DESCRIPTION.en_us.html -2017-03-17T19:46:23+00:00 +2017-03-17T23:26:03+00:00 https://home-assistant.io/static/mdi-demo.html -2017-03-17T19:46:23+00:00 +2017-03-17T23:26:03+00:00