Control the August Smart Lock with HTTPS request // PROJECT NO LONGER MAINTAINED
Switch branches/tags
Nothing to show
Clone or download
Pull request Compare This branch is even with mtvg:master.
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
augustctl
README.md
alexaws.js
august-server.js
config.js
package.json

README.md

August

Based on the work of Dan Walters: https://github.com/sretlawd/augustctl

TODO: Fork augustctl to merge some features of this project, and use augustctl as a dependency.

Info

This NodeJS script creates a web server that controls an August Lock via Bluetooth LE.

The server will respond to Alexa Skill requests. (https://youtu.be/dMDONhdPdxo)

The server also respond to those actions:

  • https://server:port/august/control/status gets the lock status
  • https://server:port/august/control/lock locks the door
  • https://server:port/august/control/unlock unlocks the door
  • https://server:port/august/control/neverlock unlocks the door and disables the autolock feature
  • https://server:port/august/control/everlock locks the door and enables the autolock feature
  • https://server:port/august/control/neverlock?relock=3600 unlocks the door and automatically everlocks the door after 1 hour (3600sec)
  • https://server:port/august/control/cached returns the last known lock status without requesting the lock
  • https://server:port/august/control/relocktime returns the time remaining after a neverlock?relock=3600 call

I haven't implemented any kind of security, it is more a proof of concept than a real project. Use this at your own risk.

Requirements

For this project I've used:

You only need to install node and npm on your pi.

Setup

Here are my old notes for my basic setup:

Config

  • Login to your Pi and clone this project in your home directory (/home/pi/): git clone git://github.com/mtvg/August
  • Install dependencies inside the project directory: npm install
  • Edit the config.js file, and add your SSL certificate files if you're enabling the HTTPS server
  • Clone fauxmo in your home directory: git clone git://github.com/makermusings/fauxmo
  • Clone and install fauxmo dependency: git clone git://github.com/kennethreitz/requests.git then in the requests folder: sudo python setup.py install
  • Configure fauxmo.py

Test

Run sudo node august/august-server.js and try opening http://raspberrypi.local:8080/august/control/status on your computer

Startup /etc/rc.local

Edit /etc/rc.local and add those lines in order to make things start automatically on startup:

PATH=$PATH:/usr/local/bin/

node /home/pi/august/august-server.js > /home/pi/august.log 2> /home/pi/august_err.log &
/home/pi/fauxmo/fauxmo.py &

Getting your offline key:

The offline key is an encryption key used by the lock to communicate securely through a BLE communication. This key is stored in the offical August app preferences on both iOS and Android.

I'm only going to cover how to retreive the key using an iPhone and OSX, please read this for Android.

In order for the August app to save the offline key to your preferences file, the AutoUnlock feature has to be activated at least once. (You can disable it right after)

  • Create an unencrypted backup of your iOS device on your computer. (Uncheck "Encrypt iPhone backup" in iTunes)
  • Use iPhone Backup Extractor to extract the data of the app named com.august.iosapp (more details here, a Windows alternative probably exsists)
  • Open the file com.august.iossapp/Library/Preferences/com.august.iossapp.plist using Xcode or any binary plist viewer
  • Look inside Root/AGCurrentUserOfflineKey_XXXXXXXXXXXXXX, and copy the value of key and slot

Alexa using virtual WeMo switch

With this method, no need to expose your webserver to the world. And the voice command is more natural than using a Skill for Alexa. But you'll be limited to just open and close the door.

You can say: "Alexa, open the door" or "Alexa, close the door" (door is the name of your virtual WeMo device, you can change it if you want)

You can also say: "Alex, turn off autolock" and it will disable the autolock feature plus open the door, but re enabled it 3 hours later (neverlock?relock=180)

For this, we're gonna use fauxmo

Download and install the python script to your RaspberryPi and edit the end of the file as this:

FAUXMOS = [
	['Door', rest_api_handler('http://127.0.0.1:8080/august/control/unlock', 'http://127.0.0.1:8080/august/control/lock')],
	['Autolock', rest_api_handler('http://127.0.0.1:8080/august/control/everlock', 'http://127.0.0.1:8080/august/control/neverlock?relock=180')],
]

Alexa Skill

Setup a new Skill in your Amazon Developer Conosole

Create a self-signed certificate and save your key and cert as .pem files for our HTTPS web server

Intent Schema

{
  "intents": [
  {
    "intent": "UnlockDoorFor",
    "slots": [
      {
        "name": "Duration",
        "type": "NUMBER"
      }
    ]
  },
  {
    "intent": "LockDoor"
  },
  {
    "intent": "UnlockDoor"
  },
  {
    "intent": "GetStatus"
  }
  ]
}

Sample Utterances

LockDoor lock the door
LockDoor lock
LockDoor close the door
LockDoor close
UnlockDoor unlock the door
UnlockDoor unlock
UnlockDoor open the door
UnlockDoor open
UnlockDoorFor unlock the door for {twenty|Duration} minutes
UnlockDoorFor lock the door in {twenty|Duration} minutes
UnlockDoorFor open the door for {twenty|Duration} minutes
UnlockDoorFor close the door in {twenty|Duration} minutes
GetStatus what is the status of the lock
GetStatus what is your status
GetStatus what is the status of the door
GetStatus what is the status of august