homebridge-tcc/config.schema.json

Honeywell Total Connect Comfort support for Homebridge: https://github.com/nfarina/homebridge

{
  "pluginAlias": "tcc",
  "pluginType": "platform",
  "singular": true,
  "headerDisplay": "<p align='center'><img width='250px' src='https://user-images.githubusercontent.com/3979615/71876008-d99d7400-3179-11ea-909b-9d2a3d1e670f.png'></p>\n\nThe **Homebridge TCC** plugin allows you to control your North American Honeywell Total Comformt Connect thermostats from HomeKit.",
  "footerDisplay": "",
  "schema": {
    "type": "object",
    "properties": {
      "name": {
        "type": "string",
        "title": "Name",
        "default": "Thermostat",
        "required": true,
        "description": "Can be anything you want, this is only used in the homebridge logs and is not the thermostat name."
      },
      "username": {
        "title": "Username",
        "type": "string",
        "required": true,
        "description": "Your Honeywell E-mail."
      },
      "password": {
        "title": "Password",
        "type": "string",
        "required": true,
        "description": "Your Honeywell password."
      },
      "usePermanentHolds": {
        "title": "Use Permanent Holds",
        "type": "boolean",
        "required": false,
        "description": "If set to true, temperature changes will be set as permanent holds, rather than temporary holds. This will allow you to use HomeKit automations to completely replace your thermostat's schedule. If set to false, the temperature changes will expire after a certain period of time and resume your normal schedule. By default, this is off."
      },
      "sensors": {
        "title": "Sensors",
        "type": "string",
        "description": "Create temperature and humidity HomeKit sensors that are useful for automations, defaults to none.",
        "default": "none",
        "required": true,
        "oneOf": [
          {
            "title": "None (default)",
            "enum": ["none"]
          },
          {
            "title": "Indoor temperature and humidity",
            "enum": ["inside"]
          },
          {
            "title": "Indoor humidity",
            "enum": ["insideHumidity"]
          },
          {
            "title": "Outdoor temperature and humidity",
            "enum": ["outside"]
          },
          {
            "title": "All available",
            "enum": ["all"]
          }
        ]
      },
      "refresh": {
        "title": "Refresh Token",
        "default": 600,
        "type": "integer",
        "minimum": 30,
        "maximum": 3600,
        "description": "Data polling interval in seconds, defaults to 10 minutes.  Setting lower than 10 minutes may trigger request rate limiter on Honeywell site."
      },
      "storage": {
        "title": "Storage",
        "type": "string",
        "required": true,
        "description": "Storage of chart graphing data for history graphing, either fs or googleDrive, defaults to fs.",
        "default": "fs",
        "oneOf": [
          {
            "title": "File System (default)",
            "enum": ["fs"]
          },
          {
            "title": "Google Drive",
            "enum": ["googleDrive"]
          }
        ]
      },
      "debug": {
        "title": "Debug Logging",
        "type": "boolean",
        "required": false,
        "description": "Enable DEBUG logging for homebridge-tcc"
      }
    }
  },
  "layout": [
    {
      "type": "fieldset",
      "title": "Thermostat",
      "items": ["username", "password", "sensors", "usePermanentHolds"]
    },
    {
      "type": "fieldset",
      "title": "Optional Settings",
      "expandable": true,
      "expanded": false,
      "items": ["refresh", "storage", "debug"]
    }
  ]
}