homebridge-airthings/config.schema.json

A Homebridge plugin for Airthings air quality monitors via the Airthings Consumer API.

{
  "pluginAlias": "Airthings",
  "pluginType": "accessory",
  "footerDisplay": "Generating a Client ID & Secret: [Airthings Dashboard](https://dashboard.airthings.com) -> Integrations -> Request API Client",
  "schema": {
    "type": "object",
    "properties": {
      "name": {
        "title": "Name",
        "type": "string",
        "required": true,
        "default": "Airthings Device"
      },
      "clientId": {
        "title": "Client ID",
        "type": "string",
        "required": true
      },
      "clientSecret": {
        "title": "Client Secret",
        "type": "string",
        "required": true
      },
      "serialNumber": {
        "title": "Serial Number",
        "type": "string",
        "required": true
      },
      "co2AirQualityDisabled": {
        "title": "CO₂ Disabled in Air Quality Sensor",
        "type": "boolean",
        "required": false
      },
      "humidityAirQualityDisabled": {
        "title": "Humidity Disabled in Air Quality Sensor",
        "type": "boolean",
        "required": false
      },
      "pm25AirQualityDisabled": {
        "title": "PM2.5 Disabled in Air Quality Sensor",
        "type": "boolean",
        "required": false
      },
      "radonAirQualityDisabled": {
        "title": "Radon Disabled in Air Quality Sensor",
        "type": "boolean",
        "required": false
      },
      "vocAirQualityDisabled": {
        "title": "VOC Disabled in Air Quality Sensor",
        "type": "boolean",
        "required": false
      },
      "co2DetectedThreshold": {
        "title": "CO₂ Detected Threshold (ppm)",
        "type": "number",
        "required": false,
        "placeholder": 1000
      },
      "radonLeakThreshold": {
        "title": "Radon Leak Threshold (Bq/m³)",
        "type": "number",
        "required": false
      },
      "debug": {
        "title": "Debug Logging",
        "type": "boolean",
        "required": false
      },
      "refreshInterval": {
        "title": "Airthings API Refresh Interval (seconds)",
        "type": "number",
        "required": false,
        "placeholder": 150
      },
      "tokenScope": {
        "title": "Airthings API Token Scope",
        "type": "string",
        "required": false,
        "placeholder": "read:device:current_values"
      }
    }
  },
  "layout": [
    {
      "type": "section",
      "title": "General Settings",
      "expandable": true,
      "expanded": true,
      "items": [
        {
          "items": [
            "name",
            "clientId",
            "clientSecret",
            "serialNumber"
          ]
        }
      ]
    },
    {
      "type": "section",
      "title": "Sensor Settings (Optional)",
      "expandable": true,
      "expanded": false,
      "items": [
        {
          "items": [
            "co2AirQualityDisabled",
            "humidityAirQualityDisabled",
            "pm25AirQualityDisabled",
            "radonAirQualityDisabled",
            "vocAirQualityDisabled",
            "co2DetectedThreshold",
            "radonLeakThreshold"
          ]
        }
      ]
    },
    {
      "type": "section",
      "title": "Advanced Settings (Optional)",
      "expandable": true,
      "expanded": false,
      "items": [
        {
          "items": [
            "debug",
            "refreshInterval",
            "tokenScope"
          ]
        }
      ]
    }
  ]
}