Clear Lock Jammed Status?

mboarman · December 27, 2021, 12:42am

I added several Yale YRD 256 locks to my Zwave HASSIO setup this week. Not all of them were seemless installs and I ended up having to tweak the door jams to get the bolt to slide in and out without getting hung up. Nevertheless, my question is there a way to clear the lock jammed entity after it gets flagged? I’d like to build a notification to alert me when the lock doesn’t seat correctly (ie “jammed”)…but I can’t seem to figure out how to tell the entity that the lock is no longer jammed?!

Bartem · December 27, 2021, 3:50am

I don’t know about Yale but on my
Schlages a manual thumb turn back and forth would clear the status

mboarman · December 27, 2021, 12:18pm

Took a little digging, but I found I can change the jammed entity state in the developers tools tab. I made a script to notify me and reset them if they get tripped. Thanks all!

cntx · January 8, 2022, 4:29pm

@mboarman

May I ask you to please share the details on which options were used in the Developer Tools to clear the ‘lock jammed’ state for the BE469?

After many attempts, I was unable to find a solution on my own.

I am hopeful a similar approach can be used to reset the ‘tamper alarm’, too.

Thanks for your assistance!

mboarman · January 9, 2022, 1:52pm

Sure…I built a simple script to clear it out, see below:

clear_lock_jam_status:
  sequence:
  - service: python_script.set_state
    data_template:
      entity_id: binary_sensor.lock_back_door_access_control_lock_jammed
      state: 'off'
  mode: single
  alias: Clear Lock Jam Status

You’ll just need to replace the entity name with your lock’s jammed entity. Hopefully that makes sense?

cntx · January 10, 2022, 3:01pm

@mboarman

Thank you for your quick response and details!

Is the ‘set_state’ python script built-in to HA, or does this script need to be added to my configuration?

mboarman · January 10, 2022, 3:04pm

@cntx Whoops! I completely forgot I added that into HA to make this work since it’s not baked in natively to Home Assistant. See this post:

cntx · January 10, 2022, 8:13pm

@mboarman

Thank you for your expeditious response and pointing me in the right direction.

I am reviewing the python script and integration instructions. This is a good fix until I upgrade my locks [BE469] or zwave_js supports the older notification CC items.

dshokouhi · January 10, 2022, 8:16pm

i dont think its a smart idea to manually set the lock status…you know in case it actually jammed…probably best to send another lock command to ensure its state is correct. Anytime I see its jammed I just send another lock command to fix it.

mboarman · January 10, 2022, 11:15pm

@dshokouhi While I don’t disagree with you, I haven’t found any other way to clear the status of my Yale jammed lock. I’ve sent commands to lock and unlock (both of which work fine) but the jam state remains unchanged once it’s registered as a jam. Any advice would be appreciated?!

dshokouhi · January 10, 2022, 11:31pm

coudl it be an integration bug? surely it must clear on its own somehow when the lock is indeed locked or unlocked.

mboarman · January 10, 2022, 11:33pm

I would have thought the same thing…To no avail, it won’t release the jam state on any of my Yale locks, and I have three YRD256 devices. That was the whole reason I built a script to manually change the state.

freshcoast · January 10, 2022, 11:34pm

No, it’s not an integration bug. Some locks don’t send an Idle notification.

github.com/zwave-js/node-zwave-js

Make handle idling of "Lock Jammed" variable smarter

opened 03:32PM - 31 Jan 21 UTC

itewk

