homebridge-hivehome-control/config.schema.json

Allows control of Hive devices, including water heaters, through Homebridge.

{
  "pluginAlias": "HiveHomeController",
  "pluginType": "platform",
  "singular": true,
  "headerDisplay": "Device Credentials are obtained via 2FA auth, by running 'npx homebridge-hivehome-control'",
  "schema": {
    "hiveUsername": {
      "title": "Username",
      "type": "string",
      "format": "email",
      "required": true
    },
    "hivePassword": {
      "title": "Password",
      "type": "string",
      "required": true
    },
    "deviceGroupKey": {
      "title": "Device Group Key",
      "type": "string",
      "required": true
    },
    "deviceKey": {
      "title": "Device Key",
      "type": "string",
      "required": true
    },
    "devicePassword": {
      "title": "Device Password",
      "type": "string",
      "required": true
    },
    "hotWaterBoostMins": {
      "title": "Boost Duration",
      "placeholder": "Time in minutes",
      "type": "integer",
      "required": true,
      "default": 60
    },
    "heatingBoostMins": {
      "title": "Boost Duration",
      "placeholder": "Time in minutes",
      "type": "integer",
      "required": true,
      "default": 60
    },
    "heatingBoostTemp": {
      "title": "Boost Temperature",
      "placeholder": "Temperature in degrees",
      "type": "number",
      "required": true,
      "default": 21
    },
    "enableDebugLog": {
      "title": "Debug Logging",
      "type": "boolean",
      "default": false
    }
  },
  "layout": [
    {
      "key": "user_credentials",
      "title": "User Credentials",
      "type": "section",
      "expandable": true,
      "expanded": false,
      "items": [
        "hiveUsername",
        "hivePassword"
      ]
    },
    {
      "key": "device_credentials",
      "title": "Device Credentials",
      "type": "section",
      "expandable": true,
      "expanded": false,
      "items": [
        "deviceGroupKey",
        "deviceKey",
        "devicePassword"
      ]
    },
    {
      "key": "heating_options",
      "title": "Heating Options",
      "type": "section",
      "expandable": true,
      "expanded": true,
      "items": [
        "heatingBoostMins",
        "heatingBoostTemp"
      ]
    },
    {
      "key": "hot_water_options",
      "title": "Hot Water Options",
      "type": "section",
      "expandable": true,
      "expanded": true,
      "items": [
        "hotWaterBoostMins"
      ]
    },
    {
      "key": "debug_options",
      "title": "Debug Options",
      "type": "section",
      "expandable": true,
      "expanded": false,
      "items": [
        "enableDebugLog"
      ]
    }
  ]
}