diff --git a/source/_integrations/lock.mqtt.markdown b/source/_integrations/lock.mqtt.markdown index 8e8e1ab6639..f1790916c8e 100644 --- a/source/_integrations/lock.mqtt.markdown +++ b/source/_integrations/lock.mqtt.markdown @@ -24,11 +24,30 @@ To enable MQTT locks in your installation, add the following to your `configurat ```yaml # Example configuration.yaml entry +mqtt: + lock: + - command_topic: "home/frontdoor/set" +``` + + + +{% details "Previous configuration format" %} + +The configuration format of manual configured MQTT items has changed. +The old format that places configurations under the `lock` 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 lock: - platform: mqtt command_topic: "home/frontdoor/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`. @@ -229,19 +248,19 @@ The example below shows a full configuration for a MQTT lock. ```yaml # Example configuration.yaml entry -lock: - - platform: mqtt - name: Frontdoor - state_topic: "home-assistant/frontdoor/" - command_topic: "home-assistant/frontdoor/set" - payload_lock: "LOCK" - payload_unlock: "UNLOCK" - state_locked: "LOCK" - state_unlocked: "UNLOCK" - optimistic: false - qos: 1 - retain: true - value_template: "{{ value.x }}" +mqtt: + lock: + - name: Frontdoor + state_topic: "home-assistant/frontdoor/" + command_topic: "home-assistant/frontdoor/set" + payload_lock: "LOCK" + payload_unlock: "UNLOCK" + state_locked: "LOCK" + state_unlocked: "UNLOCK" + optimistic: false + qos: 1 + retain: true + value_template: "{{ value.x }}" ``` {% endraw %}