KeyMaster Z-Wave lock manager and scheduler

lenny1 · July 25, 2025, 11:50pm

Tykeal,
Has anybody written a guide on how to do this?
I keep having problems with getting stuck in “Deleting”.
I have 7 Kwikset locks here, and am afraid to add any more…

lenny1 · July 25, 2025, 11:52pm

Bibbleq:

Ok after some testing I’ve found to enable the slot in my lock I need to do a Z-wave set:

Command class: 99
Property: userIdStatus
Property Key: “Slot number”
Value: 1

So I’ve modified the automation from above into the following generic one (for slots 1-10) which seems to do the trick:

alias: KeyMaster_Fix_Stuck_Codes
description: >
  Generic automation to fix Z-Wave lock codes that get stuck in "Adding" state.
  Monitors multiple lock code slots and automatically resets them if needed.

mode: queued

trigger:
  - platform: state
    entity_id:
      # 🡒 List all your lock code status sensors here
      # Example: sensor.connected_front_door_lock_1
      # Repeat for each slot you want to monitor (1-10 in this example)
      - sensor.connected_front_door_lock_1
      - sensor.connected_front_door_lock_2
      - sensor.connected_front_door_lock_3
      - sensor.connected_front_door_lock_4
      - sensor.connected_front_door_lock_5
      - sensor.connected_front_door_lock_6
      - sensor.connected_front_door_lock_7
      - sensor.connected_front_door_lock_8
      - sensor.connected_front_door_lock_9
      - sensor.connected_front_door_lock_10
    to: "Adding"
    for:
      seconds: 55

action:
  # Extract the lock code slot number from the sensor entity_id
  - variables:
      slot: "{{ trigger.entity_id.split('_')[-1] }}"

  # 🡒 Turn OFF the input_boolean for this slot (adjust your entity naming if needed)
  - service: input_boolean.turn_off
    target:
      entity_id: "input_boolean.enabled_front_door_lock_{{ slot }}"

  - delay:
      seconds: 5

  # 🡒 Turn ON the input_boolean again to trigger your lock manager logic
  - service: input_boolean.turn_on
    target:
      entity_id: "input_boolean.enabled_front_door_lock_{{ slot }}"

  - delay:
      seconds: 3

  # 🡒 Reset the userIdStatus on the lock using Z-Wave JS
  - service: zwave_js.set_value
    data:
      # 🡒 Replace with your actual lock device ID
      device_id: YOUR_LOCK_DEVICE_ID_HERE
      command_class: 99
      property: userIdStatus
      property_key: "{{ slot }}"
      value: 1   # 1 = Enabled

  # 🡒 Send a notification (adjust or remove if you don’t use mobile notifications)
  - service: notify.NOTIFIER_NAME_HERE
    data:
      message: "Code {{ slot }} reset complete"

Does this work for issues with locks stuck in “Deleting” ?

tykeal · July 26, 2025, 1:53pm

@lenny1 ,

No, and it’s not likely that someone would write a detailed guide. The process is similar to a lot of documentation on how to install an integration without using HACS. Up until the most recent major release of HACS it was possible to select alternate branches to install from, but they did away with that as it caused several issues for folks.

I will, for simplicity write a very simple guide. I will not give more information related to this as per the check boxes when you installed HACS you should have an idea of how this works already…

Clone GitHub - FutureTense/keymaster: Home Assistant integration for managing Z-Wave enabled locks
Checkout the beta branch
copy everything from your clone in custom_components/keymaster to your HA system and overwrite everything at /config/custom_components/keymaster
Restart your HA system
Wait until everything is finished starting up, if you see anything weird still, restart again as the beta seems to have an issue with a completely transition on first restart but a second one usually fixes it

lenny1 · August 1, 2025, 3:18pm

Applied beta and copied files, rebooted several times.
Getting this now.
Going to delete everything and rebuild using the beta version.
I am looking at several days of work now…

tykeal · August 1, 2025, 3:31pm

Please note that the beta has a different pre-built dashboard for you to put in place. It does not get generated in /config/packages/keymaster/<door> anymore but under /config/custom_packages/keymaster/??? I can’t remember where since I’m not currently using the beta. But if you’re trying to use the default built dashboard, you’ll need that instead as a lot of the entities get moved around with the beta.

lenny1 · August 1, 2025, 3:35pm

The entity names changed?

lenny1 · August 1, 2025, 3:45pm

Using File Editor, I cannot go below the /root/homeassistant/ directory
to get to /config

tykeal · August 1, 2025, 3:49pm

Sorry, when I say /config I don’t mean at the root level. I should have been more *nix with ~/config if you’re using the file editor then it’s /homeassistant/custom_components/keymaster/... I’m always doing stuff via SSH so I don’t use the file editor (had to install it just to tell you the path!)

DesmoHub · August 17, 2025, 8:10pm

