jeans/home-assistant.io
jeans/home-assistant.io
1
0
Fork 0
mirror of https://github.com/home-assistant/home-assistant.io.git synced 2025-07-26 10:46:51 +00:00
Code Issues Packages Projects Releases Wiki Activity

MQTT scene config to integration key (#22832)

Browse Source
This commit is contained in:
Jan Bouwhuis 2022-05-23 14:35:17 +02:00 committed by GitHub
parent bad42341cf
commit 0f2777f579
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 35 additions and 16 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

51
source/_integrations/scene.mqtt.markdown
View File

@ -16,11 +16,30 @@ To enable a MQTT scene in your installation, add the following to your `configur
```yaml ```yaml
# Example configuration.yaml entry # Example configuration.yaml entry
mqtt:
scene:
- command_topic: zigbee2mqtt/living_room_group/set
```
<a id='new_format'></a>
{% 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:
```yaml
scene: scene:
- platform: mqtt - platform: mqtt
command_topic: zigbee2mqtt/living_room_group/set command_topic: zigbee2mqtt/living_room_group/set
``` ```
{% enddetails %}
{% configuration %} {% configuration %}
availability: availability:
description: A list of MQTT topics subscribed to receive availability (online/offline) updates. Must not be used together with `availability_topic`. description: A list of MQTT topics subscribed to receive availability (online/offline) updates. Must not be used together with `availability_topic`.
@ -132,16 +151,16 @@ The example below shows a full configuration for a scene.
```yaml ```yaml
# Example configuration.yaml entry # Example configuration.yaml entry
scene: mqtt:
- platform: mqtt scene:
unique_id: living_room_party_scene - unique_id: living_room_party_scene
name: "Living Room Party Scene" name: "Living Room Party Scene"
command_topic: "home/living_room/party_scene/set" command_topic: "home/living_room/party_scene/set"
availability: availability:
- topic: "home/living_room/party_scene/available" - topic: "home/living_room/party_scene/available"
payload_on: "ON" payload_on: "ON"
qos: 0 qos: 0
retain: true retain: true
``` ```
### Use with a JSON Payload ### Use with a JSON Payload
@ -150,10 +169,10 @@ The example below shows a configuration using a JSON payload.
```yaml ```yaml
# Example configuration.yaml entry # Example configuration.yaml entry
scene: mqtt:
- platform: mqtt scene:
name: Living Room Blue Scene - name: Living Room Blue Scene
unique_id: living_room_blue_scene unique_id: living_room_blue_scene
command_topic: "home/living_room/set" command_topic: "home/living_room/set"
payload_on: '{"activate_scene": "Blue Scene"}' payload_on: '{"activate_scene": "Blue Scene"}'
``` ```