mirror of
https://github.com/home-assistant/home-assistant.io.git
synced 2025-05-03 17:48:59 +00:00
1aca7b08cf
* e.g. to e.g., and proper case for Home Assistant * Instructions how to -> Instructions on how to
127 lines
3.9 KiB
Markdown
127 lines
3.9 KiB
Markdown
---
|
|
layout: page
|
|
title: "MQTT Lock"
|
|
description: "Instructions on how to integrate MQTT locks into Home Assistant."
|
|
date: 2016-02-28 15:00
|
|
sidebar: true
|
|
comments: false
|
|
sharing: true
|
|
footer: true
|
|
logo: mqtt.png
|
|
ha_category: Lock
|
|
ha_release: 0.15
|
|
ha_iot_class: depends
|
|
---
|
|
|
|
The `mqtt` lock platform lets you control your MQTT enabled locks.
|
|
|
|
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 lock will receive an instant state update after subscription and will start with correct state. Otherwise, the initial state of the lock will be `false` / unlocked.
|
|
|
|
When a `state_topic` is not available, the lock will work in optimistic mode. In this mode, the lock will immediately change state after every command. Otherwise, the lock will wait for state confirmation from the device (message from `state_topic`).
|
|
|
|
Optimistic mode can be forced, even if state topic is available. Try to enable it, if experiencing incorrect lock operation.
|
|
|
|
To enable MQTT locks in your installation, add the following to your `configuration.yaml` file:
|
|
|
|
```yaml
|
|
# Example configuration.yml entry
|
|
lock:
|
|
- platform: mqtt
|
|
command_topic: "home/frontdoor/set"
|
|
```
|
|
|
|
{% configuration %}
|
|
name:
|
|
description: The name of the lock.
|
|
required: false
|
|
type: string
|
|
default: MQTT Lock
|
|
command_topic:
|
|
description: The MQTT topic to publish commands to change the lock state.
|
|
required: true
|
|
type: string
|
|
state_topic:
|
|
description: The MQTT topic subscribed to receive state updates.
|
|
required: false
|
|
type: string
|
|
payload_lock:
|
|
description: The payload that represents enabled/locked state.
|
|
required: false
|
|
type: string
|
|
default: LOCK
|
|
payload_unlock:
|
|
description: The payload that represents disabled/unlocked state.
|
|
required: false
|
|
type: string
|
|
default: UNLOCK
|
|
optimistic:
|
|
description: Flag that defines if lock works in optimistic mode.
|
|
required: false
|
|
type: string
|
|
default: "`true` if no `state_topic` defined, else `false`."
|
|
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
|
|
value_template:
|
|
description: "Defines a [template](/docs/configuration/templating/#processing-incoming-data) to extract a value from the payload."
|
|
required: false
|
|
type: string
|
|
availability_topic:
|
|
description: The MQTT topic subscribed to receive availability (online/offline) updates.
|
|
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
|
|
{% endconfiguration %}
|
|
|
|
<p class='note warning'>
|
|
Make sure that your topics match exactly. `some-topic/` and `some-topic` are different topics.
|
|
</p>
|
|
|
|
## {% linkable_title Examples %}
|
|
|
|
In this section you will find some real life examples of how to use this lock.
|
|
|
|
### {% linkable_title Full configuration %}
|
|
|
|
The example below shows a full configuration for a MQTT lock.
|
|
|
|
```yaml
|
|
# Example configuration.yml entry
|
|
lock:
|
|
- platform: mqtt
|
|
name: Frontdoor
|
|
state_topic: "home-assistant/frontdoor/"
|
|
command_topic: "home-assistant/frontdoor/set"
|
|
payload_lock: "LOCK"
|
|
payload_unlock: "UNLOCK"
|
|
optimistic: false
|
|
qos: 1
|
|
retain: true
|
|
value_template: '{% raw %}{{ value.x }}{% endraw %}'
|
|
```
|
|
|
|
Keep an eye on retaining messages to keep the state as you don't want to unlock your door by accident when you restart something.
|
|
|
|
For a check you can use the command line tools `mosquitto_pub` shipped with `mosquitto` to send MQTT messages. This allows you to operate your lock manually:
|
|
|
|
```bash
|
|
$ mosquitto_pub -h 127.0.0.1 -t home-assistant/frontdoor/set -m "LOCK"
|
|
```
|
|
|