Schlage Encode

[MrBill]

I found this thread:

And don't see newer information in the forum.

@hart2hart 's quote

Quote

I’ve been in touch with the Schlage group. They indicated there were no immediate plans to open the Encode API for HA use. At this points, it’s all Commerical and/or paid usage. Couldn’t get beyond that point.

Things may have changed.  I was researching this Schlage Encode recently because it's an option that's only a small increase in the options on a custom front entry I was ordering.

It appears Home Assistant has a custom integration installable from HACS, it also appears there is a separate python library available.  Given that a Node Server should be doable now.

those that participated in the original thread are: @RandyT @hart2hart @lilyoyo1

I placed my order with the Encode Wifi lock... I'll update after it's installed.  It's unclear to me if Lock/Unlock is supported, but Status (locked/unlocked/jammed is reported, and last code used to unlock Id# and Name#.

Edit to add:  I just looked at the documentation for the python library, apparently it's reverse engineered but includes all or most abilities, including code changes, lock/unlock... etc

Edited May 23, 2023 by MrBill

[lilyoyo1]

30 minutes ago, MrBill said:

I found this thread:

And don't see newer information in the forum.

@hart2hart 's quote

Things may have changed.  I was researching this Schlage Encode recently because it's an option that's only a small increase in the options on a custom front entry I was ordering.

It appears Home Assistant has a custom integration installable from HACS, it also appears there is a separate python library available.  Given that a Node Server should be doable now.

those that participated in the original thread are: @RandyT @hart2hart @lilyoyo1

I placed my order with the Encode Wifi lock... I'll update after it's installed.  It's unclear to me if Lock/Unlock is supported, but Status (locked/unlocked/jammed is reported, and last code used to unlock Id# and Name#.

Edit to add:  I just looked at the documentation for the python library, apparently it's reverse engineered but includes all or most abilities, including code changes, lock/unlock... etc

Its a nice lock. I installed one for a friend of mine. Works with their app without issues. 

[hart2hart]

I installed an encode plus yesterday! Hope the same api will work! I’m in for a node server.

[Goose66]

I installed a Schlage Encode Wi-Fi lock some months back and played with the API a little in preparation for developing a node server, but it just fell of the to-do list. Hopefully can circle back to it in a couple of weeks.

[hart2hart]

I installed a Schlage Encode Wi-Fi lock some months back and played with the API a little in preparation for developing a node server, but it just fell of the to-do list. Hopefully can circle back to it in a couple of weeks.

Fantastic! From what you saw, would this apply to the Encode Plus?

[MrBill]

35 minutes ago, hart2hart said:

Fantastic! From what you saw, would this apply to the Encode Plus?

I believe encode plus is the HomeKit version.

[Goose66]

From what I can tell, the API that the node server would us should work for any of these Schlage locks that use the mobile app and connect over Wi-Fi.

[hart2hart]

From what I can tell, the API that the node server would us should work for any of these Schlage locks that use the mobile app and connect over Wi-Fi.

I’d really like to have Encode Plus integrated via a node server. I bought the Plus because it had Home Kit thinking either that fact or that it appears to have Matter would eventually afford me avenue for support.

I would prefer a node server. Do you feel you’ll be building it?

[Goose66]

I have looked at the API available for Schlage Encode lock and feel like it will be possible to build a node server for it. I started it about 3 months ago but, as I said, it fell off the radar. What I can't tell you is 1) will it definitely support Encode Plus (e.g., since it's homekit compatible may it be purposefully limited in what other APIs it supports) or 2) how long will it last (e.g., they could change or withdraw the API).

Overall, many of my home automation projects have been pushed to the back burner since I moved last August and have since been waiting to see how Matter shakes out before diving in at my new townhome. I've also been working remotely at my vacation home a lot. I return from an extended absence in the second week of June and will try and look at it then.

[hart2hart]

I have looked at the API available for Schlage Encode lock and feel like it will be possible to build a node server for it. I started it about 3 months ago but, as I said, it fell off the radar. What I can't tell you is 1) will it definitely support Encode Plus (e.g., since it's homekit compatible may it be purposefully limited in what other APIs it supports) or 2) how long will it last (e.g., they could change or withdraw the API).
Overall, many of my home automation projects have been pushed to the back burner since I moved last August and have since been waiting to see how Matter shakes out before diving in at my new townhome. I've also been working remotely at my vacation home a lot. I return from an extended absence in the second week of June and will try and look at it then.

