README.md

augustctl

A node.js module to operate an August Smart Lock, via BLE.

This is not developed or officially support by August, it works for me but use at your own risk!

Prerequisties

Same as for noble.

On Linux, you will need bluez 5.

Also tested and working on OSX Yosemite.

Install

npm install -g augustctl

Configuration

It's necessary to have an offlineKey and corresponding offlineKeyOffset that are recognized by your lock. These should placed in a config.json file, which should be in your current directory when you run augustctl.

Android Phone (with Root)

If the phone is rooted, you can copy the /data/data/com.august.luna/shared_prefs/PeripheralInfoCache.xml file from your phone to your computer. Many file manager apps, or an adb shell, will let you access it, as long as your phone is rooted.

Open the PeripheralInfoCache.xml file and find the handshakeKey and handshakeKeyIndex strings. Copy the strings that follow those (excluding the " bits) into a config.json file formatted like so:

{ "offlineKey": "handshakeKey", "offlineKeyOffset": handshakeKeyIndex }

The configuration file location can be explicitly set via the AUGUSTCTL_CONFIG environment variable.

Android Phone (without Root)

The latest August app no longer exposes the offline keys. Rooting is required.

iPhone

The key and offset can be found in plist located at:

User Applications/August/Library/Preferences/com.august.iossapp.plist

This can be retrieved by using a file explorer like http://www.i-funbox.com/ifunboxmac/, and opening the plist in Xcode.

Alternatively, you can enter the debug mode in the application by long pressing the application version number, entering the password (like in Android, it is KryspyKym) and e-mailing yourself the application logs. Search those logs for "offline", and you'll find the key and slot that are used by your device.

Note that the key and slot will be all that is necessary to open your lock, so it's not advisable to leave those logs laying around in your e-mail account.

Usage

Assuming you've configured your offline key and offset, as above, just:

augustctl unlock
augustctl lock

That's it!

Alternatively, a simple HTTP API server is available. From a checked out installation:

npm start

License

MIT