Enhance Keypad unlock operation notification with userCode

[karmingc]

Is your feature request related to a problem? Please describe.

Currently, whenever a lock is unlocked by a usercode, the Keypad unlock operation notification is created with the parameters: userId: {value}. However, we need to look at the users tab to confirm which code it was used. This may work for most case except the master key.

We recently tested with a Yale Assure Touchscreen Deadbolt YRD226 and when the master key was used to unlock it, the userId that was provided was actually in a disabled in the scheduling column in the users tab.

Describe the solution you'd like

1. The Keypad unlock operation enhancing the parameters field with userCode.
2. The Keypad unlock operation would include a parameter to indicate whether the userId/userCode represents the master key.

Describe alternatives you've considered

Open to suggestions!

Additional context

[robertsLando]

I think this should be something for driver? @AlCalzone

[karmingc]

Should I be posting this in a different repository @robertsLando / @AlCalzone ?

[AlCalzone]

Can you share a driver log where you generate these notifications? Please put it on loglevel debug and attach it here as a file (drag & drop into the text field).

I'm not entirely sure I've understood the issue.

[karmingc]

Hi, no worries. I'll try to explain the issue once more:

1st ask - I have a programmed usercode 4545 on userId/slot 7. There's currently a notification that is being emitted whenever the device unlocked with that code. However, it only includes the userId. My request here would be to include the userCode.

2nd ask - I have the master usercode 1111. Whenever the device is unlocked with that code, the unlock event provides a userId that seems to be "empty"/"disabled" on the Users tab. My request + question/bug:

• enhance the unlock event such as it indicates it was the master usercode
• the userId on the users page is empty -- is that slot/userId dedicated to the master code?

usercode	events UI	users UI
programmed usercode
master usercode

logs: zwavejs_2025-01-28.log

[AlCalzone]

Okay, so for normal users, we should be able to add the current user code to the event notification:

2025-01-28T14:40:20.914Z CNTRLR   [Node 043] [Notification]
                                    type:   Access Control
                                    event:  Keypad unlock operation
                                    userId: 7

I would still make it an opt-in option, since the user code should be considered sensitive information.

For the master code it might work if you query the code first. It looks like that hasn't been done, so Z-Wave JS doesn't know the code.
These older locks typically use a user code slot outside of the normal range for the master code, in this case 251.

[karmingc]

Hi @AlCalzone,

The opt-in would be good with our team!

I was able to perform the User Code CC command get on userId 251 and it now shows on the UI.

However, I also tried the command getAdminCode and it returned FailedZWaveCommand: zwave_error: Z-Wave error 302 - Node #43 does not support the command AdminCodeGet! (ZW0302).

With the given information, would there still be a way to deterministically know whether a code was a master code with the current device?

[AlCalzone]

With the given information, would there still be a way to deterministically know whether a code was a master code with the current device?

With this exact device yes, by checking if the user ID is 251. Generically for all User Code CC V1 locks, no.