Merge branch 'develop' into forecast_max_days

modules/README.md

@@ -2,6 +2,30 @@
 
 This document describes the way to develop your own MagicMirror² modules.
 
+Table of Contents:
+
+- Module structure
+  - Files
+
+- The Core module file: modulename.js
+  - Available module instance properties
+  - Subclassable module methods
+  - Module instance methods
+  - Visibility locking
+
+- The Node Helper: node_helper.js
+  - Available module instance properties
+  - Subclassable module methods
+  - Module instance methods
+  
+- MagicMirror Helper Methods
+  - Module Selection
+
+- MagicMirror Logger
+
+---
+
+
 ## General Advice
 
 As MagicMirror has gained huge popularity, so has the number of available modules. For new users and developers alike, it is very time consuming to navigate around the various repositories in order to find out what exactly a certain modules does, how it looks and what it depends on. Unfortunately, this information is rarely available, nor easily obtained without having to install it first. 
@@ -26,7 +50,7 @@ A module can be placed in one single folder. Or multiple modules can be grouped
 - **modulename/public** - Any files in this folder can be accesed via the browser on `/modulename/filename.ext`.
 - **modulename/anyfileorfolder** Any other file or folder in the module folder can be used by the core module script. For example: *modulename/css/modulename.css* would be a good path for your additional module styles.
 
-## Core module file: modulename.js
+## The Core module file: modulename.js
 This is the script in which the module will be defined. This script is required in order for the module to be used. In it's most simple form, the core module file must contain:
 ````javascript
 Module.register("modulename",{});
@@ -56,30 +80,16 @@ As you can see, the `Module.register()` method takes two arguments: the name of
 ### Available module instance properties
 After the module is initialized, the module instance has a few available module properties:
 
-#### `this.name`
-**String**
+| Instance Property | Type | Description |
+|:----------------- |:---- |:----------- |
+| `this.name` | String | The name of the module. |
+| `this.identifier` | String | This is a unique identifier for the module instance. |
+| `this.hidden` | Boolean | This represents if the module is currently hidden (faded away). |
+| `this.config` | Boolean | The configuration of the module instance as set in the user's `config.js` file. This config will also contain the module's defaults if these properties are not over-written by the user config. |
+| `this.data` | Object | The data object contain additional metadata about the module instance. (See below) |
 
-The name of the module.
 
-#### `this.identifier`
-**String**
-
-This is a unique identifier for the module instance.
-
-#### `this.hidden`
-**Boolean**
-
-This represents if the module is currently hidden (faded away).
-
-#### `this.config`
-**Boolean**
-
-The configuration of the module instance as set in the user's config.js file. This config will also contain the module's defaults if these properties are not over written by the user config.
-
-#### `this.data`
-**Object**
-
-The data object contains additional metadata about the module instance:
+The `this.data` data object contain the follwoing metadata:
 - `data.classes` - The classes which are added to the module dom wrapper.
 - `data.file` - The filename of the core module file.
 - `data.path` - The path of the module folder.

modules/default/alert/README.md

@@ -60,5 +60,5 @@ self.sendNotification("SHOW_ALERT", {});
 | `timer` (optional)                              | How long the alert should stay visible in ms. <br> **Important:** If you do not use the `timer`, it is your duty to hide the alert by using `self.sendNotification("HIDE_ALERT");`! <br><br>**Possible values:** `int` `float` <br> **Default value:** `none`
 
 ## Open Source Licenses
