homebridge-eveatmo/config.schema.json

Homebridge plugin which adds a Netatmo weatherstation as HomeKit device and tries to act like Elgato Eve Room/Weather

{
  "pluginAlias": "eveatmo",
  "pluginType": "platform",
  "singular": true,
  "headerDisplay": "Homebridge plugin for the Netatmo Weatherstation",
  "footerDisplay": "For a detailed description, see the [README](https://github.com/skrollme/homebridge-eveatmo#readme) file.",
  "schema": {
    "type": "object",
    "properties": {
      "name": {
        "title": "Name",
        "type": "string",
        "default": "eveatmo platform",
        "required": true
      },
      "ttl": {
        "title": "TTL",
        "type": "integer",
        "default": 540,
        "minimum": 300,
        "description": "Seconds between two Netatmo API polls (default 540)"
      },
      "extra_aq_sensor": {
        "title": "Extra AirQuality sensor",
        "type": "boolean",
        "default": true,
        "description": "Adds an extra AirQuality sensor reporting CO2 level"
      },
      "extra_co2_sensor": {
        "title": "Extra CO2 sensor",
        "type": "boolean",
        "default": false,
        "description": "Adds an extra CO2 sensor for alerts"
      },
      "weatherstation": {
        "title": "Weatherstation",
        "type": "boolean",
        "default": true,
        "description": "Activate Netatmo Weatherstation reporting"
      },
      "airquality": {
        "title": "Air Quality Monitor",
        "type": "boolean",
        "default": false,
        "description": "Activate Netatmo Air Quality Monitor reporting"
      },
      "co2_alert_threshold": {
        "title": "CO2 alert threshold",
        "type": "integer",
        "default": 1000,
        "minimum": 450,
        "description": "Sets the CO2-level in ppm at which the sensors switches to alert-state"
      },
      "module_suffix": {
        "title": "Name suffix",
        "type": "string",
        "description": "Suffix to the module name. Deletes the prepended Netatmo device name"
      },
      "log_info_msg": {
        "title": "Log info messages",
        "type": "boolean",
        "default": true,
        "description": "Outputs log messages with loglevel set to info"
      },
      "auth": {
        "title": "Netatmo credentials",
        "type": "object",
        "properties": {
          "client_id": {
            "title": "Client ID",
            "type": "string",
            "required": true,
            "description": "Create this at https://dev.netatmo.com/"
          },
          "client_secret": {
            "title": "Client secret",
            "type": "string",
            "required": true,
            "description": "Create this at https://dev.netatmo.com/"
          },
          "grant_type": {
            "title": "grant_type",
            "type": "string",
            "required": true,
            "default": "refresh_token",
            "oneOf": [
              {
                "title": "refresh_token",
                "enum": [
                  "refresh_token"
                ]
              },
              {
                "title": "password",
                "enum": [
                  "password"
                ]
              }
            ],
            "description": "use either 'password' or 'refresh_token'. Please see https://github.com/skrollme/homebridge-eveatmo/blob/master/README.md for more information"
          },
          "refresh_token": {
            "title": "Refresh Token",
            "type": "string",
            "required": false,
            "description": "Necessary, if you use grant_type='refresh_token'. A valid Netatmo refreshToken. You can generate this on the page where you got the 'client_id' and 'client_secret' from"
          },
          "username": {
            "title": "Username",
            "type": "string",
            "required": false,
            "description": "Necessary, if you use grant_type='password'. The email-address of your Netatmo account. Must be the same account as the developer app which the 'client_id' and 'client_secret' belong to"
          },
          "password": {
            "title": "Password",
            "type": "string",
            "required": false,
            "description": "Necessary, if you use grant_type='password'. The password of your Netatmo account. Must be the same account as the developer app which the 'client_id' and 'client_secret' belong to"
          }
        }
      }
    }
  }
}