tomsinger / mmm-forecast-io

Forecast.io Module for MagicMirror

MMM-Forecast-IO

This an extension for MagicMirror that adds localized weather using the forecast.io API -- the same service that powers the Dark Sky App.

This module makes use of the geolocation API to determine the location of the mirror. This can be turned off by setting latitude and longitude in the module's config (see Configuration options below).

Unfortunately, Geolocation will currently not work with MagicMirror's Electron-based browser wrapper because of a known issue: electron/electron#6648 If you are using MagicMirror headless with your own browser this shouldn't be a problem.

Using the module

To use this module, add it to the modules array in the config/config.js file:

modules: [
  {
    module: 'MMM-forecast-io',
    position: 'top_right',  // This can be any of the regions.
    config: {
      // See 'Configuration options' for more information.
      apiKey: 'abcde12345abcde12345abcde12345ab' // forecast.io API key.
      // Only required if geolocation doesn't work:
      latitude:   16.77532,
      longitude: -3.008265
    }
  }
]

Configuration options

Option	Description
apiKey	The Forecast.io API key, which can be obtained by creating an Forecast.io account. This value is REQUIRED
units	What units to use. Specified by config.js Possible values: config.units = Specified by config.js, default = Kelvin, metric = Celsius, imperial =Fahrenheit Default value: config.units
language	The language of the weather text. Possible values: en, nl, ru, etc ... Default value: uses value of config.language
updateInterval	How often does the content needs to be fetched? (Milliseconds) Forecast.io enforces a 1,000/day request limit, so if you run your mirror constantly, anything below 90,000 (every 1.5 minutes) may require payment information or be blocked. Possible values: 1000 - 86400000 Default value: 300000 (5 minutes)
animationSpeed	Speed of the update animation. (Milliseconds) Possible values:0 - 5000 Default value: 2000 (2 seconds)
initialLoadDelay	The initial delay before loading. If you have multiple modules that use the same API key, you might want to delay one of the requests. (Milliseconds) Possible values: 1000 - 5000 Default value: 0
retryDelay	The delay before retrying after a request failure. (Milliseconds) Possible values: 1000 - 60000 Default value: 2500
latitude	The latitude location in decimal. Set this (and longitude) as the location for the forecast. If this is not set, the module will attempt to approximate using browser geolocation. Example value: 16.77532 Default value: null
longitude	The longitude location in decimal. Set this (and latitude) as the location for the forecast. If this is not set, the module will attempt to approximate using browser geolocation. Example value: -3.008265 Default value: null
apiBase	The Forecast.io base URL. Default value: 'https://api.forecast.io/forecast'
iconTable	The conversion table to convert the weather conditions to weather-icons. Default value: iconTable: { 'clear-day': 'wi-day-sunny', 'clear-night': 'wi-night-clear', 'rain': 'wi-rain', 'snow': 'wi-snow', 'sleet': 'wi-rain-mix', 'wind': 'wi-cloudy-gusts', 'fog': 'wi-fog', 'cloudy': 'wi-cloudy', 'partly-cloudy-day': 'wi-day-cloudy', 'partly-cloudy-night': 'wi-night-cloudy', 'hail': 'wi-hail', 'thunderstorm': 'wi-thunderstorm', 'tornado': 'wi-tornado' }