home-assistant.io/light.mqtt.markdown at 03048e091609184b36258ef4d06d5738a2623fb5

jeans/home-assistant.io

Fork 0

mirror of https://github.com/home-assistant/home-assistant.io.git synced 2025-04-28 23:37:35 +00:00

Jan Bouwhuis 03048e0916

MQTT availability_template documentation (#20522 )

2021-12-03 09:18:58 +01:00

49 KiB

Raw Blame History

title

description

ha_category

ha_iot_class

ha_release

ha_domain

MQTT Light

Instructions on how to setup MQTT lights using default schema within Home Assistant.

Light

Configurable

0.8

mqtt

The mqtt light platform lets you control your MQTT enabled lights through one of the supported message schemas, default, json or template.

Comparison of light MQTT schemas

Function	`default`	`json`	`template`
Brightness	✔	✔	✔
Color mode	✔	✔	✘
Color temperature	✔	✔	✔
Effects	✔	✔	✔
Flashing	✘	✔	✔
HS Color	✔	✔	✘
RGB Color	✔	✔	✔
RGBW Color	✔	✔	✘
RGBWW Color	✔	✔	✘
Transitions	✘	✔	✔
XY Color	✔	✔	✘

Default schema

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

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.

Home Assistant internally assumes that a light's state corresponds to a defined color_mode. The state of MQTT lights with default schema and support for both color and color temperature will set the color_mode according to the last received valid color or color temperature. Optionally, a color_mode_state_topic can be configured for explicit control of the color_mode

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

{% configuration %} availability: description: A list of MQTT topics subscribed to receive availability (online/offline) updates. Must not be used together with availability_topic. required: false type: list keys: payload_available: description: The payload that represents the available state. required: false type: string default: online payload_not_available: description: The payload that represents the unavailable state. required: false type: string default: offline topic: description: An MQTT topic subscribed to receive availability (online/offline) updates. required: true type: string value_template: description: "Defines a template to extract device's availability from the topic. To determine the devices's availability result of this template will be compared to payload_available and payload_not_available." required: false type: template availability_mode: description: When availability is configured, this controls the conditions needed to set the entity to available. Valid entries are all, any, and latest. If set to all, payload_available must be received on all configured availability topics before the entity is marked as online. If set to any, payload_available must be received on at least one configured availability topic before the entity is marked as online. If set to latest, the last payload_available or payload_not_available received on any configured availability topic controls the availability. required: false type: string default: latest availability_template: description: "Defines a template to extract device's availability from the availability_topic. To determine the devices's availability result of this template will be compared to payload_available and payload_not_available." required: false type: template availability_topic: description: The MQTT topic subscribed to receive availability (online/offline) updates. Must not be used together with availability. required: false type: string brightness_command_topic: description: The MQTT topic to publish commands to change the light’s brightness. required: false type: string brightness_scale: description: "Defines the maximum brightness value (i.e., 100%) of the MQTT device." required: false type: integer default: 255 brightness_state_topic: description: The MQTT topic subscribed to receive brightness state updates. required: false type: string brightness_value_template: description: "Defines a template to extract the brightness value." required: false type: string color_mode_state_topic: description: "The MQTT topic subscribed to receive color mode updates. If this is not configured, color_mode will be automatically set according to the last received valid color or color temperature" required: false type: string color_mode_value_template: description: "Defines a template to extract the color mode." required: false type: string color_temp_command_template: description: "Defines a template to compose message which will be sent to color_temp_command_topic. Available variables: value." required: false type: string color_temp_command_topic: description: 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). required: false type: string color_temp_state_topic: description: "The MQTT topic subscribed to receive color temperature state updates." required: false type: string color_temp_value_template: description: "Defines a template to extract the color temperature value." required: false type: string command_topic: description: The MQTT topic to publish commands to change the switch state. required: true type: string device: description: '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. At least one of identifiers or connections must be present to identify the device.' required: false type: map keys: configuration_url: description: 'A link to the webpage that can manage the configuration of this device. Can be either an HTTP or HTTPS link.' required: false type: string connections: description: '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"]].' required: false type: list identifiers: description: 'A list of IDs that uniquely identify the device. For example a serial number.' required: false type: [string, list] manufacturer: description: 'The manufacturer of the device.' required: false type: string model: description: 'The model of the device.' required: false type: string name: description: 'The name of the device.' required: false type: string suggested_area: description: 'Suggest an area if the device isn’t in one yet.' required: false type: string sw_version: description: 'The firmware version of the device.' required: false type: string via_device: description: 'Identifier of a device that routes messages between this device and Home Assistant. Examples of such devices are hubs, or parent devices of a sub-device. This is used to show device topology in Home Assistant.' required: false type: string enabled_by_default: description: Flag which defines if the entity should be enabled when first added. required: false type: boolean default: true entity_category: description: The category of the entity. required: false type: string default: None effect_command_topic: description: "The MQTT topic to publish commands to change the light's effect state." required: false type: string effect_list: description: The list of effects the light supports. required: false type: [string, list] effect_state_topic: description: The MQTT topic subscribed to receive effect state updates. required: false type: string effect_value_template: description: "Defines a template to extract the effect value." required: false type: string hs_command_topic: description: "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." required: false type: string hs_state_topic: description: "The MQTT topic subscribed to receive color state updates in HS format. Note: Brightness is received separately in the brightness_state_topic." required: false type: string hs_value_template: description: "Defines a template to extract the HS value." required: false type: string icon: description: "Icon for the entity." required: false type: icon json_attributes_template: description: "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." required: false type: template json_attributes_topic: description: 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. required: false type: string max_mireds: description: The maximum color temperature in mireds. required: false type: integer min_mireds: description: The minimum color temperature in mireds. required: false type: integer name: description: The name of the light. required: false type: string default: MQTT Light object_id: description: Used instead of name for automatic generation of entity_id required: false type: string on_command_type: description: "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." required: false type: string optimistic: description: Flag that defines if switch works in optimistic mode. required: false type: boolean default: "true if no state topic defined, else false." payload_available: description: The payload that represents the available state. required: false type: string default: online payload_not_available: description: The payload that represents the unavailable state. required: false type: string default: offline payload_off: description: The payload that represents disabled state. required: false type: string default: "OFF" payload_on: description: The payload that represents enabled state. required: false type: string default: "ON" qos: description: The maximum QoS level of the state topic. required: false type: integer default: 0 retain: description: If the published message should have the retain flag on or not. required: false type: boolean default: false rgb_command_template: description: "Defines a template to compose message which will be sent to rgb_command_topic. Available variables: red, green and blue." required: false type: string rgb_command_topic: description: "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." required: false type: string rgb_state_topic: description: "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." required: false type: string rgb_value_template: description: "Defines a template to extract the RGB value." required: false type: string schema: description: The schema to use. Must be default or omitted to select the default schema". required: false type: string default: default state_topic: description: The MQTT topic subscribed to receive state updates. required: false type: string state_value_template: description: "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 {{ value }}." required: false type: string unique_id: description: An ID that uniquely identifies this light. If two lights have the same unique ID, Home Assistant will raise an exception. required: false type: string white_command_topic: description: "The MQTT topic to publish commands to change the light to white mode with a given brightness." required: false type: string white_scale: description: "Defines the maximum white level (i.e., 100%) of the MQTT device." required: false type: integer default: 255 xy_command_topic: description: "The MQTT topic to publish commands to change the light's XY state." required: false type: string xy_state_topic: description: The MQTT topic subscribed to receive XY state updates. required: false type: string xy_value_template: description: "Defines a template to extract the XY value." required: false type: string {% endconfiguration %}

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:

