August Smart Lock Pro (zwave)

August recently released their third generation smart lock, with zwave functionality. The current generic zwave lock component works with the new August lock. It exposes the locked / unlocked status and battery level. It doesn’t currently expose the other data points August says the lock is currently communicating.

I am interested in seeing the generic component updated with additional data points, or a separate component created for the August Smart Lock Pro.

According to the Product Manager at August that I exchanged emails with, they are currently supporting:

  • Command classes for Door Lock and Keypad types
  • Door condition (8-bit)
    Bit Description
    0 0 = Door Open;
    0 1 = Door Closed
    1 0 = Bolt Locked;
    1 1 = Bolt Unlocked
    2 0 = Latch Open;
    2 1 = Latch Closed
    3-7 Reserved

They are in the process of implementing the Notification Command Class for:

  • Manual Lock Operation
  • Manual Unlock Operation
  • RF Lock Operation
  • RF Unlock Operation
  • Keypad Lock Operation
  • Keypad Unlock Operation
  • Auto Lock Locked Operation
  • Lock Jammed

They are considering adding data for who performed the unlock operation. (Assuming it was done with an August account, or code)

I would like to see these enhancements as well.

that means is not possible to lock/unlock via ZWAVE?

I would think that this info needs to be added upstream in Openzwave since this particular lock is relatively new. Any idea if that’s been done yet? Once ozw has the config data these things should get exposed in HA as sensors I would think.

Edit: just checked and the August pro lock hasn’t been added to ozw yet. I’d be happy to add it but I’m reluctant to as I can’t test afterwards. Maybe @alexb you could add it?

I don’t have any experience with adding things to OZW, it’s currently beyond my skill set.

I’ve connected with the Product Manager in charge of development for the device a couple times via email. August is real tight lipped on providing information about the product and offers zero documentation unless you’re someone like a hub manufacturer. My many requests for documentation have been met with “we’ll make note of the request”.

Well the nice thing is that the product manager seems to have reported to you the things they currently support and the configuration parameters to set them. Also since Z-Wave is a standard they can’t hide everything; see: https://products.z-wavealliance.org/products/2624.

Adding a device to the ozw database is actually pretty straightforward, it doesn’t require any coding knowledge or anything like that - all you need to do is take the information you have already and turn it into xml according to this guide: https://github.com/OpenZWave/open-zwave/wiki/Adding-Devices.

1 Like

i downloaded the XML file from: https://products.z-wavealliance.org/Products/2624/XML

and added to the ZWAVE config path, now i can lock/unlock the august lock, i will check how that works with the door sensor, thanks

I’m 100% positive that adding the XML file downloaded from that site didn’t add any functionality for you. Command classes are detected automatically and the configuration variables described by @alexb aren’t found in that file.

What someone needs to do is take the information that @alexb got from August and create an entry for the lock in the ozw database.

well, i can’t argue about that because my knowledge is limited on this matter, however i just did what you said i should do, took the XML file and added to the database, before i was not able to operate the lock, now i can operate the lock.

not sure what happened but i’m happy :slight_smile: thanks.

:man_shrugging:

I wasn’t able to find the Door Condition bits the Product Manager told me about. When I pressed for more information, my question was ignored.

I did however get confirmation on number / value matching for “Access Control” under “COMMAND_CLASS_ALARM”. Here are the values for that.

0 - unassigned
1 - Manual Lock Operation
2 - Manual Unlock Operation
3 - RF Lock Operation
4 - RF Unlock Operation
5 - Keypad Lock Operation
6 - Keypad Unlock Operation
7 - unassigned
8 - unassigned
9 - Auto Lock Locked Operation
10 - unassigned
11 - Lock Jammed

i’m sorry, i just discovered that the magic was done by WINK and not Z-WAVE, i was testing both components and didn;t realize that WINK was actually working, you were right @marthocoo.

i guess that send me back to where i was, still looking for this to work with Z-WAVE

When I pair my August Smart Lock Pro with HA, it pairs as a “generic lock” and it communicates the lock/unlock status just fine. What I’m interested in is all of the other data that is available in the August app, like the DoorSense data and the user that unlocked the door.

@alexb what kinf of Z-WAVE gateway are you using?? i’m using an Aeotec and can’t make it work with it, not even the state of the lock, also which HA version are you using?

@peteonus I’m using the Aeotec Z-Stick also. I paired the August Smart Lock Pro with it through HA, using the secure pairing option. It was a few versions back, when the lock first came out. You have to go into the August app, to the z-wave settings, initiate the pairing process from there, before you click the secure pair button in HA.

@alexb: you say that you got it to appear as a generic lock and work, I’m not having as much success here. But it sounds like I have the exact same setup you do (aeotec z-stick and august pro)

Any chance you could share the relevant parts of your config files? So far I have one lock device listed as:
lock.<name_of_device>_locked
And it neither shows the correct current state, nor does it successfully allow me to change the state. When I tried without the “locked” part on the end it vanished altogether.

(be gentle, I’m still pretty new to home-assistant in general, so I apologize if I’m missing something painfully obvious)

