You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: components/light.mqtt/index.html
+91-14Lines changed: 91 additions & 14 deletions
Original file line number
Diff line number
Diff line change
@@ -90,7 +90,7 @@ <h1 class="title indent">
90
90
<hrclass="divider">
91
91
92
92
93
-
<p>The <codeclass="highlighter-rouge">mqtt</code> light platform let you control your MQTT enabled light.</p>
93
+
<p>The <codeclass="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>
94
94
95
95
<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>
96
96
@@ -109,29 +109,106 @@ <h1 class="title indent">
109
109
110
110
<ul>
111
111
<li><strong>command_topic</strong> (<em>Required</em>): The MQTT topic to publish commands to change the switch state.</li>
112
-
<li><strong>name</strong> (<em>Optional</em>): The name of the switch. Default is ‘MQTT Switch’.</li>
113
-
<li><strong>state_topic</strong> (<em>Optional</em>): The MQTT topic subscribed to receive state updates.</li>
114
-
<li><strong>brightness_state_topic</strong> (<em>Optional</em>): The MQTT topic subscribed to receive brightness state updates.</li>
115
112
<li><strong>brightness_command_topic</strong> (<em>Optional</em>): The MQTT topic to publish commands to change the light’s brightness.</li>
116
-
<li><strong>rgb_state_topic</strong> (<em>Optional</em>): The MQTT topic subscribed to receive RGB state updates.</li>
117
-
<li><strong>rgb_command_topic</strong> (<em>Optional</em>): The MQTT topic to publish commands to change the light’s RGB state.</li>
118
-
<li><strong>color_temp_state_topic</strong> (<em>Optional</em>): The MQTT topic subscribed to receive color temperature state updates.</li>
119
-
<li><strong>color_temp_command_topic</strong> (<em>Optional</em>): The MQTT topic to publish commands to change the light’s color temperature state.</li>
120
-
<li><strong>state_value_template</strong> (<em>Optional</em>): Defines a <ahref="/topics/templating/">template</a> to extract the state value.</li>
113
+
<li><strong>brightness_scale</strong> (<em>Optional</em>): Defines the maximum brightness value (i.e. 100%) of the MQTT device (defaults to 255).</li>
114
+
<li><strong>brightness_state_topic</strong> (<em>Optional</em>): The MQTT topic subscribed to receive brightness state updates.</li>
121
115
<li><strong>brightness_value_template</strong> (<em>Optional</em>): Defines a <ahref="/topics/templating/">template</a> to extract the brightness value.</li>
122
-
<li><strong>rgb_value_template</strong> (<em>Optional</em>): Defines a <ahref="/topics/templating/">template</a> to extract the RGB value.</li>
116
+
<li><strong>color_temp_command_topic</strong> (<em>Optional</em>): The MQTT topic to publish commands to change the light’s color temperature state.</li>
117
+
<li><strong>color_temp_state_topic</strong> (<em>Optional</em>): The MQTT topic subscribed to receive color temperature state updates.</li>
123
118
<li><strong>color_temp_value_template</strong> (<em>Optional</em>): Defines a <ahref="/topics/templating/">template</a> to extract the color temperature value.</li>
124
-
<li><strong>brightness_scale</strong> (<em>Optional</em>): Defines the maximum brightness value (i.e. 100%) of the MQTT device (defaults to 255).</li>
125
-
<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>
126
-
<li><strong>payload_on</strong> (<em>Optional</em>): The payload that represents enabled state. Default is “ON”.</li>
127
-
<li><strong>payload_off</strong> (<em>Optional</em>): The payload that represents disabled state. Default is “OFF”.</li>
119
+
<li><strong>effect_command_topic</strong> (<em>Optional</em>): The MQTT topic to publish commands to change the light’s effect state.</li>
120
+
<li><strong>effect_state_topic</strong> (<em>Optional</em>): The MQTT topic subscribed to receive effect state updates.</li>
121
+
<li><strong>effect_value_template</strong> (<em>Optional</em>): Defines a <ahref="/topics/templating/">template</a> to extract the effect value.</li>
122
+
<li><strong>effect_list</strong> (<em>Optional</em>): The list of effects the light supports.</li>
123
+
<li><strong>name</strong> (<em>Optional</em>): The name of the switch. Default is ‘MQTT Switch’.</li>
128
124
<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>
125
+
<li><strong>payload_off</strong> (<em>Optional</em>): The payload that represents disabled state. Default is “OFF”.</li>
126
+
<li><strong>payload_on</strong> (<em>Optional</em>): The payload that represents enabled state. Default is “ON”.</li>
127
+
<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>
128
+
<li><strong>rgb_command_topic</strong> (<em>Optional</em>): The MQTT topic to publish commands to change the light’s RGB state.</li>
129
+
<li><strong>rgb_state_topic</strong> (<em>Optional</em>): The MQTT topic subscribed to receive RGB state updates.</li>
130
+
<li><strong>rgb_value_template</strong> (<em>Optional</em>): Defines a <ahref="/topics/templating/">template</a> to extract the RGB value.</li>
131
+
<li><strong>state_topic</strong> (<em>Optional</em>): The MQTT topic subscribed to receive state updates.</li>
132
+
<li><strong>state_value_template</strong> (<em>Optional</em>): Defines a <ahref="/topics/templating/">template</a> to extract the state value.</li>
133
+
<li><strong>white_value_command_topic</strong> (<em>Optional</em>): The MQTT topic to publish commands to change the light’s white value.</li>
134
+
<li><strong>white_value_state_topic</strong> (<em>Optional</em>): The MQTT topic subscribed to receive white value updates.</li>
135
+
<li><strong>white_value_value_template</strong> (<em>Optional</em>): Defines a <ahref="/topics/templating/">template</a> to extract the white value.</li>
136
+
<li><strong>xy_command_topic</strong> (<em>Optional</em>): The MQTT topic to publish commands to change the light’s XY state.</li>
137
+
<li><strong>xy_state_topic</strong> (<em>Optional</em>): The MQTT topic subscribed to receive XY state updates.</li>
138
+
<li><strong>xy_value_template</strong> (<em>Optional</em>): Defines a <ahref="/topics/templating/">template</a> to extract the XY value.</li>
129
139
</ul>
130
140
131
141
<pclass="note warning">
132
142
Make sure that your topics match exact. <codeclass="highlighter-rouge">some-topic/</code> and <codeclass="highlighter-rouge">some-topic</code> are different topics.
133
143
</p>
134
144
145
+
<pclass="note warning">
146
+
XY and RGB can not be used at the same time. If both are provided, XY overrides RGB.
147
+
</p>
148
+
149
+
<h2><aclass="title-link" name="comparison-of-light-mqtt-platforms" href="#comparison-of-light-mqtt-platforms"></a> Comparison of light MQTT platforms</h2>
0 commit comments