Skip to content

Add code support for MQTT lock #25781

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
frenck merged 3 commits into from
Jan 23, 2023
Merged

Add code support for MQTT lock #25781

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
2511878
Add code support for MQTT lock
jbouwh Jan 16, 2023
e3ad64b
correct type
jbouwh Jan 16, 2023
a1dffef
The `code` parameter is always available.
jbouwh Jan 23, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 10 additions & 0 deletions source/_integrations/lock.mqtt.markdown
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -69,6 +69,14 @@ availability_topic:
description: The MQTT topic subscribed to receive availability (online/offline) updates. Must not be used together with `availability`.
required: false
type: string
code_format:
description: A regular expression to validate a supplied code when it is set during the service call to `open`, `lock` or `unlock` the MQTT lock.
required: false
type: string
command_template:
description: Defines a [template](/docs/configuration/templating/#using-templates-with-the-mqtt-integration) 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.
required: false
type: template
command_topic:
description: The MQTT topic to publish commands to change the lock state.
required: true
Expand Down Expand Up @@ -255,7 +263,9 @@ 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"
Expand Down