I hope my question is in the correct place, otherwise please advise.
I am running HA OS 15.2, Core 2025.7.4, Z-Wave 3.2.1 and Keymaster v0.0.99 through HACS with Schlage BE469ZP locks. Everything works great, with some issues with notifications, but that’s a minor issue for me.
Has anyone updated to the latest OS 16.1 and Core 2025.8.2 and Keymaster 0.0.99?

Cake1468 · August 18, 2025, 5:47am

KM 0.0.99 doesn’t work with HA 2024.8.x. it doesn’t recognize the zwave network. You can run the pre-release of 0.1.0, however it’s still being dialed in. Personally, I haven’t been able to make it work yet. Others seem to have it working.

tykeal · August 18, 2025, 1:21pm

@Cake1468 is correct on both statements. 0.0.99 does not recognize the Zwave network so it won’t manage the locks. 0.1.0 is up to beta 3 now with a few changes already on branch past the latest beta release. It works, but can have issues with migration, especially locks with a lot of slots being managed, or a lot of locks.

The cleanest way to migrate to the beta is to take note of your entire configuration and tear Keymaster down. Upgrade to 0.1.0, restart HA, and then start rebuilding your lock configuration.

Also note that the lovelace no longer ends up in packages/keymaster/<lock>.yaml it ends up in custom_components/keymaster/lovelace/<lock>.yaml.

New features of the beta are the following:

All Keymaster entities are created and managed by the integration now instead of a combination of the integration and a packages yaml file that has to load to get all the control entities
A fallout of 1. is that many (most) entity IDs have changed
The beta is entirely event driven instead of a combination of event and automation driven
I have yet to encounter an issue with a slot failing to get programmed properly in a few seconds (outside of when the lock stops responding for some reason)
It is possible to turn off the Advanced Date Range and Day of Week options slimming down the generated UI considerably

Known issues:

Child lock functionality is still be validated, especially if advanced options are disabled.
There is a known issue with some locks going through a slot reset to no code followed by what Keymaster has configured. This appears to be related to migrations that did not happen cleanly or a particular cache not getting fully cleared before a restart of the integration or HA.

zhazell · August 18, 2025, 1:49pm

I’m having a hard time getting the beta Lovelace code working and displaying anything. When I copy the code and past it in the dashboard I have for the lock, I just get a blank page. Must be doing something wrong or the formatting is off… anyone else figure it out?

Cake1468 · August 18, 2025, 2:16pm

The generated lovelace dash worked for me. I pasted it as the second line.

tykeal · August 18, 2025, 6:01pm

Open the dashboard that you want to add it to, go into raw edit mode and scroll all the way to the bottom. Paste in the generated code. Save and close out of the editor. It will automatically create a new subview on the dashboard for the lock that you’re adding the the code for.

jschafermo · August 22, 2025, 3:48pm

I upgraded to Keymaster v0.1.0-b4 from v0.0.99. The only issue I’m having is code ‘Limit by number of Uses’. This feature was working with v0.0.99, but I’m unable to get working with the beta versions. For testing, I have entered codes in slot 1 and slot 2 with number of uses set at 2 each. When I use these codes to unlock the lock, the lock will unlock as expected. The problem is the number of uses isn’t updated allowing these codes to be used multiple times. If I manually reduce ‘Uses Remaining’, the code will be deleted as expected when the number reaches 0. I haven’t been able to find the cause of ‘Uses Remaining’ being updated when the code is used to unlock the lock. I have 2 Kwikset locks with the same issue.

Appreciate any help, thanks.

brenthaag · August 24, 2025, 3:02am

I’m needing to update to the 0.1.0 beta…sorry for my ignorance, but what do you mean by “tear Keymaster down”. Do I need to delete any configuration files or do anything to move to 0.1.0? Thanks in adavance!

tykeal · August 24, 2025, 4:36pm

For the cleanest migration, yes I do mean you do the following:

Copy all of your current configuration out to something else, say a screen shot or text file or something
Go to the Keymaster integration and systematically remove all current configurations
Upgrade
Restart HA
Re-add each of your Keymaster configurations
Clean out your old dashboard and add in the new dashboard that is generated

brenthaag · August 24, 2025, 8:20pm

Awesome! Thank you–this worked great. I’m back in business.

Seriously, thank you for your help and work on this.

lordratner · August 28, 2025, 3:26am

What does the door sensor do?

I looked through the code and couldn’t figure it. In my head, the door sensor would be used as the trigger for auto lock, if installed. Instead of locking the door xx minutes after it was unlocked, lock it xx minutes after the door closes, resetting the timer each time the door is opened and closed again.

Anyone know?

tykeal · August 28, 2025, 12:55pm

I don’t use that feature myself but IIRC it’s used during the auto-lock operation to detect if the door is open or not. If it is, then do not lock the door and reset the timer. At least that’s my memory of how it is used from when I did try it.