MQTT Light


The mqtt light platform with lets you control your MQTT enabled lights through one of the supported message schemas.

Comparison of light MQTT schemas

Function default json template
Brightness
Color temperature
Effects
Flashing
RGB Color
Transitions
XY Color
HS Color
White Value

Default schema

The mqtt light platform with default schema lets you control your MQTT enabled lights. It supports setting brightness, color temperature, effects, flashing, on/off, RGB colors, transitions, XY colors and white values.

Default schema - Configuration

In an ideal scenario, the MQTT device will have a state topic to publish state changes. If these messages are published with a 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 switch will be false / off.

When a state topic is not available, the light will work in optimistic mode. In this mode, the light will immediately change state after every command. Otherwise, the light will wait for state confirmation from the device (message from state_topic).

Optimistic mode can be forced, even if the state_topic is available. Try to enable it, if experiencing incorrect light operation.

# Example configuration.yaml entry
light:
  - platform: mqtt
    command_topic: "office/rgb1/light/switch"

Configuration Variables

name

(string)(Optional)

The name of the light.

Default value:

MQTT Light

unique_id

(string)(Optional)

An ID that uniquely identifies this light. If two lights have the same unique ID, Home Assistant will raise an exception.

command_topic

(string)(Required)

The MQTT topic to publish commands to change the switch state.

brightness_command_topic

(string)(Optional)

The MQTT topic to publish commands to change the light’s brightness.

brightness_scale

(integer)(Optional)

Defines the maximum brightness value (i.e. 100%) of the MQTT device.

Default value:

255

brightness_state_topic

(string)(Optional)

The MQTT topic subscribed to receive brightness state updates.

brightness_value_template

(string)(Optional)

Defines a template to extract the brightness value.

color_temp_command_template

(string)(Optional)

Defines a template to compose message which will be sent to color_temp_command_topic. Available variables: value.

color_temp_command_topic

(string)(Optional)

The MQTT topic to publish commands to change the light’s color temperature state. The color temperature command slider has a range of 153 to 500 mireds (micro reciprocal degrees).

color_temp_state_topic

(string)(Optional)

The MQTT topic subscribed to receive color temperature state updates.

color_temp_value_template

(string)(Optional)

Defines a template to extract the color temperature value.

effect_command_topic

(string)(Optional)

The MQTT topic to publish commands to change the light’s effect state.

effect_state_topic

(string)(Optional)

The MQTT topic subscribed to receive effect state updates.

effect_value_template

(string)(Optional)

Defines a template to extract the effect value.

effect_list

(string | list)(Optional)

The list of effects the light supports.

hs_command_topic

(string)(Optional)

The MQTT topic to publish commands to change the light’s color state in HS format (Hue Saturation). Range for Hue: 0° .. 360°, Range of Saturation: 0..100. Note: Brightness is sent separately in the brightness_command_topic.

hs_state_topic

(string)(Optional)

The MQTT topic subscribed to receive color state updates in HS format. Note: Brightness is received separately in the brightness_state_topic.

hs_value_template

(string)(Optional)

Defines a template to extract the HS value.

on_command_type

(string)(Optional)

Defines when on the payload_on is sent. Using last (the default) will send any style (brightness, color, etc) topics first and then a payload_on to the command_topic. Using first will send the payload_on and then any style topics. Using brightness will only send brightness commands instead of the payload_on to turn the light on.

optimistic

(boolean)(Optional)

Flag that defines if switch works in optimistic mode.

Default value:

true if no state topic defined, else false.

payload_on

(string)(Optional)

The payload that represents enabled state.

Default value:

ON

payload_off

(string)(Optional)

The payload that represents disabled state.

Default value:

OFF

qos

(integer)(Optional)

The maximum QoS level of the state topic.

Default value:

0

retain

(boolean)(Optional)

If the published message should have the retain flag on or not.

Default value:

false

rgb_command_template

(string)(Optional)

Defines a template to compose message which will be sent to rgb_command_topic. Available variables: red, green and blue.

rgb_command_topic

(string)(Optional)

The MQTT topic to publish commands to change the light’s RGB state. Please note that the color value sent by Home Assistant is normalized to full brightness if brightness_command_topic is set. Brightness information is in this case sent separately in the brightness_command_topic. This will cause a light that expects an absolute color value (including brightness) to flicker.

rgb_state_topic

