homebridge-airkorea

Homebridge plugin for the AirKorea API

Installation

1. Install homebridge using the instructions at https://github.com/nfarina/homebridge#installation
2. Install this plugin using: npm install -g https://github.com/slasherLee/homebridge-airkorea
3. Register for an account and get an API key at http://www.data.go.kr
4. Update the Homebridge configuration file

Configuration

Example config.json:

"accessories": [
  {
    "accessory": "AirKorea",
    "name": "AirKorea",
    "sensor": "air_quality",
    "api_key": "",
    "station": "",
    "creteria": "",
    "interval": 60,
    "polling": true
  }
],

Details

Field | Required | Default | Description :--- | :---: | :---: | :--- accessory | yes | AirKorea | Must always be AirKorea name | yes | AirKorea | Can be specified by user api_key | yes | | Obtain from http://www.data.go.kr sensor | no | air_quality | Must be air_quality station | yes | | Search station name from http://www.data.go.kr creteria | no | khai | You can choose "khai|pm10|pm25" or "khai|pm10" or "pm25" interval | no | 60(minutes) | Can be specified by user, minutes(must be a number) polling | no | false | Must be true or false (must be a boolean, not a string)