You can use Dev Tools UI to set/clear/enable/disable the codes:
1 Like
Yep. Thatâs awesome. I was hoping to be able to view them. But for the meantime, I can just keep notes on slots.
Iâve finally been able to unplug my SmartThings hub! Thank you!
Is there any way to create automations yet when certain codes are used?
edit: n/m I was able to figure this out. Great excuse for me to finally try out the native HA automations. 
1 Like
Does lock manager support ZHA yet? Iâve been happy with setting them manually via the developer tools, but it also lacks any feedback or advanced features I like in lock manager
1 Like
Hi, i am new into HA so please bear with me. Does it mean that with this new addition for ZHA, i can just get a zigbee lock and connected to ZHA and i can lock/unlock already?
You can (I think) now do everything with zigbee locks that you can with zwave, its just much more cumbersome.
1 Like
Thanks so much for this - added both my Schlage zigbee locks today and was able to easily set codes via the dev panel.
Can someone give me a pointer on how to detect what code is used to unlock these? @flyize mentioned figuring this out when creating automation, I assume through state changes, care to share?
This isnât pretty, but it works. Basically, youâll have to go into Dev Tools > Events and listen for zha_events. When the door is unlocked, youâll see an event like this (screenshot taken from Automations).
Once you have the device id, under args, youâll see also see a slot parameter. Each unlock code is a slot. Youâll just have to tie together the unlock codes to a slot. Then itâs just a matter of finishing the automation.
Apologies for the screenshots, I should probably learn how to share native HA Automations (I normally just use NR).
1 Like
I donât know whatâs this worth to you guys, but the wife really likes to be able to manage and see the lock codes for the front door and was the last thing i need to migrate from smartthings⊠Im still really new to hass so if there was a better way please let me know!
The lock code table is just markdown, so you will have to add / remove entries there as needed.
here is what i did.
- Grab GitHub - gadgetchnnel/lovelace-text-input-row: A custom Lovelace text input row for use in entities cards and install it
- Enable input_text on your configuration
- Enable scripts on your configuration (if not already)
Create a new dashboard with the following example
Lovelace template
views:
- title: Home
cards:
- type: vertical-stack
cards:
- type: entities
header:
image: >-
https://www.ryadel.com/wp-content/uploads/2017/11/IT-Security.jpg
type: picture
show_header_toggle: false
entities:
- type: custom:text-input-row
entity: input_text.codeslot
- type: custom:text-input-row
entity: input_text.usercode
- entity: script.add_code
icon: mdi:key-plus
- entity: script.clear_code
icon: mdi:key-minus
title: Code Details
- type: markdown
content: >
| ID | User |
Lockcode |
|:-----|:--------------------
|:----------------------------------------- |
|1 | User1 | <details>1111</details> |
|2 | User2 | <details>2222</details> |
|3 | User3 | <details>33333</details> |
title: Lock Codes
Create the add / clear scripts
Scripts
add_code:
alias: Add Lock Code
variables:
codeslot: '{{ states(''input_text.codeslot'') | int }}'
usercode: '{{ states(''input_text.usercode'') | int }}'
lock: YOUR.LOCK_DEVICE
mode: single
sequence:
- service: logbook.log
data:
name: Lock code added
message: 'slot: {{ codeslot }} was updated with a new code: {{ usercode }}'
- service: zha.set_lock_user_code
target:
device_id: YOUR LOCK ID
entity_id: YOUR LOCK ENTITY
data:
code_slot: '{{ codeslot }}'
user_code: '{{ usercode }}'
- service: notify.mobile_app_YOURPHONE
data:
message: USER REMOVE
title: FOOBAR
clear_code:
alias: Clear Lock Code
variables:
codeslot: '{{ states(''input_text.codeslot'') | int }}'
lock: YOUR.LOCK_DEVICE
mode: single
sequence:
- service: logbook.log
data:
name: Lock code added
message: 'slot: {{ codeslot }} was updated with a new code: {{ usercode }}'
- service: zha.clear_lock_user_code
target:
device_id: YOUR LOCK ID
entity_id: YOUR LOCK ENTITY
data:
code_slot: '{{ codeslot }}'
- service: notify.mobile_app_YOURPHONE
data:
message: USER REMOVE
title: FOOBAR
Add the following to your input_text section
input_text:
codeslot:
name: Code Slot
initial: 0
usercode:
name: User Code
initial: 0
Here is what it looks like
5 Likes
No need for the extra steps in your Actions when you can just add code_slot: {code slot} under the operation: Unlock argument.
I just implemented it and it works pretty well.
In my case the next step is to notify my HA app. But you certainly donât have to!
A couple of quick questions on your script.
lock: YOUR.LOCK_DEVICE
Is that an entity or device ID?
And I feel like a total newb for this one, but what the heck is a device_id and where do I find it?
@flyize Configuration â Devices â /choose your lock/, then youâll see itâs ID in the URL
1 Like
@vilord I just found a bug, related to ZHA Yale locks - actual user code slots on the lock are shifted by 1, compared to what is handled by ZHA functions. I.e. if I set up a code for user #1 via yale keypad (master code, 1, 2, 1 /user slot #/, code) - it actually corresponds to slot #2 handled via zha calls (clear, set, enable, disable).
As a side node - I also have one Z-wave Yale lock, where it handles all the slots correctly (i.e. slot #1 on the lock = slot #1 in zwave lock calls).
Hey Vlad, is that bug still a thing?
I just installed my first zigbee lock, a yale assure SL (branded as a lockwood tlock here in australia)
I set up the first few codes via the panel itself and then found this thread. Managed to get @jkuntz805 dashboard working without too much trouble and have configured 2 more codes through home assistant using it.
It seems the codes created from the panel started at 1 for the master code and counted up. on the surface, (to a noob like me) it seems okay. maybe iâm missing something? Just wanted to check I didnât have to watch out for a gotcha.
Master code is NOT the same as User1 code. I have 3 Zigbee + 1 Zwave Yale locks and initially configured all of them via keypad. Master as master, User1 for me, User2 for my wife etc.
When I tried to reset the code for me (User1) via the above dashboard. I was able to get with new code to Zwave lock, but not to any Zigbee. When I reset code for User2, it propagated to User2 on Zwave lock (as expected), but to User1 instead of User2 on all Zigbee locks.
I ended up with the following workaround for Yale Zigbee locks (+1 increment while calling zha functions)
add_code:
alias: Add Lock Code
variables:
codeslot: "{{ states('input_text.codeslot') | int }}"
usercode: "{{ states('input_text.usercode') | int }}"
sequence:
- service: zwave_js.set_lock_usercode
target:
device_id: <yale_zwave_lock_id>
data:
code_slot: '{{ codeslot }}'
usercode: '{{ usercode }}'
- service: zha.set_lock_user_code
data:
code_slot: '{{ codeslot+1 }}'
user_code: '{{ usercode }}'
target:
device_id:
- <yale1_zigbee_lock_id>
- <yale2_zigbee_lock_id>
- <yale3_zigbee_lock_id>
- service: notify.my_mobile
data:
title: 'YALE LOCKS - USER CODE UPDATED'
message: 'Slot #{{ codeslot }} was updated with user code {{ usercode }}'
mode: single
clear_code:
alias: Clear Lock Code
variables:
codeslot: "{{ states('input_text.codeslot') | int }}"
usercode: "{{ states('input_text.usercode') | int }}" # Unused
sequence:
- service: zwave_js.clear_lock_usercode
target:
device_id: <yale_zwave_lock_id>
data:
code_slot: '{{ codeslot }}'
- service: zha.clear_lock_user_code
data:
code_slot: '{{ codeslot+1 }}'
target:
device_id:
- <yale1_zigbee_lock_id>
- <yale2_zigbee_lock_id>
- <yale3_zigbee_lock_id>
- service: notify.my_mobile
data:
title: 'YALE LOCKS - USER CODE DELETED'
message: 'User code was deleted from slot #{{ codeslot }}'
mode: single
Just to contribute with something quite easy, but useful (at least for me).
Itâs a single use code. Meaning it gets cleared after a single use.
Considering you installed the custom Lovelace text input row* mentioned by @jkuntz805:
Create an input text for your single use code
Input Text - Single Use Code
In your configuration.yaml, add this input_text.
input_text:
##Input do cĂłdigo temporĂĄrio da porta
singleusecode:
name: Single Use Code
initial: 0000
Create a script that sets the user code and notifies you
Script - Set new lock code and notify
Important: Iâm using codeslot 100, since I probably wonât create 100 codes in this lifetime. Which also means in this workflow, only 1 single use code is possible. Please check your lock max number of codes to see if 100 is usable.
alias: Add Single Use Code
sequence:
- service: zha.set_lock_user_code
target:
#Easiest way to locate your device ID is through the Call Service on Developer Tools, selecting zha.set_lock_user_code, selecting your device and checking the YAML editor
device_id: yourDeviceID
data:
code_slot: '100'
user_code: '{{ states(''input_text.singleusecode'') | int }}'
- service: notify.your_phone_goes_here
data:
message: Um cĂłdigo de uso Ășnico foi criado.
title: Novo cĂłdigo - Porta da Frente
data:
#This part is only valid for Android devices. For some reason, I need this or the notification won't show unless I unlock my phone. This sets the notification priority as urgent. In case you need it, check documentation for iOS settings on priority.
ttl: 0
priority: high
mode: single
icon: mdi:key-plus
Create a card to input your single use code and run the script
Lovelace Card
You can place this in a lovelace card, editing it in YAML mode.
type: vertical-stack
cards:
- type: entities
header:
image: https://www.ryadel.com/wp-content/uploads/2017/11/IT-Security.jpg
type: picture
show_header_toggle: false
entities:
- type: custom:text-input-row
entity: input_text.singleusecode
- entity: script.add_single_use_code
icon: mdi:key-plus
Create an automation that deletes the code when used and notifies you
Automation to delete used code and send notification
This was created for a Yale YRD256 lock with Zigbee. Itâs probably the same for a few other Yale Locks with Zigbee. For your lock, you might want to check which args you should use to detect Unlocking on the trigger and the code slot args to use on the condition. You can check this by listening to zha_event on Developer Tools and unlocking your door through the keypad to check for the event info.
alias: Fechadura - Deleta Single Use Code
trigger:
- platform: event
event_type: zha_event
event_data:
#You can find the device_ieee on your Zigbee integration.
device_ieee: 00:00:00:00:00:00:00:00
args:
operation: Unlock
condition:
- condition: template
value_template: '{{ trigger.event.data.args.code_slot == 100 }}'
action:
- service: zha.clear_lock_user_code
target:
device_id: yourDeviceID
data:
code_slot: '100'
- service: notify.your_phone_goes_here
data:
title: Porta da Frente
message: CĂłdigo de Uso Ănico foi utilizado e apagado.
data:
ttl: 0
priority: high
mode: single
Thatâs it. I made a few comments along the way to help people that - like me - are noobs.
Hope someone finds it helpful.
** btw if you didnât install the custom elements, easiest way is through HACS. Itâs available there.
2 Likes
Hi all, @VladStar sorry for that bug⊠it seems like kwikset vs yale handles the slot numbers differently, I didnât run into that with my kwikset locks.
@Bruno_Dantas this is great! Glad to see youâre able to leverage all the functions and put them together into this! A perfect use for the integration.
1 Like
Thanks @jkuntz805 ! I was able to implement this card in my dashboard and update the scripts to reflect service calls to Hubitat, so itâs easy-peasy to add new codes and looks pretty too!
Background: I use Hubitat to connect to all my Zigbee and Zwave devices, so the usual OTS integrations like KeyMaster probably wonât work to manage locks without significant effort since I donât have any Zwave services in HA. My Yale Zigbee lock was the last thing still on SmartThings, as the Hubitat UI for lock code management isnât very wife friendly. But now Iâm off ST and wife will be content.
For any other Hubitat users who come through this thread, I am using the Hubitat integration to HA through Maker API. Itâs fairly trivial to add/remove codes for any lock in Hubitat using this card, with only slight modification of the associated scripts (Iâm not a developer).
Feature Request: Ideally, all codes added through these scripts get logged to a file, which is then read by the Lock Codes display section of the card to reflect current users/codes without having to manually update a static list.