(string)(Optional)

The MQTT topic subscribed to receive RGB state updates. The expected payload is the RGB values separated by commas, for example, 255,0,127. Please note that the color value received by Home Assistant is normalized to full brightness. Brightness information is received separately in the brightness_state_topic.

rgb_value_template

(string)(Optional)

Defines a template to extract the RGB value.

state_topic

(string)(Optional)

The MQTT topic subscribed to receive state updates.

state_value_template

(string)(Optional)

Defines a template to extract the state value. The template should match the payload on and off values, so if your light uses power on to turn on, your state_value_template string should return power on when the switch is on. For example if the message is just on, your state_value_template should be power.

white_value_command_topic

(string)(Optional)

The MQTT topic to publish commands to change the light’s white value.

white_value_scale

(integer)(Optional)

Defines the maximum white value (i.e. 100%) of the MQTT device.

Default value:

255

white_value_state_topic

(string)(Optional)

The MQTT topic subscribed to receive white value updates.

white_value_template

(string)(Optional)

Defines a template to extract the white value.

xy_command_topic

(string)(Optional)

The MQTT topic to publish commands to change the light’s XY state.

xy_state_topic

(string)(Optional)

The MQTT topic subscribed to receive XY state updates.

xy_value_template

(string)(Optional)

Defines a template to extract the XY value.

availability_topic

(string)(Optional)

The MQTT topic subscribed to receive availability (online/offline) updates.

payload_available

(string)(Optional)

The payload that represents the available state.

Default value:

online

payload_not_available

(string)(Optional)

The payload that represents the unavailable state.

Default value:

offline

json_attributes_topic

(string)(Optional)

The MQTT topic subscribed to receive a JSON dictionary payload and then set as sensor attributes. Usage example can be found in MQTT sensor documentation.

json_attributes_template

(template)(Optional)

Defines a template to extract the JSON dictionary from messages received on the json_attributes_topic. Usage example can be found in MQTT sensor documentation.

device

(map)(Optional)

Information about the device this light is a part of to tie it into the device registry. Only works through MQTT discovery and when unique_id is set.

identifiers

(string | list)(Optional)

A list of IDs that uniquely identify the device. For example a serial number.

connections

(list)(Optional)

A list of connections of the device to the outside world as a list of tuples [connection_type, connection_identifier]. For example the MAC address of a network interface: "connections": [["mac", "02:5b:26:a8:dc:12"]].

manufacturer

(string)(Optional)

The manufacturer of the device.

model

(string)(Optional)

The model of the device.

name

(string)(Optional)

The name of the device.

sw_version

(string)(Optional)

The firmware version of the device.

Make sure that your topics match exactly. 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.

Default schema - Examples

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

Brightness and RGB support

To enable a light with brightness and RGB support in your installation, add the following to your configuration.yaml file:

# Example configuration.yaml entry
light:
  - platform: mqtt
    name: "Office Light RGB"
    state_topic: "office/rgb1/light/status"
    command_topic: "office/rgb1/light/switch"
    brightness_state_topic: "office/rgb1/brightness/status"
    brightness_command_topic: "office/rgb1/brightness/set"
    rgb_state_topic: "office/rgb1/rgb/status"
    rgb_command_topic: "office/rgb1/rgb/set"
    state_value_template: "{{ value_json.state }}"
    brightness_value_template: "{{ value_json.brightness }}"
    rgb_value_template: "{{ value_json.rgb | join(',') }}"
    qos: 0
    payload_on: "ON"
    payload_off: "OFF"
    optimistic: false

Brightness and no RGB support

To enable a light with brightness (no RGB version) in your installation, add the following to your configuration.yaml file:

# Example configuration.yaml entry
light:
  - platform: mqtt
    name: "Office light"
    state_topic: "office/light/status"
    command_topic: "office/light/switch"
    brightness_state_topic: 'office/light/brightness'
    brightness_command_topic: 'office/light/brightness/set'
    qos: 0
    payload_on: "ON"
    payload_off: "OFF"
    optimistic: false

Brightness without on commands

To enable a light that sends only brightness topics to turn it on, add the following to your configuration.yaml file. The command_topic is only used to send an off command in this case:

# Example configuration.yaml entry
light:
  - platform: mqtt
    name: "Brightness light"
    state_topic: "office/light/status"
    command_topic: "office/light/switch"
    payload_off: "OFF"
    brightness_state_topic: 'office/light/brightness'
    brightness_command_topic: 'office/light/brightness/set'
    on_command_type: 'brightness'

