currentweather

Module: Current Weather

The currentweather module is one of the default modules of the MagicMirror. This module displays the current weather, including the windspeed, the sunset or sunrise time, the temperature and an icon to display the current conditions.

Using the module

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

modules: [
	{
		module: 'currentweather',
		position: 'top_right',	// This can be any of the regions.
									// Best results in left or right regions.
		config: {
			// See 'Configuration options' for more information.
			location: 'Amsterdam,Netherlands',
			locationID: '', //Location ID from http://openweathermap.org/help/city_list.txt
			appid: 'abcde12345abcde12345abcde12345ab' //openweathermap.org API key.
		}
	}
]

Configuration options

The following properties can be configured:

Option	Description
location	The location used for weather information. Example: 'Amsterdam,Netherlands' Default value: false Note: When the location and locationID are both not set, the location will be based on the information provided by the calendar module. The first upcoming event with location data will be used.
locationID	Location ID from OpenWeatherMap This will override anything you put in location. Leave blank if you want to use location. Example: 1234567 Default value: false Note: When the location and locationID are both not set, the location will be based on the information provided by the calendar module. The first upcoming event with location data will be used.
appid	The OpenWeatherMap API key, which can be obtained by creating an OpenWeatherMap 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
roundTemp	Round temperature value to nearest integer. Possible values: true (round to integer) or false (display exact value with decimal point) Default value: false
updateInterval	How often does the content needs to be fetched? (Milliseconds) Possible values: 1000 - 86400000 Default value: 600000 (10 minutes)
animationSpeed	Speed of the update animation. (Milliseconds) Possible values:0 - 5000 Default value: 1000 (1 second)
timeFormat	Use 12 or 24 hour format. Possible values: 12 or 24 Default value: uses value of config.timeFormat
showPeriod	Show the period (am/pm) with 12 hour format Possible values: true or false Default value: true
showPeriodUpper	Show the period (AM/PM) with 12 hour format as uppercase Possible values: true or false Default value: false
showWindDirection	Show the wind direction next to the wind speed. Possible values: true or false Default value: true
showHumidity	Show the current humidity Possible values: true or false Default value: false
onlyTemp	Show only current Temperature and weather icon. Possible values: true or false Default value: false
useBeaufort	Pick between using the Beaufort scale for wind speed or using the default units. Possible values: true or false Default value: true
lang	The language of the days. Possible values: en, nl, ru, etc ... Default value: uses value of config.language
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
apiVersion	The OpenWeatherMap API version to use. Default value: 2.5
apiBase	The OpenWeatherMap base URL. Default value: 'http://api.openweathermap.org/data/'
weatherEndpoint	The OpenWeatherMap API endPoint. Default value: 'weather'
appendLocationNameToHeader	If set to true, the returned location name will be appended to the header of the module, if the header is enabled. This is mainly intresting when using calender based weather. Default value: true
calendarClass	The class for the calender module to base the event based weather information on. Default value: 'calendar'
iconTable	The conversion table to convert the weather conditions to weather-icons. Default value: iconTable: { '01d':'wi-day-sunny', '02d':'wi-day-cloudy', '03d':'wi-cloudy', '04d':'wi-cloudy-windy', '09d':'wi-showers', '10d':'wi-rain', '11d':'wi-thunderstorm', '13d':'wi-snow', '50d':'wi-fog', '01n':'wi-night-clear', '02n':'wi-night-cloudy', '03n':'wi-night-cloudy', '04n':'wi-night-cloudy', '09n':'wi-night-showers', '10n':'wi-night-rain', '11n':'wi-night-thunderstorm', '13n':'wi-night-snow', '50n':'wi-night-alt-cloudy-windy' }