README.md

MMM-AirNow

This is a module for the MagicMirror. This module shows air quality based on the US AirNow API.

Installation

1. Navigate into your MagicMirror's modules folder and execute git clone https://github.com/nigel-daniels/MMM-AirNow. A new folder MMM-AirNow will appear, navigate into it.
2. Execute npm install to install the node dependencies.

Config

The entry in config.js can include the following options:

Option	Description
api_key	Required This is the API key you need to use to request Air Quality Index (AQI) data from the AirNow site. To request an API key visit the AirNow API site here Type: string Default Value: null
zip_code	Required The US location about which you are requesting AQI data. Type: string Default value: null
interval	How often the weather is updated. Type: integer Default value: 900000 // 15 minutes

Here is an example of an entry in config.js

{
    module:		'MMM-AirNow',
    position:	'top_left',
    config:		{
                api_key:	'your-api-key',
                zip_code:	'20500'
                }
},

Dependencies

• request (installed via npm install)

Notes

Enjoy this module it's a port of one I had in a home-brew mirror project I had prior to moving to using MM2.

Thanks To...

• Michael Teeuw for the MagicMirror2 framework that made this module possible.
• Sam Lewis whose MMM-Traffic module I use and whose code I learnt a great deal from.
• AirNow API Site for the helpful guides and information they publish on their APIs.