MQTT Lock
The mqtt lock platform lets you control your MQTT enabled locks.
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 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:
# Example configuration.yaml entry
lock:
- platform: mqtt
command_topic: "home/frontdoor/set"
Configuration Variables
A list of MQTT topics subscribed to receive availability (online/offline) updates. Must not be used together with availability_topic.
The payload that represents the available state.
The payload that represents the unavailable state.
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.
The MQTT topic subscribed to receive availability (online/offline) updates. Must not be used together with availability.
Information about the device this lock 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.
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"]].
A list of IDs that uniquely identify the device. For example a serial number.
Flag which defines if the entity should be enabled when first added.
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.
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.
Flag that defines if lock works in optimistic mode.
true if no state_topic defined, else false.
The payload that represents the available state.
The payload that represents the unavailable state.
The payload that represents disabled/unlocked state.
If the published message should have the retain flag on or not.
The value that represents the lock to be in locked state
The value that represents the lock to be in unlocked state
An ID that uniquely identifies this lock. If two locks have the same unique ID, Home Assistant will raise an exception.
Defines a template to extract a value from the payload.
Make sure that your topics match exactly. some-topic/ and some-topic are different topics.
Examples
In this section you will find some real-life examples of how to use this lock.
Full configuration
The example below shows a full configuration for a MQTT lock.
# 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 }}"
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:
mosquitto_pub -h 127.0.0.1 -t home-assistant/frontdoor/set -m "LOCK"