homebridge-air-quality

1.1.3 • Public • Published

Homebridge-air-quality

Homebridge plugin to show informations about air quality, temperature and humidity, provided by Airly.

Plugin inspired by homenridge-airly.

Instalation

NPM

  1. Install required package: npm install -g homebridge-air-quality.
  2. Create new account in Airly.eu https://developer.airly.eu/register and get your individual API Key.
  3. Find your coordinates (latitude and longitude). You should be in range of minimum one sensor.
  4. Update your configuration file, including API Key, coordinates, and select which sensors to show in HomeApp.

Configuration

"accessories"[
    {
         "accessory":"AirQuality",
         "name":"Air Quality",
         "apikey":"YOUR_API_KEY",
         "latitude":"YOUR_LATITUDE",
         "longitude":"YOUR_LONGITUDE",
         "pollingInterval":300,
         "showAirQualityIndex":true,
         "airQualityIndexName":"Air Quality",
         "showHumidity":true,
         "humidityName":"Humidity",
         "showTemperature":true,
         "temperatureName":"Temperature"
    }
]

Settings

  • accessory must be "AirQuality" (required)
  • name of the accessory
  • apikey API key from Airly Developers (required)
  • latitude your latitude e.g. "52.333658" (required)
  • longitude your longitude e.g. "20.886986" (required)
  • pollingInterval how often fetch new data from Airly, in seconds (optional, default to 300)
  • showAirQualityIndex show or hide air quality sensor (optional, default to false)
  • airQualityIndexName name of air quality sensor (optional, default to "Air Quality")
  • showHumidity show or hide humidity sensor (optional, default to false)
  • humidityName name of humidity sensor (optional, default to "Humidity")
  • showTemperature show or hide temperature sensor (optional, default to false)
  • temperatureName name of temperature sensor (optional, default to "Temperature")

Minimal configuration

Minimal configuration consists only 4 lines, but nothing will be shown in HomeApp. You should set true to at least one option witch begins with show....

"accessories"[
    {
         "accessory":"AirQuality",
         "name":"Air Quality",
         "apikey":"YOUR_API_KEY",
         "latitude":"YOUR_LATITUDE",
         "longitude":"YOUR_LONGITUDE",
    }
]

Package Sidebar

Install

npm i homebridge-air-quality

Weekly Downloads

36

Version

1.1.3

License

GPL-3.0

Unpacked Size

9.61 kB

Total Files

4

Last publish

Collaborators

  • mrysz