MMM-DWD-WarnWeather.js

/* global Module */

/* Magic Mirror
 * Module: MMM-DWD-WarnWeather
 *
 * By Luke Scheffler https://github.com/LukeSkywalker92
 * MIT Licensed.
 *
 * extended by the possibility to only request warnings higher than a certain warning level
 * By @spitzlbergerj
 *
 * extended by the possibility to hide header.innerHTML
 * By @spitzlbergerj
 */

Module.register("MMM-DWD-WarnWeather", {

	// Default module config.
	defaults: {
		region: '',
		longversion: false,
		minutes: true,
		displayRegionName: true,
		width: 55,
		changeColor: true,
		interval: 10 * 60 * 1000, // every 10 minutes
		loadingText: 'Warnungen werden geladen...',
		noWarningText: 'Keine Warnungen',
		noWarningTextGreater: ' ab Warnstufe Level ',
		severityThreshold: 1,
		// hide header.innerHTML
		displayInnerHeader: true,
		hideNoWarning: false, // hide module if there is no warning
	},
	// Required scrpits
	getScripts: function () {
		return ["moment.js"];
	},
	// Required styles
	getStyles: function () {
		return ["MMM-DWD-WarnWeather.css"]
	},
	// Define parameters at start
	start: function () {
		this.loaded = false;
		this.noWarnings = false;
		this.warnings = [];
		this.community = [];
		this.icons = {
			THUNDERSTORM: 'sprite-gewitter',
			WIND: 'sprite-sturm',
			TORNADO: 'sprite-sturm',
			RAIN: 'sprite-regen',
			HAIL: 'sprite-schnee',
			SNOWFALL: 'sprite-schnee',
			SNOWDRIFT: 'sprite-schnee',
			FOG: 'sprite-nebel',
			FROST: 'sprite-frost',
			GLAZE: 'sprite-glatteis',
			SLIPPERINESS: 'sprite-glatteis',
			THAW: 'sprite-tauwetter',
			HEAT: 'sprite-hitze',
			UV: 'sprite-uv'
		}

		this.updateWarnings(this);
	},

	// Make node_helper to get new warning-data
	updateWarnings: function (self) {
		if (self.config.region) {
			var regionThreshold = { reg: self.config.region, sevThres: self.config.severityThreshold };
			self.sendSocketNotification('GET_WARNINGS', regionThreshold);
		}
		else if (self.config.warnCellID) {
			var cellIDThreshold = { cellid: self.config.warnCellID, sevThres: self.config.severityThreshold };
			self.sendSocketNotification('GET_WARNINGS', cellIDThreshold);
		}
		else if (self.config.lat && self.config.lng) {
			var coordsThreshold = { lat: self.config.lat, lng: self.config.lng, sevThres: self.config.severityThreshold };
			self.sendSocketNotification('GET_WARNINGS', coordsThreshold);
		}
		setTimeout(self.updateWarnings, self.config.interval, self);
	},

	// Override dom generator.
	getDom: function () {
		var wrapper = document.createElement("div");
		wrapper.className = 'wrapper';

		// @spitzlbergerj: possibility to hide inner header
		// with separation of header and "Location not found"
		var header = document.createElement("header");
		header.innerHTML = 'Wetterwarnungen';
		if (this.config.displayRegionName && this.loaded) {
			header.innerHTML += ' für:<br>' + this.community.properties.NAME;
		}
		if (this.config.displayInnerHeader) {
			wrapper.appendChild(header);
		}

		var locNotFound = document.createElement("div");
		locNotFound.className = 'locationNotFound';
		if (!this.community.hasOwnProperty('properties')) {
			locNotFound.innerHTML = 'Ort nicht gefunden';
			wrapper.appendChild(locNotFound);
		}

		// Check if warning data was loaded
		if (!this.loaded) {
			var loading = document.createElement("p");
			loading.className = 'status';
			loading.innerHTML = this.config.loadingText;
			wrapper.appendChild(loading);
			return wrapper;
		}

		// Check if there are warnings for defined region
		if (this.warnings.length < 1) {
			var noWarningWrapper = document.createElement("p");
			noWarningWrapper.className = 'status';
			
			// Hide the module if there are no warnings and hideNoWarning is true
			if (this.config.hideNoWarning) {
				wrapper.classList.add('hidden'); // Add 'hidden' class to wrapper for hiding full module
				return wrapper;
			}

			if (this.config.severityThreshold < 2) {
				noWarningWrapper.innerHTML = this.config.noWarningText;
			}
			else {
				noWarningWrapper.innerHTML = this.config.noWarningText + this.config.noWarningTextGreater + this.config.severityThreshold;
			}
			wrapper.appendChild(noWarningWrapper);
			return wrapper;
		}

		// Display warnings
		for (var i = 0; i < this.warnings.length; i++) {
			timeDisplayFormat = this.config.minutes ? "dd. HH:mm" : "dd. HH";
			var start = moment(this.warnings[i].properties.ONSET).format(timeDisplayFormat) + ' Uhr';
			var end = moment(this.warnings[i].properties.EXPIRES).format(timeDisplayFormat) + ' Uhr';
			var type = this.warnings[i].properties.EC_GROUP.split(';')[0];
			if (this.config.longversion) {
				var event = this.wordwrap(this.warnings[i].properties.DESCRIPTION, this.config.width, "<BR>");
			} else {
				var event = this.warnings[i].properties.EVENT;
			}
			var warnWrapper = document.createElement("div");
			warnWrapper.className = 'warning';
			var icon = document.createElement("div");
			if (this.config.changeColor) {
				iconColor = this.warnings[i].properties.EC_AREA_COLOR.replace(/ /g, ',');
				icon.setAttribute('style', 'background-color: rgb(' + iconColor + ')');
				icon.classList.add('weathericon', this.icons[type], 'small-icon');
			} else {
				icon.setAttribute('style', 'background-color: white');
				icon.classList.add('weathericon', this.icons[type], 'small-icon');
			}
			var description = document.createElement("div");
			description.className = 'description';
			var headline = document.createElement("div");
			headline.innerHTML = event;
			var duration = document.createElement("div");
			duration.className = 'duration';
			duration.innerHTML = start + ' - ' + end;

			var newLineSingleWarning = document.createElement("br");
			var newLineMultipleWarning = document.createElement("br");

			description.appendChild(headline);
			description.appendChild(duration);
			warnWrapper.appendChild(icon);
			warnWrapper.appendChild(description);
			wrapper.appendChild(warnWrapper);

			wrapper.appendChild(newLineSingleWarning);
			if (this.warnings.length > 1) {
				wrapper.appendChild(newLineMultipleWarning);
			}
		}

		//Log.info(wrapper);
		return wrapper;
	},

	getHeader: function () {
		if (this.warnings.length < 1 && this.config.hideNoWarning) {
			if (this.data.header) return "";
			else return "";
		} else {
			return this.data.header;
		}
	},

	wordwrap: function (str, width, brk) {

		brk = brk || "n";
		width = width || 75;

		if (!str) {
			return str;
		}

		var re = new RegExp(".{1," + width +
			"}(\\s|$)|\\ S+?(\\s|$)", "g");

		return str.match(RegExp(re)).join(brk);
	},

	pointInPoly: function (point, vs) {
		// ray-casting algorithm based on
		// http://www.ecse.rpi.edu/Homepages/wrf/Research/Short_Notes/pnpoly.html

		var x = point[0], y = point[1];

		var inside = false;
		for (var i = 0, j = vs.length - 1; i < vs.length; j = i++) {
			var xi = vs[i][0], yi = vs[i][1];
			var xj = vs[j][0], yj = vs[j][1];

			var intersect = ((yi > y) != (yj > y))
				&& (x < (xj - xi) * (y - yi) / (yj - yi) + xi);
			if (intersect) inside = !inside;
		}

		return inside;
	},

	socketNotificationReceived: function (notification, payload) {
		Log.info(notification);

		if (notification === 'WARNINGS_DATA') {
			if (payload.community.hasOwnProperty('geometry')) {
				if (payload.region == this.config.region || payload.region == this.config.warnCellID || this.pointInPoly([this.config.lng, this.config.lat], payload.community.geometry.coordinates[0])) {
					Log.info(payload);
					this.warnings = payload.warnings;
					this.community = payload.community;
					this.loaded = true;
					this.noWarnings = false;
					this.updateDom(1000);
				}
			}
		}
	}
});