config.schema.json

{
  "pluginAlias": "SwitchBot",
  "pluginType": "platform",
  "singular": true,
  "headerDisplay": "<p align='center'><img width='100px' src='https://user-images.githubusercontent.com/9875439/102681754-ac2eb800-4189-11eb-8e17-7c47c804484b.png'></p>\n\nThe **SwitchBot** plugin allows you to control SwitchBot Devices. \n\nTo get started link your SwtichBot account.\nTo get started link your SwtichBot account.\n\n1. Download SwitchBot App on App Store or Google Play Store.\n\n2. Register a SwitchBot account and log in into your account.\n\n3. Generate an Open Token within the App.\n\n4. Input your `Open Token` into the paramter below.",
  "footerDisplay": "Please raise any issues on our [project page](https://github.com/OpenWonderLabs/homebridge-switchbot-openapi/issues).\n\nIf you would like to have other SwitchBot Devices added to this plugin fill out [Feature Request Form](https://github.com/OpenWonderLabs/homebridge-switchbot-openapi/issues/new?assignees=&labels=&template=feature_request.md).\n\n[SwitchBot Website](https://www.switch-bot.com)",
  "schema": {
    "type": "object",
    "properties": {
      "name": {
        "type": "string",
        "title": "Name",
        "default": "SwitchBot",
        "required": true
      },
      "credentials": {
        "type": "object",
        "properties": {
          "openToken": {
            "title": "Token",
            "type": "string",
            "required": true
          },
          "notice": {
            "title": "Notice",
            "type": "string",
            "required": true,
            "default": "Keep your token a secret!"
          }
        }
      },
      "options": {
        "type": "object",
        "properties": {
          "refreshRate": {
            "title": "Refresh Rate",
            "type": "number",
            "minimum": 120,
            "placeholder": 300,
            "description": "Indicates the number of seconds between polls of SwitchBot API."
          },
          "hide_device": {
            "title": "Hide Device",
            "type": "array",
            "items": {
              "type": "string"
            }
          },
          "bot": {
            "type": "object",
            "properties": {
              "device_switch": {
                "title": "Switch Mode Bots",
                "type": "array",
                "items": {
                  "type": "string"
                }
              },
              "device_press": {
                "title": "Press Mode Bots",
                "type": "array",
                "items": {
                  "type": "string"
                }
              }
            }
          },
          "humidifier": {
            "type": "object",
            "properties": {
              "hide_temperature": {
                "title": "Hide Humidifier's Temperature Sensor",
                "type": "boolean"
              }
            }
          },
          "curtain": {
            "type": "object",
            "properties": {
              "set_minStep": {
                "title": "Set Min Step",
                "type": "number",
                "placeholder": "1"
              },
              "set_min": {
                "title": "Set Min",
                "type": "number",
                "placeholder": "0"
              },
              "set_max": {
                "title": "Set Max",
                "type": "number",
                "placeholder": "100"
              }
            }
          }
        }
      },
      "devicediscovery": {
        "name": "Device Discovery",
        "type": "boolean"
      }
    }
  },
  "layout": [
    {
      "type": "fieldset",
      "title": "SwitchBot Account Info",
      "expandable": true,
      "expanded": false,
      "items": [
        "name",
        "credentials.openToken"
      ]
    },
    {
      "type": "fieldset",
      "title": "Advanced Settings",
      "expandable": true,
      "expanded": false,
      "items": [
        {
          "type": "help",
          "helpvalue": "<h5>Refresh Rate</h5><em class='primary-text'>Refresh Rate indicates the number of seconds between polls of SwitchBot API.</em>"
        },
        {
          "key": "options.refreshRate",
          "notitle": true
        },
        {
          "type": "help",
          "helpvalue": "<h5>Hide Device</h5><em class='primary-text'>Hide Device allows you to hide a device using it's deviceID.</em>"
        },
        {
          "key": "options.hide_device",
          "notitle": true,
          "add": "Add Another Device",
          "type": "array",
          "items": [
            {
              "type": "div",
              "displayFlex": true,
              "flex-direction": "row",
              "items": [
                {
                  "key": "options.hide_device[]",
                  "placeholder": "81F3UT59513F"
                }
              ]
            }
          ]
        },
        {
          "type": "fieldset",
          "title": "Bot Settings",
          "expandable": true,
          "expanded": false,
          "items": [
            {
              "key": "options.bot.device_switch",
              "notitle": false,
              "add": "Add Another Bot in Switch Mode",
              "type": "array",
              "items": [
                {
                  "type": "div",
                  "displayFlex": true,
                  "flex-direction": "row",
                  "items": [
                    {
                      "key": "options.bot.device_switch[]",
                      "placeholder": "81F3UT59513F"
                    }
                  ]
                }
              ]
            },
            {
              "key": "options.bot.device_press",
              "notitle": false,
              "add": "Add Another Bot in Press Mode",
              "type": "array",
              "items": [
                {
                  "type": "div",
                  "displayFlex": true,
                  "flex-direction": "row",
                  "items": [
                    {
                      "key": "options.bot.device_press[]",
                      "placeholder": "81F3UT59513F"
                    }
                  ]
                }
              ]
            }
          ]
        },
        {
          "type": "fieldset",
          "title": "Humidifier Settings",
          "expandable": true,
          "expanded": false,
          "items": [
            "options.humidifier.hide_temperature"
          ]
        },
        {
          "type": "fieldset",
          "title": "Curtain Settings",
          "expandable": true,
          "expanded": false,
          "items": [
            "options.curtain.set_minStep",
            "options.curtain.set_min",
            "options.curtain.set_max"
          ]
        },
        {
          "type": "help",
          "helpvalue": "<h5>Device Discovery</h5><em class='primary-text'>Enables Device Info Logging.</em>"
        },
        {
          "key": "devicediscovery",
          "title": "Device Discovery"
        }
      ]
    }
  ]
}