Home Assistant lock control. Use Keymaster integration to automate your locks.
Vložit
- čas přidán 27. 06. 2024
- In this video, I install and demo the keymaster Home Assistant Integration by FutureTense. This integration allows you to control one or more z-wave enabled locks. You can set lock codes and when those lock codes are active in the lock. You can create multiple slots with each one having its own code. This is a very flexible add-on that gives you the ability to automate and receive notifications based on lock activity.
FutureTense Keymaster: github.com/FutureTense/keymas...
Videos:
Z-Wave playlist: • Z-Wave
HACS Install: • Home Assistant Basics ...
Discord: / discord
If you would like to support me:
Buy me a beverage: ko-fi.com/mostlychris
Become a patron: / mostlychris
Products I reference in my videos (Contains affiliate links)
www.mostlychris.com/my-smart-...
www.xsplit.com?ref=chriswest&discount=mostlychri&pp=stripe_affiliate
DISCLAIMER: Some of the links above take you to affiliate sites that may or may not pay a small commission to me. It doesn't increase the cost to you, but it does help support me in making these videos.
00:00 Intro and considerations
01:54 Pre-Installation
02:50 Install Keymaster via HACS
03:55 Install UI components via HACS
06:07 Restart Home Assistant
06:43 Add Integration in HA
07:48 Configure Integration
11:05 Build the UI
13:48 UI Walkthrough and Demo
20:04 Notifications
22:17 Wrap Up - Final Thoughts
Want to send me something? Send it here!
Mostlychris
24165 IH-10 West
STE 217 #164
San Antonio, TX 78257 - Jak na to + styl
Let me know in the comments if you got this working and what lock(s) you are using it with.
Thanks for the video Chris, this helped me setup my lock with Keymaster. Did you ever make the follow up video on automations? Did a search for keymaster and couldn't find the video. Thanks.
@@teek541 I'm looking to make an automation that disarms alarmo when a certain user slot is used
@@kevinhenes4920 That's 100% doable.
This is much-needed tutorial and definitely the 1st on CZcams explaining keymaster
Really first. I didn't know that. Excellent!
@@mostlychris It worked perfectly. Thank you!
@@waelzayed You're welcome!
This is FutureTense. My dev partners pointed me here. We’re flattered for the coverage. You nailed it with this video. The best way to explain KeyMaster is to point out it is basically a database of PIN codes, where each PIN has a set of rules to determine if it is active. The Advanced section has a whole slew of options, but that’s mostly because there is an option for every day of the week. Most people will never build a complicated set of rules, but it’s nice to know you can if you want to. Every option you see in the PIN GUI’s slot is “added” together using simple binary logic. If every rule passes (1) then 1*1*1…*1 =1. But if even one rule fails(0) then the result will be zero.
Hey FutureTense! I love keymaster. It works well for automating my locks and setting those pins as I want. Great work on this!
Got it working with the Schlage Connect Z Wave Plus thanks to your video!!!
I have the same lock. In the GUI everything just says entity not available? Any insight on what you did?
Thanks Chris for yet another great tutorial.
Your video on changing to Z-wave JS actually made me do the "upgrade" from OpenZ-wave - THANKS
Have a DanaLock, but not tried the Keymaster yet..
You're welcome and thanks for the compliments. Congrats on the switch to the new zwave! Good luck with the lock. I haven't heard of that brand but not surprised. There are a lot of brands out there.
Thanks a lot for this awesome video! This really saved me. I recently bought bought a Kwikset lock and was surprised for the poor integration out of the box just by adding it to the ZwaveJS integration. The walk-though to adding Keymaster was exaxctly what I needed. Much appreciated.
Glad you found it useful. Thanks for watching!
Thank you! I spent hours trying to make my Kwikset locks work in HA until I finally stumbled on to your excellent tutorial.
The only issue that I had was HA seemed stuck on Adding PIN codes (which means they were not added yet).
Someone on the HA forum helped me with a cryptic message: "Try pressing the “Run Actions” on the syncronize_slot_1 and slot_2 scripts."
That worked. It took me a moment to find what he was talking about in Configuration>Entities>Test Lock [the name of my lock]> “Part of the Following Automations.” Not the most intuitive setting, but that's the painful reality of Home Assistant.
Thank you, Chris!
Glad you were able to get it going. Thanks for the tip on "forcing" the lock to add the PIN codes. I've run into this issue but iirc I just deleted the slot and re-added it.
I have the same issue. Every time I want to change a code I have to click the enable/disable and do the "Run Actions" on the keymaster_synchronize_codeslot_[YOUR LOCK] _[CODE #] entities.
Looks like an awesome integration, now I need to get some Z-Wave devices.
Yesss
Amazing video.. i missed the include packages part and had missing entities but everything is working perfectly now
Excellent!
Hi Chris your tutorial was super helpful, Thanks! Is there a way to create a log of door access activity viewable in a lovelace card?
Great thanks! I will use that with my kwickset.
Let me know how it goes.
It went really well with my kwickset 914. Thanks a lot for the video Chris!
@@Fox350Karting Thanks for the update and I'm glad it's working now for you.
the best tutorial!! thanks Chris!! .. a little question.. there is a way to add a "child" lock? take care!
Thanks for the video. I was avoiding this setup because a few things I read made it so daunting. There were a couple of bumps, but I've now got it up and running with a Kwikset 914. After adding the Lovelace integration I was missing the PIN status and Desired PIN state and the PINS didn't sync up with the lock. I could still go into the entity and lock it, so the lock was connected to Z-Wave, it was just the codes that didn't seem to sync.. After a server restart, those options showed up and I had to go to advanced options, reset the code slot, re-enter the name, code, etc. and all worked.
Ultimately I'd like to figure out a way to use this with dynamic codes for some vacation rentals I own, using a calendar to set the codes based on a reservation's date range.
Glad you got it working. Need me to head to those vacation rentals and get it set up for you? 😉😜
@@mostlychris That's not an offer that's out of the question! Even with the repetition it tends to take longer than you'd think. 🤣
This really helped me. Was ready to throw in the towel
Hey Chris, I am planning on migrating my Schlage lock from Smartthings to HA. Your video as always seems very straight forward, my only question is in regards to the Number of Codes to use. I fully get that all those entities need to load up in the UI and that can be slow. My questions are: 1. Can you add additional codes after the fact, or is this only available at time of setup? 2. Other lock functions that might be available on the Schlage unit, are they accessible through jwave-js or keymaster such as the built-in autolock feature or the alarm setting?
You can change the number of code slots in the integration's configuration page in HA. I use zwavejs2mqtt so I can see all the options available to the lock.
Hi Chris, Great Video and amazing instructions. Thanks for sharing. Quick Question: How did you get to the control panel for Zwave JS i tried following but couldn't find the way to get it. I went to Zwave JS add-on but didn't get to see a similar screen. Any help
If you go to the add-on, there is an "Open Web UI" link. This is for the zwavejs2mqtt add-on. It is the one that has the control panel.
Great Video as always! I did notice that you configured the lock brand/model how does it know how to program the codes if it is not code specific. I have a yale lock with zigbee I am not sure if it works, I can get the zwave dongle for the same lock if not.
Hey Jawad. The locks were part of my z-wave network and showed up as such when configuring keymaster. What does "not code specific" mean? Do you mean slot specific?
Appreciate the video! Very helpful. Any ideas on how to configure a way that would allow you to set one card/pin code for multiple locks? i.e., I have 3 Z-wave locks and I’d like to set one code for slot 1 and one code for slot 2 and have those code propagate to all 3 of my Z-Wave locks
There is a concept called child locks which I *think* can do this. Not sure though. Take a look at the child lock settings in Keymaster and see if that is what you need.
1. Parent lock
Use this to make this lock a child of the specified parent lock. This will copy all of the names/PIN/settings from the parent to this lock. Any changes made to the parent lock will happen on this lock allowing you to manage multiple locks from one location.
Tutorial idea: Near the end of your video (22:15), you mentioned that you can run automations based on the user codes. I'd like to know how to run automations based on the user codes as a trigger. Thanks.
Thanks for the great video. Moving from my locks from Vera to HA so thought I would try KeyMaster. Works OK, but really makes a cluttered mess of my automations page. Was thinking I could install a second instance of HA and HACS in a container along with ZwaveJS just for my locks to keep my production HASS uncluttered. Do you know if that would work?
I feel ya on the cluttered automations. Not sure how it would work to run another instance. If you can get your zwave via MQTT then it might work. I'd have to dig in and see if the locks are exposed in my zwavejs2mqtt.
@@mostlychris
I set up HA on a Docker instance, installed zwavejs2mqtt and it could see my locks. Installed Keymaster and got an error that it could not load entity cards.. Figured I could kill the container and recreate it and start fresh, but all the settings came back so it must me storing something in the OS file system. Deleted every folder remotely related but couldn't solve the persistence of the config information and gave up. I think it would work if I could figure out the error. BUt I really don't need all the features of KeyMaster. One thing Vera got right. Much better lock management for sure. I am using Yale locks with z-wave modules btw. Biggest obstacle to resolving this is the persistence of config data after the container is deleted. Thanks for responding. Also, I keep thinking Keymaster could really benefit from choose.
Chris, Do I need a Aeotec by Aeon Labs ZW090 Z Stick or similar one for keymaster to identify the lock ?
Shouldn't. As long as the zwave hub can reach the lock any hub should work.
@@mostlychris I am new to HA and z wave.Do you have any recommendation on z wave hub ? what hub you are using ?
Maybe I missed it Chris, but will these cards be available for each seperate door lock or will we need to create seperate cards for each unique door lock i.e. front door, back door, side door etc...
Figured it out..This is where the parent/child locks come into play.... Great content!
Yes. Child locks are nice for this type of setup. Thanks for the compliment!
I am attempting with Kwikset 910 and everything worked well except it’s throwing an error and when adding the Loveless YAML to the dashboard. Any thoughts?
What is the error?
Thank you for a great video. I've added the lock can lock/unlock it using HA but can't find where to set a pin code at all... also can't add those card to lovelace... Is anyone willing to help? :) Thanks
Chris, thanks for the detailed video. I followed the video but i'm getting errors on lovelace for Entity not available: Sensor connected and Binary sensor active and bunch fold entity row. I even tried it on a fresh home assistant install and still the same issue and I did include the packages txt in the configration.yaml and can't figure out what the issue is. I'm using Zwave Js to MQTT with Kiwkset 910.
So I was able to fix all the issues with some research and experimentation. What I did was add the lock name at the end to all entities associated with the lock and added two more spaces to the configuration yaml entry. So just copying and pasting the txt from the wiki instructions didn’t work and I had to add more spaces to the packages entry I’m yaml.
Replying to the original comment so YT doesn't tell me I didn't respond...anyway, glad you got it figured out. This will likely help others who run into the same issue. Thanks!
@@Pochacco_block I am having the same issue that you referenced above, but I don't really understand the solution you found. For example here is one of my entities: "input_text.sunroom_name_1" And the name of the entity is Sunroom Lock. Are you saying to make this change "input_text.sunroom_name_1_sunrooom_lock"?
Also with regards to the configuration yaml entry...where exactly did you add the two more spaces?
"Mostlychris" is a very apropos name for you. You'll show us how to mostly do it*. *some steps not included. :D lmao Take care, Chris.
Oh yeah? What did I forget?
How do you add multiple locks all with the same codes?
Hi Chris, I used your video to get Keymaster working with my back door Yale Assure Lever lock (YRL256-ZW2-0BP), and I stumbled my way through automating it to relock after 5 minutes if the sun is below the horizon. However, I just purchased a Yale Assure Deadbolt (YRD256-ZW2-0BP) to install on my front door, but I'm having trouble getting the codes I set in Kaymaster to synchronize between the two. Could you possibly explain the "Path to child locks" part of the configuration that you skipped over in this video? Many thanks in advance!
You should have some child lock configuration files that you'll need to specify in the main configuration as noted here: github.com/FutureTense/keymaster/wiki/Install-the-integration#9-path-to-child-locks-file. You would specify the child locks in that file.
@@mostlychris I finally found that page right after I wrote that comment, but it doesn't seem to be working? I finally got it formatted correctly so the integration configuration didn't throw any errors, but the path to the child locks YAML file disappears when I reopen the keymaster configuration. Have you been able to synchronize codes between multiple locks?
@@smizles I have not, only because I haven't tried. I have two locks and I use them with different codesso I haven't had the opportunity to try that out.
@@mostlychris do you do any polls for what to cover in future videos? I'd love to see you do an update/expansion video on the Keymaster integration if you're able to figure out how to synchronize codes across multiple locks!
@@smizles I have asked in the past and get a couple of responses. I do keep a list, so I'll add this to it. Thanks for the suggestion!
I notice that when you are showing the zwavejs2mqtt control panel user code values, they are showing in clear text. On my system, they are showing obfuscated with asterisks (******* rather than 1234). Any clue how I can get my user codes to show in clear text in the zwavejs2mqtt control panel?
Excellent video by the way. Would have taken me many more hours to figure out some of the stuff.
Thanks for the compliment. I just looked again at my js2mqtt screen and they are indeed in clear text. I have no idea why. Is this a browser thing maybe..or a lock type? What lock brand/model are you using and what browser are you looking at it in?
@@mostlychris thanks for the reply. I have an older Schlage lock. It worked well in smartthings and, in the old smartthings app, I could see the code for each slot. When they updated that app, they removed the ability to see the codes for each slot. When I moved over to home assistant, I just manually programmed the slots on the lock. When I saw your video, I decided to make the jump to zwave js because I thought I could see the codes for the slots and I needed to move anyway. I was surprised when the codes are obfuscated in zwavejs2mqtt.
I don't think the issue is the browser. I've tried it in safari, Chrome, and the HA app. Also, if I use the download values feature, the code values are all asterisks in the downloaded file and I would not think that would have anything to do with the browser.
This is not that big a deal. I was just curious. I installed key master and reprogrammed the slots and I'm good to go.
@@rickisajedi That's very interesting. I wonder if that is a lock specific function. Glad you at least have it working.
@mostlychris, did you ever get a video made about doing automations with this? I can't find it.
I have not. However, keymaster has settings to allow you to set things on a schedule. What type of automation are you needing? (I'm sure you probably told me already but I've slept a few times since then).
@@mostlychris I just like ideas about what can be done. I see in the Wiki how to extract the name associated with the slot so I'll play with it a bit.
I really appreciate all of the videos that you have released. For me you're becoming the go-to guy for Home Assistant information. I have also been sharing links to some of your videos to others on other sites.
@@rseckton Thanks for the kind words and for sharing! Makes the effort worthwhile!
would you be interested in making a revised video of keymaster? the UI is different from your video now.
Uh oh. Probably need to do that. Let me put that on the list. Technology moves so fast!
I pasted the lovelace code in raw editor and then it says "Unable to parse YAML..." due to the first line of new code. Is it not indented enough? I have my cursor right at left beginning of line.
YAML is a formatted language which means spacing and indentations are exact. I would have to see your code as it appears in order to tell what the issue is. CZcams comments don't allow for good code block formatting so the best bet is to put the code block in my Discord so I can see it. Use three backticks to start and end a code block in Discord.
hello! got everything working except the lovelace card - copied and pasted the markup into the raw config editor, but nothing. even re-opened it, code is in there with no errors (I linted it) but my dashboard doesn't seem to like it. any hints?
The dashboard is completely blank?
It creates a new tab with the dashboard generated.
@@mostlychris hey sorry for the late reply, no when I paste everything nothing happens I refresh and save and everything and all the cards remain the same
Does this work with all ZWave door locks, or just one brand?
Probably most. I don't have definitive proof on that since I only have the one brand but I believe it should work for most.
I have the Kwikset early generation locks. Schlage locks are what the wiki is built on so those work as well.
@@mostlychris awesome! I have Kwikset as well, so that's good news.
Let me know how it goes.
@@mostlychris I haven't tried the advanced features yet, but I was able to remotely set new codes for my Kwikset 99140-024 front door! Very excited to be able to do this -- thanks for the tutorial!
what about RFID cards can it manage these
I go through the steps, but then everything says entity not available. I dont see any more current videos on this.
I saloved some staff with adding into yaml config homeassistant:
packages: !include_dir_named packages. But then i had bunch off troubles but then i saw Landi J post put one more space between packages: and !include and it worked. But now my home overview is full of input daytime,input number, input boolean, input text, scrip and sensors toggles switches litterly like 50 at least! does anyone know how to get rid off them?
Thank you
Keymaster generates a ton of entities that are used to control various aspects of your lock(s). I don't use default dashboards with all the extra entities on them so I don't see those. Have you considered building a dashboard (starting with a blank one) so you don't see all of that? Oh, and I have my keymaster stuff on a separate "view" under my main dashboard so it only shows up when I look at that view and only when I need to configure or change something in the locks.
If you have a wifi lock can you use this same process?
Reading the code--no. This looks to spend its time working with the zwave network(s) for gathering and setting lock information
This guide was pretty great! I used it to connect my Schlage Connect lock and I got almost all of it working. The issue I have is i think it's not pulling the Serial number from the device and as a result it is not able to get the PIN status of the lock. This prevents me from sending any code updates from the Code cards on the dashboard. I am able to control the lock and access its firmware information, so I feel like the accessibility to the lock is there, but this last feature of the KeyMaster Code page isn't working. Anyone have this issue or know how I can update this to pull the S/N from the lock and allow me to send/receive information regarding the PIN Status of my lock? I've been trying to figure this out for a while with no success. Thanks for any help! related to this step in the guide: 13:49
Hi! Talking to you in Discord this all got resolved by not use S2. Good job figuring all that out!
@@mostlychris I have the same lock and am experiencing issues. Can you explain?
still trying to figure this out
Has anyone run into the issue where all the PIN status show disconnecting? Installed, removed and reinstalled with multiple reboots but every slot just shows disconnecting and nothing is ever set. I am using it with a Schlage Connect.
The only time I have seen something similar is when there was a communication issue with the lock and it defaulted to disconnecting.
@@mostlychris I will admit there is a communications issue with the lock. The odd thing is multiple times I get the log to work in HA, but as soon as I add keymaster it breaks everything and the lock does not respond via z-wave and it shows the node as dead.
That's strange. I don't know why it would do that unless it is "spamming it" and that somehow causes it to disappear or go dead. Are you only using a couple of code slots to start? Having too many could cause issues, mainly with the UI responsiveness.
I’m at 13:30. After adding the code to the configuration.yaml file the dashboard displays tables of errors, with the following highlighted in red: “Custom element doesn’t exist: fold-entity-row.” Any clue where I might’ve went wrong. Thought I followed this video to the T.
You need to make sure you have the custom cards installed. Sounds like you are missing a card. This is stuff that is installed via HACS.
@@mostlychris i go into frontend and it shows all 4 cards installed.
@@mostlychris I’ve reinstalled all four cards and the red error is gone. Now I see numerous yellow errors claiming numerous entities are not available. For example: “entity not available: input_text.kitchen_door_name_1”
Progress made. This step was missing: github.com/FutureTense/lock-manager/wiki/Pre-Installation-Steps-(IMPORTANT)
@@mostlychris so I misunderstood the preinstallation instructions. Because I saw the big letters saying that those steps weren’t necessary for anything pre-0.22 I took it as NONE of the steps on that page are required. Adding the packages entry to configuration.yaml is necessary regardless of version.
No luck for me with my schlage locks. I get 'Entity not available' for everything in lovelace.
Are you able to select them from the list in the integration?
It works with Schlage locks. I did notice that slot 1 is not configurable though. Guess it's reserved?
@@jeffwelvaert1494 Is slot one not showing up or grayed out? I had to use the reset slot function in the integration to reset my slot one before it would take the changes. I don't know if that was a fluke or because I entered that code using a different method originally.
@@mostlychris The slot is there and not grayed out. It says its connected and synchronized even though the name and code fields are (empty value). When you put a name and code in it just says connecting but never connects.
@@jeffwelvaert1494 I had to reset that slot a couple of times. Put the current code in that slot and then under advanced, reset it. I had some weirdness when I first installed it with the existing slot in use but it is now working after a couple of those resets.
When im adding keymaster in integration it cannot see my lock? Any idea?
Need more details about the lock.
@@mostlychris it's 910
by Kwikset
Firmware: 2.6, S0_Legacy. I can lock and unlock frpm HA but under overview in lock tab i have all !triangles. Like entity not available input_text.front_door_name_1.
next !triangle is input_tect.front_door_pin_1 basically all entities are not available in code 1 tab through code 5? i can’t seem to figure it out. thank you
There were a couple of people that had issues. I'm not sure if is exactly your problem but this is what one person said:
"What I did was add the lock name at the end to all entities associated with the lock and added two more spaces to the configuration yaml entry" -- thanks Landi J!
Probaly still the best video on keymaster out there. But, I was unable to get the notification to work. I used - service: notify.mobile_app_sm_xxxx to try and send it to my phone (which is a HA device running HA andriod)since I did not use your notification system. My 1st thought is the name in the script section. How does the system know which script section to use if that name is not relevant?? You seem to have changed to something random. Does it matter??
How do you add multiple locks with the same code?