Default schema - Implementations

  • A basic example using a nodeMCU board (ESP8266) to control its built-in LED (on/off).
  • Another example to control a RGB LED (on/off, brightness, and colors).
  • Integration guide for the ESPUrna firmware (ESP8285/ESP8266).

JSON schema

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

This schema 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": 180,
    "b": 200,
    "x": 0.406,
    "y": 0.301,
    "h": 344.0,
    "s": 29.412
  },
  "effect": "colorloop",
  "state": "ON",
  "transition": 2,
  "white_value": 150
}

JSON schema - Configuration

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.

When a state topic is not available, the light will work in optimistic mode. In this mode, the light will immediately change state after every command. Otherwise, the light will wait for state confirmation from the device (message from state_topic).

Optimistic mode can be forced, even if state topic is available. Try enabling it if the light is operating incorrectly.

# Example configuration.yaml entry
light:
  - platform: mqtt
    schema: json
    command_topic: "home/rgb1/set"

Configuration Variables

name

(string)(Optional)

The name of the light.

Default value:

MQTT JSON Light

unique_id

(string)(Optional)

An ID that uniquely identifies this light. If two lights have the same unique ID, Home Assistant will raise an exception.

command_topic

(string)(Required)

The MQTT topic to publish commands to change the light’s state.

brightness

(boolean)(Optional)

Flag that defines if the light supports brightness.

Default value:

false

brightness_scale

(integer)(Optional)

Defines the maximum brightness value (i.e. 100%) of the MQTT device.

Default value:

255

color_temp

(boolean)(Optional)

Flag that defines if the light supports color temperature.

Default value:

false

effect

(boolean)(Optional)

Flag that defines if the light supports effects.

Default value:

false

effect_list

(string | list)(Optional)

The list of effects the light supports.

flash_time_long

(integer)(Optional)

The duration, in seconds, of a “long” flash.

Default value:

10

flash_time_short

(integer)(Optional)

The duration, in seconds, of a “short” flash.

Default value:

2

optimistic

(boolean)(Optional)

Flag that defines if the light works in optimistic mode.

Default value:

true if no state topic defined, else false.

qos

(integer)(Optional)

The maximum QoS level of the state topic.

Default value:

0

retain

(boolean)(Optional)

If the published message should have the retain flag on or not.

Default value:

false

rgb

(boolean)(Optional)

Flag that defines if the light supports RGB colors.

Default value:

false

state_topic

(string)(Optional)

The MQTT topic subscribed to receive state updates.

white_value

(boolean)(Optional)

Flag that defines if the light supports white values.

Default value:

false

xy

(boolean)(Optional)

Flag that defines if the light supports XY colors.

Default value:

false

hs

(boolean)(Optional)

Flag that defines if the light supports HS colors.

Default value:

false

availability_topic

(string)(Optional)

The MQTT topic subscribed to receive availability (online/offline) updates.

payload_available

(string)(Optional)

The payload that represents the available state.

Default value:

online

payload_not_available

(string)(Optional)

The payload that represents the unavailable state.

Default value:

offline

json_attributes_topic

(string)(Optional)

The MQTT topic subscribed to receive a JSON dictionary payload and then set as sensor attributes. Usage example can be found in MQTT sensor documentation.

json_attributes_template

(template)(Optional)

Defines a template to extract the JSON dictionary from messages received on the json_attributes_topic. Usage example can be found in MQTT sensor documentation.

device

(map)(Optional)

Information about the device this light is a part of to tie it into the device registry. Only works through MQTT discovery and when unique_id is set.

identifiers

(string | list)(Optional)

A list of IDs that uniquely identify the device. For example a serial number.

connections

(list)(Optional)

A list of connections of the device to the outside world as a list of tuples [connection_type, connection_identifier]. For example the MAC address of a network interface: "connections": [["mac", "02:5b:26:a8:dc:12"]].

manufacturer

(string)(Optional)

The manufacturer of the device.

model

(string)(Optional)

The model of the device.

name

(string)(Optional)

The name of the device.

sw_version

(string)(Optional)

The firmware version of the device.

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

RGB, XY and HSV can not be used at the same time in state_topic messages. Make sure that only one of the color models is in the “color” section of the state MQTT payload.

