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-23 17:27:19 +00:00
Code Issues Packages Projects Releases Wiki Activity

Document MQTT lock.open (#20439)

Browse Source 
Co-authored-by: Franck Nijhof <frenck@frenck.nl>
Co-authored-by: Erik Montnemery <erik@montnemery.com>
This commit is contained in:
Hypnos 2021-12-02 10:33:13 +01:00 committed by GitHub
parent 92a4949cd0
commit 2744f0c7ef
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 11 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

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

@ -18,6 +18,8 @@ When a `state_topic` is not available, the lock will work in optimistic mode. In
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.
To enable MQTT locks in your installation, add the following to your `configuration.yaml` file:
```yaml
@ -143,7 +145,7 @@ payload_available:
type: string
default: online
payload_lock:
description: The payload that represents enabled/locked state.
description: The payload sent to the lock to lock it.
required: false
type: string
default: LOCK
@ -153,10 +155,15 @@ payload_not_available:
type: string
default: offline
payload_unlock:
description: The payload that represents disabled/unlocked state.
description: The payload sent to the lock to unlock it.
required: false
type: string
default: UNLOCK
payload_open:
description: The payload sent to the lock to open it.
required: false
type: string
default: OPEN
qos:
description: The maximum QoS level of the state topic.
required: false
@ -168,7 +175,7 @@ retain:
type: boolean
default: false
state_locked:
description: The value that represents the lock to be in locked state
description: The payload sent to by the lock when it's locked.
required: false
type: string
default: LOCKED
@ -177,7 +184,7 @@ state_topic:
required: false
type: string
state_unlocked:
description: The value that represents the lock to be in unlocked state
description: The payload sent to by the lock when it's unlocked.
required: false
type: string
default: UNLOCKED