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.
It’s mandatory for locks to support lock and unlock. A lock may optionally support open, (e.g. to open the bolt in addition to the latch), in this case, payload_open is required in the configuration. If the lock is in optimistic mode, it will change states to unlocked when handling the open command.
An MQTT lock can also report the intermediate states unlocking, locking or jammed if the motor reports a jammed state.
To use an MQTT lock in your installation, add the following to your configuration.yamlThe configuration.yaml file is the main configuration file for Home Assistant. It lists the integrations to be loaded and their specific configurations. In some cases, the configuration needs to be edited manually directly in the configuration.yaml file. Most integrations can be configured in the UI. [Learn more] file.
After changing the configuration.yamlThe configuration.yaml file is the main configuration file for Home Assistant. It lists the integrations to be loaded and their specific configurations. In some cases, the configuration needs to be edited manually directly in the configuration.yaml file. Most integrations can be configured in the UI. [Learn more] file, restart Home Assistant to apply the changes.
# Example configuration.yaml entry
mqtt:
- lock:
command_topic: "home/frontdoor/set"
Alternatively, a more advanced approach is to set it up via MQTT discovery.
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.
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.
The MQTT topic subscribed to receive availability (online/offline) updates. Must not be used together with availability.
A regular expression to validate a supplied code when it is set during the action to open, lock or unlock the MQTT lock.
Defines a template to generate the payload to send to command_topic. The lock command template accepts the parameters value and code. The value parameter will contain the configured value for either payload_open, payload_lock or payload_unlock. The code parameter is set during the action to open, lock or unlock the MQTT lock and will be set None if no code was passed.
Information about the device this lock is a part of to tie it into the device registry. Only works when unique_id is set. At least one of identifiers or connections must be present to identify the device.
A link to the webpage that can manage the configuration of this device. Can be either an http://, https:// or an internal homeassistant:// URL.
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.
The encoding of the payloads received and published messages. Set to "" to disable decoding of incoming payload.
The category of the entity.
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.
The name of the lock. Can be set to null if only the device name is relevant.
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.
A special payload that resets the state to unknown when received on the state_topic.
Must be lock. Only allowed and required in MQTT auto discovery device messages.
The maximum QoS level to be used when receiving and publishing messages.
If the published message should have the retain flag on or not.
The payload sent to state_topic by the lock when it’s jammed.
The payload sent to state_topic by the lock when it’s locked.
The payload sent to state_topic by the lock when it’s locking.
The MQTT topic subscribed to receive state updates. It accepts states configured with state_jammed, state_locked, state_unlocked, state_locking or state_unlocking. A “None” payload resets to an unknown state. An empty payload is ignored.
The payload sent to state_topic by the lock when it’s unlocked.
The payload sent to state_topic by the lock when it’s unlocking.
An ID that uniquely identifies this lock. If two locks have the same unique ID, Home Assistant will raise an exception. Required when used with device-based discovery.
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
mqtt:
- lock:
name: Frontdoor
state_topic: "home-assistant/frontdoor/state"
code_format: "^\\d{4}$"
command_topic: "home-assistant/frontdoor/set"
command_template: '{ "action": "{{ value }}", "code":"{{ code }}" }'
payload_lock: "LOCK"
payload_unlock: "UNLOCK"
state_locked: "LOCK"
state_unlocked: "UNLOCK"
state_locking: "LOCKING"
state_unlocking: "UNLOCKING"
state_jammed: "MOTOR_JAMMED"
state_ok: "MOTOR_OK"
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"