homebridge-poolcontroller-clocklear/config.schema.json

A (semi) private Homebridge plugin for my custom Pool Controller app

{
  "pluginAlias": "PoolControllerPlugin",
  "pluginType": "platform",
  "singular": true,
  "schema": {
    "type": "object",
    "properties": {
      "url": {
        "title": "Pool Controller URL",
        "type": "string",
        "required": true,
        "description": "The URL of the Pool Controller API",
        "default": "https://poolcontroller.lockleartech.com"
      },
      "apiKey": {
        "title": "API Key",
        "description": "The API key for the Pool Controller app",
        "placeholder": "abc123",
        "type": "string",
        "required": true
      },
      "relays":{
        "title": "Active Relays",
        "description": "The relays that should be controlled by this plugin",
        "type": "array",
        "uniqueItems": true,
        "items": {
          "title": "Relay ID",
          "type": "string",
          "enum": [
            "1",
            "2",
            "3"
          ]
        }
      },
      "asyncUpdates": {
        "title": "Asynchronous Updates",
        "description": "Enable this option to allow the plugin to update the status of the relays asynchronously. This will allow the plugin to update the status of the relays constantly in the background (however it has been known to fail over time).",
        "type": "boolean",
        "default": false
      }
    }
  }
}