I am trying to get my August Lock Pro (https://github.com/zwave-js/node-zwave-js…/blob/master/packages/config/config/devices/0x033f/asl-03.json) to properly report if the lock is jammed or not. When the lock jams I get this event: ``` { "type": "event", "event": { "source": "node", "event": "value updated", "nodeId": 8, "args": { "commandClassName": "Notification", "commandClass": 113, "endpoint": 0, "property": "Access Control", "propertyKey": "Lock state", "newValue": 11, "prevValue": 11, "propertyName": "Access Control", "propertyKeyName": "Lock state", "metadata": { "type": "number", "readable": true, "writeable": false, "min": 0, "max": 255, "label": "Lock state", "states": { "0": "idle", "11": "Lock jammed" }, "ccSpecific": { "notificationType": 6 } }, "value": 11, "ccVersion": 8 } } } ``` When I then un-jam the lock whether manually or automatically then I get: ``` { "type": "event", "event": { "source": "node", "event": "notification", "nodeId": 8, "notificationLabel": "Manual lock operation" } } ``` or ``` { "type": "event", "event": { "source": "node", "event": "notification", "nodeId": 8, "notificationLabel": "RF lock operation" } } ``` The problem is there is never another `"event": "value updated",` to clear the state of the lock jammed back to `0` / `idle`. What I can't tell is if this is some particularity of the August lock that it doesnt send a new notification that the lock is unjammed, or if this has to do with how this library is differentiating between which events are value update events and which are asynchronous notifications Digging around the code if found https://github.com/zwave-js/node-zwave-js/blob/master/packages/config/config/notifications.json#L386-L393 defining the lock jammed as a variable and then down in the events seciton https://github.com/zwave-js/node-zwave-js/blob/master/packages/config/config/notifications.json#L571-L576 there is a jumnp of 0x0A to 0xC skipping the 0x0B for lock jammed. I am curious if/why not lock jammed isn't listed in that events section and is instead listed in variables section? Should the `0x0b` state be an event instead? Or is this something just weird with how August Lock is woring in which case need some specific override for the august device (if that is even possible in the config). Before I did any PRs was hoping for some insight on what you all think the "correct" behavior here is for z-wave vs what I am seeing with my august lock. The context for all of this is experimenting with this libraries alpha intigraiton with Home Assistant and trying to get locks to accruatly display locked/unlocked/jammed. Currently what happens is the lock jammed event value change event comes in and flips the created entity for the Lock State to `on` but then there is never an event to flip it back to `off` because that notification for value update only ever comes to say lock is jammed, any event that may indicate its no longer jammed comes in as a `"event": "notification"` rather then `"event": "value updated",` for the `"propertyName": "Access Control",`

dshokouhi · January 10, 2022, 11:36pm

thanks for clearing that up

cntx · January 11, 2022, 12:44pm

When my Schlage BE469 locks were z-wave nodes on an ISY-994iz controller, the ‘jammed’ condition cleared after manually operating the lock or sending an RF lock / unlock. However, after moving the same locks to Home Assistant as z-wave nodes, the binary sensor for the jammed condition will not clear when the manual lock / unlock or RF lock / unlock is executed.

I am not sure if the ISY-994iz was clearing the jammed state after an observed state change OR a zwave_js issue.

cntx · January 12, 2022, 7:48pm

@mboarman

Thanks for sharing your information. The python_script.set_state implementation is working well to reset the binary sensor for the jammed lock. However, after the python script executes, it is renaming the frontend friendly name to be the entity_id and the icon is reset to the default device_class.

Are you experiencing this same behavior when observing the frontend state objects?

The code below includes the ‘commented’ icon section, but the script was tested with and without the comment-out.

# python_scripts/set_state.py
#--------------------------------------------------------------------------------------------------
# Set the state for the entity specified in the automation / script action
#--------------------------------------------------------------------------------------------------

inputEntity = data.get('entity_id')
inputStateObject = hass.states.get(inputEntity)
inputState = inputStateObject.state
inputAttributesObject = inputStateObject.attributes.copy()

newState = data.get('state')
if newState is not None:
    inputState = newState
    
#newIcon = data.get('icon')
#if newIcon is not None:
#    inputAttributesObject['icon'] = newIcon

hass.states.set(inputEntity, inputState, inputAttributesObject)

mboarman · January 24, 2022, 3:00pm

Sorry for the delayed response, I’ve been out of pocket for a bit. I haven’t noticed this behavior? Seems a little odd? Did you get it resolved?

cntx · February 7, 2022, 7:26pm

Mark,

No apology necessary.

The error was on my side / user-error. Ultimately the working script is as follows:

# python_scripts/set_state.py
#--------------------------------------------------------------------------------------------------
# Set the state for the entity specified in the automation / script action
#--------------------------------------------------------------------------------------------------

inputEntity = data.get('entity_id')
inputStateObject = hass.states.get(inputEntity)
inputState = inputStateObject.state
inputAttributesObject = inputStateObject.attributes.copy()

newState = data.get('state')
if newState is not None:
    inputState = newState
    
#newIcon = data.get('icon')
#if newIcon is not None:
#    inputAttributesObject['icon'] = newIcon

hass.states.set(inputEntity, inputState, inputAttributesObject)

jeeftor · April 3, 2023, 8:10pm

Thats because Yale/August has a faulty Z-Wave implementation …