homebridge-daikin-oneplus/config.schema.json

Control a Daikin One+ thermostat.

{
  "pluginAlias": "DaikinOnePlus",
  "pluginType": "platform",
  "singular": true,
  "headerDisplay": "All devices associated with the configured Daikin account will be loaded as accessories.\nYou must have a Daikin One+ Smart Thermostat and Daikin cloud account for this plugin to work.",
  "footerDisplay": "See the [homebridge-daikin-oneplus](https://github.com/jeffschubert/homebridge-daikin-oneplus) developer page for detailed documentation, and to submit feature requests and bug reports.",
  "schema": {
    "type": "object",
    "properties": {
      "name": {
        "title": "Name",
        "type": "string",
        "required": true,
        "default": "Daikin One Plus"
      },
      "user": {
        "title": "Daikin Username",
        "type": "string",
        "required": true,
        "x-schema-form": {
          "type": "username"
        }
      },
      "password": {
        "title": "Daikin Password",
        "type": "string",
        "required": true,
        "x-schema-form": {
          "type": "password"
        }
      },
      "debug": {
        "title": "Debug Logging",
        "type": "boolean",
        "required": false,
        "description": "Enables debug level logging. Defaults to false."
      },
      "includeDeviceName": {
        "title": "Include Device Name",
        "description": "Include device name as part of the default sensor name.",
        "type": "boolean",
        "default": false
      },
      "ignoreThermostat": {
        "title": "Ignore Thermostat(s)",
        "description": "Do not load thermostats found in Daikin account.",
        "type": "boolean",
        "default": false
      },
      "ignoreOutdoorTemp": {
        "title": "Ignore Outdoor Temperature",
        "description": "Do not load outdoor temperature data of thermostats found in Daikin account.",
        "type": "boolean",
        "default": false
      },
      "ignoreIndoorAqi": {
        "title": "Ignore Indoor Air Quality Sensor(s)",
        "description": "Do not load indoor air quality sensors of thermostats found in Daikin account.",
        "type": "boolean",
        "default": false
      },
      "ignoreOutdoorAqi": {
        "title": "Ignore Outdoor Air Quality Sensor(s)",
        "description": "Do not load outdoor air quality sensors of thermostats found in Daikin account.",
        "type": "boolean",
        "default": false
      },
      "ignoreIndoorHumSensor": {
        "title": "Ignore Indoor Humidity Sensor(s)",
        "description": "Do not load indoor humidity sensors of thermostats found in Daikin account.",
        "type": "boolean",
        "default": false
      },
      "ignoreOutdoorHumSensor": {
        "title": "Ignore Outdoor Humidity Sensor(s)",
        "description": "Do not load outdoor humidity sensors of thermostats found in Daikin account.",
        "type": "boolean",
        "default": false
      },
      "enableScheduleSwitch": {
        "title": "Enable Schedule Switch",
        "description": "Enable switch to get/set the Schedule state of thermostats found in Daikin account.",
        "type": "boolean",
        "default": false
      },
      "enableAwaySwitch": {
        "title": "Enable Away Switch",
        "description": "Enable switch to get/set the Away state of thermostats found in Daikin account.",
        "type": "boolean",
        "default": false
      },
      "enableStateSwitches": {
        "title": "Enable System State Switches",
        "description": "Enable read-only switches for each potential running state of thermostats found in Daikin account. Can be used to trigger automations when the thermostat changes to a particular state.",
        "type": "boolean",
        "default": false
      },
      "enableEmergencyHeatSwitch": {
        "title": "Enable Emergency Heat Switch",
        "description": "Enable switch to request auxiliary/emergency heat only",
        "type": "boolean",
        "default": false
      },
      "enableOneCleanFan": {
        "title": "Enable One Clean Fan",
        "description": "Enable fan that allows the user to run one clean.",
        "type": "boolean",
        "default": false
      },
      "enableCirculateAirFan": {
        "title": "Enable Circulate Air Fan",
        "description": "Enable fan that allows the user to run the fan constantly at the specified speed.",
        "type": "boolean",
        "default": false
      },
      "autoResumeSchedule": {
        "title": "Enable Schedule after Away",
        "description": "When the Away switch is toggled off, automatically enable the schedule.",
        "type": "boolean",
        "default": false
      },
      "logRaw": {
        "title": "Device Data Logging",
        "type": "boolean",
        "description": "Enables logging of raw device data from Daikin API. Debug logging must also be enabled. Defaults to false. <br>WARNING: May include sensitive or identifying information. Review before sharing. Will also significantly increase log size.",
        "default": false
      }
    }
  },
  "layout": [
    {
      "type": "section",
      "title": "General",
      "expandable": true,
      "expanded": true,
      "items": [
        {
          "description": "Enter your Daikin credentials here.",
          "items": [
            "user",
            "password",
            "name"
          ]
        }
      ]
    },
    {
      "type": "section",
      "title": "Sensor Setup",
      "expandable": true,
      "expanded": false,
      "description": "Specify whether specific sensors should not be loaded on start up.",
      "items": [
        "ignoreThermostat",
        "ignoreIndoorAqi",
        "ignoreOutdoorAqi",
        "ignoreIndoorHumSensor",
        "ignoreOutdoorHumSensor",
        "ignoreOutdoorTemp"
      ]
    },
    {
      "type": "section",
      "title": "Optional Accessories",
      "expandable": true,
      "expanded": false,
      "description": "Extra accessories to control specific aspects of the thermostat.",
      "items": [
        "enableScheduleSwitch",
        "enableAwaySwitch",
        "enableStateSwitches",
        "autoResumeSchedule",
        "enableEmergencyHeatSwitch",
        "enableOneCleanFan",
        "enableCirculateAirFan"
      ]
    },
    {
      "type": "section",
      "title": "Advanced Options",
      "expandable": true,
      "expanded": false,
      "items": [
        "debug",
        "logRaw",
        "includeDeviceName"
      ]
    }]
}