Skip to content
A module for the MagicMirror, to display the current air quality index of a certain location.
JavaScript
Branch: master
Clone or download
Latest commit a0f1ce4 May 14, 2017
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
LICENSE Initial commit Mar 30, 2016
MMM-AirQuality.js change module name May 14, 2017
README.md Update README.md May 14, 2017
String.format.js change rendering method Apr 1, 2016
aqiFeed.js initial commit Mar 30, 2016

README.md

AirQuality-Module for the MagicMirror

MagicMirror Project on Github | Air Quality Index

bildschirmfoto 2016-03-31 um 23 08 38

Usage

You need to install the module for your MagicMirror.

Installation

Navigate into your MagicMirror's modules folder:

cd ~/MagicMirror/modules

Clone this repository:

git clone https://github.com/CFenner/MMM-AirQuality

Configure the module in your config.js file.

Configuration

To run the module, you need to add the following data to your config.js file.

{
	module: 'MMM-AirQuality',
	position: 'top_center', // you may choose any location
	config: {
	  location: 'beijing' // the location to check the index for
	}
}

Location

Use the part behind http://aqicn.org/city/ for your location. For example http://aqicn.org/city/netherland/utrecht/griftpark/ would be:

location: 'netherland/utrecht/griftpark/'

You may want to set the following options in the config section as well:

Option Description
location The location for that you you want to show the air quality.

This is REQUIRED.
lang change the language

This is OPTIONAL.
Default value: en
updateInterval change the update period in minutes

This is OPTIONAL.
Default value: 30 (minutes)
showLocation toggle location printing

This is OPTIONAL.
Default value:true
showIndex toggle index printing

This is OPTIONAL.
Default value:true

Known Issues

Due to the AQI rendering script it is not possible to have multiple instances of this module running.

There is a bug in the skript that prevent some locations from being displayed (e.g. 'Mannheim').

Not all languages may be supported (see: http://aqicn.org/faq/2015-07-28/air-quality-widget-new-improved-feed/).

You can’t perform that action at this time.