config.schema.json

{
  "pluginAlias": "HoneywellHome",
  "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 Honeywell Home** plugin allows you to control Honeywell Home thermostats and also view your Leak and Room Sensors from HomeKit. \n\nTo get started link your Honeywell Home account using the button below.",
  "footerDisplay": "Your Honeywell Home account has been linked. Please raise any issues on our [project page](https://github.com/donavanbecker/homebridge-honeywell-home/issues).\n\nIf you would like to have other Honeywell Devices besides Thermostat, Leak Sensors, or Room Sensors added to this plugin fill out [Feature Request Form](https://github.com/donavanbecker/homebridge-honeywell-home/issues/new?assignees=&labels=&template=feature_request.md).",
  "schema": {
    "type": "object",
    "properties": {
      "name": {
        "type": "string",
        "title": "Name",
        "default": "HoneywellHome",
        "required": true
      },
      "credentials": {
        "type": "object",
        "properties": {
          "consumerKey": {
            "title": "Consumer Key",
            "type": "string",
            "required": true
          },
          "consumerSecret": {
            "title": "Consumer Secret",
            "type": "string"
          },
          "refreshToken": {
            "title": "Refresh Token",
            "type": "string",
            "required": true
          },
          "notice": {
            "title": "Notice",
            "type": "string",
            "required": true,
            "default": "Keep your tokens a secret!"
          }
        }
      },
      "options": {
        "type": "object",
        "properties": {
          "refreshRate": {
            "title": "Refresh Rate",
            "type": "number",
            "minimum": 120,
            "placeholder": 900,
            "description": "Indicates the number of seconds between polls of the Honeywell Home service."
          },
          "pushRate": {
            "title": "Push Rate",
            "type": "number",
            "placeholder": 1,
            "description": "Indicates the number of seconds between pushes to Honewell Home API."
          },
          "hide_device": {
            "title": "Hide Device",
            "type": "array",
            "items": {
              "type": "string"
            }
          },
          "thermostat": {
            "title": "Thermostat",
            "type": "object",
            "properties": {
              "hide_fan": {
                "title": "Hide Thermostat Fan",
                "type": "boolean",
                "requried": false
              },
              "hide_humidity": {
                "title": "Hide Humidity Service",
                "type": "boolean",
                "required": false
              },
              "thermostatSetpointStatus": {
                "title": "Thermostat Setpoint Status",
                "type": "string",
                "description": "For \"LCC-\" devices only. \"PermanentHold\" will hold the setpoint until user requests another change. \"NoHold\" will return to schedule. \"TemporaryHold\" will hold the set temperature until \"nextPeriodTime\".",
                "required": true,
                "default": "PermanentHold",
                "oneOf": [
                  {
                    "title": "No Hold",
                    "enum": [
                      "NoHold"
                    ]
                  },
                  {
                    "title": "Permanent Hold",
                    "enum": [
                      "PermanentHold"
                    ]
                  },
                  {
                    "title": "Temporary Hold",
                    "enum": [
                      "TemporaryHold"
                    ]
                  }
                ]
              }
            }
          },
          "leaksensor": {
            "title": "Leak Sensor",
            "type": "object",
            "properties": {
              "hide_leak": {
                "title": "Hide Leak Service",
                "type": "boolean",
                "required": false
              },
              "hide_temperature": {
                "title": "Hide Temperature Service",
                "type": "boolean",
                "required": false
              },
              "hide_humidity": {
                "title": "Hide Humidity Service",
                "type": "boolean",
                "required": false
              }
            }
          },
          "roomsensor": {
            "title": "Room Sensor",
            "type": "object",
            "properties": {
              "hide_temperature": {
                "title": "Hide Temperature Service",
                "type": "boolean",
                "requried": false
              },
              "hide_humidity": {
                "title": "Hide Humidity Service",
                "type": "boolean",
                "requried": false
              },
              "hide_occupancy": {
                "title": "Hide Occupancy Service",
                "type": "boolean",
                "requried": false
              }
            }
          },
          "roompriority": {
            "title": "Room Priority",
            "type": "object",
            "properties": {
              "thermostat": {
                "title": "Thermostat Room Priority",
                "type": "boolean",
                "requried": false
              },
              "priorityType": {
                "title": "Priority Type",
                "type": "string",
                "required": true,
                "default": "PickARoom",
                "oneOf": [
                  {
                    "title": "Pick A Room",
                    "enum": [
                      "PickARoom"
                    ]
                  },
                  {
                    "title": "Whole House",
                    "enum": [
                      "WholeHouse"
                    ]
                  },
                  {
                    "title": "Follow Me",
                    "enum": [
                      "FollowMe"
                    ]
                  }
                ]
              }
            }
          }
        }
      },
      "devicediscovery": {
        "name": "Device Discovery",
        "type": "boolean"
      }
    }
  },
  "layout": [
    {
      "type": "fieldset",
      "title": "Honeywell Home Account Info",
      "expandable": true,
      "expanded": false,
      "items": [
        {
          "type": "help",
          "helpvalue": "<h5></h5><em class='primary-text'>This is for Manual Setup Only.</em>"
        },
        "name",
        "credentials.consumerKey",
        "credentials.consumerSecret",
        "credentials.refreshToken"
      ]
    },
    {
      "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 the Honeywell Home service.</em>"
        },
        {
          "key": "options.refreshRate",
          "notitle": true
        },
        {
          "type": "help",
          "helpvalue": "<h5>Push Rate</h5><em class='primary-text'>Push Rate indicates the number of seconds between pushes to Honeywell Home API.</em>"
        },
        {
          "key": "options.pushRate",
          "notitle": true
        },
        {
          "type": "fieldset",
          "title": "Hidden Devices",
          "expandable": true,
          "expanded": false,
          "items": [
            {
              "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": "LLC-81F3UT59513F"
                    }
                  ]
                }
              ]
            }
          ]
        },
        {
          "type": "fieldset",
          "title": "Thermostat Options",
          "expandable": true,
          "expanded": false,
          "items": [
            "options.thermostat.thermostatSetpointStatus",
            {
              "type": "help",
              "helpvalue": "<h5>Hide Thermostat Fan Service</h5><em class='primary-text'>Allows you to hide your Thermostat's Fan.</em>"
            },
            "options.thermostat.hide_fan",
            "options.thermostat.hide_humidity",
            {
              "type": "fieldset",
              "title": "Room Sensor Options",
              "expandable": true,
              "expanded": false,
              "items": [
                {
                  "type": "help",
                  "helpvalue": "<h5>Hide Room Sensor Services</h5><em class='primary-text'>Allows you to hide your tempeture sensor, occupancy sensor, or humidity sensor of your Room Sensor(s).</em>"
                },
                "options.roomsensor.hide_temperature",
                "options.roomsensor.hide_occupancy",
                "options.roomsensor.hide_humidity",
                {
                  "type": "fieldset",
                  "title": "Room Priority Options",
                  "expandable": true,
                  "expanded": false,
                  "items": [
                    {
                      "type": "help",
                      "helpvalue": "<em class='primary-text'>Allows you to set your Priority to your Room Sensor(s).</em>"
                    },
                    "options.roompriority.thermostat",
                    "options.roompriority.priorityType"
                  ]
                }
              ]
            }
          ]
        },
        {
          "type": "fieldset",
          "title": "Leak Sensor Options",
          "expandable": true,
          "expanded": false,
          "items": [
            {
              "type": "help",
              "helpvalue": "<h5>Hide Leak Sensor Services</h5><em class='primary-text'>Allows you to hide your Leak Sensor's tempeture sensor, leak sensor, or humidity sensor.</em>"
            },
            "options.leaksensor.hide_temperature",
            "options.leaksensor.hide_leak",
            "options.leaksensor.hide_humidity"
          ]
        },
        {
          "type": "help",
          "helpvalue": "<h5>Device Discovery</h5><em class='primary-text'>Enables Device Info Logging.</em>"
        },
        {
          "key": "devicediscovery",
          "title": "Device Discovery"
        }
      ]
    }
  ]
}