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.
+
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:
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.