A first setup of the new Weather Module

2025-08-21 04:45:17 +00:00 · 2017-09-21 16:38:18 +02:00
parent 8a101f9e9a
commit ef172592b8
5 changed files with 343 additions and 1 deletions
--- a/modules/default/weather/providers/openweathermap.js
+++ b/modules/default/weather/providers/openweathermap.js
@@ -0,0 +1,120 @@
+/* global WeatherProvider, WeatherDay */
+
+/* Magic Mirror
+ * Module: Weather
+ *
+ * By Michael Teeuw http://michaelteeuw.nl
+ * MIT Licensed.
+ * 
+ * This class is the blueprint for a weather provider.
+ */
+
+WeatherProvider.register("openweathermap", {
+
+	// Set the name of the provider.
+	// This isn't strictly nessecery, since it will fallback to the provider identifier
+	// But for debugging (and future alerts) it would be nice to have the real name.
+	providerName: "OpenWeatherMap",
+
+	// Overwrite the fetchCurrentWeather method.
+	fetchCurrentWeather: function() {
+		var  apiVersion = "2.5"
+		var  apiBase =  "http://api.openweathermap.org/data/"
+		var  weatherEndpoint = "weather"
+
+		var url = apiBase + apiVersion + "/" + weatherEndpoint + this.getParams()
+
+		this.fetchData(url)
+			.then(data => {
+				Log.log(data)
+
+				if (!data || !data.main || typeof data.main.temp === "undefined") {
+					// Did not receive usable new data.
+					// Maybe this needs a better check?
+					return;
+				}
+
+				var currentWeather = this.generateWeatherDayFromCurrentWeather(data)
+				this.setCurrentWeather(currentWeather)
+			})
+			.catch(function(request) {
+				Log.error("Could not load data ... ", request)
+			})
+	},
+
+
+	/** OpenWeatherMap Specific Methods - These are not part of the default provider methods */
+
+
+	/* 
+	 * Generate a WeatherDay based on currentWeatherInformation
+	 */
+	generateWeatherDayFromCurrentWeather: function(currentWeatherData) {
+		var currentWeather = new WeatherDay()
+
+		currentWeather.humidity = parseFloat(currentWeatherData.main.humidity)
+		currentWeather.temperature = parseFloat(currentWeatherData.main.temp)
+		currentWeather.windSpeed = parseFloat(currentWeatherData.wind.speed)
+		currentWeather.windDirection = currentWeatherData.wind.deg
+		currentWeather.weatherType = this.convertWeatherType(currentWeatherData.weather[0].icon)
+		currentWeather.sunrise = new Date(currentWeatherData.sys.sunrise * 1000)
+		currentWeather.sunset = new Date(currentWeatherData.sys.sunset * 1000)
+
+		return currentWeather
+	},
+
+	/*
+	 * Convert the OpenWeatherMap icons to a more usable name.
+	 */
+	convertWeatherType: function(weatherType) {
+		var weatherTypes = {
+			"01d": "day-sunny",
+			"02d": "day-cloudy",
+			"03d": "cloudy",
+			"04d": "cloudy-windy",
+			"09d": "showers",
+			"10d": "rain",
+			"11d": "thunderstorm",
+			"13d": "snow",
+			"50d": "fog",
+			"01n": "night-clear",
+			"02n": "night-cloudy",
+			"03n": "night-cloudy",
+			"04n": "night-cloudy",
+			"09n": "night-showers",
+			"10n": "night-rain",
+			"11n": "night-thunderstorm",
+			"13n": "night-snow",
+			"50n": "night-alt-cloudy-windy"
+		}
+
+		return weatherTypes.hasOwnProperty(weatherType) ? weatherTypes[weatherType] : null
+	},
+
+	/* getParams(compliments)
+	 * Generates an url with api parameters based on the config.
+	 *
+	 * return String - URL params.
+	 */
+	getParams: function() {
+		var params = "?";
+		if(this.config.locationID) {
+			params += "id=" + this.config.locationID;
+		} else if(this.config.location) {
+			params += "q=" + this.config.location;
+		} else if (this.firstEvent && this.firstEvent.geo) {
+			params += "lat=" + this.firstEvent.geo.lat + "&lon=" + this.firstEvent.geo.lon
+		} else if (this.firstEvent && this.firstEvent.location) {
+			params += "q=" + this.firstEvent.location;
+		} else {
+			this.hide(this.config.animationSpeed, {lockString:this.identifier});
+			return;
+		}
+
+		params += "&units=" + this.config.units;
+		params += "&lang=" + this.config.lang;
+		params += "&APPID=" + this.config.apiKey;
+
+		return params;
+	},
+});