{% raw %}

# 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

{% endraw %}

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 and short/long flashing. The messages sent to/from the lights look similar to this, omitting fields when they aren't needed. The color_mode will not be present in messages sent to the light. It is optional in messages received from the light, but can be used to disambiguate the current mode in the light. In the example below, color_mode is set to rgb and color_temp, color.c, color.w, color.x, color.y, color.h, color.s will all be ignored by Home Assistant:

{
  "brightness": 255,
  "color_mode": "rgb",
  "color_temp": 155,
  "color": {
    "r": 255,
    "g": 180,
    "b": 200,
    "c": 100,
    "w": 50,
    "x": 0.406,
    "y": 0.301,
    "h": 344.0,
    "s": 29.412
  },
  "effect": "colorloop",
  "state": "ON",
  "transition": 2,
}

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.

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"

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
    color_mode: true
    supported_color_modes: ["rgb"]

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
    color_mode: true
    supported_color_modes: ["brightness"]

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
    color_mode: true
    supported_color_modes: ["brightness"]

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 supported_color_modes to ["hs"] in the platform configuration:

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

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_mode": "hs",
  "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
    color_mode: true
    supported_color_modes: ["rgbw"]

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 repository, 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, color temperature, flashing and transitions. Also it includes MQTT Auto Discovery) and the MQTT Last Will and Testament is enabled as well.
h801-mqtt-json is a custom firmware for the H801 LED dimmer, a 5 channel (RGBWWCW) WiFi LED strip controller for 12V LED strips. The firmware is meant to control the 5 channels of the H801 to simultaneously control an RGB and a Warm-white/Cold-white LED strip such as a 5050 RGB LED strip and a 5025 Dual White strip. It implements the MQTT JSON light platform and supports ON/OFF, RGBW colours (RGB strip), brightness, color temperature (CW/WW strip) and transitions.

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 and effects.

