ZHA: User code management on Zigbee door locks

[VladStar (Vladislav Staroselskiy)]

component/zha/lock.py code is missing 3 important services for the user code management on Zigbee locks, similar to implemented in component/zwave/lock.py

SERVICE_SET_USERCODE = "set_usercode"
SERVICE_GET_USERCODE = "get_usercode"
SERVICE_CLEAR_USERCODE = "clear_usercode"

Please, add.

References:

• Zigbee door locks in SmartThings: zigbee-lock.groovy
• ZWave door locks in HA: components/zwave/lock.py

[Maxi1134]

This! And if we could also find a way to receive the code ID fo who unlocked the door, that would be another plus.

[VladStar (Vladislav Staroselskiy)]

@Maxi1134 Well, at least having those functions we can write some wrappers, like described here:

Yale Zwave locks

Here’s another way to show the changes made at the lock and it shows the “true” method used to close or open instead of the previous method which shows “manual” for some that were actually keypad presses. The only potential drawback so far I’ve seen with this is that some of the changes are lengthy, so it will wrap lines in the card. - platform: template sensors: yale_lock_status: entity_id: lock.assa_abloy_unknown_type0004_idaa00_locked value_template: >- …

[cdevl]

This would be very useful. It would also be nice if there was a way to use the same codes on more than one lock automatically after setting it up for one lock.

[inishchith (Nishchith Shetty)]

@VladStar Any new findings thus far?

[cdevl]

I was able to use the zigbee cluster commands to set a code and (sort of) get a pin code:

Schlage Connect Smart Deadbolt (ZigBee): anyone have any luck getting user codes to work?

I am trying to figure out a way to set and get user codes for Schlage locks. I am using the Conbee II in ZHA. From what I can tell, this feature may not be directly available in ZHA, as there is a feature request for user codes: And there appears to be no code in the associated code: I was playing around with “Manage Clusters” in the “Devices” tab for the lock, and I can find Cluster Commands to send and get lock codes in the Cluster DoorLock (Endpoint id: 1, Id: 0x0101, Type: in) F…

not sure if this will help at all though…

[VladStar (Vladislav Staroselskiy)]

@inishchith sorry, it doesn’t depend on me, but rather on HA Developers to pick this feature request up

[flyize]

I don’t understand the lack of love for Zigbee locks.

[stephack]

Same here. Seems like an obvious addition to me. Maybe it’s more complicated than meets the eye. The team has been consistently adding features to the ZHA integration so let’s hope it’s at least on their todo list.

[VladStar (Vladislav Staroselskiy)]

@stephack agree, even Z-wave JS integration has them from the very beginning

[flyize]

My Zigbee lock is essentially the last thing that I have connected to SmartThings so that I can manage it. What I wouldn’t do to learn python well enough to make all this happen.

[vilord (Jesse Campbell)]

Hmmmm… What could this be?

ZHA lock code services and events

[VladStar (Vladislav Staroselskiy)]

@vilord wow, thanks man! looks like we have to prepare some beer for ya

[vilord (Jesse Campbell)]

So, this should now be present in 2021.4.0 I haven’t tried the release build yet (or even the betas), but at least it worked before that!

[cdn4lf]

Confirm. Works like a charm in the release build.

Now we need a ZHA lock manager add-on

[flyize]

This is so exciting. Thank you @vilord!

edit: Where do I find the documentation for how to use this manually, until it gets integrated into Keymaster?

[vilord (Jesse Campbell)]

I added documentation here:

Zigbee Home Automation

[flyize]

Got it. Is there something like a view_lock_codes?

[vilord (Jesse Campbell)]

Services do not support return values, so no there is not.

Support is built in for getting lock codes with a key manager, but I have not yet worked with the KeyManager people to get ZHA added.

[VladStar (Vladislav Staroselskiy)]

Yay! I’ve updated my HA to the version 2021.4 yesterday and tested - indeed works great.
Many thanks to @vilord !