jeans/home-assistant.io
jeans/home-assistant.io
1
0
Fork 0
mirror of https://github.com/home-assistant/home-assistant.io.git synced 2025-07-19 07:17:14 +00:00
Code Issues Packages Projects Releases Wiki Activity

Document locking and unlocking for MQTT lock (#25728)

Browse Source 
Co-authored-by: Jan Bouwhuis <jbouwh@users.noreply.github.com>
This commit is contained in:
Patrick ZAJDA 2023-01-16 08:44:07 +01:00 committed by GitHub
parent 5f0a5aa274
commit 234ecccbcc
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 13 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

11
source/_integrations/lock.mqtt.markdown
View File

@ -20,6 +20,7 @@ Optimistic mode can be forced, even if state topic is available. Try to enable i
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. 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` and `locking`.
<a id='new_format'></a> <a id='new_format'></a>
To enable MQTT locks in your installation, add the following to your `configuration.yaml` file: To enable MQTT locks in your installation, add the following to your `configuration.yaml` file:
@ -198,6 +199,11 @@ state_locked:
required: false required: false
type: string type: string
default: LOCKED default: LOCKED
state_locking:
description: The payload sent to by the lock when it's locking.
required: false
type: string
default: LOCKING
state_topic: state_topic:
description: The MQTT topic subscribed to receive state updates. description: The MQTT topic subscribed to receive state updates.
required: false required: false
@ -207,6 +213,11 @@ state_unlocked:
required: false required: false
type: string type: string
default: UNLOCKED default: UNLOCKED
state_unlocking:
description: The payload sent to by the lock when it's unlocking.
required: false
type: string
default: UNLOCKING
unique_id: unique_id:
description: An ID that uniquely identifies this lock. If two locks have the same unique ID, Home Assistant will raise an exception. description: An ID that uniquely identifies this lock. If two locks have the same unique ID, Home Assistant will raise an exception.
required: false required: false

2
source/_integrations/mqtt.markdown
View File

@ -432,7 +432,9 @@ Configuration variable names in the discovery payload may be abbreviated to cons
'stat_opening': 'state_opening', 'stat_opening': 'state_opening',
'stat_stopped': 'state_stopped', 'stat_stopped': 'state_stopped',
'stat_locked': 'state_locked', 'stat_locked': 'state_locked',
'stat_locking': 'state_locking',
'stat_unlocked': 'state_unlocked', 'stat_unlocked': 'state_unlocked',
'stat_unlocking': 'state_unlocking',
'stat_t': 'state_topic', 'stat_t': 'state_topic',
'stat_tpl': 'state_template', 'stat_tpl': 'state_template',
'stat_val_tpl': 'state_value_template', 'stat_val_tpl': 'state_value_template',