JSON schema - Examples

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

Brightness and RGB support

To enable a light with brightness and RGB support in your installation, add the following to your configuration.yaml file:

# Example configuration.yaml entry
light:
  - platform: mqtt
    schema: json
    name: mqtt_json_light_1
    state_topic: "home/rgb1"
    command_topic: "home/rgb1/set"
    brightness: true
    rgb: true

Brightness and no RGB support

To enable a light with brightness (but no color support) in your installation, add the following to your configuration.yaml file:

# Example configuration.yaml entry
light:
  - platform: mqtt
    schema: json
    name: mqtt_json_light_1
    state_topic: "home/rgb1"
    command_topic: "home/rgb1/set"
    brightness: true

Brightness Scaled

To enable a light using a brightness scale other than 8bit the brightness_scale option may be added to denote the “fully on” value:

# Example configuration.yaml entry
light:
  - platform: mqtt
    schema: json
    name: mqtt_json_light_1
    state_topic: "home/light"
    command_topic: "home/light/set"
    brightness: true
    brightness_scale: 4095

Home Assistant will then convert its 8bit value in the message to and from the device:

{
  "brightness": 4095,
  "state": "ON"
}

HS Color

To use a light with hue+saturation as the color model, set hs to true in the platform configuration:

light:
  - platform: mqtt
    schema: json
    name: mqtt_json_hs_light
    state_topic: "home/light"
    command_topic: "home/light/set"
    hs: true

Home Assistant expects the hue values to be in the range 0 to 360 and the saturation values to be scaled from 0 to 100. For example, the following is a blue color shade:

{
  "state": "ON",
  "color": {
    "h": 24.0,
    "s": 100.0
  }
}

Brightness and RGBW support

To enable a light with brightness, RGB support and a separate white channel (RGBW) in your installation, add the following to your configuration.yaml file:

# Example configuration.yaml entry
light:
  - platform: mqtt
    schema: json
    name: mqtt_json_light_1
    state_topic: "home/rgbw1"
    command_topic: "home/rgbw1/set"
    brightness: true
    rgb: true
    white_value: true

Implementations

  • A full example of custom lighting using this platform and an ESP8266 microcontroller can be found here. It supports on/off, brightness, transitions, RGB colors, and flashing.

  • There is also another implementation forked from the above repo, it supports all the same features but is made for addressable LED strips using FastLED on a NodeMCU V3 it can be found here.

  • McLighting is another ESP8266 firmware for WS2812 addressable LEDs.

  • MQTT JSON Light is another implementation for ESP8266 including MQTT discovery.

  • ESPHome implements the JSON schema for MQTT based installs and supports MQTT discovery.

  • AiLight is a custom firmware for the Ai-Thinker (and equivalent) RGBW WiFi light bulbs that has an ESP8266 onboard and controlled by the MY9291 LED driver. It implements the MQTT JSON light platform and supports ON/OFF, RGBW colours, brightness, colour temperature, flashing and transitions. Also it includes MQTT Auto Discovery) and the MQTT Last Will and Testament is enabled as well.

Template schema

The mqtt light platform with template schema 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 schema supports on/off, brightness, RGB colors, XY colors, color temperature, transitions, short/long flashing, effects and white values.

Template schema - Configuration

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.

When a state topic is not available, the light will work in optimistic mode. In this mode, the light will immediately change state after every command. Otherwise, the light will wait for state confirmation from the device (message from state_topic).

Optimistic mode can be forced, even if state topic is available. Try enabling it if the light is operating incorrectly.

# Example configuration.yaml entry
light:
  - platform: mqtt
    schema: template
    command_topic: "home/rgb1/set"
    command_on_template: "on"
    command_off_template: "off"

Configuration Variables

name

(string)(Optional)

The name of the light.

Default value:

MQTT Template Light

unique_id

(string)(Optional)

An ID that uniquely identifies this light. If two lights have the same unique ID, Home Assistant will raise an exception.

effect_list

(string | list)(Optional)

List of possible effects.

command_topic

(string)(Required)

The MQTT topic to publish commands to change the light’s state.

state_topic

(string)(Optional)

The MQTT topic subscribed to receive state updates.

command_on_template

(string)(Required)

The template for on state changes. Available variables: state, brightness, red, green, blue, white_value, flash, transition and effect.

