homebridge-kobold-Homaassistant-Flavour/config.schema.json

{
  "pluginAlias": "KoboldVacuumRobot",
  "pluginType": "platform",
  "singular": true,
  "headerDisplay": "homebridge-kobold plugin details [on github](https://github.com/himbeles/homebridge-kobold#readme)",
  "schema": {
    "type": "object",
    "properties": {
      "token": {
        "title": "Vorwerk Kobold Token",
        "type": "string",
        "required": true,
        "description": "How to get your Vorwerk Kobold Token (https://git.io/J3g1b)"
      },
      "language": {
        "title": "Services Language",
        "description": "The displayed language of the registered services (and associated Siri commands)",
        "type": "string",
        "default": "en",
        "oneOf": [
          {
            "title": "English",
            "enum": ["en"]
          },
          {
            "title": "German",
            "enum": ["de"]
          },
          {
            "title": "French",
            "enum": ["fr"]
          }
        ],
        "required": true
      },
      "prefix": {
        "title": "Prefix with Robot Name",
        "description": "Display the name of the robot in front of every service.",
        "type": "boolean",
        "default": false
      },
      "backgroundUpdate": {
        "title": "Background Update Interval",
        "description": "Interval for background updates while the robot is not cleaning (in minutes). During cleaning, the robot will automatically update at a faster rate.",
        "type": "integer",
        "minimum": 1,
        "default": 30
      },
      "services": {
        "type": "array",
        "title": "Displayed Services",
        "description": "The services to be made available for Homekit",
        "uniqueItems": true,
        "items": {
          "type": "string",
          "enum": [
            "clean",
            "cleanThe",
            "cleanSpot",
            "goToDock",
            "dockState",
            "binFull",
            "eco",
            "noGoLines",
            "extraCare",
            "schedule",
            "findMe",
            "battery"
          ],
          "enumNames": [
            "Clean",
            "Clean Zone",
            "Clean Spot",
            "Go to Dock",
            "Docked State",
            "Bin Full",
            "Eco Mode",
            "NoGo Lines",
            "Extra Care",
            "Schedule",
            "Find me",
            "Battery"
          ]
        },
        "default": [
          "clean",
          "cleanThe",
          "goToDock",
          "dockState",
          "binFull",
          "eco",
          "noGoLines",
          "extraCare",
          "schedule",
          "findMe",
          "cleanSpot",
          "battery"
        ]
      }
    }
  },
  "layout" : [
    "language",
    "token",
    "prefix",
    "backgroundUpdate",
    {
      "type": "fieldset",
      "title": "Displayed Services",
      "description": "<i>Services to be displayed in Homekit</i>",
      "expandable": true,
      "items": [
        {
          "key": "services",
          "notitle": false
        }
      ]
    }
  ]
}