config.schema.json

{
  "pluginAlias": "TedeeBridge",
  "pluginType": "platform",
  "headerDisplay": "Connect your Tedee smart locks with homebridge.",
  "footerDisplay": "The Tedee bridge is required for this plugin to work.",
  "singular": true,
  "schema": {
    "type": "object",
    "properties": {
      "bridgeIp": {
        "title": "The local Bridge IP",
        "type": "string",
        "required": false,
        "placeholder": "192.168.0.123"
      },
      "apiKey": {
        "title": "API Key obtained in tedee app settings",
        "type": "string",
        "required": true,
        "placeholder": "abcd1234"
      },
      "timeout": {
        "title": "Timeout in milliseconds",
        "type": "integer",
        "default": 10000,
        "placeholder": "10000",
        "description": "The timeout in milliseconds for the API calls."
      },
      "webhookPort": {
        "title": "Webhook port",
        "type": "integer",
        "default": 3003,
        "placeholder": "3003",
        "description": "The port on which the plugin listens for webhooks. Make sure this port is open in your firewall."
      },
      "devices": {
        "type": "array",
        "title": "Devices",
        "items": {
          "type": "object",
          "properties": {
            "name": {
              "title": "Device name",
              "type": "string",
              "required": true,
              "placeholder": "Device name from the app",
              "description": "The name of the lock. This name has to match the name that is configured in the Tedee app."
            },
            "ignore": {
              "title": "Ignore device",
              "type": "boolean",
              "required": true,
              "default": false,
              "description": "If set to true, the device will be ignored and not added to HomeKit."
            }
          }
        }
      },
      "maximumApiRetry": {
        "title": "Maximum amount of retries",
        "type": "integer",
        "default": 3,
        "placeholder": 3,
        "description": "The amount of attempts to call the API. Useful if you do not want to repeat failed lock/unlock/unlatch attempts after a long timeout delay."
      }
    }
  }
}