Home Assistant

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 enable MQTT locks in your installation, add the following to your configuration.yaml file:

# Example configuration.yaml entry
mqtt:
  - lock:
      command_topic: "home/frontdoor/set"

Configuration Variables

Looking for your configuration file?
availability list (Optional)

A list of MQTT topics subscribed to receive availability (online/offline) updates. Must not be used together with availability_topic.

payload_available string (Optional, default: online)

The payload that represents the available state.

payload_not_available string (Optional, default: offline)

The payload that represents the unavailable state.

topic string Required

An MQTT topic subscribed to receive availability (online/offline) updates.

value_template template (Optional)

Defines a template to extract device’s availability from the topic. To determine the devices’s availability result of this template will be compared to payload_available and payload_not_available.

availability_mode string (Optional, default: latest)

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.

availability_template template (Optional)

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.

availability_topic string (Optional)

The MQTT topic subscribed to receive availability (online/offline) updates. Must not be used together with availability.

code_format string (Optional)

A regular expression to validate a supplied code when it is set during the service call to open, lock or unlock the MQTT lock.

command_template template (Optional)

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 service call to open, lock or unlock the MQTT lock and will be set None if no code was passed.

command_topic string Required

The MQTT topic to publish commands to change the lock state.

device map (Optional)

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.

configuration_url string (Optional)

A link to the webpage that can manage the configuration of this device. Can be either an http://, https:// or an internal homeassistant:// URL.

connections list (Optional)

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"]].

hw_version string (Optional)

The hardware version of the device.

identifiers string | list (Optional)

A list of IDs that uniquely identify the device. For example a serial number.

manufacturer string (Optional)

The manufacturer of the device.

model string (Optional)

The model of the device.

name string (Optional)

The name of the device.

suggested_area string (Optional)

Suggest an area if the device isn’t in one yet.

sw_version string (Optional)

The firmware version of the device.

via_device string (Optional)

Identifier of a device that routes messages between this device and Home Assistant. Examples of such devices are hubs, or parent devices of a sub-device. This is used to show device topology in Home Assistant.

enabled_by_default boolean (Optional, default: true)

Flag which defines if the entity should be enabled when first added.

encoding string (Optional, default: utf-8)

The encoding of the payloads received and published messages. Set to "" to disable decoding of incoming payload.

entity_category string (Optional, default: None)

The category of the entity.

icon icon (Optional)

Icon for the entity.

json_attributes_template template (Optional)

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.

json_attributes_topic string (Optional)

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.

name string (Optional, default: MQTT Lock)

The name of the lock. Can be set to null if only the device name is relevant.

object_id string (Optional)

Used instead of name for automatic generation of entity_id

optimistic boolean (Optional)

Flag that defines if lock works in optimistic mode.

Default:

true if no state_topic defined, else false.

payload_available string (Optional, default: online)

The payload that represents the available state.

payload_lock string (Optional, default: LOCK)

The payload sent to the lock to lock it.

payload_not_available string (Optional, default: offline)

The payload that represents the unavailable state.

payload_unlock string (Optional, default: UNLOCK)

The payload sent to the lock to unlock it.

payload_open string (Optional)

The payload sent to the lock to open it.

payload_reset string (Optional, default: “None”)

A special payload that resets the state to unknown when received on the state_topic.

qos integer (Optional, default: 0)

The maximum QoS level to be used when receiving and publishing messages.

retain boolean (Optional, default: false)

If the published message should have the retain flag on or not.

state_jammed string (Optional, default: JAMMED)

The payload sent to state_topic by the lock when it’s jammed.

state_locked string (Optional, default: LOCKED)

The payload sent to state_topic by the lock when it’s locked.

state_locking string (Optional, default: LOCKING)

The payload sent to state_topic by the lock when it’s locking.

state_topic string (Optional)

The MQTT topic subscribed to receive state updates. It accepts states configured with state_jammed, state_locked, state_unlocked, state_locking or state_unlocking.

state_unlocked string (Optional, default: UNLOCKED)

The payload sent to state_topic by the lock when it’s unlocked.

state_unlocking string (Optional, default: UNLOCKING)

The payload sent to state_topic by the lock when it’s unlocking.

unique_id string (Optional)

An ID that uniquely identifies this lock. If two locks have the same unique ID, Home Assistant will raise an exception.

value_template template (Optional)

Defines a template to extract a state 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
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"