config.schema.json

{
  "pluginAlias": "HomebridgeIthoDaalderop",
  "pluginType": "platform",
  "singular": true,
  "headerDisplay": "Please [read the README](https://github.com/jvandenaardweg/homebridge-itho-daalderop#readme) of the plugin for more information and instructions on how to configure it.",

  "schema": {
    "type": "object",
    "properties": {
      "name": {
        "title": "Bridge name",
        "type": "string",
        "required": true,
        "placeholder": "Itho Daalderop",
        "description": "You'll see this name when you add the bridge in your Home app and also in the logs within Homebridge.",
        "default": "Itho Daalderop"
      },
      "verboseLogging": {
        "title": "Verbose Logging",
        "type": "boolean",
        "required": false,
        "default": false,
        "description": "If enabled, the plugin will log all debug messages. If everything works as expected, there's no need to enable this."
      },
      "device": {
        "type": "object",
        "title": "Device properties",

        "properties": {
          "co2Sensor": {
            "title": "Using built-in CO2 Sensor",
            "type": "boolean",
            "required": false,
            "default": false
          },
          "nonCve": {
            "title": "Is a HRU-350, DemandFlow, QualityFlow or HRU Eco Fan",
            "type": "boolean",
            "required": false,
            "default": false
          }
        }
      },
      "api": {
        "type": "object",
        "title": "MQTT Broker settings",
        "description": "",
        "properties": {
          "protocol": {
            "title": "API Protocol",
            "type": "string",
            "required": true,
            "default": "mqtt",
            "oneOf": [
              {
                "title": "HTTP",
                "enum": ["http"]
              },
              {
                "title": "MQTT",
                "enum": ["mqtt"]
              }
            ]
          },
          "ip": {
            "type": "string",
            "title": "IP Address",
            "placeholder": "192.168.0.10",
            "format": "ipv4",
            "required": true
          },
          "port": {
            "type": "number",
            "title": "Port",
            "placeholder": "1883 (mqtt) or 80 (http)",
            "required": true
          },
          "username": {
            "type": "string",
            "title": "Username",
            "placeholder": "Optional",
            "required": false
          },
          "password": {
            "type": "string",
            "title": "Password",
            "placeholder": "Optional",
            "required": false
          }
        }
      }
    }
  },
  "layout": [
    {
      "type": "flex",
      "flex-flow": "row wrap",
      "orderable": false,
      "items": [
        {
          "key": "name",
          "type": "name"
        }
      ]
    },
    {
      "type": "fieldset",
      "title": "Device properties",
      "expandable": false,
      "orderable": false,
      "items": [
        {
          "items": [
            {
              "key": "device.co2Sensor",
              "description": "Indicate wether your fan is using the built-in CO2 sensor. If so, the plugin will automatically switch to using virtual remote commands like low, medium or high instead of rotation speed 0 - 100 to set the fan speed. <a href='https://github.com/jvandenaardweg/homebridge-itho-daalderop#about-manual-speed-control'>More about this in the README</a>."
            },
            {
              "key": "device.nonCve",
              "description": "Indicate if your device is a non-CVE device like HRU-350, DemandFlow, QualityFlow or HRU Eco Fan. If so, the plugin will automatically switch to using virtual remote commands like low, medium or high instead of rotation speed 0 - 100 to set the fan speed. <a href='https://github.com/jvandenaardweg/homebridge-itho-daalderop#about-manual-speed-control'>More about this in the README</a>."
            }
          ]
        }
      ]
    },
    {
      "type": "fieldset",
      "title": "API Settings",
      "description": "Select which API protocol you want to use for this plugin. The HTTP API requires no additional setup. In order to use MQTT you must have set up a MQTT broker on your network. <a href='https://github.com/jvandenaardweg/homebridge-itho-daalderop#mqtt'>More about this in the README</a>.",
      "expandable": false,
      "orderable": false,
      "items": [
        {
          "type": "flex",
          "flex-flow": "row wrap",
          "items": [
            {
              "type": "flex",
              "flex-flow": "row wrap",
              "items": [
                {
                  "key": "api.protocol"
                },
                {
                  "key": "api.ip"
                },
                {
                  "key": "api.port"
                }
              ]
            },
            {
              "type": "flex",
              "flex-flow": "row wrap",
              "items": [
                {
                  "key": "api.username"
                },
                {
                  "key": "api.password"
                },
                {
                  "key": "",
                  "description": "The Itho WiFi module allows setting a username and password for using the HTTP API or MQTT. If you have set this, enter the username and password here."
                }
              ]
            },
            {
              "type": "flex",
              "flex-flow": "row wrap",
              "items": [
                {
                  "key": "verboseLogging"
                }
              ]
            }
          ]
        }
      ]
    }
  ]
}