-###[NotificationStyles](https://github.com/codrops/NotificationStyles)
+### [NotificationStyles](https://github.com/codrops/NotificationStyles)
 See [ympanus.net](http://tympanus.net/codrops/licensing/) for license.

modules/default/calendar/README.md

@@ -46,7 +46,7 @@ The following properties can be configured:
 | `urgency`                    | When using a timeFormat of `absolute`, the `urgency` setting allows you to display events within a specific time frame as `relative`. This allows events within a certain time frame to be displayed as relative (in xx days) while others are displayed as absolute dates <br><br> **Possible values:** a positive integer representing the number of days for which you want a relative date, for example `7` (for 7 days) <br><br> **Default value:** `7`
 | `broadcastEvents`            | If this property is set to true, the calendar will broadcast all the events to all other modules with the notification message: `CALENDAR_EVENTS`. The event objects are stored in an array and contain the following fields: `title`, `startDate`, `endDate`, `fullDayEvent`, `location` and `geo`. <br><br> **Possible values:** `true`, `false` <br><br> **Default value:** `true`
 | `hidePrivate`                | Hides private calendar events. <br><br> **Possible values:** `true` or `false` <br> **Default value:** `false`
-| `excludedEvents`             | An array of words / phrases from event titles that will be excluded from being shown. <br><br> **Example:** `['Birthday', 'Hide This Event']` <br> **Default value:** `[]`
+| `excludedEvents`             | An array of words / phrases from event titles that will be excluded from being shown. <br><br>Additionally advanced filter objects can be passed in. Below is the configuration for the advance filtering object.<br>**Required**<br>`filterBy` - string used to determine if filter is applied.<br>**Optional**<br>`until` - Time before an event to display it  Ex: [`'3 days'`, `'2 months'`, `'1 week'`]<br>`caseSensitive` - By default, excludedEvents are case insensitive, set this to true to enforce case sensitivity<br><br> **Example:** `['Birthday', 'Hide This Event', {filterBy: 'Payment', until: '6 days', caseSensitive: true}]` <br> **Default value:** `[]`
 
 ### Calendar configuration
 

modules/default/calendar/calendarfetcher.js

@@ -113,11 +113,38 @@ var CalendarFetcher = function(url, reloadInterval, excludedEvents, maximumEntri
 						title = event.description;
 					}
 
-					var excluded = false;
+					var excluded = false,
+						dateFilter = null;
+
 					for (var f in excludedEvents) {
-						var filter = excludedEvents[f];
-						if (title.toLowerCase().includes(filter.toLowerCase())) {
-							excluded = true;
+						var filter = excludedEvents[f],
+							testTitle = title.toLowerCase(),
+							until = null;
+
+						if (filter instanceof Object) {
+							if (typeof filter.until !== "undefined") {
+								until = filter.until;
+							}
+
+							// If additional advanced filtering is added in, this section
+							// must remain last as we overwrite the filter object with the
+							// filterBy string
+							if (filter.caseSensitive) {
+								filter = filter.filterBy;
+								testTitle = title;
+							} else {
+								filter = filter.filterBy.toLowerCase();
+							}
+						} else {
+							filter = filter.toLowerCase();
+						}
+
+						if (testTitle.includes(filter)) {
+							if (until) {
+								dateFilter = until;
+							} else {
+								excluded = true;
+							}
 							break;
 						}
 					}
@@ -137,6 +164,11 @@ var CalendarFetcher = function(url, reloadInterval, excludedEvents, maximumEntri
 						for (var d in dates) {
 							startDate = moment(new Date(dates[d]));
 							endDate  = moment(parseInt(startDate.format("x")) + duration, "x");
+
+							if (timeFilterApplies(now, endDate, dateFilter)) {
+								continue;
+							}
+
 							if (endDate.format("x") > now) {
 								newEvents.push({
 									title: title,
@@ -171,6 +203,10 @@ var CalendarFetcher = function(url, reloadInterval, excludedEvents, maximumEntri
 							continue;
 						}
 
+						if (timeFilterApplies(now, endDate, dateFilter)) {
+							continue;
+						}
+
 						// Every thing is good. Add it to the list.
 
 						newEvents.push({
@@ -236,6 +272,28 @@ var CalendarFetcher = function(url, reloadInterval, excludedEvents, maximumEntri
 		return false;
 	};
 
+	/* timeFilterApplies()
+	 * Determines if the user defined time filter should apply
+	 *
+	 * argument now Date - Date object using previously created object for consistency
+	 * argument endDate Moment - Moment object representing the event end date
+	 * argument filter string - The time to subtract from the end date to determine if an event should be shown
+	 *
+	 * return bool - The event should be filtered out
+	 */
+	var timeFilterApplies = function(now, endDate, filter) {
+		if (filter) {
+			var until = filter.split(" "),
+				value = parseInt(until[0]),
+				increment = until[1].slice("-1") === "s" ? until[1] : until[1] + "s", // Massage the data for moment js
+				filterUntil = moment(endDate.format()).subtract(value, increment);
+
+			return now < filterUntil.format("x");
+		}
+
+		return false;
+	};
+
 	/* public methods */
 
 	/* startFetch()

modules/default/currentweather/README.md

@@ -43,7 +43,9 @@ The following properties can be configured:
 | `showWindDirectionAsArrow`   | Show the wind direction as an arrow instead of abbreviation <br><br> **Possible values:** `true` or `false` <br> **Default value:** `false`
 | `showHumidity`               | Show the current humidity <br><br> **Possible values:** `true` or `false` <br> **Default value:** `false`
 | `showIndoorTemperature`      | If you have another module that emits the INDOOR_TEMPERATURE notification, the indoor temperature will be displayed <br> **Default value:** `false`
-| `onlyTemp`                   | Show only current Temperature and weather icon without windspeed, sunset and sunrise time. <br><br> **Possible values:** `true` or `false` <br> **Default value:** `false`
+| `onlyTemp`                   | Show only current Temperature and weather icon without windspeed, sunset, sunrise time and feels like. <br><br> **Possible values:** `true` or `false` <br> **Default value:** `false`
+| `showFeelsLike`              | Shows the Feels like temperature weather. <br><br> **Possible values:**`true` or `false`<br>**Default value:** `true`
+| `useKMPHWind`                | Uses KMPH as units for windspeed. <br><br> **Possible values:**`true` or `false`<br>**Default value:** `false`
 | `useBeaufort`                | Pick between using the Beaufort scale for wind speed or using the default units. <br><br> **Possible values:** `true` or `false` <br> **Default value:** `true`
 | `lang`                       | The language of the days. <br><br> **Possible values:** `en`, `nl`, `ru`, etc ... <br> **Default value:** uses value of _config.language_
 | `decimalSymbol`              | The decimal symbol to use.<br><br> **Possible values:** `.`, `,` or any other symbol.<br> **Default value:** `.`

modules/default/currentweather/currentweather.js

@@ -23,12 +23,14 @@ Module.register("currentweather",{
 		showWindDirection: true,
 		showWindDirectionAsArrow: false,
 		useBeaufort: true,
+		useKMPHwind: false,
 		lang: config.language,
 		decimalSymbol: ".",
 		showHumidity: false,
 		degreeLabel: false,
 		showIndoorTemperature: false,
 		showIndoorHumidity: false,
+		showFeelsLike: true,
 
 		initialLoadDelay: 0, // 0 seconds delay
 		retryDelay: 2500,
@@ -105,7 +107,7 @@ Module.register("currentweather",{
 		this.indoorTemperature = null;
 		this.indoorHumidity = null;
 		this.weatherType = null;
-
+		this.feelsLike = null;
 		this.loaded = false;
 		this.scheduleUpdate(this.config.initialLoadDelay);
 
@@ -242,6 +244,19 @@ Module.register("currentweather",{
 		}
 
 		wrapper.appendChild(large);
+
+		if (this.config.showFeelsLike && this.config.onlyTemp === false){
+			var small = document.createElement("div");
+			small.className = "normal medium";
+
+			var feelsLike = document.createElement("span");
+			feelsLike.className = "dimmed";
+			feelsLike.innerHTML = "Feels " + this.feelsLike + "°" + degreeLabel;
+			small.appendChild(feelsLike);
+
+			wrapper.appendChild(small);
+		}
+
 		return wrapper;
 	},
 
@@ -365,13 +380,71 @@ Module.register("currentweather",{
 
 		this.humidity = parseFloat(data.main.humidity);
 		this.temperature = this.roundValue(data.main.temp);
+		this.feelsLike = 0;
 
 		if (this.config.useBeaufort){
 			this.windSpeed = this.ms2Beaufort(this.roundValue(data.wind.speed));
+		} else if (this.config.useKMPHwind) {
+			this.windSpeed = parseFloat((data.wind.speed * 60 * 60) / 1000).toFixed(0);
 		} else {
 			this.windSpeed = parseFloat(data.wind.speed).toFixed(0);
 		}
 
+		// ONLY WORKS IF TEMP IN C //
+		var windInMph = parseFloat(data.wind.speed * 2.23694);
+
+		var tempInF = 0;
+		switch (this.config.units){
+		case "metric": tempInF = 1.8 * this.temperature + 32;
+			break;
+		case "imperial": tempInF = this.temperature;
+			break;
+		case "default":
+			var tc = this.temperature - 273.15;
+			tempInF = 1.8 * tc + 32;
+			break;
+		}
+
+		if (windInMph > 3 && tempInF < 50){
+			// windchill
+			var windchillinF = Math.round(35.74+0.6215*tempInF-35.75*Math.pow(windInMph,0.16)+0.4275*tempInF*Math.pow(windInMph,0.16));
+			var windChillInC = (windchillinF - 32) * (5/9);
+			// this.feelsLike = windChillInC.toFixed(0);
+
+			switch (this.config.units){
+			case "metric": this.feelsLike = windChillInC.toFixed(0);
+				break;
+			case "imperial": this.feelsLike = windChillInF.toFixed(0);
+				break;
+			case "default":
+				var tc = windChillInC - 273.15;
+				this.feelsLike = tc.toFixed(0);
+				break;
+			}
+
+		} else if (tempInF > 80 && this.humidity > 40){
+			// heat index
+			var Hindex = -42.379 + 2.04901523*tempInF + 10.14333127*this.humidity
+				- 0.22475541*tempInF*this.humidity - 6.83783*Math.pow(10,-3)*tempInF*tempInF
+				- 5.481717*Math.pow(10,-2)*this.humidity*this.humidity
+				+ 1.22874*Math.pow(10,-3)*tempInF*tempInF*this.humidity
+				+ 8.5282*Math.pow(10,-4)*tempInF*this.humidity*this.humidity
+				- 1.99*Math.pow(10,-6)*tempInF*tempInF*this.humidity*this.humidity;
+
+			switch (this.config.units){
+			case "metric": this.feelsLike = Hindex.toFixed(0);
+				break;
+			case "imperial": this.feelsLike = parseFloat(Hindex * 1.8 + 32).toFixed(0);
+				break;
+			case "default":
+				var tc = Hindex - 273.15;
+				this.feelsLike = tc.toFixed(0);
+				break;
+			}
+		} else {
+			this.feelsLike = parseFloat(this.temperature).toFixed(0);
+		}
+
 		this.windDirection = this.deg2Cardinal(data.wind.deg);
 		this.windDeg = data.wind.deg;
 		this.weatherType = this.config.iconTable[data.weather[0].icon];
@@ -497,4 +570,5 @@ Module.register("currentweather",{
 		var decimals = this.config.roundTemp ? 0 : 1;
 		return parseFloat(temperature).toFixed(decimals);
 	}
+
 });

modules/default/newsfeed/fetcher.js

@@ -45,7 +45,7 @@ var Fetcher = function(url, reloadInterval, encoding) {
 
 			var title = item.title;
 			var description = item.description || item.summary || item.content || "";
-			var pubdate = item.pubdate || item.published || item.updated;
+			var pubdate = item.pubdate || item.published || item.updated || item["dc:date"];
 			var url = item.url || item.link || "";
 
 			if (title && pubdate) {

modules/default/updatenotification/updatenotification.js

@@ -58,16 +58,19 @@ Module.register("updatenotification", {
 			icon.innerHTML = " ";
 			message.appendChild(icon);
 
-			var subtextHtml = this.translate("UPDATE_INFO")
-				.replace("COMMIT_COUNT", this.status.behind + " " + ((this.status.behind == 1) ? "commit" : "commits"))
-				.replace("BRANCH_NAME", this.status.current);
+			var subtextHtml = this.translate("UPDATE_INFO", {
+				COMMIT_COUNT: this.status.behind + " " + ((this.status.behind == 1) ? "commit" : "commits"),
+				BRANCH_NAME: this.status.current
+			});
 
 			var text = document.createElement("span");
 			if (this.status.module == "default") {
 				text.innerHTML = this.translate("UPDATE_NOTIFICATION");
 				subtextHtml = this.diffLink(subtextHtml);
 			} else {
-				text.innerHTML = this.translate("UPDATE_NOTIFICATION_MODULE").replace("MODULE_NAME", this.status.module);
+				text.innerHTML = this.translate("UPDATE_NOTIFICATION_MODULE", {
+					MODULE_NAME: this.status.module
+				});
 			}
 			message.appendChild(text);