Understand and respect your schedule. Thanks for everything you do.

Let me know if I can test etc when it starts.

[MrBill]

5 hours ago, Goose66 said:

1) will it definitely support Encode Plus (e.g., since it's homekit compatible may it be purposefully limited in what other APIs it supports) or 2) how long will it last (e.g., they could change or withdraw the API).

I've been deep into the differences and the Schlage documentation today and ended up swapping up from Encode to Encode Plus.   I feel that the API will work the same with both models. and two, I doubt Schlage will change too much of the API because they have shared it with Amazon and Google.

[MrBill]

The Schlage Encode Plus (BE499) has now been installed. 

To answer the specific question "can Homekit/Home app and Schlage Home app co-exist?"  the answer is Yes.  However there are some serious shortcomings, that frankly I blame more on Apple than I do Schlage. 

Basically, Users can be created either in (Apple) Home or Schlage Home. Users must be managed from whichever app created them, not interchangeable.  Once the User/home key/guest code is created in (Apple) Home the lock can be unlocked very quickly and awesomely in using an iPhone or Apple Watch.   The home app can be configured to send notifications that will show locked/unlocked status, and if by another user the notification will include that users name.  Other than the notification, there appears to be no other way in (Apple) Home to see the history of the lock.  (specifically for example: there is no way to see who unlocked the door or when UNLESS the push notification from the Home app is still around in iOS Notifications.)  A lot of the (Apple) Home app notifications are pretty generic too, for example "Front Door was locked" "Front Door was unlocked" with no information about the source (By Contrast, the Schlage Home app notifications include words like "Locked by Thumbturn" vs "Locked by 1-touch Locking" which tells you if the person locking was inside (staying) or outside (leaving) when they locked the door.

In the Schlage Home App Users can be created with code only access (no HomeKey). The Schlage users can be scheduled (Apple users and guests can not be scheduled), and there is a slide switch to turn notifications for these users on/off by user.

Viewing History in the Schlage Home app shows every lock and unlock, but if an Apple device was used it simply shows "Unlocked by Apple Home Key" but not whose home key.  I take this to mean that Apple won't let that detailed information be known. 

I've experimented with one of the Home Assistant integrations installed via HACS, the information supplied is basic, locked/unlocked state (with user name if it's a code Created via Schlage Home) and Battery state.   Haven't had time to look at a few others i find at github, I'll report back if any of them turn out to be better.  I had more expectation based on what's been built into the pyschlage library linked at the top of the thread.

@Goose66 @hart2hart @lilyoyo1

 

[hart2hart]

The Schlage Encode Plus (BE499) has now been installed. 
To answer the specific question "can Homekit/Home app and Schlage Home app co-exist?"  the answer is Yes.  However there are some serious shortcomings, that frankly I blame more on Apple than I do Schlage. 
Basically, Users can be created either in (Apple) Home or Schlage Home. Users must be managed from whichever app created them, not interchangeable.  Once the User/home key/guest code is created in (Apple) Home the lock can be unlocked very quickly and awesomely in using an iPhone or Apple Watch.   The home app can be configured to send notifications that will show locked/unlocked status, and if by another user the notification will include that users name.  Other than the notification, there appears to be no other way in (Apple) Home to see the history of the lock.  (specifically for example: there is no way to see who unlocked the door or when UNLESS the push notification from the Home app is still around in iOS Notifications.)  A lot of the (Apple) Home app notifications are pretty generic too, for example "Front Door was locked" "Front Door was unlocked" with no information about the source (By Contrast, the Schlage Home app notifications include words like "Locked by Thumbturn" vs "Locked by 1-touch Locking" which tells you if the person locking was inside (staying) or outside (leaving) when they locked the door.
In the Schlage Home App Users can be created with code only access (no HomeKey). The Schlage users can be scheduled (Apple users and guests can not be scheduled), and there is a slide switch to turn notifications for these users on/off by user.
Viewing History in the Schlage Home app shows every lock and unlock, but if an Apple device was used it simply shows "Unlocked by Apple Home Key" but not whose home key.  I take this to mean that Apple won't let that detailed information be known. 
I've experimented with one of the Home Assistant integrations installed via HACS, the information supplied is basic, locked/unlocked state (with user name if it's a code Created via Schlage Home) and Battery state.   Haven't had time to look at a few others i find at github, I'll report back if any of them turn out to be better.  I had more expectation based on what's been built into the pyschlage library linked at the top of the thread.
@Goose66 @hart2hart @lilyoyo1
 

Thanks for the deep dive. I’ve been loving the locks and wife appreciates the smaller inside footprint.

I’d likely be happy using either method if the api goose 66 located will work for more integration.

I actually added my two 300 series Schlage be469 locks back into service by putting them an inch from the zmatter zwave antenna and then once interviewed by iox moving them to basement and garage. Hi

[Goose66]

The API options I have looked at are Yonomi and Seam. Both of these companies are IoT platform companies offering a single (web-based, unfortunately) API across a variety of devices. Yonomi is owned by Schlage or the same company as Schlage, and as an IoT platform supports Schlage, Honeywell, Ecobee, Philips Hue, Resideo, Kasa, Sonos, and more. Seam has an even longer list of supported devices and manufacturers. Both of these companies also offer "developer" accounts that allow limited access and/or limited device counts. I guess it would be possible to develop a node server that integrated with a developer account, and then require each person to establish a developer account at the company in order to utilize the node server. I believe that is how the Honeywell Thermostat node server works today. But I have to admit that being web-based and all the rigamarole is a bit de-incentivizing to making a good node server.

The other possibility would be to try and establish a paid account with one of these platforms (they both allow multiple user accounts to segment devices), but I doubt the node server sales income would cover the costs.

I'll keep looking and let you know what more I find out. BTW, this is exactly the sort of BS I am hoping Matter eliminates.

[MrBill]

@Goose66 is the 3rd party Python library on github that's documented here not usable?

Granted its not a local API, but sadly many are not.

[Goose66]

@MrBill sorry I misread your posts above regarding the capabilities (or lack thereof) of this API. Let me look into the code and license model.

[hart2hart]

Thanks @Goose66 for looking further. It appears we could meet a lot of needs with this api.

I see lock, unlock, manage access codes, and event notification like when it’s unlocked and by whom.

[MrBill]

18 hours ago, Goose66 said:

@MrBill sorry I misread your posts above regarding the capabilities (or lack thereof) of this API. Let me look into the code and license model.

The Home Assistant integration leaves a lot to be desired.  (A Home Assistant "integration" is essentially like a node server but all the terminology is different.)  That library seems to have a lot more functionally than the Home Assistant integration is making use of.    The same guy developed both the library and the HA integration that I'm using, I'm surprised there is not more functionality in the integration.   Hope it works out!

[Goose66]

I usually code node servers for retrieving and updating state, and leave configuration (properties) changes to the native app. What's a use case for managing access codes (specifically if it turns out that you can just see them in a list and delete them) from the ISY vs. just using the Schlage app?

[hart2hart]

I usually code node servers for retrieving and updating state, and leave configuration (properties) changes to the native app. What's a use case for managing access codes (specifically if it turns out that you can just see them in a list and delete them) from the ISY vs. just using the Schlage app?

I’m with you. Maintaining codes from native app is fine and I’d likely never do it from eISY.

[Goose66]

I have released an initial version of the Schlage node server. See here: 

Right now just locks with lock and unlock. The one thing I can see adding in the next version is last action from the log (time, action, and MAYBE user number or name).

[MrBill]

20 minutes ago, Goose66 said:

Right now just locks with lock and unlock. The one thing I can see adding in the next version is last action from the log (time, action, and MAYBE user number or name).

Thanks, I'll check it out.  After your question in a post above, I meant to read through the possibilities in the library's documentation and see if I had suggestions.   Defiantly who Unlocked is of interest to me tho for automation purposes.  I'll attempt to check out the node server later.

[hart2hart]

Thanks, I'll check it out.  After your question in a post above, I meant to read through the possibilities in the library's documentation and see if I had suggestions.   Defiantly who Unlocked is of interest to me tho for automation purposes.  I'll attempt to check out the node server later.

I’ll be checking it out soon too! Very interested to know if the library supports the Encode Plus.

[MrBill]

9 minutes ago, hart2hart said:

I’ll be checking it out soon too! Very interested to know if the library supports the Encode Plus.

@Goose66 I'm not seeing it in the store...

Sorted by author:

 

[Goose66]

1 hour ago, MrBill said:

@Goose66 I'm not seeing it in the store...

Sorted by author:

 

Try refreshing your store. I just checked again after being away for a couple of hours and I still see it in the store.