FutureTense / keymaster

Home Assistant integration for managing Z-Wave enabled locks
MIT License
218 stars 44 forks source link

[Feature Request] Document "boltchecked" lock entity feature #291

Open phrz opened 1 year ago

phrz commented 1 year ago

Is your feature request related to a problem? Please describe. Keymaster adds "boltchecked" versions of each lock, and I cannot find this documented anywhere.

Describe the solution you'd like Please provide documentation for this feature.

Describe alternatives you've considered None.

Additional context n/a

johnboiles commented 1 year ago

This is what I've found: https://community.home-assistant.io/t/keymaster-z-wave-lock-manager-and-scheduler/166419/2238

I too have several dings in my doorframe where the deadbolt locked while I was slamming the door shut. See the Door open check 8 beta release for more info.

But in a nutshell: All integration commands that lock/unlock the device are now being sent to a “shadow lock”. This lock (named boltchecked_LOCKNAME) will first determine the status of the door. When it receives a lock command, if the door sensor is closed, the command is executed. If the door sensor is open, input_boolean.keymaster_LOCKNAME_retry is set to True. When the door sensor reads closed (presumably because the door was closed!) and if input_boolean.keymaster_LOCKNAME_retry is True the lock command will be called again.

In fact, every time the lock command is attempted, if the door is open than the next time time the door is closed it should lock. However any other commands to the lock should override this “lock retry” attempt.

Then from that link:

A “shadow” lock has been created called boltchecked_LOCKNAME, e.g. boltchecked_frontdoor. All code in the automation that sends lock/unlock commands uses this lock entity. When a lock command is executed, the integration determines if the door’s sensor is closed. If so, the door is immediately locked. If the door is open, then a persistent notification is created in the lovelace dashboard. When the door sensor is closed, the lock command is immediately re-attempted.