bobaejeon / fineDust

MagicMirror module: displays air pollution level(especially fine dust level)

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

MagicMirror² Module: fineDust

Simply displays air pollution status in Korean English(update 26.8.2020). It shows the level of the pollution depends on the type.

This module is based on AirVisual API. Get an APIkey, write it in config, then it's all done.

Installation

cd ~/MagicMirror/modules
git clone https://github.com/bobaejeon/fineDust.git
cd fineDust
npm install

Configuration

Add this module to the modules array in the config/config.js. You can copy this and make some changes:

    {
        module: 'fineDust',
        position: 'top_right',
        config: {
                    //stated below
                }
    },

Configuration options

Option Description Possible values
apiKey [required] The AirVisual APIKey to get the pollution data.

Default: null
APIkey you've got from AirVisual
updateInterval [optional] How often the information will be updated.

Default: 10 * 60 * 1000 // every 10 minutes
60 * 1000 // every minute
animationSpeed [optional] The speed of the update animation in milliseconds.

Default: 1000 // 1 second
500 // 0.5 second

About

MagicMirror module: displays air pollution level(especially fine dust level)


Languages

Language:JavaScript 93.5%Language:CSS 6.5%