homebridge-august-door-sense/config.schema.json

Homebridge Plugin for August DoorSense.

{
  "pluginAlias": "AugustDoorSense",
  "pluginType": "platform",
  "singular": true,
  "headerDisplay": "**IMPORTANT:** please check this [README](https://github.com/WLBQE/homebridge-august-door-sense/blob/master/README.md) before proceeding.",
  "schema": {
    "type": "object",
    "properties": {
      "name": {
        "title": "Name",
        "type": "string",
        "required": true,
        "default": "August DoorSense"
      },
      "id": {
        "title": "August ID",
        "type": "string",
        "description": "The login ID for your August account (email or phone).",
        "required": true
      },
      "idType": {
        "title": "ID Type",
        "type": "string",
        "oneOf": [
          {
            "title": "Email",
            "enum": [
              "email"
            ]
          },
          {
            "title": "Phone",
            "enum": [
              "phone"
            ]
          }
        ],
        "description": "Type of your August ID.",
        "required": true
      },
      "password": {
        "title": "Password",
        "type": "string",
        "x-schema-form": {
          "type": "password"
        },
        "description": "The password of your August account.",
        "required": true
      },
      "installId": {
        "title": "Installation ID",
        "type": "string",
        "description": "A unique, static UUID. Check README for details.",
        "required": true
      },
      "code": {
        "title": "2FA Code",
        "type": "string",
        "required": false
      },
      "filter": {
        "title": "Lock Filter",
        "type": "string",
        "description": "IDs of devices you want to exclude. Check README for details.",
        "required": false
      },
      "refreshInterval": {
        "title": "Refresh Interval",
        "type": "number",
        "description": "Refresh interval in seconds.",
        "required": false
      },
      "securityToken": {
        "title": "API Key",
        "type": "string",
        "description": "Custom API key (optional).",
        "required": false
      },
      "email": {
        "title": "Email (for backward compatibility only)",
        "type": "string",
        "required": false,
        "condition": {
          "functionBody": "return false;"
        }
      },
      "phone": {
        "title": "Phone (for backward compatibility only)",
        "type": "string",
        "required": false,
        "condition": {
          "functionBody": "return false;"
        }
      }
    }
  }
}