5.7 KiB
| title | description | ha_category | ha_release | ha_iot_class | ha_domain | |
|---|---|---|---|---|---|---|
| MQTT Scene | Instructions on how to integrate MQTT scenes into Home Assistant. |
|
2020.12 | Configurable | mqtt |
The mqtt scene platform lets you control your MQTT enabled scenes.
Configuration
To enable a MQTT scene in your installation, add the following to your configuration.yaml file:
# Example configuration.yaml entry
mqtt:
scene:
- command_topic: zigbee2mqtt/living_room_group/set
{% details "Previous configuration format" %}
The configuration format of manual configured MQTT items has changed.
The old format that places configurations under the scene platform key
should no longer be used and is deprecated.
The above example shows the new and modern way, this is the previous/old example:
scene:
- platform: mqtt
command_topic: zigbee2mqtt/living_room_group/set
{% enddetails %}
{% 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
command_topic:
description: The MQTT topic to publish payload_on to activate the scene.
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
icon:
description: Icon for the scene.
required: false
type: icon
name:
description: The name to use when displaying this scene.
required: false
type: string
default: MQTT Scene
object_id:
description: Used instead of name for automatic generation of entity_id
required: false
type: string
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_on:
description: The payload that will be sent to command_topic when activating the MQTT scene.
required: false
type: string
default: "ON"
qos:
description: The maximum QoS level of the state topic. Default is 0 and will also be used to publishing messages.
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
unique_id:
description: An ID that uniquely identifies this scene entity. If two scenes have the same unique ID, Home Assistant will raise an exception.
required: false
type: string
{% endconfiguration %}
Make sure that your topic matches exactly. some-topic/ and some-topic are different topics.
Examples
In this section, you will find some real-life examples of how to use the MQTT Scene.
Full configuration
The example below shows a full configuration for a scene.
# Example configuration.yaml entry
mqtt:
scene:
- unique_id: living_room_party_scene
name: "Living Room Party Scene"
command_topic: "home/living_room/party_scene/set"
availability:
- topic: "home/living_room/party_scene/available"
payload_on: "ON"
qos: 0
retain: true
Use with a JSON Payload
The example below shows a configuration using a JSON payload.
# Example configuration.yaml entry
mqtt:
scene:
- name: Living Room Blue Scene
unique_id: living_room_blue_scene
command_topic: "home/living_room/set"
payload_on: '{"activate_scene": "Blue Scene"}'