config.schema.json

{
  "pluginAlias": "ShellyDoorLock",
  "pluginType": "accessory",
  "singular": false,
  "schema": {
    "type": "object",
    "properties": {
      "name": {
        "title": "Name",
        "type": "string",
        "required": true,
        "description": "Name to appear in the Home app"
      },
      "http_method": {
        "title": "HTTP Method",
        "type": "string",
        "oneOf": [
          {
            "title": "GET",
            "enum": ["GET"]
          },
          {
            "title": "POST",
            "enum": ["POST"]
          }
        ],
        "required": true,
        "default": "GET",
        "description": "The HTTP method to be used to communicate with the device API."
      },
      "unlockURL": {
        "title": "Unlock URL",
        "type": "string",
        "required": true,
        "description": "URL to trigger the opening of your garage"
      },
      "lockURL": {
        "title": "Lock URL",
        "type": "string",
        "required": true,
        "description": "URL to trigger the closing of your garage"
      },
      "username": {
        "title": "Username",
        "type": "string",
        "description": "Username if HTTP authentication is enabled"
      },
      "password": {
        "title": "Password",
        "type": "string",
        "description": "Password if HTTP authentication is enabled"
      },
      "polling": {
        "title": "Poll state",
        "type": "boolean",
        "default": false,
        "description": "Whether the state should be polled at intervals (requires magnetic sensor)."
      },
      "pollInterval": {
        "title": "Polling interval",
        "type": "integer",
        "default": 120,
        "description": "Time (in seconds) between device polls (if `polling` is enabled) "
      },
      "statusURL": {
        "title": "Status polling URL",
        "type": "string",
        "description": "URL to retrieve state on poll (if `statusField*` options are not set, expects HTTP response body to be `0` or `1`)"
      },
      "statusKey": {
        "title": "Status Key",
        "type": "string",
        "default": "$.inputs[0].input",
        "description": "JSONPath that identifies the property that contains the status of the door (e.g. `$.inputs[0].input` is the default for Shelly 1) | `$.inputs[0].input`"
      },
      "statusValueUnlocked": {
        "title": "Unlocked status value",
        "type": "string",
        "default": "0",
        "description": "Regex that will match the `unlocked` state of the relay status (e.g. `unlocked`)"
      },
      "statusValueLocked": {
        "title": "Locked status value",
        "type": "string",
        "default": "1",
        "description": "Regex that will match the `locked` state of the relay status (e.g. `locked`)"
      },
      "manufacturer": {
        "title": "Manufactor",
        "type": "string",
        "description": "Appears under the Manufacturer field for the accessory"
      },
      "model": {
        "title": "Model",
        "type": "string",
        "description": "Appears under the Model field for the accessory"
      },
      "debug": {
        "title": "Debug mode",
        "type": "boolean",
        "default": false,
        "description": "Turn on debug mode, i.e. additional information will show up on the homebridge log."
      }
    }
  }
}