MMM-Ruter.js

/* Magic Mirror
 * Module: Ruter
 *
 * By Cato Antonsen (https://github.com/CatoAntonsen)
 * MIT Licensed.
 */
 
Module.register("MMM-Ruter",{

	// Default module config.
	defaults: {
		timeFormat: null,			// This is set automatically based on global config
		showHeader: false, 			// Set this to true to show header above the journeys (default is false)
		showPlatform: false,			// Set this to true to get the names of the platforms (default is false)
		showStopName: false,			// Show the name of the stop (you have to configure 'name' for each stop)
		maxItems: 5,				// Number of journeys to display (default is 5)
		humanizeTimeTreshold: 15, 		// If time to next journey is below this value, it will be displayed as "x minutes" instead of time (default is 15 minutes)
		serviceReloadInterval: 30000, 		// Refresh rate in MS for how often we call Ruter's web service. NB! Don't set it too low! (default is 30 seconds)
		timeReloadInterval: 1000, 		// Refresh rate how often we check if we need to update the time shown on the mirror (default is every second)
		animationSpeed: 0,			// How fast the animation changes when updating mirror (default is 0 second)
		fade: true,				// Set this to true to fade list from light to dark. (default is true)
		fadePoint: 0.25				// Start on 1/4th of the list. 
	},

	getStyles: function () {
		return ["ruter.css"];
	},

	getScripts: function() {
		return ["moment.js"];
	},

	getTranslations: function() {
		return {
			en: "translations/en.json",
			nb: "translations/nb.json"
		}
	},

	start: function() {
		console.log(this.translate("STARTINGMODULE") + ": " + this.name);

		this.journeys = [];
		this.previousJourneys = [];
		var self = this;

 		// Set locale and time format based on global config
		moment.locale(config.language);
		if (config.timeFormat === 24) {
				this.config.timeFormat = 'HH:mm';
		} else {
				this.config.timeFormat = 'h:mm A';
		}

		// Just do an initial poll. Otherwise we have to wait for the serviceReloadInterval
		self.startPolling(); 

		setInterval(function() {
			self.startPolling();
		}, this.config.serviceReloadInterval);
		
		setInterval(function() {
			self.updateDomIfNeeded();
		}, this.config.timeReloadInterval);
	},
	
	getDom: function() {
		if (this.journeys.length > 0) {
			
			var table = document.createElement("table");
			table.className = "ruter small";
			
			if (this.config.showHeader) {
				table.appendChild(this.getTableHeaderRow());
			}
			
			for(var i = 0; i < this.journeys.length; i++) {

				var journey = this.journeys[i];
				var tr = this.getTableRow(journey);
				
				// Create fade effect. <-- stolen from default "calendar" module
				if (this.config.fade && this.config.fadePoint < 1) {
					if (this.config.fadePoint < 0) {
						this.config.fadePoint = 0;
					}
					var startingPoint = this.journeys.length * this.config.fadePoint;
					var steps = this.journeys.length - startingPoint;
					if (i >= startingPoint) {
						var currentStep = i - startingPoint;
						tr.style.opacity = 1 - (1 / steps * currentStep);
					}
				}
				
				table.appendChild(tr);
			}
			
			return table;
		} else {
			var wrapper = document.createElement("div");
			wrapper.innerHTML = this.translate("LOADING");
			wrapper.className = "small dimmed";
		}

		return wrapper;
	},

	startPolling: function() {
		var self = this;

		var promises = [];
		for(var i=0; i < this.config.stops.length; i++) {
			promises.push(new Promise((resolv) => {
				this.getStopInfo(this.config.stops[i], function(err, result) {
					resolv(result);
				});
			}));
		}
		
		Promise.all(promises).then(function(promiseResults) {
			if (promiseResults.length > 0) {
				var allJourneys = [];
				for(var i=0; i < promiseResults.length; i++) {
					allJourneys = allJourneys.concat(promiseResults[i])
				}
				
				allJourneys.sort(function(a,b) {
					var dateA = new Date(a.time);
					var dateB = new Date(b.time);
					return dateA - dateB;
				});

				self.journeys = allJourneys.slice(0, self.config.maxItems);
			}
		});
	},
	
	updateDomIfNeeded: function() {
		var needUpdate = false;
		
		for(var i=0; i < this.journeys.length; i++)  {
			var time = this.formatTime(this.journeys[i].time);	
			if (this.previousJourneys[i] == undefined || this.previousJourneys[i].lineName != this.journeys[i].lineName || this.previousJourneys[i].time != time) {
				needUpdate = true;
				this.previousJourneys[i] = {};
				this.previousJourneys[i].lineName = this.journeys[i].lineName;
				this.previousJourneys[i].time = time;
			}
		}
		
		if (needUpdate) {
			this.updateDom(this.config.animationSpeed);
		}
	},

	getStopInfo: function(stopItem, callback) {
		var self = this;

		var HttpClient = function() {
			this.get = function(requestUrl, requestCallback) {
				var httpRequest = new XMLHttpRequest();
				httpRequest.onreadystatechange = function() { 
					if (httpRequest.readyState == 4 && httpRequest.status == 200)
						requestCallback(httpRequest.responseText);
				}

				httpRequest.open( "GET", requestUrl, true );            
				httpRequest.send( null );
			}
		}

		var shouldAddPlatform = function(platform, platformFilter) {
			if (platformFilter == null || platformFilter.length == 0) { return true; } // If we don't add any interesting platformFilter, then we asume we'll show all
			for(var i=0; i < platformFilter.length; i++) {
				if (platformFilter[i] === platform) { return true; }
			}
			
			return false;
		};

		var departureUrl = function() {
			var dateParam = ""
			if (stopItem.timeToThere) {
				var min = stopItem.timeToThere;
				var timeAhead = moment(moment.now()).add(min, "minute").format().substring(0, 16);
				console.log("Looking for journeys " + min + " minutes ahead in time.");
				dateParam = "?datetime=" + timeAhead;
			} else {
				console.log("Looking for current journeys");
			}
			
			return "http://reisapi.ruter.no/StopVisit/GetDepartures/" + stopItem.stopId + dateParam;
		};

		var stopUrl = function() {
			return "http://reisapi.ruter.no/Place/GetStop/" + stopItem.stopId;
		};

		var client = new HttpClient();

		client.get(stopUrl(), function(stopResponse) {
			var stop = JSON.parse(stopResponse);

			client.get(departureUrl(), function(response) {
				var stops = JSON.parse(response);
	
				var allStopItems = new Array();
	
				for(var j = 0; j < stops.length; j++) {
					var journey = stops[j].MonitoredVehicleJourney;
					
					if (shouldAddPlatform(journey.MonitoredCall.DeparturePlatformName, stopItem.platforms)) {
						var numBlockParts = null;
						if (journey.TrainBlockPart != null) {
							numBlockParts = journey.TrainBlockPart.NumberOfBlockParts;
						}

						var stopName = stopItem.stopName ? stopItem.stopName : stop.Name;
						if (self.config.maxNameLength) {
							stopName = stopName.substring(0, self.config.maxNameLength);
						}

						allStopItems.push({
							stopId: stopItem.stopId,
							stopName: stopName,
							lineName: journey.PublishedLineName,
							destinationName: journey.DestinationName,
							time: journey.MonitoredCall.ExpectedDepartureTime,
							platform: journey.MonitoredCall.DeparturePlatformName
						});
					}
				};
	
				callback(null, allStopItems)		
			});
		})
	},
	
	getTableHeaderRow: function() {
		var thLine = document.createElement("th");
		thLine.className = "light";
		thLine.appendChild(document.createTextNode(this.translate("LINEHEADER")));

		var thDestination = document.createElement("th");
		thDestination.className = "light";
		thDestination.appendChild(document.createTextNode(this.translate("DESTINATIONHEADER")));
		
		var thPlatform = document.createElement("th");
		thPlatform.className = "light";
		thPlatform.appendChild(document.createTextNode(this.translate("PLATFORMHEADER")));

		var thStopName = document.createElement("th");
		thStopName.className = "light"
		thStopName.appendChild(document.createTextNode(this.translate("STOPNAMEHEADER")));
		
		var thTime = document.createElement("th");
		thTime.className = "light time"
		thTime.appendChild(document.createTextNode(this.translate("TIMEHEADER")));

		var thead = document.createElement("thead");
		thead.addClass = "xsmall dimmed";
		thead.appendChild(thLine);
		thead.appendChild(thDestination);
		if (this.config.showStopName) { thead.appendChild(thStopName); }
		if (this.config.showPlatform) { thead.appendChild(thPlatform); }
		thead.appendChild(thTime);
		
		return thead;
	},
	
	getTableRow: function(journey) {
		var tdLine = document.createElement("td");
		tdLine.className = "line";
		var txtLine = document.createTextNode(journey.lineName);
		tdLine.appendChild(txtLine);
		
		var tdDestination = document.createElement("td");
		tdDestination.className = "destination bright";
		tdDestination.appendChild(document.createTextNode(journey.destinationName));
		
		if (this.config.showPlatform) {
			var tdPlatform = document.createElement("td");
			tdPlatform.className = "platform";
			tdPlatform.appendChild(document.createTextNode(journey.platform));
		}

		if (this.config.showStopName) {
			var tdStopName = document.createElement("td");
			tdStopName.className = "light";
			tdStopName.appendChild(document.createTextNode(journey.stopName));	
		}
		
		var tdTime = document.createElement("td");
		tdTime.className = "time light";
		tdTime.appendChild(document.createTextNode(this.formatTime(journey.time)));
		
		var tr = document.createElement("tr");
		tr.appendChild(tdLine);
		tr.appendChild(tdDestination);
		if (this.config.showStopName) { tr.appendChild(tdStopName); }
		if (this.config.showPlatform) { tr.appendChild(tdPlatform); }
		tr.appendChild(tdTime);
		
		return tr;
	},
	
	formatTime: function(t) {
		var diff = moment.duration(moment(t) - moment.now());
		var min = diff.minutes() + diff.hours() * 60;

		if (min == 0) {
			return this.translate("NOW")
		} else if (min == 1) {
			return this.translate("1MIN");
		} else if (min < this.config.humanizeTimeTreshold) {
			return min + " " + this.translate("MINUTES");
		} else {
			return moment(t).format(this.config.timeFormat);
		}
	}
});