command_off_template

(string)(Required)

The template for off state changes. Available variables: state and transition.

state_template

(string)(Optional)

Template to extract state from the state payload value.

brightness_template

(string)(Optional)

Template to extract brightness from the state payload value.

red_template

(string)(Optional)

Template to extract red color from the state payload value.

green_template

(string)(Optional)

Template to extract green color from the state payload value.

blue_template

(string)(Optional)

Template to extract blue color from the state payload value.

color_temp_template

(string)(Optional)

Template to extract color temperature from the state payload value.

effect_template

(string)(Optional)

Template to extract effect from the state payload value.

white_value_template

(string)(Optional)

Template to extract white value from the state payload value.

optimistic

(string)(Optional)

Flag that defines if the light works in optimistic mode.

Default value:

true if no state topic or state template is defined, else false.

qos

(integer)(Optional)

The maximum QoS level of the state topic.

Default value:

0

availability_topic

(string)(Optional)

The MQTT topic subscribed to receive availability (online/offline) updates.

payload_available

(string)(Optional)

The payload that represents the available state.

Default value:

online

payload_not_available

(string)(Optional)

The payload that represents the unavailable state.

Default value:

offline

json_attributes_topic

(string)(Optional)

The MQTT topic subscribed to receive a JSON dictionary payload and then set as sensor attributes. Usage example can be found in MQTT sensor documentation.

json_attributes_template

(template)(Optional)

Defines a template to extract the JSON dictionary from messages received on the json_attributes_topic. Usage example can be found in MQTT sensor documentation.

device

(map)(Optional)

Information about the device this light is a part of to tie it into the device registry. Only works through MQTT discovery and when unique_id is set.

identifiers

(string | list)(Optional)

A list of IDs that uniquely identify the device. For example a serial number.

connections

(list)(Optional)

A list of connections of the device to the outside world as a list of tuples [connection_type, connection_identifier]. For example the MAC address of a network interface: "connections": [["mac", "02:5b:26:a8:dc:12"]].

manufacturer

(string)(Optional)

The manufacturer of the device.

model

(string)(Optional)

The model of the device.

name

(string)(Optional)

The name of the device.

sw_version

(string)(Optional)

The firmware version of the device.

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

Template schema - Examples

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

Simple string payload

For a simple string payload with the format state,brightness,r-g-b (e.g., on,255,255-255-255), add the following to your configuration.yaml file:

# Example configuration.yaml entry
light:
  - platform: mqtt
    schema: template
    command_topic: "home/rgb1/set"
    state_topic: "home/rgb1/status"
    command_on_template: "on,{{ brightness|d }},{{ red|d }}-{{ green|d }}-{{ blue|d }}"
    command_off_template: "off"
    state_template: "{{ value.split(',')[0] }}"  # must return `on` or `off`
    brightness_template: "{{ value.split(',')[1] }}"
    red_template: "{{ value.split(',')[2].split('-')[0] }}"
    green_template: "{{ value.split(',')[2].split('-')[1] }}"
    blue_template: "{{ value.split(',')[2].split('-')[2] }}"

JSON payload

For a JSON payload with the format {"state": "on", "brightness": 255, "color": [255, 255, 255], "effect": "rainbow"}, add the following to your configuration.yaml file:

# Example configuration.yaml entry
light:
  - platform: mqtt
    schema: template
    effect_list:
      - rainbow
      - colorloop
    command_topic: "home/rgb1/set"
    state_topic: "home/rgb1/status"
    command_on_template: >
      {"state": "on"
      {%- if brightness is defined -%}
      , "brightness": {{ brightness }}
      {%- endif -%}
      {%- if red is defined and green is defined and blue is defined -%}
      , "color": [{{ red }}, {{ green }}, {{ blue }}]
      {%- endif -%}
      {%- if effect is defined -%}
      , "effect": "{{ effect }}"
      {%- endif -%}
      }
    command_off_template: '{"state": "off"}'
    state_template: '{{ value_json.state }}'
    brightness_template: '{{ value_json.brightness }}'
    red_template: '{{ value_json.color[0] }}'
    green_template: '{{ value_json.color[1] }}'
    blue_template: '{{ value_json.color[2] }}'
    effect_template: '{{ value_json.effect }}'

Template schema - No brightness or color support

If you don’t want brightness, color or effect support, just omit the corresponding configuration sections.