Configuration

Configuration

Breakdown of each Config option:

Name: defaults August, what will show up in the log to identify the plugin, and is not an option in the Plugin Config UI

credentials: object that holds augustId, password, & validateCode.

• augustId: input your August E-mail you use to login to the August App.
• password: input your August password you use to login to the August App.
• validateCode: input the Code that is sent to your August Email.

options: object that holds all optional settings

• logging: this is the logging used for the whole plugin, this will be used for every device unless a specific device override is made.
• devices: array that holds config for each different device setting that is set.

  • Breakdown of each device config option:

    • lockId: this can be found either on the Devices Tab of the Plugin Config UI for each Device, in the logs.
    • configDeviceName: this is the name of the device
    • hide_device: this is used to hide devices from the Home App (HomeKit)
    • firmware: this is used to override the firmware.
    • external: allows you to set device as external display so it isn't bridge to homebridge or a child bridge..
    • refreshRate: this is the refreshRate used for this specific device based of lockId.
    • logging: this is the logging used for this specific device based of lockId
    • lock: Object that holds Lock device config options
      • hide_contactsensor: allows you to hide the contact sensor

Sample Configuration

{
  "name": "August",
  "credentials": {
    "augustId": "august@email.com",
    "password": "password",
    "validateCode": "123456",
    "notice": "Keep your tokens a secret!"
  },
  "options": {
    "devices": [
      {
        "lockId": "TSSQ97FRDMX7TPGU3Z2HWNRDPQXJ9YSM",
        "configLockName": "Garage Door Lock",
        "hide_device": false,
        "lock": {
                "hide_contactsensor": true
        },
        "firmware": "1.28",
        "external": true,
        "refreshRate": 360,
        "logging": "standard"
      }
    ],
    "refreshRate": 360,
    "logging": "standard"
  },
  "platform": "August"
}