Just jumping back in to say that the lock is Zwave, so as long as you’ve paired it properly you should at least be able to lock and unlock it. Did you add it to HA securely?

If you add that lock.name_locked entity to a group that is visible on the frontend, it should give you a toggle that you can hit to lock and unlock.

If that doesn’t work, you’ll need to show us your Zwave log so that we can take a look.

I did add it securely, and the August app shows that it’s connected.

In groups.yaml I have:

door:
name:Doors
entities:
-lock.back_door_lock_locked

(not sure why the indent spacing isn’t showing up, but it’s there…)

When I look in homeassistant it shows an entry labelled “Back Door Lock Locked” with an open padlock symbol, and a switch showing the off position. If I click it the switch slides to “on” then almost immediately slides back to “off” OZW_log.txt says:

2017-12-22 20:07:30.660 Info, Node006, Value::Set - COMMAND_CLASS_DOOR_LOCK - Locked - 0 - 1 - True
2017-12-22 20:07:30.661 Info, Node006, Value_Lock::Set - Requesting lock to be Locked
2017-12-22 20:07:30.661 Detail, Node006, Queuing (Send) DoorLockCmd_Set (Node=6): 0x01, 0x0a, 0x00, 0x13, 0x06, 0x03, 0x62, 0x01, 0xff, 0x25, 0x1c, 0x46
2017-12-22 20:07:30.661 Detail, Node006, Queuing (Send) DoorLockCmd_Get (Node=6): 0x01, 0x09, 0x00, 0x13, 0x06, 0x02, 0x62, 0x02, 0x25, 0x1d, 0xb9
2017-12-22 20:07:30.661 Detail,
2017-12-22 20:07:30.661 Info, Node006, Sending (Send) message (Callback ID=0x1c, Expected Reply=0x04) - DoorLockCmd_Set (Node=6): 0x01, 0x0a, 0x00, 0x13, 0x06, 0x03, 0x62, 0x01, 0xff, 0x25, 0x1c, 0x46
2017-12-22 20:07:30.671 Detail, Node006, Received: 0x01, 0x04, 0x01, 0x13, 0x01, 0xe8
2017-12-22 20:07:30.671 Detail, Node006, ZW_SEND_DATA delivered to Z-Wave stack
2017-12-22 20:07:31.936 Detail, Node006, Received: 0x01, 0x07, 0x00, 0x13, 0x1c, 0x00, 0x00, 0x7f, 0x88
2017-12-22 20:07:31.936 Detail, Node006, ZW_SEND_DATA Request with callback ID 0x1c received (expected 0x1c)
2017-12-22 20:07:31.936 Info, Node006, Request RTT 1274 Average Request RTT 1276
2017-12-22 20:07:31.936 Detail, Expected callbackId was received
2017-12-22 20:07:40.663 Error, Node006, ERROR: Dropping command, expected response not received after 1 attempt(s)
2017-12-22 20:07:40.663 Detail, Node006, Removing current message
2017-12-22 20:07:40.663 Detail, Node006, Notification: Notification - TimeOut
2017-12-22 20:07:40.665 Detail,
2017-12-22 20:07:40.666 Info, Node006, Sending (Send) message (Callback ID=0x1d, Expected Reply=0x04) - DoorLockCmd_Get (Node=6): 0x01, 0x09, 0x00, 0x13, 0x06, 0x02, 0x62, 0x02, 0x25, 0x1d, 0xb9
2017-12-22 20:07:40.673 Detail, Node006, Received: 0x01, 0x04, 0x01, 0x13, 0x01, 0xe8
2017-12-22 20:07:40.674 Detail, Node006, ZW_SEND_DATA delivered to Z-Wave stack
2017-12-22 20:07:41.954 Detail, Node006, Received: 0x01, 0x07, 0x00, 0x13, 0x1d, 0x00, 0x00, 0x80, 0x76
2017-12-22 20:07:41.954 Detail, Node006, ZW_SEND_DATA Request with callback ID 0x1d received (expected 0x1d)
2017-12-22 20:07:41.955 Info, Node006, Request RTT 1288 Average Request RTT 1282
2017-12-22 20:07:41.955 Detail, Expected callbackId was received
2017-12-22 20:07:50.667 Error, Node006, ERROR: Dropping command, expected response not received after 1 attempt(s)
2017-12-22 20:07:50.668 Detail, Node006, Removing current message
2017-12-22 20:07:50.668 Detail, Node006, Notification: Notification - TimeOut

I have confirmed that Node006 is the august lock.
Lock starts (and finishes) this operation in the locked position.
(desired behaviour would be a switch that shows whether the lock is currently locked or unlocked and allows me to toggle the state)

How close is your lock to the zwave stick? Looks like the lock requests are timing out.

it’s the closest z-wave device to the controller, and in exactly the same place as it was when I paired it initially.

But I think I may have found something it appears that despite the appearance of success on all sides with the secure inclusion, it may not in fact have included securely as I had never set a network key (not knowing I had to) I’ve now set one of those, but am having a devil of a time removing this node to add it again now that I have a key. Interestingly enough though, the August app no longer shows the device as paired, but home assistant still does (despite multiple attempts at remove node, remove failed node, and replace failed node)