Template schema - Configuration

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"

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:

{% raw %}

# 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] }}"

{% endraw %}

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:

{% raw %}

# 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 }}'

{% endraw %}

CCT light (brightnes and temperature)

This example comes from a configuration of Shelly RGBW Bulb working in White mode. max_mireds and min_mireds set color temperature boundaries to 3000K - 6500K. Notice the same limits are applied in command_on_template, but in kelvin units this time. It's due to conversion from mired to kelvin which causes exceeding boundary values accepted by the device. The code also ensures bi-directional conversion of brightness scale between 0-100 (required by the device) and 0-255 (required by Home Assistant). Add the following to your configuration.yaml file:

{% raw %}

# Example configuration.yaml entry
light:
  - platform: mqtt
    schema: template
    name: "Bulb-white"
    command_topic: "shellies/bulb/color/0/set"
    state_topic: "shellies/bulb/color/0/status"
    availability_topic: "shellies/bulb/online"
    command_on_template: >
      {"turn": "on", "mode": "white"
      {%- if brightness is defined -%}
      , "brightness": {{brightness | float | multiply(0.39215686) | round(0)}}
      {%- endif -%}
      {%- if color_temp is defined -%}
      , "temp": {{ [[(1000000 / color_temp | float) | round(0), 3000] | max, 6500] | min }}
      {%- endif -%}
      }
    command_off_template: '{"turn":"off", "mode": "white"}'
    state_template: "{% if value_json.ison and value_json.mode == 'white' %}on{% else %}off{% endif %}"
    brightness_template: "{{ value_json.brightness | float | multiply(2.55) | round(0) }}"
    color_temp_template: "{{ (1000000 / value_json.temp | float) | round(0) }}"
    payload_available: "true"
    payload_not_available: "false"
    max_mireds: 334
    min_mireds: 153
    qos: 1
    retain: false
    optimistic: false

{% endraw %}

Template schema - No brightness or color support

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

49 KiB Raw Blame History Unescape Escape

Comparison of light MQTT schemas

Default schema

Default schema - Configuration

Default schema - Examples

Brightness and RGB support

Brightness and no RGB support

Brightness without on commands

Default schema - Implementations

JSON schema

JSON schema - Configuration

JSON schema - Examples

Brightness and RGB support

Brightness and no RGB support

Brightness Scaled

HS Color

Brightness and RGBW support

Implementations

Template schema

Template schema - Configuration

Template schema - Examples

Simple string payload

JSON payload

CCT light (brightnes and temperature)

Template schema - No brightness or color support

49 KiB

Raw Blame History