Merge pull request #1968 from MichMich/develop

Release 2.11.0

.eslintignore

@@ -3,4 +3,3 @@ vendor/*
 !/modules/default/**
 !/modules/node_helper
 !/modules/node_helper/**
-!/modules/default/defaultmodules.js

.eslintrc.json

@@ -2,9 +2,12 @@
 	"rules": {
 		"indent": ["error", "tab"],
 		"quotes": ["error", "double"],
+        "semi": ["error"],
 		"max-len": ["error", 250],
 		"curly": "error",
 		"camelcase": ["error", {"properties": "never"}],
+        "no-multiple-empty-lines": ["error", { "max": 1, "maxEOF": 1 }],
+		"no-multi-spaces": "error",
 		"no-trailing-spaces": ["error", {"ignoreComments": false }],
 		"no-irregular-whitespace": ["error"]
 	},
@@ -15,6 +18,7 @@
 	},
 	"parserOptions": {
 		"sourceType": "module",
+		"ecmaVersion": 2017,
 		"ecmaFeatures": {
 			"globalReturn": true
 		}

.github/ISSUE_TEMPLATE.md

@@ -1,15 +1,28 @@
-Please only submit reproducible issues. 
-
+## I'm not sure if this is a bug
 If you're not sure if it's a real bug or if it's just you, please open a topic on the forum: [https://forum.magicmirror.builders/category/15/bug-hunt](https://forum.magicmirror.builders/category/15/bug-hunt)
+
+## I'm having troubles installing or configuring MagicMirror
 Problems installing or configuring your MagicMirror? Check out: [https://forum.magicmirror.builders/category/10/troubleshooting](https://forum.magicmirror.builders/category/10/troubleshooting)
 
+## I found a bug in the MagicMirror installer
+If you are facing an issue or found a bug while trying to install MagicMirror via the installer please report it in the respective GitHub repository:
+[https://github.com/sdetweil/MagicMirror_scripts](https://github.com/sdetweil/MagicMirror_scripts)
+
+## I found a bug in the MagicMirror Docker image
+If you are facing an issue or found a bug while running MagicMirror inside a Docker container please create an issue in the GitHub repository of the MagicMirror Docker image:
+[https://github.com/bastilimbach/docker-MagicMirror](https://github.com/bastilimbach/docker-MagicMirror)
+
+---
+
+## I found a bug in MagicMirror
+Please make sure to only submit reproducible issues. You can safely remove everything above the dividing line. 
 When submitting a new issue, please supply the following information:
 
 **Platform**: Place your platform here... give us your web browser/Electron version *and* your hardware (Raspberry Pi 2/3, Windows, Mac, Linux, System V UNIX).
 
-**Node Version**: Make sure it's version 0.12.13 or later.
+**Node Version**: Make sure it's version 8 or later.
 
-**MagicMirror Version**: Now that the versions have split, tell us if you are using the PHP version (v1) or the newer JavaScript version (v2).
+**MagicMirror Version**: Please let us now which version of MagicMirror you are running. It can be found in the `package.log` file. 
 
 **Description**: Provide a detailed description about the issue and include specific details to help us understand the problem. Adding screenshots will help describing the problem.
 

.github/stale.yml

@@ -0,0 +1,19 @@
+# Number of days of inactivity before an issue becomes stale
+daysUntilStale: 60
+# Number of days of inactivity before a stale issue is closed
+daysUntilClose: 7
+# Issues with these labels will never be considered stale
+exemptLabels:
+  - pinned
+  - security
+  - under investigation
+  - pr welcome
+# Label to use when marking an issue as stale
+staleLabel: wontfix
+# Comment to post when marking an issue as stale. Set to `false` to disable
+markComment: >
+  This issue has been automatically marked as stale because it has not had
+  recent activity. It will be closed if no further activity occurs. Thank you
+  for your contributions.
+# Comment to post when closing a stale issue. Set to `false` to disable
+closeComment: false

.gitignore

@@ -11,7 +11,9 @@ coverage
 .grunt
 .lock-wscript
 build/Release
-node_modules
+/node_modules/**/*
+fonts/node_modules/**/*
+vendor/node_modules/**/*
 jspm_modules
 .npm
 .node_repl_history
@@ -57,12 +59,6 @@ Temporary Items
 .directory
 .Trash-*
 
-# Various Magic Mirror ignoramuses and anti-ignoramuses.
-
-# Don't ignore the node_helper core module.
-!/modules/node_helper
-!/modules/node_helper/**
-
 # Ignore all modules except the default modules.
 /modules/**
 !/modules/default
@@ -81,3 +77,5 @@ Temporary Items
 *.orig
 *.rej
 *.bak
+
+!/tests/node_modules/**/*

.snyk

@@ -1,14 +0,0 @@
-version: v1.5.2
-ignore: {}
-patch:
-  'npm:minimatch:20160620':
-    - snyk > recursive-readdir > minimatch:
-        patched: '2016-07-30T14:02:31.280Z'
-  'npm:negotiator:20160616':
-    - socket.io > engine.io > accepts > negotiator:
-        patched: '2016-07-30T14:02:31.280Z'
-  'npm:ws:20160624':
-    - socket.io > engine.io > ws:
-        patched: '2016-07-30T14:02:31.280Z'
-    - socket.io > socket.io-client > engine.io-client > ws:
-        patched: '2016-07-30T14:02:31.280Z'

.travis.yml

@@ -1,18 +1,24 @@
+dist: trusty
 language: node_js
 node_js:
- - "8"
+  - 10
+  - lts/*
+  - node
+before_install:
+  - npm i -g npm
 before_script:
- - yarn danger ci
- - npm install grunt-cli -g
- - "export DISPLAY=:99.0"
- - "sh -e /etc/init.d/xvfb start"
- - sleep 5
+  - yarn danger ci
+  - npm install grunt-cli -g
+  - "export DISPLAY=:99.0"
+  - "export ELECTRON_DISABLE_SANDBOX=1"
+  - "sh -e /etc/init.d/xvfb start"
+  - sleep 5
 script:
-- grunt
-- npm run test:unit
-- npm run test:e2e
+  - npm run test:lint
+  - npm run test:e2e
+  - npm run test:unit
 after_script:
- - npm list
+  - npm list
 cache:
- directories:
-  - node_modules
+  directories:
+    - node_modules

CHANGELOG.md

@@ -3,9 +3,159 @@
 All notable changes to this project will be documented in this file.
 This project adheres to [Semantic Versioning](http://semver.org/).
 
----
+❤️ **Donate:** Enjoying MagicMirror²? [Please consider a donation!](https://magicmirror.builders/donate) With your help we can continue to improve the MagicMirror²
 
-❤️ **Donate:** Enjoying MagicMirror²? [Please consider a donation!](https://magicmirror.builders/donate) With your help we can continue to improve the MagicMirror² core.
+## [2.11.0] - 2020-04-01
+
+🚨 READ THIS BEFORE UPDATING 🚨
+
+In the past years the project has grown a lot. This came with a huge downside: poor maintainability. If I let the project continue the way it was, it would eventually crash and burn. More important: I would completely lose the drive and interest to continue the project. Because of this the decision was made to simplify the core by removing all side features like automatic installers and support for exotic platforms. This release (2.11.0) is the first real release that will reflect (parts) of these changes. As a result of this, some things might break. So before you continue make sure to backup your installation. Your config, your modules or better yet: your full MagicMirror folder. In other words: update at your own risk.
+
+For more information regarding this major change, please check issue [#1860](https://github.com/MichMich/MagicMirror/issues/1860).
+
+### Deleted
+- Remove installers.
+- Remove externalized scripts.
+- Remove jshint dependency, instead eslint checks your config file now
+
+### Added
+- Brazilian translation for "FEELS".
+- Ukrainian translation.
+- Finnish translation for "PRECIP", "UPDATE_INFO_MULTIPLE" and "UPDATE_INFO_SINGLE".
+- Added the ability to hide the temp label and weather icon in the `currentweather` module to allow showing only information such as wind and sunset/rise.
+- The `clock` module now optionally displays sun and moon data, including rise/set times, remaining daylight, and percent of moon illumination.
+- Added Hebrew translation.
+- Add HTTPS support and update config.js.sample
+- Run tests on long term support and latest stable version of nodejs
+- Added the ability to configure a list of modules that shouldn't be update checked.
+- Run linters on git commits
+- Added date functionality to compliments: display birthday wishes or celebrate an anniversary
+
+### Fixed
+- Force declaration of public ip address in config file (ISSUE #1852)
+- Fixes `run-start.sh`: If running in docker-container, don't check the environment, just start electron (ISSUE #1859)
+- Fix calendar time offset for recurring events crossing Daylight Savings Time (ISSUE #1798)
+- Fix regression in currentweather module causing 'undefined' to show up when config.hideTemp is false
+- Fix FEELS translation for Croatian
+- Fixed weather tests [#1840](https://github.com/MichMich/MagicMirror/issues/1840)
+- Fixed Socket.io can't be used with Reverse Proxy in serveronly mode [#1934](https://github.com/MichMich/MagicMirror/issues/1934)
+- Fix update checking skipping 3rd party modules the first time
+
+### Changed
+- Remove documentation from core repository and link to new dedicated docs site: [docs.magicmirror.builders](https://docs.magicmirror.builders).
+- Updated config.js.sample: Corrected some grammar on `config.js.sample` comment section.
+- Removed `run-start.sh` script and update start commands:
+  - To start using electron, use `npm run start`.
+  - To start in server only mode, use `npm run server`.
+- Remove redundant logging from modules.
+- Timestamp in log output now also contains the date
+- Turkish translation.
+- Option to configure the size of the currentweather module.
+
+## [2.10.1] - 2020-01-10
+
+### Changed
+- Updated README.md: Added links to the official documentation website and remove links to broken installer.
+
+## [2.10.0] - 2020-01-01
+
+Special thanks to @sdetweil for all his great contributions!
+
+ℹ️ **Note:** This update uses new dependencies. Please update using the following command: `git pull && npm install`.
+
+### Added
+- Timestamps in log output.
+- Padding in dateheader mode of the calendar module.
+- New upgrade script to help users consume regular updates installers/upgrade-script.sh.
+- New script to help setup pm2, without install installers/fixuppm2.sh.
+
+### Updated
+- Updated lower bound of `lodash` and `helmet` dependencies for security patches.
+- Updated compliments.js to handle newline in text, as textfields to not interpolate contents.
+- Updated raspberry.sh installer script to handle new platform issues, split node/npm, pm2, and screen saver changes.
+- Improve handling for armv6l devices, where electron support has gone away, add optional serveronly config option.
+- Improved run-start.sh to handle for serveronly mode, by choice, or when electron not available.
+- Only check for xwindows running if not on macOS.
+
+### Fixed
+- Fixed issue in weatherforecast module where predicted amount of rain was not using the decimal symbol specified in config.js.
+- Module header now updates correctly, if a module need to dynamically show/hide its header based on a condition.
+- Fix handling of config.js for serverOnly mode commented out.
+- Fixed issue in calendar module where the debug script didn't work correctly with authentication.
+- Fixed issue that some full day events were not correctly recognized as such.
+- Display full day events lasting multiple days as happening today instead of some days ago if they are still ongoing.
+
+## [2.9.0] - 2019-10-01
+
+ℹ️ **Note:** This update uses new dependencies. Please update using the following command: `git pull && npm install`. If you are having issues running Electron, make sure your [Raspbian is up to date](https://www.raspberrypi.org/documentation/raspbian/updating.md).
+
+### Added
+- Spanish translation for "PRECIP".
+- Adding a Malay (Malaysian) translation for MagicMirror².
+- Add test check URLs of vendors 200 and 404 HTTP CODE.
+- Add tests for new weather module and helper to stub ajax requests.
+
+### Updated
+- Updatenotification module: Display update notification for a limited (configurable) time.
+- Enabled e2e/vendor_spec.js tests.
+- The css/custom.css will be rename after the next release. We've add into `run-start.sh` a instruction by GIT to ignore with `--skip-worktree` and `rm --cached`. [#1540](https://github.com/MichMich/MagicMirror/issues/1540)
+- Disable sending of notification CLOCK_SECOND when displaySeconds is false.
+
+### Fixed
+- Updatenotification module: Properly handle race conditions, prevent crash.
+- Send `NEWS_FEED` notification also for the first news messages which are shown.
+- Fixed issue where weather module would not refresh data after a network or API outage. [#1722](https://github.com/MichMich/MagicMirror/issues/1722)
+- Fixed weatherforecast module not displaying rain amount on fallback endpoint.
+- Notifications CLOCK_SECOND & CLOCK_MINUTE being from startup instead of matched against the clock and avoid drifting.
+
+## [2.8.0] - 2019-07-01
+
+ℹ️ **Note:** This update uses new dependencies. Please update using the following command: `git pull && npm install`. If you are having issues running Electron, make sure your [Raspbian is up to date](https://www.raspberrypi.org/documentation/raspbian/updating.md).
+
+### Added
+- Option to show event location in calendar
+- Finnish translation for "Feels" and "Weeks"
+- Russian translation for “Feels”
+- Calendar module: added `nextDaysRelative` config option
+- Add `broadcastPastEvents` config option for calendars to include events from the past `maximumNumberOfDays` in event broadcasts
+- Added feature to broadcast news feed items `NEWS_FEED` and updated news items `NEWS_FEED_UPDATED` in default [newsfeed](https://github.com/MichMich/MagicMirror/tree/develop/modules/default/newsfeed) module (when news is updated) with documented default and `config.js` options in [README.md](https://github.com/MichMich/MagicMirror/blob/develop/modules/default/newsfeed/README.md)
+- Added notifications to default `clock` module broadcasting `CLOCK_SECOND` and `CLOCK_MINUTE` for the respective time elapsed.
+- Added UK Met Office Datapoint feed as a provider in the default weather module.
+- Added new provider class
+- Added suncalc.js dependency to calculate sun times (not provided in UK Met Office feed)
+- Added "tempUnits" and "windUnits" to allow, for example, temp in metric (i.e. celsius) and wind in imperial (i.e. mph). These will override "units" if specified, otherwise the "units" value will be used.
+- Use Feels Like temp from feed if present
+- Optionally display probability of precipitation (PoP) in current weather (UK Met Office data)
+- Automatically try to fix eslint errors by passing `--fix` option to it
+- Added sunrise and sunset times to weathergov weather provider [#1705](https://github.com/MichMich/MagicMirror/issues/1705)
+- Added "useLocationAsHeader" to display "location" in `config.js` as header when location name is not returned
+- Added to `newsfeed.js`: in order to design the news article better with css, three more class-names were introduced: newsfeed-desc, newsfeed-desc, newsfeed-desc
+
+### Updated
+- English translation for "Feels" to "Feels like"
+- Fixed the example calender url in `config.js.sample`
+- Update `ical.js` to solve various calendar issues.
+- Update weather city list url [#1676](https://github.com/MichMich/MagicMirror/issues/1676)
+- Only update clock once per minute when seconds aren't shown
+
+### Fixed
+- Fixed uncaught exception, race condition on module update
+- Fixed issue [#1696](https://github.com/MichMich/MagicMirror/issues/1696), some ical files start date to not parse to date type
+- Allowance HTML5 autoplay-policy (policy is changed from Chrome 66 updates)
+- Handle SIGTERM messages
+- Fixes sliceMultiDayEvents so it respects maximumNumberOfDays
+- Minor types in default NewsFeed [README.md](https://github.com/MichMich/MagicMirror/blob/develop/modules/default/newsfeed/README.md)
+- Fix typos and small syntax errors, cleanup dependencies, remove multiple-empty-lines, add semi-rule
+- Fixed issues with calendar not displaying one-time changes to repeating events
+- Updated the fetchedLocationName variable in currentweather.js so that city shows up in the header
+
+### Updated installer
+- give non-pi2+ users (pi0, odroid, jetson nano, mac, windows, ...) option to continue install
+- use current username vs hardcoded 'pi' to support non-pi install
+- check for npm installed. node install doesn't do npm anymore
+- check for mac as part of PM2 install, add install option string
+- update pm2 config with current username instead of hard coded 'pi'
+- check for screen saver config, "/etc/xdg/lxsession", bypass if not setup
 
 ## [2.7.1] - 2019-04-02
 
@@ -440,7 +590,7 @@ A huge, huge, huge thanks to user @fewieden for all his hard work on the new `we
 - Added option `remoteFile` to compliments module to load compliment array from filesystem.
 - Added option `zoom` to scale the whole mirror display with a given factor.
 - Added option `roundTemp` for currentweather and weatherforecast modules to display temperatures rounded to nearest integer.
-- Added abilty set the classes option to compliments module for style and text size of compliments.
+- Added ability set the classes option to compliments module for style and text size of compliments.
 - Added ability to configure electronOptions
 - Calendar module: option to hide private events
 - Add root_path for global vars

Gruntfile.js

@@ -1,9 +1,10 @@
 module.exports = function(grunt) {
 	require("time-grunt")(grunt);
+	var fix = (grunt.option("env") || "lint") === "lint";
 	grunt.initConfig({
-		pkg: grunt.file.readJSON("package.json"),
 		eslint: {
 			options: {
+				fix: fix,
 				configFile: ".eslintrc.json"
 			},
 			target: [
@@ -19,14 +20,14 @@ module.exports = function(grunt) {
 				"!modules/default/alert/classie.js",
 				"config/*",
 				"translations/translations.js",
-				"vendor/vendor.js",
-				"modules/node_modules/node_helper/index.js"
+				"vendor/vendor.js"
 			]
 		},
 		stylelint: {
 			simple: {
 				options: {
-					configFile: ".stylelintrc"
+					fix: fix,
+					configFile: ".stylelintrc.json"
 				},
 				src: [
 					"css/main.css",
@@ -42,11 +43,10 @@ module.exports = function(grunt) {
 				src: [
 					"package.json",
 					".eslintrc.json",
-					".stylelintrc",
+					".stylelintrc.json",
 					"translations/*.json",
 					"modules/default/*/translations/*.json",
-					"installers/pm2_MagicMirror.json",
-					"vendor/package.js"
+					"vendor/package.json"
 				],
 				options: {
 					reporter: "jshint"
@@ -76,7 +76,8 @@ module.exports = function(grunt) {
 						"MD018": false,
 						"MD012": false,
 						"MD026": false,
-						"MD038": false
+						"MD038": false,
+						"MD047": false
 					}
 				},
 				src: [
@@ -100,5 +101,6 @@ module.exports = function(grunt) {
 	grunt.loadNpmTasks("grunt-jsonlint");
 	grunt.loadNpmTasks("grunt-yamllint");
 	grunt.loadNpmTasks("grunt-markdownlint");
+
 	grunt.registerTask("default", ["eslint", "stylelint", "jsonlint", "markdownlint", "yamllint"]);
 };

LICENSE.md

@@ -1,7 +1,7 @@
 The MIT License (MIT)
 =====================
 
-Copyright © 2016-2017 Michael Teeuw
+Copyright © 2016-2019 Michael Teeuw
 
 Permission is hereby granted, free of charge, to any person
 obtaining a copy of this software and associated documentation

README.md

@@ -5,7 +5,7 @@
 	<a href="https://david-dm.org/MichMich/MagicMirror#info=devDependencies"><img src="https://david-dm.org/MichMich/MagicMirror/dev-status.svg" alt="devDependency Status"></a>
 	<a href="https://bestpractices.coreinfrastructure.org/projects/347"><img src="https://bestpractices.coreinfrastructure.org/projects/347/badge"></a>
 	<a href="http://choosealicense.com/licenses/mit"><img src="https://img.shields.io/badge/license-MIT-blue.svg" alt="License"></a>
-	<a href="https://travis-ci.org/MichMich/MagicMirror"><img src="https://travis-ci.org/MichMich/MagicMirror.svg" alt="Travis"></a>
+	<a href="https://travis-ci.com/MichMich/MagicMirror"><img src="https://travis-ci.com/MichMich/MagicMirror.svg" alt="Travis"></a>
 	<a href="https://snyk.io/test/github/MichMich/MagicMirror"><img src="https://snyk.io/test/github/MichMich/MagicMirror/badge.svg" alt="Known Vulnerabilities" data-canonical-src="https://snyk.io/test/github/MichMich/MagicMirror" style="max-width:100%;"></a>
 </p>
 
@@ -13,194 +13,20 @@
 
 MagicMirror² focuses on a modular plugin system and uses [Electron](http://electron.atom.io/) as an application wrapper. So no more web server or browser installs necessary!
 
-## Table Of Contents
+## Documentation
+For the full documentation including **[installation instructions](https://docs.magicmirror.builders/getting-started/installation.html)**, please visit our dedicated documentation website: [https://docs.magicmirror.builders](https://docs.magicmirror.builders).
 
-- [Table Of Contents](#table-of-contents)
-- [Installation](#installation)
-  - [Raspberry Pi](#raspberry-pi)
-    - [Automatic Installation (Raspberry Pi only!)](#automatic-installation-raspberry-pi-only)
-    - [Manual Installation](#manual-installation)
-  - [Server Only](#server-only)
-  - [Client Only](#client-only)
-  - [Docker](#docker)
-- [Configuration](#configuration)
-  - [Raspberry Specific](#raspberry-specific)
-  - [General](#general)
-- [Modules](#modules)
-- [Updating](#updating)
-- [Community](#community)
-- [Contributing Guidelines](#contributing-guidelines)
-- [Enjoying MagicMirror? Consider a donation!](#enjoying-magicmirror-consider-a-donation)
-- [Manifesto](#manifesto)
-
-## Installation
-
-### Raspberry Pi
-
-#### Automatic Installation (Raspberry Pi only!)
-
-*Electron*, the app wrapper around MagicMirror², only supports the Raspberry Pi 2/3. The Raspberry Pi 0/1 is currently **not** supported. If you want to run this on a Raspberry Pi 1, use the [server only](#server-only) feature and setup a fullscreen browser yourself. (Yes, people have managed to run MM² also on a Pi0, so if you insist, search in the forums.)
-
-Note that you will need to install the latest full version of Raspbian, **don't use the Lite version**.
-
-Execute the following command on your Raspberry Pi to install MagicMirror²:
-
-```bash
-bash -c "$(curl -sL https://raw.githubusercontent.com/MichMich/MagicMirror/master/installers/raspberry.sh)"
-```
-
-#### Manual Installation
-
-1. Download and install the latest *Node.js* version:
-- `curl -sL https://deb.nodesource.com/setup_10.x | sudo -E bash -`
-- `sudo apt install -y nodejs`
-2. Clone the repository and check out the master branch: `git clone https://github.com/MichMich/MagicMirror`
-3. Enter the repository: `cd MagicMirror/`
-4. Install and run the app with: `npm install && npm start` \
-   For **Server Only** use: `npm install && node serveronly` .
-
-
-**:warning: Important!**
-
-- **The installation step for `npm install` will take a very long time**, often with little or no terminal response! \
-  For the RPi3 this is **~10** minutes and for the Rpi2 **~25** minutes. \
-  Do not interrupt or you risk getting a :broken_heart: by Raspberry Jam.
-
-
-Also note that:
-
-- `npm start` does **not** work via SSH. But you can use `DISPLAY=:0 nohup npm start &` instead. \
-  This starts the mirror on the remote display.
-- If you want to debug on Raspberry Pi you can use `npm start dev` which will start MM with *Dev Tools* enabled.
-- To access toolbar menu when in mirror mode, hit `ALT` key.
-- To toggle the (web) `Developer Tools` from mirror mode, use `CTRL-SHIFT-I` or `ALT` and select `View`.
-
-
-### Server Only
-
-In some cases, you want to start the application without an actual app window. In this case, you can start MagicMirror² in server only mode by manually running `node serveronly` or using Docker. This will start the server, after which you can open the application in your browser of choice. Detailed description below.
-
-**Important:** Make sure that you whitelist the interface/ip (`ipWhitelist`) in the server config where you want the client to connect to, otherwise it will not be allowed to connect to the server. You also need to set the local host `address` field to `0.0.0.0` in order for the RPi to listen on all interfaces and not only `localhost` (default).
-
-```javascript
-var config = {
-	address: "0.0.0.0",	// default is "localhost"
-	port: 8080,		// default
-	ipWhitelist: ["127.0.0.1", "::ffff:127.0.0.1", "::1", "::ffff:172.17.0.1"], // default -- need to add your IP here
-	...
-};
-```
-
-
-### Client Only
-
-This is when you already have a server running remotely and want your RPi to connect as a standalone client to this instance, to show the MM from the server. Then from your RPi, you run it with: `node clientonly --address 192.168.1.5 --port 8080`. (Specify the ip address and port number of the server)
-
-
-### Docker
-
-MagicMirror² in server only mode can be deployed using [Docker](https://docker.com). After a successful [Docker installation](https://docs.docker.com/engine/installation/) you just need to execute the following command in the shell:
-
-```bash
-docker run  -d \
-	--publish 80:8080 \
-	--restart always \
-	--volume ~/magic_mirror/config:/opt/magic_mirror/config \
-	--volume ~/magic_mirror/modules:/opt/magic_mirror/modules \
-	--name magic_mirror \
-	bastilimbach/docker-magicmirror
-```
-To get more information about the available Dockerfile versions and configurations head over to the respective [GitHub repository](https://github.com/bastilimbach/docker-MagicMirror).
-
-
-## Configuration
-
-### Raspberry Specific
-
-The following wiki links are helpful for the initial configuration of your MagicMirror² operating system:
-- [Configuring the Raspberry Pi](https://github.com/MichMich/MagicMirror/wiki/Configuring-the-Raspberry-Pi)
-- [Auto Starting MagicMirror](https://github.com/MichMich/MagicMirror/wiki/Auto-Starting-MagicMirror)
-
-
-### General
-
-1. Copy `/home/pi/MagicMirror/config/config.js.sample` to `/home/pi/MagicMirror/config/config.js`. \
-   **Note:** If you used the installer script. This step is already done for you.
-
-2. Modify your required settings. \
-   Note: You can check your configuration running `npm run config:check` in `/home/pi/MagicMirror`.
-
-
-The following properties can be configured:
-
-| **Option** | **Description** |
-| --- | --- |
-| `port` | The port on which the MagicMirror² server will run on. The default value is `8080`. |
-| `address` | The *interface* ip address on which to accept connections. The default is `localhost`, which would prevent exposing the built-in webserver to machines on the local network. To expose it to other machines, use: `0.0.0.0`. |
-| `ipWhitelist` | The list of IPs from which you are allowed to access the MagicMirror². The default value is `["127.0.0.1", "::ffff:127.0.0.1", "::1"]`, which is from `localhost` only. Add your IP when needed. You can also specify IP ranges with subnet masks (`["127.0.0.1", "127.0.0.1/24"]`) or directly with (`["127.0.0.1", ["192.168.0.1", "192.168.0.100"]]`). Set `[]` to allow all IP addresses. For more information see: [follow post ipWhitelist HowTo](https://forum.magicmirror.builders/topic/1326/ipwhitelist-howto) |
-| `zoom` | This allows to scale the mirror contents with a given zoom factor. The default value is `1.0`|
-| `language` | The language of the interface. (Note: Not all elements will be localized.) Possible values are `en`, `nl`, `ru`, `fr`, etc., but the default value is `en`. |
-| `timeFormat` | The form of time notation that will be used. Possible values are `12` or `24`. The default is `24`. |
-| `units` | The units that will be used in the default weather modules. Possible values are `metric` or `imperial`. The default is `metric`. |
-| `modules` | An array of active modules. **The array must contain objects. See the next table below for more information.** |
-| `electronOptions` | An optional array of Electron (browser) options. This allows configuration of e.g. the browser screen size and position (example: `electronOptions: { fullscreen: false, width: 800, height: 600 }`). Kiosk mode can be enabled by setting `kiosk: true`, `autoHideMenuBar: false` and `fullscreen: false`. More options can be found [here](https://github.com/electron/electron/blob/master/docs/api/browser-window.md). |
-| `customCss` | The path of the `custom.css` stylesheet. The default is `css/custom.css`. |
-
-Module configuration:
-
-| **Option** | **Description** |
-| --- | --- |
-| `module` | The name of the module. This can also contain the subfolder. Valid examples include `clock`, `default/calendar` and `custommodules/mymodule`. |
-| `position` | The location of the module in which the module will be loaded. Possible values are `top_bar`, `top_left`, `top_center`, `top_right`, `upper_third`, `middle_center`, `lower_third`, `bottom_left`, `bottom_center`, `bottom_right`, `bottom_bar`, `fullscreen_above`, and `fullscreen_below`. This field is optional but most modules require this field to set. Check the documentation of the module for more information. Multiple modules with the same position will be ordered based on the order in the configuration file. |
-| `classes` | Additional classes which are passed to the module. The field is optional. |
-| `header` | To display a header text above the module, add the header property. This field is optional. |
-| `disabled` | Set disabled to `true` to skip creating the module. This field is optional. |
-| `config` | An object with the module configuration properties. Check the documentation of the module for more information. This field is optional, unless the module requires extra configuration. |
-
-## Modules
-
-The following modules are installed by default.
-
-- [**Clock**](modules/default/clock)
-- [**Calendar**](modules/default/calendar)
-- [**Current Weather**](modules/default/currentweather)
-- [**Weather Forecast**](modules/default/weatherforecast)
-- [**News Feed**](modules/default/newsfeed)
-- [**Compliments**](modules/default/compliments)
-- [**Hello World**](modules/default/helloworld)
-- [**Alert**](modules/default/alert)
-
-For more available modules, check out out the wiki page [MagicMirror² 3rd Party Modules](https://github.com/MichMich/MagicMirror/wiki/3rd-party-modules). If you want to build your own modules, check out the [MagicMirror² Module Development Documentation](modules) and don't forget to add it to the wiki and the [forum](https://forum.magicmirror.builders/category/7/showcase)!
-
-
-## Updating
-
-If you want to update your MagicMirror² to the latest version, use your terminal to go to your Magic Mirror folder and type the following command:
-
-```bash
-git pull && npm install
-```
-
-If you changed nothing more than the config or the modules, this should work without any problems.
-Type `git status` to see your changes, if there are any, you can reset them with `git reset --hard`. After that, git pull should be possible.
-
-
-## Community
-
-The community around the MagicMirror² is constantly growing. We even have a [forum](https://forum.magicmirror.builders) now where you can share your ideas, ask questions, help others and get inspired by other builders. We would love to see you there!
+## Links
+- Website: [https://magicmirror.builders](https://magicmirror.builders)
+- Documentation: [https://docs.magicmirror.builders](https://docs.magicmirror.builders)
+- Forum: [https://forum.magicmirror.builders](https://forum.magicmirror.builders)
+- Discord: [https://discord.gg/J5BAtvx](https://discord.gg/J5BAtvx)
+- Blog: [https://michaelteeuw.nl/tagged/magicmirror](https://michaelteeuw.nl/tagged/magicmirror)
+- Donations: [https://magicmirror.builders/#donate](https://magicmirror.builders/#donate)
 
 ## Contributing Guidelines
 
-Contributions of all kinds are welcome, not only in the form of code but also with regards bug reports and documentation.
-
-Please keep the following in mind:
-
-- **Bug Reports**:  Make sure you're running the latest version. If the issue(s) still persist: please open a clearly documented issue with a clear title.
-- **Minor Bug Fixes**: Please send a pull request with a clear explanation of the issue or a link to the issue it solves.
-- **Major Bug Fixes**: please discuss your approach in an GitHub issue before you start to alter a big part of the code.
-- **New Features**: please please discuss in a GitHub issue before you start to alter a big part of the code. Without discussion upfront, the pull request will not be accepted / merged.
-
-Thanks for your help in making MagicMirror² better!
+Contributions of all kinds are welcome, not only in the form of code but also with regards bug reports and documentation. For the full contribution guidelines, check out: [https://docs.magicmirror.builders/getting-started/contributing.html](https://docs.magicmirror.builders/getting-started/contributing.html)
 
 
 ## Enjoying MagicMirror? Consider a donation!
@@ -208,26 +34,10 @@ Thanks for your help in making MagicMirror² better!
 MagicMirror² is opensource and free. That doesn't mean we don't need any money.
 
 Please consider a donation to help us cover the ongoing costs like webservers and email services.
-If we recieve enough donations we might even be able to free up some working hours and spend some extra time improving the MagicMirror² core.
+If we receive enough donations we might even be able to free up some working hours and spend some extra time improving the MagicMirror² core.
 
 To donate, please follow [this](https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick&hosted_button_id=G5D8E9MR5DTD2&source=url) link.
 
-## Manifesto
-
-A real Manifesto is still to be written. Till then, Michael's response on [one of the repository issues](https://github.com/MichMich/MagicMirror/issues/1174) gives a great summary:
-
-> "... I started this project as an ultimate starter project for Raspberry Pi enthusiasts. As a matter of fact, for most of the contributors, the MagicMirror project is the first open source project they ever contributed to. This is one of the reasons why the MagicMirror project is featured in several RasPi magazines.
->
->The project has a lot of opportunities for improvement. We could use a powerful framework like Vue to ramp up the development speed. We could use SASS for better/easier css implementations. We could make it an NPM installable package. And as you say, we could bundle it up. The big downside of of of these changes is that it over complicates things: a user no longer will be able to open just one file and make a small modification and see how it works out.
->
->Of course, a bundled version can be complimentary to the regular un-bundled version. And I'm sure a lot of (new) users will opt for the bundled version. But this means those users won't be motivated to take a peek under the hood. They will just remain 'users'. They won't become contributors, and worse: they won't be motivated to take their first steps in software development.
->
->And to be honest: motivating curious users to step out of their comfort zone and take those first steps is what drives me in this project. Therefor my ultimate goal is this project is to keep it as accessible as possible."
->
-> ~ Michael Teeuw
-
-
-
 <p align="center">
 <br>
 	<a href="https://forum.magicmirror.builders/topic/728/magicmirror-is-voted-number-1-in-the-magpi-top-50"><img src="https://magicmirror.builders/img/magpi-best-watermark-custom.png" width="150" alt="MagPi Top 50"></a>

clientonly/index.js

@@ -1,8 +1,6 @@
-/* jshint esversion: 6 */
-
 "use strict";
 
-// Use seperate scope to prevent global scope pollution
+// Use separate scope to prevent global scope pollution
 (function () {
 	var config = {};
 
@@ -19,7 +17,7 @@
 		// Prefer command line arguments over environment variables
 		["address", "port"].forEach((key) => {
 			config[key] = getCommandLineParameter(key, process.env[key.toUpperCase()]);
-		})
+		});
 	}
 
 	function getServerConfig(url) {
@@ -30,7 +28,7 @@
 			const request = lib.get(url, (response) => {
 				var configData = "";
 
-				// Gather incomming data
+				// Gather incoming data
 				response.on("data", function(chunk) {
 					configData += chunk;
 				});
@@ -43,8 +41,8 @@
 			request.on("error", function(error) {
 				reject(new Error(`Unable to read config from server (${url} (${error.message}`));
 			});
-		})
-	};
+		});
+	}
 
 	function fail(message, code = 1) {
 		if (message !== undefined && typeof message === "string") {
@@ -89,7 +87,7 @@
 				});
 
 				child.on("close", (code) => {
-					if (code != 0) {
+					if (code !== 0) {
 						console.log(`There something wrong. The clientonly is not running code ${code}`);
 					}
 				});

config/config.js.sample

@@ -3,7 +3,7 @@
  * By Michael Teeuw http://michaelteeuw.nl
  * MIT Licensed.
  *
- * For more information how you can configurate this file
+ * For more information on how you can configure this file
  * See https://github.com/MichMich/MagicMirror#configuration
  *
  */
@@ -12,8 +12,8 @@ var config = {
 	address: "localhost", // Address to listen on, can be:
 	                      // - "localhost", "127.0.0.1", "::1" to listen on loopback interface
 	                      // - another specific IPv4/6 to listen on a specific interface
-	                      // - "", "0.0.0.0", "::" to listen on any interface
-	                      // Default, when address config is left out, is "localhost"
+	                      // - "0.0.0.0", "::" to listen on any interface
+	                      // Default, when address config is left out or empty, is "localhost"
 	port: 8080,
 	ipWhitelist: ["127.0.0.1", "::ffff:127.0.0.1", "::1"], // Set [] to allow all IP addresses
 	                                                       // or add a specific IPv4 of 192.168.1.5 :
@@ -21,9 +21,18 @@ var config = {
 	                                                       // or IPv4 range of 192.168.3.0 --> 192.168.3.15 use CIDR format :
 	                                                       // ["127.0.0.1", "::ffff:127.0.0.1", "::1", "::ffff:192.168.3.0/28"],
 
+	useHttps: false, 		// Support HTTPS or not, default "false" will use HTTP
+	httpsPrivateKey: "", 	// HTTPS private key path, only require when useHttps is true
+	httpsCertificate: "", 	// HTTPS Certificate path, only require when useHttps is true
+
 	language: "en",
 	timeFormat: 24,
 	units: "metric",
+	// serverOnly:  true/false/"local" ,
+			     // local for armv6l processors, default
+			     //   starts serveronly and then starts chrome browser
+			     // false, default for all  NON-armv6l devices
+			     // true, force serveronly mode, because you want to.. no UI on this device
 
 	modules: [
 		{
@@ -45,8 +54,7 @@ var config = {
 				calendars: [
 					{
 						symbol: "calendar-check",
-						url: "webcal://www.calendarlabs.com/templates/ical/US-Holidays.ics"
-					}
+						url: "webcal://www.calendarlabs.com/ical-calendar/ics/76/US_Holidays.ics"					}
 				]
 			}
 		},
@@ -59,7 +67,7 @@ var config = {
 			position: "top_right",
 			config: {
 				location: "New York",
-				locationID: "",  //ID from http://bulk.openweathermap.org/sample/; unzip the gz file and find your city
+				locationID: "", //ID from http://bulk.openweathermap.org/sample/city.list.json.gz; unzip the gz file and find your city
 				appid: "YOUR_OPENWEATHER_API_KEY"
 			}
 		},
@@ -69,7 +77,7 @@ var config = {
 			header: "Weather Forecast",
 			config: {
 				location: "New York",
-				locationID: "5128581",  //ID from https://openweathermap.org/city
+				locationID: "5128581", //ID from http://bulk.openweathermap.org/sample/city.list.json.gz; unzip the gz file and find your city
 				appid: "YOUR_OPENWEATHER_API_KEY"
 			}
 		},
@@ -84,7 +92,9 @@ var config = {
 					}
 				],
 				showSourceTitle: true,
-				showPublishDate: true
+				showPublishDate: true,
+				broadcastNewsFeeds: true,
+				broadcastNewsUpdates: true
 			}
 		},
 	]

css/custom.css

@@ -1,14 +0,0 @@
-/*****************************************************
- * Magic Mirror                                      *
- * Custom CSS                                        *
- *                                                   *
- * By Michael Teeuw http://michaelteeuw.nl           *
- * MIT Licensed.                                     *
- *                                                   *
- * Add any custom CSS below.                         *
- * Changes to this files will be ignored by GIT. *
- *****************************************************/
-
- body {
- 	
- }

dangerfile.js

@@ -1,9 +1,9 @@
-import { danger, fail, warn } from "danger"
+import { danger, fail, warn } from "danger";
 
 // Check if the CHANGELOG.md file has been edited
 // Fail the build and post a comment reminding submitters to do so if it wasn't changed
 if (!danger.git.modified_files.includes("CHANGELOG.md")) {
-	warn("Please include an updated `CHANGELOG.md` file.<br>This way we can keep track of all the contributions.")
+	warn("Please include an updated `CHANGELOG.md` file.<br>This way we can keep track of all the contributions.");
 }
 
 // Check if the PR request is send to the master branch.
@@ -12,6 +12,6 @@ if (danger.github.pr.base.ref === "master" && danger.github.pr.user.login !== "M
 	// Check if the PR body or title includes the text: #accepted.
 	// If not, the PR will fail.
 	if ((danger.github.pr.body + danger.github.pr.title).includes("#accepted")) {
-		fail("Please send all your pull requests to the `develop` branch.<br>Pull requests on the `master` branch will not be accepted.")
+		fail("Please send all your pull requests to the `develop` branch.<br>Pull requests on the `master` branch will not be accepted.");
 	}
-}
+}

index.html

@@ -37,7 +37,7 @@
 		<div class="region bottom right"><div class="container"></div></div>
 	</div>
 	<div class="region fullscreen above"><div class="container"></div></div>
-	<script type="text/javascript" src="/socket.io/socket.io.js"></script>
+	<script type="text/javascript" src="socket.io/socket.io.js"></script>
 	<script type="text/javascript" src="vendor/node_modules/nunjucks/browser/nunjucks.min.js"></script>
 	<script type="text/javascript" src="js/defaults.js"></script>
 	<script type="text/javascript" src="#CONFIG_FILE#"></script>

installers/mm.sh

@@ -1,2 +1,3 @@
+# This file is still here to keep PM2 working on older installations.
 cd ~/MagicMirror
 DISPLAY=:0 npm start

installers/pm2_MagicMirror.json

@@ -1,7 +0,0 @@
-{
-  "apps" : [{
-    "name"        : "MagicMirror",
-    "script"      : "/home/pi/MagicMirror/installers/mm.sh",
-    "watch"       : ["/home/pi/MagicMirror/config/config.js"]
-  }]
-}

installers/postinstall/postinstall.sh

@@ -1,2 +0,0 @@
-echo "\033[32mMagicMirror installation successful!"
-exit 0

installers/raspberry.sh

@@ -1,173 +0,0 @@
-#!/usr/bin/env bash
-
-# This is an installer script for MagicMirror2. It works well enough
-# that it can detect if you have Node installed, run a binary script
-# and then download and run MagicMirror2.
-
-echo -e "\e[0m"
-echo '$$\      $$\                     $$\           $$\      $$\ $$\                                          $$$$$$\'
-echo '$$$\    $$$ |                    \__|          $$$\    $$$ |\__|                                        $$  __$$\'
-echo '$$$$\  $$$$ | $$$$$$\   $$$$$$\  $$\  $$$$$$$\ $$$$\  $$$$ |$$\  $$$$$$\   $$$$$$\   $$$$$$\   $$$$$$\  \__/  $$ |'
-echo '$$\$$\$$ $$ | \____$$\ $$  __$$\ $$ |$$  _____|$$\$$\$$ $$ |$$ |$$  __$$\ $$  __$$\ $$  __$$\ $$  __$$\  $$$$$$  |'
-echo '$$ \$$$  $$ | $$$$$$$ |$$ /  $$ |$$ |$$ /      $$ \$$$  $$ |$$ |$$ |  \__|$$ |  \__|$$ /  $$ |$$ |  \__|$$  ____/'
-echo '$$ |\$  /$$ |$$  __$$ |$$ |  $$ |$$ |$$ |      $$ |\$  /$$ |$$ |$$ |      $$ |      $$ |  $$ |$$ |      $$ |'
-echo '$$ | \_/ $$ |\$$$$$$$ |\$$$$$$$ |$$ |\$$$$$$$\ $$ | \_/ $$ |$$ |$$ |      $$ |      \$$$$$$  |$$ |      $$$$$$$$\'
-echo '\__|     \__| \_______| \____$$ |\__| \_______|\__|     \__|\__|\__|      \__|       \______/ \__|      \________|'
-echo '                       $$\   $$ |'
-echo '                       \$$$$$$  |'
-echo '                        \______/'
-echo -e "\e[0m"
-
-# Define the tested version of Node.js.
-NODE_TESTED="v5.1.0"
-
-# Determine which Pi is running.
-ARM=$(uname -m) 
-
-# Check the Raspberry Pi version.
-if [ "$ARM" != "armv7l" ]; then
-	echo -e "\e[91mSorry, your Raspberry Pi is not supported."
-	echo -e "\e[91mPlease run MagicMirror on a Raspberry Pi 2 or 3."
-	echo -e "\e[91mIf this is a Pi Zero, you are in the same boat as the original Raspberry Pi. You must run in server only mode."
-	exit;
-fi
-
-# Define helper methods.
-function version_gt() { test "$(echo "$@" | tr " " "\n" | sort -V | head -n 1)" != "$1"; }
-function command_exists () { type "$1" &> /dev/null ;}
-
-# Update before first apt-get
-echo -e "\e[96mUpdating packages ...\e[90m"
-sudo apt-get update || echo -e "\e[91mUpdate failed, carrying on installation ...\e[90m"
-
-# Installing helper tools
-echo -e "\e[96mInstalling helper tools ...\e[90m"
-sudo apt-get --assume-yes install curl wget git build-essential unzip || exit
-
-# Check if we need to install or upgrade Node.js.
-echo -e "\e[96mCheck current Node installation ...\e[0m"
-NODE_INSTALL=false
-if command_exists node && command_exists npm; then
-	echo -e "\e[0mNode currently installed. Checking version number.";
-	NODE_CURRENT=$(node -v)
-	echo -e "\e[0mMinimum Node version: \e[1m$NODE_TESTED\e[0m"
-	echo -e "\e[0mInstalled Node version: \e[1m$NODE_CURRENT\e[0m"
-	if version_gt $NODE_TESTED $NODE_CURRENT; then
-		echo -e "\e[96mNode should be upgraded.\e[0m"
-		NODE_INSTALL=true
-
-		# Check if a node process is currenlty running.
-		# If so abort installation.
-		if pgrep "node" > /dev/null; then
-			echo -e "\e[91mA Node process is currently running. Can't upgrade."
-			echo "Please quit all Node processes and restart the installer."
-			exit;
-		fi
-
-	else
-		echo -e "\e[92mNo Node.js upgrade necessary.\e[0m"
-	fi
-
-else
-	echo -e "\e[93mNode.js is not installed.\e[0m";
-	NODE_INSTALL=true
-fi
-
-# Install or upgrade node if necessary.
-if $NODE_INSTALL; then
-	
-	echo -e "\e[96mInstalling Node.js ...\e[90m"
-
-	# Fetch the latest version of Node.js from the selected branch
-	# The NODE_STABLE_BRANCH variable will need to be manually adjusted when a new branch is released. (e.g. 7.x)
-	# Only tested (stable) versions are recommended as newer versions could break MagicMirror.
-	
-	NODE_STABLE_BRANCH="10.x"
-	curl -sL https://deb.nodesource.com/setup_$NODE_STABLE_BRANCH | sudo -E bash -
-	sudo apt-get install -y nodejs
-	echo -e "\e[92mNode.js installation Done!\e[0m"
-fi
-
-# Install MagicMirror
-cd ~
-if [ -d "$HOME/MagicMirror" ] ; then
-	echo -e "\e[93mIt seems like MagicMirror is already installed."
-	echo -e "To prevent overwriting, the installer will be aborted."
-	echo -e "Please rename the \e[1m~/MagicMirror\e[0m\e[93m folder and try again.\e[0m"
-	echo ""
-	echo -e "If you want to upgrade your installation run \e[1m\e[97mgit pull\e[0m from the ~/MagicMirror directory."
-	echo ""
-	exit;
-fi
-
-echo -e "\e[96mCloning MagicMirror ...\e[90m"
-if git clone --depth=1 https://github.com/MichMich/MagicMirror.git; then 
-	echo -e "\e[92mCloning MagicMirror Done!\e[0m"
-else
-	echo -e "\e[91mUnable to clone MagicMirror."
-	exit;
-fi
-
-cd ~/MagicMirror  || exit
-echo -e "\e[96mInstalling dependencies ...\e[90m"
-if npm install; then 
-	echo -e "\e[92mDependencies installation Done!\e[0m"
-else
-	echo -e "\e[91mUnable to install dependencies!"
-	exit;
-fi
-
-# Use sample config for start MagicMirror
-cp config/config.js.sample config/config.js
-
-# Check if plymouth is installed (default with PIXEL desktop environment), then install custom splashscreen.
-echo -e "\e[96mCheck plymouth installation ...\e[0m"
-if command_exists plymouth; then
-	THEME_DIR="/usr/share/plymouth/themes"
-	echo -e "\e[90mSplashscreen: Checking themes directory.\e[0m"
-	if [ -d $THEME_DIR ]; then
-		echo -e "\e[90mSplashscreen: Create theme directory if not exists.\e[0m"
-		if [ ! -d $THEME_DIR/MagicMirror ]; then
-			sudo mkdir $THEME_DIR/MagicMirror
-		fi
-
-		if sudo cp ~/MagicMirror/splashscreen/splash.png $THEME_DIR/MagicMirror/splash.png && sudo cp ~/MagicMirror/splashscreen/MagicMirror.plymouth $THEME_DIR/MagicMirror/MagicMirror.plymouth && sudo cp ~/MagicMirror/splashscreen/MagicMirror.script $THEME_DIR/MagicMirror/MagicMirror.script; then
-			echo -e "\e[90mSplashscreen: Theme copied successfully.\e[0m"
-			if sudo plymouth-set-default-theme -R MagicMirror; then
-				echo -e "\e[92mSplashscreen: Changed theme to MagicMirror successfully.\e[0m"
-			else
-				echo -e "\e[91mSplashscreen: Couldn't change theme to MagicMirror!\e[0m"
-			fi
-		else
-			echo -e "\e[91mSplashscreen: Copying theme failed!\e[0m"
-		fi
-	else
-		echo -e "\e[91mSplashscreen: Themes folder doesn't exist!\e[0m"
-	fi
-else
-	echo -e "\e[93mplymouth is not installed.\e[0m";
-fi
-
-# Use pm2 control like a service MagicMirror
-read -p "Do you want use pm2 for auto starting of your MagicMirror (y/N)?" choice
-if [[ $choice =~ ^[Yy]$ ]]; then
-    sudo npm install -g pm2
-	if [[ "$(ps --no-headers -o comm 1)" =~ systemd ]]; then #Checking for systemd
-		sudo pm2 startup systemd -u pi --hp /home/pi
-	else
-		sudo su -c "env PATH=$PATH:/usr/bin pm2 startup linux -u pi --hp /home/pi"
-	fi
-	pm2 start ~/MagicMirror/installers/pm2_MagicMirror.json
-	pm2 save
-fi
-# Disable Screensaver
-read -p "Do you want to disable the screen saver? (y/N)?" choice
-if [[ $choice =~ ^[Yy]$ ]]; then
-	sudo su -c "echo -e '@xset s noblank\n@xset s off\n@xset -dpms' >> /etc/xdg/lxsession/LXDE-pi/autostart"
-	export DISPLAY=:0; xset s noblank;xset s off;xset -dpms
-fi
-
-echo " "
-echo -e "\e[92mWe're ready! Run \e[1m\e[97mDISPLAY=:0 npm start\e[0m\e[92m from the ~/MagicMirror directory to start your MagicMirror.\e[0m"
-echo " "
-echo " "

js/app.js

@@ -4,13 +4,18 @@
  * By Michael Teeuw http://michaelteeuw.nl
  * MIT Licensed.
  */
-
 var fs = require("fs");
 var Server = require(__dirname + "/server.js");
 var Utils = require(__dirname + "/utils.js");
 var defaultModules = require(__dirname + "/../modules/default/defaultmodules.js");
 var path = require("path");
 
+// Alias modules mentioned in package.js under _moduleAliases.
+require("module-alias/register");
+
+// add timestamps in front of log messages
+require("console-stamp")(console, "yyyy-mm-dd HH:MM:ss.l");
+
 // Get version number.
 global.version = JSON.parse(fs.readFileSync("package.json", "utf8")).version;
 console.log("Starting MagicMirror: v" + global.version);
@@ -48,7 +53,6 @@ var App = function() {
 	 *
 	 * argument callback function - The callback function.
 	 */
-
 	var loadConfig = function(callback) {
 		console.log("Loading config ...");
 		var defaults = require(__dirname + "/defaults.js");
@@ -67,7 +71,7 @@ var App = function() {
 			var config = Object.assign(defaults, c);
 			callback(config);
 		} catch (e) {
-			if (e.code == "ENOENT") {
+			if (e.code === "ENOENT") {
 				console.error(Utils.colors.error("WARNING! Could not find config file. Please create one. Starting with default configuration."));
 			} else if (e instanceof ReferenceError || e instanceof SyntaxError) {
 				console.error(Utils.colors.error("WARNING! Could not validate config file. Starting with default configuration. Please correct syntax errors at or above this line: " + e.stack));
@@ -96,7 +100,7 @@ var App = function() {
 				". Check README and CHANGELOG for more up-to-date ways of getting the same functionality.")
 			);
 		}
-	}
+	};
 
 	/* loadModule(module)
 	 * Loads a specific module.
@@ -107,10 +111,10 @@ var App = function() {
 
 		var elements = module.split("/");
 		var moduleName = elements[elements.length - 1];
-		var moduleFolder =  __dirname + "/../modules/" + module;
+		var moduleFolder = __dirname + "/../modules/" + module;
 
 		if (defaultModules.indexOf(moduleName) !== -1) {
-			moduleFolder =  __dirname + "/../modules/default/" + module;
+			moduleFolder = __dirname + "/../modules/default/" + module;
 		}
 
 		var helperPath = moduleFolder + "/node_helper.js";
@@ -173,7 +177,7 @@ var App = function() {
 	};
 
 	/* cmpVersions(a,b)
-	 * Compare two symantic version numbers and return the difference.
+	 * Compare two semantic version numbers and return the difference.
 	 *
 	 * argument a string - Version number a.
 	 * argument a string - Version number b.
@@ -197,7 +201,7 @@ var App = function() {
 	/* start(callback)
 	 * This methods starts the core app.
 	 * It loads the config, then it loads all modules.
-	 * When it"s done it executs the callback with the config as argument.
+	 * When it's done it executes the callback with the config as argument.
 	 *
 	 * argument callback function - The callback function.
 	 */
@@ -231,7 +235,6 @@ var App = function() {
 					if (typeof callback === "function") {
 						callback(config);
 					}
-
 				});
 			});
 		});
@@ -259,7 +262,16 @@ var App = function() {
 	 */
 	process.on("SIGINT", () => {
 		console.log("[SIGINT] Received. Shutting down server...");
-		setTimeout(() => { process.exit(0); }, 3000);  // Force quit after 3 seconds
+		setTimeout(() => { process.exit(0); }, 3000); // Force quit after 3 seconds
+		this.stop();
+		process.exit(0);
+	});
+
+	/* We also need to listen to SIGTERM signals so we stop everything when we are asked to stop by the OS.
+	 */
+	process.on("SIGTERM", () => {
+		console.log("[SIGTERM] Received. Shutting down server...");
+		setTimeout(() => { process.exit(0); }, 3000); // Force quit after 3 seconds
 		this.stop();
 		process.exit(0);
 	});

js/class.js

@@ -21,7 +21,7 @@
 		var prototype = new this();
 		initializing = false;
 
-		// Make a copy of all prototype properies, to prevent reference issues.
+		// Make a copy of all prototype properties, to prevent reference issues.
 		for (var name in prototype) {
 			prototype[name] = cloneObject(prototype[name]);
 		}
@@ -29,8 +29,8 @@
 		// Copy the properties over onto the new prototype
 		for (var name in prop) {
 			// Check if we're overwriting an existing function
-			prototype[name] = typeof prop[name] == "function" &&
-				typeof _super[name] == "function" && fnTest.test(prop[name]) ? (function (name, fn) {
+			prototype[name] = typeof prop[name] === "function" &&
+				typeof _super[name] === "function" && fnTest.test(prop[name]) ? (function (name, fn) {
 					return function () {
 						var tmp = this._super;
 
@@ -43,7 +43,6 @@
 						var ret = fn.apply(this, arguments);
 						this._super = tmp;
 
-
 						return ret;
 					};
 				})(name, prop[name]) : prop[name];

js/electron.js

@@ -1,5 +1,3 @@
-/* jshint esversion: 6 */
-
 "use strict";
 
 const electron = require("electron");
@@ -17,6 +15,7 @@ const BrowserWindow = electron.BrowserWindow;
 let mainWindow;
 
 function createWindow() {
+	app.commandLine.appendSwitch("autoplay-policy", "no-user-gesture-required");
 	var electronOptionsDefaults = {
 		width: 800,
 		height: 600,

js/loader.js

@@ -8,7 +8,7 @@
 
 var Loader = (function() {
 
-	/* Create helper valiables */
+	/* Create helper variables */
 
 	var loadedModuleFiles = [];
 	var loadedFiles = [];
@@ -55,7 +55,7 @@ var Loader = (function() {
 			module.start();
 		}
 
-		// Notifiy core of loded modules.
+		// Notify core of loaded modules.
 		MM.modulesStarted(moduleObjects);
 	};
 
@@ -83,10 +83,10 @@ var Loader = (function() {
 
 			var elements = module.split("/");
 			var moduleName = elements[elements.length - 1];
-			var moduleFolder =  config.paths.modules + "/" + module;
+			var moduleFolder = config.paths.modules + "/" + module;
 
 			if (defaultModules.indexOf(moduleName) !== -1) {
-				moduleFolder =  config.paths.modules + "/default/" + module;
+				moduleFolder = config.paths.modules + "/default/" + module;
 			}
 
 			if (moduleData.disabled === true) {
@@ -104,7 +104,6 @@ var Loader = (function() {
 				config: moduleData.config,
 				classes: (typeof moduleData.classes !== "undefined") ? moduleData.classes + " " + module : module
 			});
-
 		}
 
 		return moduleFiles;
@@ -138,7 +137,6 @@ var Loader = (function() {
 				afterLoad();
 			});
 		}
-
 	};
 
 	/* bootstrapModule(module, mObj)
@@ -164,7 +162,6 @@ var Loader = (function() {
 				});
 			});
 		});
-
 	};
 
 	/* loadFile(fileName)
@@ -175,7 +172,7 @@ var Loader = (function() {
 	 */
 	var loadFile = function(fileName, callback) {
 
-		var extension =  fileName.slice((Math.max(0, fileName.lastIndexOf(".")) || Infinity) + 1);
+		var extension = fileName.slice((Math.max(0, fileName.lastIndexOf(".")) || Infinity) + 1);
 
 		switch (extension.toLowerCase()) {
 		case "js":
@@ -210,7 +207,6 @@ var Loader = (function() {
 			document.getElementsByTagName("head")[0].appendChild(stylesheet);
 			break;
 		}
-
 	};
 
 	/* Public Methods */
@@ -261,5 +257,4 @@ var Loader = (function() {
 			loadFile(module.file(fileName), callback);
 		}
 	};
-
 })();

js/main.js

@@ -1,5 +1,4 @@
 /* global  Log, Loader, Module, config, defaults */
-/* jshint -W020, esversion: 6 */
 
 /* Magic Mirror
  * Main System
@@ -39,11 +38,13 @@ var MM = (function() {
 			dom.opacity = 0;
 			wrapper.appendChild(dom);
 
-			if (typeof module.getHeader() !== "undefined" && module.getHeader() !== "") {
-				var moduleHeader = document.createElement("header");
-				moduleHeader.innerHTML = module.getHeader();
-				moduleHeader.className = "module-header";
-				dom.appendChild(moduleHeader);
+			var moduleHeader = document.createElement("header");
+			moduleHeader.innerHTML = module.getHeader();
+			moduleHeader.className = "module-header";
+			dom.appendChild(moduleHeader);
+
+			if (typeof module.getHeader() === "undefined" || module.getHeader() !== "") {
+				moduleHeader.style = "display: none;";
 			}
 
 			var moduleContent = document.createElement("div");
@@ -203,15 +204,15 @@ var MM = (function() {
 	 */
 	var updateModuleContent = function(module, newHeader, newContent) {
 		var moduleWrapper = document.getElementById(module.identifier);
+		if (moduleWrapper === null) {return;}
 		var headerWrapper = moduleWrapper.getElementsByClassName("module-header");
 		var contentWrapper = moduleWrapper.getElementsByClassName("module-content");
 
 		contentWrapper[0].innerHTML = "";
 		contentWrapper[0].appendChild(newContent);
 
-		if( headerWrapper.length > 0 && newHeader) {
-			headerWrapper[0].innerHTML = newHeader;
-		}
+		headerWrapper[0].innerHTML = newHeader;
+		headerWrapper[0].style = headerWrapper.length > 0 && newHeader ? undefined : "display: none;";
 	};
 
 	/* hideModule(module, speed, callback)
@@ -291,7 +292,7 @@ var MM = (function() {
 		var moduleWrapper = document.getElementById(module.identifier);
 		if (moduleWrapper !== null) {
 			moduleWrapper.style.transition = "opacity " + speed / 1000 + "s";
-			// Restore the postition. See hideModule() for more info.
+			// Restore the position. See hideModule() for more info.
 			moduleWrapper.style.position = "static";
 
 			updateWrapperStates();
@@ -304,14 +305,16 @@ var MM = (function() {
 			module.showHideTimer = setTimeout(function() {
 				if (typeof callback === "function") { callback(); }
 			}, speed);
-
+		} else {
+			// invoke callback
+			if (typeof callback === "function") { callback(); }
 		}
 	};
 
 	/* updateWrapperStates()
 	 * Checks for all positions if it has visible content.
 	 * If not, if will hide the position to prevent unwanted margins.
-	 * This method schould be called by the show and hide methods.
+	 * This method should be called by the show and hide methods.
 	 *
 	 * Example:
 	 * If the top_bar only contains the update notification. And no update is available,
@@ -319,7 +322,6 @@ var MM = (function() {
 	 * an ugly top margin. By using this function, the top bar will be hidden if the
 	 * update notification is not visible.
 	 */
-
 	var updateWrapperStates = function() {
 		var positions = ["top_bar", "top_left", "top_center", "top_right", "upper_third", "middle_center", "lower_third", "bottom_left", "bottom_center", "bottom_right", "bottom_bar", "fullscreen_above", "fullscreen_below"];
 
@@ -329,7 +331,7 @@ var MM = (function() {
 
 			var showWrapper = false;
 			Array.prototype.forEach.call(moduleWrappers, function(moduleWrapper) {
-				if (moduleWrapper.style.position == "" || moduleWrapper.style.position == "static") {
+				if (moduleWrapper.style.position === "" || moduleWrapper.style.position === "static") {
 					showWrapper = true;
 				}
 			});
@@ -376,7 +378,7 @@ var MM = (function() {
 		 *
 		 * return array - Filtered collection of modules.
 		 */
-		var exceptWithClass  = function(className) {
+		var exceptWithClass = function(className) {
 			return modulesByClass(className, false);
 		};
 
@@ -438,10 +440,10 @@ var MM = (function() {
 			});
 		};
 
-		if (typeof modules.withClass === "undefined") { Object.defineProperty(modules, "withClass",  {value: withClass, enumerable: false}); }
-		if (typeof modules.exceptWithClass === "undefined") { Object.defineProperty(modules, "exceptWithClass",  {value: exceptWithClass, enumerable: false}); }
-		if (typeof modules.exceptModule === "undefined") { Object.defineProperty(modules, "exceptModule",  {value: exceptModule, enumerable: false}); }
-		if (typeof modules.enumerate === "undefined") { Object.defineProperty(modules, "enumerate",  {value: enumerate, enumerable: false}); }
+		if (typeof modules.withClass === "undefined") { Object.defineProperty(modules, "withClass", {value: withClass, enumerable: false}); }
+		if (typeof modules.exceptWithClass === "undefined") { Object.defineProperty(modules, "exceptWithClass", {value: exceptWithClass, enumerable: false}); }
+		if (typeof modules.exceptModule === "undefined") { Object.defineProperty(modules, "exceptModule", {value: exceptModule, enumerable: false}); }
+		if (typeof modules.enumerate === "undefined") { Object.defineProperty(modules, "enumerate", {value: enumerate, enumerable: false}); }
 	};
 
 	return {
@@ -478,7 +480,7 @@ var MM = (function() {
 		/* sendNotification(notification, payload, sender)
 		 * Send a notification to all modules.
 		 *
-		 * argument notification string - The identifier of the noitication.
+		 * argument notification string - The identifier of the notification.
 		 * argument payload mixed - The payload of the notification.
 		 * argument sender Module - The module that sent the notification.
 		 */
@@ -558,7 +560,7 @@ var MM = (function() {
 })();
 
 // Add polyfill for Object.assign.
-if (typeof Object.assign != "function") {
+if (typeof Object.assign !== "function") {
 	(function() {
 		Object.assign = function(target) {
 			"use strict";

js/module.js

@@ -76,7 +76,7 @@ var Module = Class.extend({
 	/* getDom()
 	 * This method generates the dom which needs to be displayed. This method is called by the Magic Mirror core.
 	 * This method can to be subclassed if the module wants to display info on the mirror.
-	 * Alternatively, the getTemplete method could be subclassed.
+	 * Alternatively, the getTemplate method could be subclassed.
 	 *
 	 * return DomObject | Promise - The dom or a promise with the dom to display.
 	 */
@@ -92,7 +92,7 @@ var Module = Class.extend({
 				// the template is a filename
 				self.nunjucksEnvironment().render(template, templateData, function (err, res) {
 					if (err) {
-						Log.error(err)
+						Log.error(err);
 					}
 
 					div.innerHTML = res;
@@ -121,7 +121,7 @@ var Module = Class.extend({
 
 	/* getTemplate()
 	 * This method returns the template for the module which is used by the default getDom implementation.
-	 * This method needs to be subclassed if the module wants to use a tempate.
+	 * This method needs to be subclassed if the module wants to use a template.
 	 * It can either return a template sting, or a template filename.
 	 * If the string ends with '.html' it's considered a file from within the module's folder.
 	 *
@@ -138,7 +138,7 @@ var Module = Class.extend({
 	 * return Object
 	 */
 	getTemplateData: function () {
-		return {}
+		return {};
 	},
 
 	/* notificationReceived(notification, payload, sender)
@@ -151,9 +151,9 @@ var Module = Class.extend({
 	 */
 	notificationReceived: function (notification, payload, sender) {
 		if (sender) {
-			Log.log(this.name + " received a module notification: " + notification + " from sender: " + sender.name);
+			// Log.log(this.name + " received a module notification: " + notification + " from sender: " + sender.name);
 		} else {
-			Log.log(this.name + " received a system notification: " + notification);
+			// Log.log(this.name + " received a system notification: " + notification);
 		}
 	},
 
@@ -164,7 +164,7 @@ var Module = Class.extend({
 	 * @returns Nunjucks Environment
 	 */
 	nunjucksEnvironment: function() {
-		if (this._nunjucksEnvironment != null) {
+		if (this._nunjucksEnvironment !== null) {
 			return this._nunjucksEnvironment;
 		}
 
@@ -175,7 +175,7 @@ var Module = Class.extend({
 			lstripBlocks: true
 		});
 		this._nunjucksEnvironment.addFilter("translate", function(str) {
-			return self.translate(str)
+			return self.translate(str);
 		});
 
 		return this._nunjucksEnvironment;
@@ -233,7 +233,7 @@ var Module = Class.extend({
 	},
 
 	/* socket()
-	 * Returns a socket object. If it doesn"t exist, it"s created.
+	 * Returns a socket object. If it doesn't exist, it"s created.
 	 * It also registers the notification callback.
 	 */
 	socket: function () {
@@ -417,8 +417,11 @@ var Module = Class.extend({
 		callback = callback || function () { };
 		options = options || {};
 
-		this.resume();
-		MM.showModule(this, speed, callback, options);
+		var self = this;
+		MM.showModule(this, speed, function () {
+			self.resume();
+			callback;
+		}, options);
 	}
 });
 
@@ -438,11 +441,10 @@ Module.create = function (name) {
 	var ModuleClass = Module.extend(clonedDefinition);
 
 	return new ModuleClass();
-
 };
 
 /* cmpVersions(a,b)
-* Compare two symantic version numbers and return the difference.
+* Compare two semantic version numbers and return the difference.
 *
 * argument a string - Version number a.
 * argument a string - Version number b.

js/node_helper.js

@@ -5,7 +5,7 @@
  * MIT Licensed.
  */
 
-var Class = require("../../../js/class.js");
+var Class = require("./class.js");
 var express = require("express");
 var path = require("path");
 
@@ -101,9 +101,9 @@ NodeHelper = Class.extend({
 			var onevent = socket.onevent;
 			socket.onevent = function(packet) {
 				var args = packet.data || [];
-				onevent.call(this, packet);    // original call
+				onevent.call(this, packet); // original call
 				packet.data = ["*"].concat(args);
-				onevent.call(this, packet);      // additional call to catch-all
+				onevent.call(this, packet); // additional call to catch-all
 			};
 
 			// register catch all.

js/server.js

@@ -7,8 +7,6 @@
 
 var express = require("express");
 var app = require("express")();
-var server = require("http").Server(app);
-var io = require("socket.io")(server);
 var path = require("path");
 var ipfilter = require("express-ipfilter").IpFilter;
 var fs = require("fs");
@@ -22,12 +20,24 @@ var Server = function(config, callback) {
 		port = process.env.MM_PORT;
 	}
 
+	var server = null;
+	if(config.useHttps){
+		var options = {
+			key: fs.readFileSync(config.httpsPrivateKey),
+			cert: fs.readFileSync(config.httpsCertificate)
+		};
+		server = require("https").Server(options, app);
+	}else{
+		server = require("http").Server(app);
+	}
+	var io = require("socket.io")(server);
+
 	console.log("Starting server on port " + port + " ... ");
 
-	server.listen(port, config.address ? config.address : null);
+	server.listen(port, config.address ? config.address : "localhost");
 
-	if (config.ipWhitelist instanceof Array && config.ipWhitelist.length == 0) {
-		console.info(Utils.colors.warn("You're using a full whitelist configuration to allow for all IPs"))
+	if (config.ipWhitelist instanceof Array && config.ipWhitelist.length === 0) {
+		console.info(Utils.colors.warn("You're using a full whitelist configuration to allow for all IPs"));
 	}
 
 	app.use(function(req, res, next) {

js/socketclient.js

@@ -8,15 +8,17 @@ var MMSocket = function(moduleName) {
 	self.moduleName = moduleName;
 
 	// Private Methods
-	self.socket = io("/" + self.moduleName);
+	self.socket = io("/" + self.moduleName, {
+		path: window.location.pathname + "socket.io"
+	});
 	var notificationCallback = function() {};
 
 	var onevent = self.socket.onevent;
 	self.socket.onevent = function(packet) {
 		var args = packet.data || [];
-		onevent.call(this, packet);    // original call
+		onevent.call(this, packet); // original call
 		packet.data = ["*"].concat(args);
-		onevent.call(this, packet);      // additional call to catch-all
+		onevent.call(this, packet); // additional call to catch-all
 	};
 
 	// register catch all.

js/translator.js

@@ -18,7 +18,7 @@ var Translator = (function() {
 		xhr.overrideMimeType("application/json");
 		xhr.open("GET", file, true);
 		xhr.onreadystatechange = function () {
-			if (xhr.readyState == 4 && xhr.status == "200") {
+			if (xhr.readyState === 4 && xhr.status === 200) {
 				callback(JSON.parse(stripComments(xhr.responseText)));
 			}
 		};
@@ -159,6 +159,7 @@ var Translator = (function() {
 
 			return key;
 		},
+
 		/* load(module, file, isFallback, callback)
 		 * Load a translation file (json) and remember the data.
 		 *

modules/README.md

@@ -1,721 +0,0 @@
-# MagicMirror² Module Development Documentation
-
-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. 
-Therefore **we highly recommend you to include the following information in your README file.**
-
-- A high quality screenshot of your working module
-- A short, one sentence, clear description what it does (duh!)
-- What external API's it depends upon, including web links to those
-- Whether the API/request require a key and the user limitations of those. (Is it free?)
-
-Surely this also help you get better recognition and feedback for your work. 
-
-## Module structure
-
-All modules are loaded in the `modules` folder. The default modules are grouped together in the `modules/default` folder. Your module should be placed in a subfolder of `modules`. Note that any file or folder your create in the `modules` folder will be ignored by git, allowing you to upgrade the MagicMirror² without the loss of your files.
-
-A module can be placed in one single folder. Or multiple modules can be grouped in a subfolder. Note that name of the module must be unique. Even when a module with a similar name is placed in a different folder, they can't be loaded at the same time.
-
-### Files
-- **modulename/modulename.js** - This is your core module script.
-- **modulename/node_helper.js** - This is an optional helper that will be loaded by the node script. The node helper and module script can communicate with each other using an integrated socket system.
-- **modulename/public** - Any files in this folder can be accessed 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.
-
-## 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",{});
-````
-Of course, the above module would not do anything fancy, so it's good to look at one of the simplest modules: **helloworld**:
-
-````javascript
-//helloworld.js:
-
-Module.register("helloworld",{
-	// Default module config.
-	defaults: {
-		text: "Hello World!"
-	},
-
-	// Override dom generator.
-	getDom: function() {
-		var wrapper = document.createElement("div");
-		wrapper.innerHTML = this.config.text;
-		return wrapper;
-	}
-});
-````
-
-As you can see, the `Module.register()` method takes two arguments: the name of the module and an object with the module properties.
-
-### Available module instance properties
-After the module is initialized, the module instance has a few available module properties:
-
-| 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 `this.data` data object contain the following 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.
-- `data.header` - The header added to the module.
-- `data.position` - The position in which the instance will be shown.
-
-
-#### `defaults: {}`
-Any properties defined in the defaults object, will be merged with the module config as defined in the user's config.js file. This is the best place to set your modules' configuration defaults. Any of the module configuration properties can be accessed using `this.config.propertyName`, but more about that later.
-
-#### `requiresVersion:`
-
-*Introduced in version: 2.1.0.*
-
-A string that defines the minimum version of the MagicMirror framework. If it is set, the system compares the required version with the users version. If the version of the user is out of date, it won't run the module. Make sure to also set this value in the Node helper.
-
-**Note:** Since this check is introduced in version 2.1.0, this check will not be run in older versions. Keep this in mind if you get issue reports on your module.
-
-Example:
-````javascript
-requiresVersion: "2.1.0",
-````
-
-### Subclassable module methods
-
-#### `init()`
-This method is called when a module gets instantiated. In most cases you do not need to subclass this method.
-
-#### `loaded(callback)`
-
-*Introduced in version: 2.1.1.*
-
-This method is called when a module is loaded. Subsequent modules in the config are not yet loaded. The `callback` function MUST be called when the module is done loading. In most cases you do not need to subclass this method.
-
-**Example:**
-````javascript
-loaded: function(callback) {
-	this.finishLoading();
-	Log.log(this.name + ' is loaded!');
-	callback();
-}
-````
-
-#### `start()`
-This method is called when all modules are loaded and the system is ready to boot up. Keep in mind that the dom object for the module is not yet created. The start method is a perfect place to define any additional module properties:
-
-**Example:**
-````javascript
-start: function() {
-	this.mySpecialProperty = "So much wow!";
-	Log.log(this.name + ' is started!');
-}
-````
-
-#### `getScripts()`
-**Should return: Array**
-
-The getScripts method is called to request any additional scripts that need to be loaded. This method should therefore return an array with strings. If you want to return a full path to a file in the module folder, use the `this.file('filename.js')` method. In all cases the loader will only load a file once. It even checks if the file is available in the default vendor folder.
-
-**Example:**
-````javascript
-getScripts: function() {
-	return [
-		'script.js', // will try to load it from the vendor folder, otherwise it will load is from the module folder.
-		'moment.js', // this file is available in the vendor folder, so it doesn't need to be available in the module folder.
-		this.file('anotherfile.js'), // this file will be loaded straight from the module folder.
-		'https://code.jquery.com/jquery-2.2.3.min.js',  // this file will be loaded from the jquery servers.
-	]
-}
-
-````
-**Note:** If a file can not be loaded, the boot up of the mirror will stall. Therefore, it's advised not to use any external urls.
-
-
-#### `getStyles()`
-**Should return: Array**
-
-The getStyles method is called to request any additional stylesheets that need to be loaded. This method should therefore return an array with strings. If you want to return a full path to a file in the module folder, use the `this.file('filename.css')` method. In all cases the loader will only load a file once. It even checks if the file is available in the default vendor folder.
-
-**Example:**
-````javascript
-getStyles: function() {
-	return [
-		'script.css', // will try to load it from the vendor folder, otherwise it will load is from the module folder.
-		'font-awesome.css', // this file is available in the vendor folder, so it doesn't need to be available in the module folder.
-		this.file('anotherfile.css'), // this file will be loaded straight from the module folder.
-		'https://maxcdn.bootstrapcdn.com/bootstrap/3.3.6/css/bootstrap.min.css',  // this file will be loaded from the bootstrapcdn servers.
-	]
-}
-
-````
-**Note:** If a file can not be loaded, the boot up of the mirror will stall. Therefore, it's advised not to use any external URLs.
-
-#### `getTranslations()`
-**Should return: Dictionary**
-
-The getTranslations method is called to request translation files that need to be loaded. This method should therefore return a dictionary with the files to load, identified by the country's short name.
-
-If the module does not have any module specific translations, the function can just be omitted or return `false`.
-
-**Example:**
-````javascript
-getTranslations: function() {
-	return {
-			en: "translations/en.json",
-			de: "translations/de.json"
-	}
-}
-
-````
-
-#### `getDom()`
-**Should return:** Dom Object
-
-Whenever the MagicMirror needs to update the information on screen (because it starts, or because your module asked a refresh using `this.updateDom()`), the system calls the getDom method. This method should therefore return a dom object.
-
-**Example:**
-````javascript
-getDom: function() {
-	var wrapper = document.createElement("div");
-	wrapper.innerHTML = 'Hello world!';
-	return wrapper;
-}
-
-````
-
-#### `getHeader()`
-**Should return:** String
-
-Whenever the MagicMirror needs to update the information on screen (because it starts, or because your module asked a refresh using `this.updateDom()`), the system calls the getHeader method to retrieve the module's header. This method should therefor return a string. If this method is not subclassed, this function will return the user's configured header.
-
-If you want to use the original user's configured header, reference `this.data.header`.
-
-**NOTE:** If the user did not configure a default header, no header will be displayed and thus this method will not be called.
-
-**Example:**
-````javascript
-getHeader: function() {
-	return this.data.header + ' Foo Bar';
-}
-
-````
-
-#### `notificationReceived(notification, payload, sender)`
-
-That MagicMirror core has the ability to send notifications to modules. Or even better: the modules have the possibility to send notifications to other modules. When this module is called, it has 3 arguments:
-
-- `notification` - String - The notification identifier.
-- `payload` - AnyType - The payload of a notification.
-- `sender` - Module - The sender of the notification. If this argument is `undefined`, the sender of the notification is the core system.
-
-**Example:**
-````javascript
-notificationReceived: function(notification, payload, sender) {
-	if (sender) {
-		Log.log(this.name + " received a module notification: " + notification + " from sender: " + sender.name);
-	} else {
-		Log.log(this.name + " received a system notification: " + notification);
-	}
-}
-````
-
-**Note:** the system sends three notifications when starting up. These notifications could come in handy!
-
-
-- `ALL_MODULES_STARTED` - All modules are started. You can now send notifications to other modules.
-- `DOM_OBJECTS_CREATED` - All dom objects are created. The system is now ready to perform visual changes.
-- `MODULE_DOM_CREATED` - This module's dom has been fully loaded. You can now access your module's dom objects.
-
-
-#### `socketNotificationReceived: function(notification, payload)`
-When using a node_helper, the node helper can send your module notifications. When this module is called, it has 2 arguments:
-
-- `notification` - String - The notification identifier.
-- `payload` - AnyType - The payload of a notification.
-
-**Note 1:** When a node helper sends a notification, all modules of that module type receive the same notifications. <br>
-**Note 2:** The socket connection is established as soon as the module sends its first message using [sendSocketNotification](thissendsocketnotificationnotification-payload).
-
-**Example:**
-````javascript
-socketNotificationReceived: function(notification, payload) {
-	Log.log(this.name + " received a socket notification: " + notification + " - Payload: " + payload);
-},
-````
-
-#### `suspend()`
-When a module is hidden (using the `module.hide()` method), the `suspend()` method will be called. By subclassing this method you can perform tasks like halting the update timers.
-
-#### `resume()`
-When a module is requested to be shown (using the `module.show()` method), the `resume()` method will be called. By subclassing this method you can perform tasks restarting the update timers.
-
-
-### Module instance methods
-
-Each module instance has some handy methods which can be helpful building your module.
-
-
-#### `this.file(filename)`
-***filename* String** - The name of the file you want to create the path for.<br>
-**Returns String**
-
-If you want to create a path to a file in your module folder, use the `file()` method. It returns the path to the filename given as the attribute. Is method comes in handy when configuring the [getScripts](#getscripts) and [getStyles](#getstyles) methods.
-
-#### `this.updateDom(speed)`
-***speed* Number** - Optional. Animation speed in milliseconds.<br>
-
-Whenever your module need to be updated, call the `updateDom(speed)` method. It requests the MagicMirror core to update its dom object. If you define the speed, the content update will be animated, but only if the content will really change.
-
-As an example: the clock modules calls this method every second:
-
-````javascript
-...
-start: function() {
-	var self = this;
-	setInterval(function() {
-		self.updateDom(); // no speed defined, so it updates instantly.
-	}, 1000); //perform every 1000 milliseconds.
-},
-...
-````
-
-#### `this.sendNotification(notification, payload)`
-***notification* String** - The notification identifier.<br>
-***payload* AnyType** - Optional. A notification payload.<br>
-
-If you want to send a notification to all other modules, use the `sendNotification(notification, payload)`. All other modules will receive the message via the [notificationReceived](#notificationreceivednotification-payload-sender) method. In that case, the sender is automatically set to the instance calling the sendNotification method.
-
-**Example:**
-````javascript
-this.sendNotification('MYMODULE_READY_FOR_ACTION', {foo:bar});
-````
-
-#### `this.sendSocketNotification(notification, payload)`
-***notification* String** - The notification identifier.<br>
-***payload* AnyType** - Optional. A notification payload.<br>
-
-If you want to send a notification to the node_helper, use the `sendSocketNotification(notification, payload)`. Only the node_helper of this module will receive the socket notification.
-
-**Example:**
-````javascript
-this.sendSocketNotification('SET_CONFIG', this.config);
-````
-
-#### `this.hide(speed, callback, options)`
-***speed* Number** - Optional (Required when setting callback or options), The speed of the hide animation in milliseconds.
-***callback* Function** - Optional, The callback after the hide animation is finished.
-***options* Function** - Optional, Object with additional options for the hide action (see below). (*Introduced in version: 2.1.0.*)
-
-To hide a module, you can call the `hide(speed, callback)` method. You can call the hide method on the module instance itself using `this.hide()`, but of course you can also hide another module using `anOtherModule.hide()`.
-
-Possible configurable options:
-
-- `lockString` - String - When setting lock string, the module can not be shown without passing the correct lockstring. This way (multiple) modules can prevent a module from showing. It's considered best practice to use your modules identifier as the locksString: `this.identifier`. See *visibility locking* below.
-
-
-**Note 1:** If the hide animation is cancelled, for instance because the show method is called before the hide animation was finished, the callback will not be called.<br>
-**Note 2:** If the hide animation is hijacked (an other method calls hide on the same module), the callback will not be called.<br>
-**Note 3:** If the dom is not yet created, the hide method won't work. Wait for the `DOM_OBJECTS_CREATED` [notification](#notificationreceivednotification-payload-sender).
-
-
-#### `this.show(speed, callback, options)`
-***speed* Number** - Optional (Required when setting callback or options), The speed of the show animation in milliseconds.
-***callback* Function** - Optional, The callback after the show animation is finished.
-***options* Function** - Optional, Object with additional options for the show action (see below). (*Introduced in version: 2.1.0.*)
-
-To show a module, you can call the `show(speed, callback)` method. You can call the show method on the module instance itself using `this.show()`, but of course you can also show another module using `anOtherModule.show()`.
-
-Possible configurable options:
-
-- `lockString` - String - When setting lock string, the module can not be shown without passing the correct lockstring. This way (multiple) modules can prevent a module from showing. See *visibility locking* below.
-- `force` - Boolean - When setting the force tag to `true`, the locking mechanism will be overwritten. Use this option with caution. It's considered best practice to let the usage of the force option be use- configurable. See *visibility locking* below.
-
-**Note 1:** If the show animation is canceled, for instance because the hide method is called before the show animation was finished, the callback will not be called.<br>
-**Note 2:** If the show animation is hijacked (an other method calls show on the same module), the callback will not be called.<br>
-**Note 3:** If the dom is not yet created, the show method won't work. Wait for the `DOM_OBJECTS_CREATED` [notification](#notificationreceivednotification-payload-sender).
-
-#### Visibility locking
-
-(*Introduced in version: 2.1.0.*)
-
-Visibility locking helps the module system to prevent unwanted hide/show actions. The following scenario explains the concept:
-
-**Module B asks module A to hide:**
-````javascript
-moduleA.hide(0, {lockString: "module_b_identifier"});
-````
-Module A is now hidden, and has an lock array with the following strings:
-````javascript
-moduleA.lockStrings == ["module_b_identifier"]
-moduleA.hidden == true
-````
-**Module C asks module A to hide:**
-````javascript
-moduleA.hide(0, {lockString: "module_c_identifier"});
-````
-Module A is now hidden, and has an lock array with the following strings:
-````javascript
-moduleA.lockStrings == ["module_b_identifier", "module_c_identifier"]
-moduleA.hidden == true
-````
-**Module B asks module A to show:**
-````javascript
-moduleA.show(0, {lockString: "module_b_identifier"});
-````
-The lockString will be removed from moduleA’s locks array, but since there still is an other lock string available, the module remains hidden:
-````javascript
-moduleA.lockStrings == ["module_c_identifier"]
-moduleA.hidden == true
-````
-**Module C asks module A to show:**
-````javascript
-moduleA.show(0, {lockString: "module_c_identifier"});
-````
-The lockString will be removed from moduleA’s locks array, and since this will result in an empty lock array, the module will be visible:
-````javascript
-moduleA.lockStrings == []
-moduleA.hidden == false
-````
-
-**Note:** The locking mechanism can be overwritten by using the force tag:
-````javascript
-moduleA.show(0, {force: true});
-````
-This will reset the lockstring array, and will show the module.
-````javascript
-moduleA.lockStrings == []
-moduleA.hidden == false
-````
-
-Use this `force` method with caution. See `show()` method for more information.
-
-
-
-#### `this.translate(identifier)`
-***identifier* String** - Identifier of the string that should be translated.
-
-The Magic Mirror contains a convenience wrapper for `l18n`. You can use this to automatically serve different translations for your modules based on the user's `language` configuration.
-
-If no translation is found, a fallback will be used. The fallback sequence is as follows:
-- 1. Translation as defined in module translation file of the user's preferred language.
-- 2. Translation as defined in core translation file of the user's preferred language.
-- 3. Translation as defined in module translation file of the fallback language (the first defined module translation file).
-- 4. Translation as defined in core translation file of the fallback language (the first defined core translation file).
-- 5. The key (identifier) of the translation.
-
-When adding translations to your module, it's a good idea to see if an appropriate translation is already available in the [core translation files](https://github.com/MichMich/MagicMirror/tree/master/translations). This way, your module can benefit from the existing translations.
-
-**Example:**
-````javascript
-this.translate("INFO") //Will return a translated string for the identifier INFO
-````
-
-**Example json file:**
-````javascript
-{
-  "INFO": "Really important information!"
-}
-````
-
-**Note:** although comments are officially not supported in JSON files, MagicMirror allows it by stripping the comments before parsing the JSON file. Comments in translation files could help other translators.
-
-##### `this.translate(identifier, variables)`
-***identifier* String** - Identifier of the string that should be translated.
-***variables* Object** - Object of variables to be used in translation.
-
-This improved and backwards compatible way to handle translations behaves like the normal translation function and follows the rules described above. It's recommended to use this new format for translating everywhere. It allows translator to change the word order in the sentence to be translated.
-
-
-**Example:**
-````javascript
-var timeUntilEnd = moment(event.endDate, "x").fromNow(true);
-this.translate("RUNNING", { "timeUntilEnd": timeUntilEnd) }); // Will return a translated string for the identifier RUNNING, replacing `{timeUntilEnd}` with the contents of the variable `timeUntilEnd` in the order that translator intended.
-````
-
-**Example English .json file:**
-````javascript
-{
-	"RUNNING": "Ends in {timeUntilEnd}",
-}
-````
-
-**Example Finnish .json file:**
-````javascript
-{
-	"RUNNING": "Päättyy {timeUntilEnd} päästä",
-}
-````
-
-**Note:** The *variables* Object has an special case called `fallback`. It's used to support old translations in translation files that do not have the variables in them. If you are upgrading an old module that had translations that did not support the word order, it is recommended to have the fallback layout.
-
-**Example:**
-````javascript
-var timeUntilEnd = moment(event.endDate, "x").fromNow(true);
-this.translate("RUNNING", {
-	"fallback": this.translate("RUNNING") + " {timeUntilEnd}"
-	"timeUntilEnd": timeUntilEnd
-)}); // Will return a translated string for the identifier RUNNING, replacing `{timeUntilEnd}` with the contents of the variable `timeUntilEnd` in the order that translator intended. (has a fallback)
-````
-
-**Example Swedish .json file that does not have the variable in it:**
-````javascript
-{
-	"RUNNING": "Slutar",
-}
-````
-In this case the `translate`-function will not find any variables in the translation, will look for `fallback` variable and use that if possible to create the translation.
-
-## The Node Helper: node_helper.js
-
-The node helper is a Node.js script that is able to do some backend task to support your module. For every module type, only one node helper instance will be created. For example: if your MagicMirror uses two calendar modules, there will be only one calendar node helper instantiated.
-
-**Note:** Because there is only one node helper per module type, there is no default config available within your module. It's your task to send the desired config from your module to your node helper.
-
-In it's most simple form, the node_helper.js file must contain:
-
-````javascript
-var NodeHelper = require("node_helper");
-module.exports = NodeHelper.create({});
-````
-
-Of course, the above helper would not do anything useful. So with the information above, you should be able to make it a bit more sophisticated.
-
-### Available module instance properties
-
-#### `this.name`
-**String**
-
-The name of the module
-
-#### `this.path`
-**String**
-
-The path of the module
-
-#### `this.expressApp`
-**Express App Instance**
-
-This is a link to the express instance. It will allow you to define extra routes.
-
-**Example:**
-````javascript
-start: function() {
-	this.expressApp.get('/foobar', function (req, res) {
-		res.send('GET request to /foobar');
-	});
-}
-````
-
-**Note:** By default, a public path to your module's public folder will be created:
-````javascript
-this.expressApp.use("/" + this.name, express.static(this.path + "/public"));
-````
-
-#### `this.io`
-**Socket IO Instance**
-
-This is a link to the IO instance. It will allow you to do some Socket.IO magic. In most cases you won't need this, since the Node Helper has a few convenience methods to make this simple.
-
-
-#### `requiresVersion:`
-*Introduced in version: 2.1.0.*
-
-A string that defines the minimum version of the MagicMirror framework. If it is set, the system compares the required version with the users version. If the version of the user is out of date, it won't run the module.
-
-**Note:** Since this check is introduced in version 2.1.0, this check will not be run in older versions. Keep this in mind if you get issue reports on your module.
-
-Example:
-````javascript
-requiresVersion: "2.1.0",
-````
-
-### Subclassable module methods
-
-#### `init()`
-This method is called when a node helper gets instantiated. In most cases you do not need to subclass this method.
-
-#### `start()`
-This method is called when all node helpers are loaded and the system is ready to boot up. The start method is a perfect place to define any additional module properties:
-
-**Example:**
-````javascript
-start: function() {
-	this.mySpecialProperty = "So much wow!";
-	Log.log(this.name + ' is started!');
-}
-````
-
-#### `stop()`
-This method is called when the MagicMirror server receives a `SIGINT` command and is shutting down. This method should include any commands needed to close any open connections, stop any sub-processes and gracefully exit the module.
-
-**Example:**
-````javascript
-stop: function() {
-	console.log("Shutting down MyModule");
-	this.connection.close();
-}
-````
-
-#### `socketNotificationReceived: function(notification, payload)`
-With this method, your node helper can receive notifications from your modules. When this method is called, it has 2 arguments:
-
-- `notification` - String - The notification identifier.
-- `payload` - AnyType - The payload of a notification.
-
-**Note:** The socket connection is established as soon as the module sends its first message using [sendSocketNotification](thissendsocketnotificationnotification-payload).
-
-**Example:**
-````javascript
-socketNotificationReceived: function(notification, payload) {
-	Log.log(this.name + " received a socket notification: " + notification + " - Payload: " + payload);
-},
-````
-
-### Module instance methods
-
-Each node helper has some handy methods which can be helpful building your module.
-
-#### `this.sendSocketNotification(notification, payload)`
-***notification* String** - The notification identifier.<br>
-***payload* AnyType** - Optional. A notification payload.<br>
-
-If you want to send a notification to all your modules, use the `sendSocketNotification(notification, payload)`. Only the module of your module type will receive the socket notification.
-
-**Note:** Since all instances of your module will receive the notifications, it's your task to make sure the right module responds to your messages.
-
-**Example:**
-````javascript
-this.sendSocketNotification('SET_CONFIG', this.config);
-````
-
-## MagicMirror Helper Methods
-
-The core Magic Mirror object: `MM` has some handy method that will help you in controlling your and other modules. Most of the `MM` methods are available via convenience methods on the Module instance.
-
-### Module selection
-The only additional method available for your module, is the feature to retrieve references to other modules. This can be used to hide and show other modules.
-
-#### `MM.getModules()`
-**Returns Array** - An array with module instances.<br>
-
-To make a selection of all currently loaded module instances, run the `MM.getModules()` method. It will return an array with all currently loaded module instances. The returned array has a lot of filtering methods. See below for more info.
-
-**Note:** This method returns an empty array if not all modules are started yet. Wait for the `ALL_MODULES_STARTED` [notification](#notificationreceivednotification-payload-sender).
-
-
-##### `.withClass(classnames)`
-***classnames* String or Array** - The class names on which you want to filter.
-**Returns Array** - An array with module instances.<br>
-
-If you want to make a selection based on one or more class names, use the withClass method on a result of the `MM.getModules()` method. The argument of the `withClass(classname)` method can be an array, or space separated string.
-
-**Examples:**
-````javascript
-var modules = MM.getModules().withClass('classname');
-var modules = MM.getModules().withClass('classname1 classname2');
-var modules = MM.getModules().withClass(['classname1','classname2']);
-````
-
-##### `.exceptWithClass(classnames)`
-***classnames* String or Array** - The class names of the modules you want to remove from the results.
-**Returns Array** - An array with module instances.<br>
-
-If you to remove some modules from a selection based on a classname, use the exceptWithClass method on a result of the `MM.getModules()` method. The argument of the `exceptWithClass(classname)` method can be an array, or space separated string.
-
-**Examples:**
-````javascript
-var modules = MM.getModules().exceptWithClass('classname');
-var modules = MM.getModules().exceptWithClass('classname1 classname2');
-var modules = MM.getModules().exceptWithClass(['classname1','classname2']);
-````
-
-##### `.exceptModule(module)`
-***module* Module Object** - The reference to a module you want to remove from the results.
-**Returns Array** - An array with module instances.<br>
-
-If you to remove a specific module instance from a selection based on a classname, use the exceptWithClass method on a result of the `MM.getModules()` method. This can be helpful if you want to select all module instances except the instance of your module.
-
-**Examples:**
-````javascript
-var modules = MM.getModules().exceptModule(this);
-````
-
-Of course, you can combine all of the above filters:
-
-**Example:**
-````javascript
-var modules = MM.getModules().withClass('classname1').exceptwithClass('classname2').exceptModule(aModule);
-````
-
-##### `.enumerate(callback)`
-***callback* Function(module)** - The callback run on every instance.
-
-If you want to perform an action on all selected modules, you can use the `enumerate` function:
-
-````javascript
-MM.getModules().enumerate(function(module) {
-    Log.log(module.name);
-});
-````
-
-**Example:**
-To hide all modules except the your module instance, you could write something like:
-````javascript
-Module.register("modulename",{
-	//...
-	notificationReceived: function(notification, payload, sender) {
-		if (notification === 'DOM_OBJECTS_CREATED') {
-			MM.getModules().exceptModule(this).enumerate(function(module) {
-				module.hide(1000, function() {
-					//Module hidden.
-				});
-			});
-		}
-	},
-	//...
-});
-````
-
-## MagicMirror Logger
-
-The Magic Mirror contains a convenience wrapper for logging. Currently, this logger is a simple proxy to the original `console.log` methods. But it might get additional features in the future. The Loggers is currently only available in the core module file (not in the node_helper).
-
-**Examples:**
-````javascript
-Log.info('error');
-Log.log('log');
-Log.error('info');
-````

modules/default/alert/README.md

@@ -1,65 +1,4 @@
 # Module: Alert
 The alert module is one of the default modules of the MagicMirror. This module displays notifications from other modules.
 
-## Usage
-To use this module, add it to the modules array in the config/config.js file:
-
-```
-modules: [
-	{
-		module: "alert",
-		config: {
-			// The config property is optional.
-			// See 'Configuration options' for more information.
-		}
-	}
-]
-```
-
-## Configuration options
-
-The following properties can be configured:
-
-
-| Option            | Description
-| ----------------- | -----------
-| `effect`          | The animation effect to use for notifications. <br><br> **Possible values:** `scale` `slide` `genie` `jelly` `flip` `exploader` `bouncyflip` <br> **Default value:** `slide`
-| `alert_effect`    | The animation effect to use for alerts. <br><br> **Possible values:** `scale` `slide` `genie` `jelly` `flip` `exploader` `bouncyflip` <br> **Default value:** `jelly`
-| `display_time`    | Time a notification is displayed in milliseconds. <br><br> **Possible values:** `int` <br> **Default value:** `3500`
-| `position`        | Position where the notifications should be displayed. <br><br> **Possible values:** `left` `center` `right` <br> **Default value:** `center`
-| `welcome_message` | Message shown at startup. <br><br> **Possible values:** `string` `false` <br> **Default value:** `false` (no message at startup)
-
-
-## Developer notes
-For notifications use:
-
-```
-self.sendNotification("SHOW_ALERT", {type: "notification"});
-```
-For alerts use:
-
-```
-self.sendNotification("SHOW_ALERT", {});
-```
-
-### Notification params
-| Option             | Description
-| ------------------ | -----------
-| `title`            | The title of the notification. <br><br> **Possible values:** `text` or `html`
-| `message`	         | The message of the notification. <br><br> **Possible values:** `text` or `html`
-| `timer` (optional) | How long the notification should stay visible in ms. <br> If absent, the default `display_time` is used. <br> **Possible values:** `int` `float`
-
-
-### Alert params
-| Option                                          | Description
-| ----------------------------------------------- | -----------
-| `title`                                         | The title of the alert. <br><br> **Possible values:** `text` or `html`
-| `message`                                       | The message of the alert. <br><br> **Possible values:** `text` or `html`
-| `imageUrl` (optional)                           | Image to show in the alert <br><br> **Possible values:** `url` `path` <br> **Default value:** `none`
-| `imageFA` (optional)                            | Font Awesome icon to show in the alert <br><br> **Possible values:** See [Font Awsome](http://fontawesome.io/icons/) website. <br> **Default value:** `none`
-| `imageHeight` (optional even with imageUrl set) | Height of the image <br><br> **Possible values:** `intpx` <br> **Default value:** `80px`
-| `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)
-See [tympanus.net](http://tympanus.net/codrops/licensing/) for license.
+For configuration options, please check the [MagicMirror² documentation](https://docs.magicmirror.builders/modules/alert.html).

modules/default/alert/alert.js

@@ -35,13 +35,13 @@ Module.register("alert",{
 		};
 	},
 	show_notification: function(message) {
-		if (this.config.effect == "slide") {this.config.effect = this.config.effect + "-" + this.config.position;}
+		if (this.config.effect === "slide") {this.config.effect = this.config.effect + "-" + this.config.position;}
 		msg = "";
 		if (message.title) {
 			msg += "<span class='thin dimmed medium'>" + message.title + "</span>";
 		}
 		if (message.message){
-			if (msg != ""){
+			if (msg !== ""){
 				msg+= "<br />";
 			}
 			msg += "<span class='light bright small'>" + message.message + "</span>";
@@ -132,7 +132,7 @@ Module.register("alert",{
 			if (typeof payload.type === "undefined") { payload.type = "alert"; }
 			if (payload.type === "alert") {
 				this.show_alert(payload, sender);
-			} else if (payload.type = "notification") {
+			} else if (payload.type === "notification") {
 				this.show_notification(payload);
 			}
 		} else if (notification === "HIDE_ALERT") {
@@ -152,5 +152,4 @@ Module.register("alert",{
 		}
 		Log.info("Starting module: " + this.name);
 	}
-
 });

modules/default/calendar/README.md

@@ -2,104 +2,4 @@
 The `calendar` module is one of the default modules of the MagicMirror.
 This module displays events from a public .ical calendar. It can combine multiple calendars.
 
-## Using the module
-
-To use this module, add it to the modules array in the `config/config.js` file:
-````javascript
-modules: [
-	{
-		module: "calendar",
-		position: "top_left",	// This can be any of the regions. Best results in left or right regions.
-		config: {
-			// The config property is optional.
-			// If no config is set, an example calendar is shown.
-			// See 'Configuration options' for more information.
-		}
-	}
-]
-````
-
-## Configuration options
-
-The following properties can be configured:
-
-
-| Option                       | Description
-| ---------------------------- | -----------
-| `maximumEntries`             | The maximum number of events shown. / **Possible values:** `0` - `100` <br> **Default value:** `10`
-| `maximumNumberOfDays`        | The maximum number of days in the future. <br><br> **Default value:** `365`
-| `displaySymbol`              | Display a symbol in front of an entry. <br><br> **Possible values:** `true` or `false` <br> **Default value:** `true`
-| `defaultSymbol`              | The default symbol. <br><br> **Possible values:** See [Font Awsome](http://fontawesome.io/icons/) website. <br> **Default value:** `calendar`
-| `maxTitleLength`             | The maximum title length. <br><br> **Possible values:** `10` - `50` <br> **Default value:** `25`
-| `wrapEvents`                 | Wrap event titles to multiple lines. Breaks lines at the length defined by `maxTitleLength`. <br><br> **Possible values:** `true` or `false` <br> **Default value:** `false`
-| `maxTitleLines`              | The maximum number of lines a title will wrap vertically before being cut (Only enabled if `wrapEvents` is also enabled). <br><br> **Possible values:** `0` - `10` <br> **Default value:** `3`
-| `fetchInterval`              | How often does the content needs to be fetched? (Milliseconds) <br><br> **Possible values:** `1000` - `86400000` <br> **Default value:** `300000` (5 minutes)
-| `animationSpeed`             | Speed of the update animation. (Milliseconds) <br><br> **Possible values:** `0` - `5000` <br> **Default value:** `2000` (2 seconds)
-| `fade`                       | Fade the future events to black. (Gradient) <br><br> **Possible values:** `true` or `false` <br> **Default value:** `true`
-| `fadePoint`                  | Where to start fade? <br><br> **Possible values:** `0` (top of the list) - `1` (bottom of list) <br> **Default value:** `0.25`
-| `tableClass`                  | Name of the classes issued from `main.css`. <br><br> **Possible values:** xsmall, small, medium, large, xlarge. <br> **Default value:** _small._
-| `calendars`                  | The list of calendars. <br><br> **Possible values:** An array, see _calendar configuration_ below. <br> **Default value:** _An example calendar._
-| `titleReplace`               | An object of textual replacements applied to the tile of the event. This allow to remove or replace certains words in the title. <br><br> **Example:** `{'Birthday of ' : '', 'foo':'bar'}` <br> **Default value:** `{	"De verjaardag van ": "", "'s birthday": ""	}`
-| `displayRepeatingCountTitle` | Show count title for yearly repeating events (e.g. "X. Birthday", "X. Anniversary") <br><br> **Possible values:** `true` or `false` <br> **Default value:** `false`
-| `dateFormat`                 | Format to use for the date of events (when using absolute dates) <br><br> **Possible values:** See [Moment.js formats](http://momentjs.com/docs/#/parsing/string-format/) <br> **Default value:** `MMM Do` (e.g. Jan 18th)
-| `dateEndFormat`              | Format to use for the end time of events <br><br> **Possible values:** See [Moment.js formats](http://momentjs.com/docs/#/parsing/string-format/) <br> **Default value:** `HH:mm` (e.g. 16:30)
-| `showEnd`                    | Show end time of events  <br><br> **Possible values:** `true` or `false` <br> **Default value:** `true`
-| `fullDayEventDateFormat`     | Format to use for the date of full day events (when using absolute dates) <br><br> **Possible values:** See [Moment.js formats](http://momentjs.com/docs/#/parsing/string-format/) <br> **Default value:** `MMM Do` (e.g. Jan 18th)
-| `timeFormat`                 | Display event times as absolute dates, or relative time, or using absolute date headers with times for each event next to it <br><br> **Possible values:** `absolute` or `relative` or `dateheaders` <br> **Default value:** `relative`
-| `showEnd`                 | Display the end of a date as well <br><br> **Possible values:** `true` or `false` <br> **Default value:** `true`
-| `getRelative`                | How much time (in hours) should be left until calendar events start getting relative? <br><br> **Possible values:** `0` (events stay absolute) - `48` (48 hours before the event starts) <br> **Default value:** `6`
-| `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`
-| `hideOngoing`                | Hides calendar events that have already started. <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>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>`regex` - set to `true` if filterBy is a regex. For those not familiar with regex it is used for pattern matching, please see [here](https://regexr.com/) for more info.<br><br> **Example:** `['Birthday', 'Hide This Event', {filterBy: 'Payment', until: '6 days', caseSensitive: true}, {filterBy: '^[0-9]{1,}.*', regex: true}]` <br> **Default value:** `[]`
-| `sliceMultiDayEvents`        | If this is set to true, events exceeding at least one midnight will be sliced into separate events including a counter like (1/2). This is especially helpful in "dateheaders" mode. Events will be sliced at midnight, end time for all events but the last will be 23:59 **Default value:** `true`
-
-
-### Calendar configuration
-
-The `calendars` property contains an array of the configured calendars.
-The `colored` property gives the option for an individual color for each calendar.
-The `coloredSymbolOnly` property will apply color to the symbol only, not the whole line. This is only applicable when `colored` is also enabled.
-
-#### Default value:
-````javascript
-config: {
-	colored: false,
-	coloredSymbolOnly: false,
-	calendars: [
-		{
-			url: 'http://www.calendarlabs.com/templates/ical/US-Holidays.ics',
-			symbol: 'calendar',
-			auth: {
-			    user: 'username',
-			    pass: 'superstrongpassword',
-			    method: 'basic'
-			}
-		},
-	],
-}
-````
-
-#### Calendar configuration options:
-| Option                | Description
-| --------------------- | -----------
-| `url`	                | The url of the calendar .ical. This property is required. <br><br> **Possible values:** Any public accessble .ical calendar.
-| `symbol`              | The symbol to show in front of an event. This property is optional. <br><br> **Possible values:** See [Font Awesome](http://fontawesome.io/icons/) website. To have multiple symbols you can define them in an array e.g. `["calendar", "plane"]`
-| `color`              | The font color of an event from this calendar. This property should be set if the config is set to colored: true. <br><br> **Possible values:** HEX, RGB or RGBA values (#efefef, rgb(242,242,242), rgba(242,242,242,0.5)).
-| `repeatingCountTitle`	| The count title for yearly repating events in this calendar.  <br><br> **Example:** `'Birthday'`
-| `maximumEntries`      | The maximum number of events shown.  Overrides global setting. **Possible values:** `0` - `100`
-| `maximumNumberOfDays` | The maximum number of days in the future.  Overrides global setting
-| `name`                | The name of the calendar.  Included in event broadcasts as `calendarName`.
-| `auth`                | The object containing options for authentication against the calendar.
-| `symbolClass`         | Add a class to the cell of symbol.
-| `titleClass`          | Add a class to the title's cell.
-| `timeClass`           | Add a class to the time's cell.
-
-
-#### Calendar authentication options:
-| Option                | Description
-| --------------------- | -----------
-| `user`                | The username for HTTP authentication.
-| `pass`                | The password for HTTP authentication. (If you use Bearer authentication, this should be your BearerToken.)
-| `method`              | Which authentication method should be used. HTTP Basic, Digest and Bearer authentication methods are supported. Basic authentication is used by default if this option is omitted. **Possible values:** `digest`, `basic`, `bearer` **Default value:** `basic`
+For configuration options, please check the [MagicMirror² documentation](https://docs.magicmirror.builders/modules/calendar.html).

modules/default/calendar/calendar.js

@@ -15,6 +15,7 @@ Module.register("calendar", {
 		maximumNumberOfDays: 365,
 		displaySymbol: true,
 		defaultSymbol: "calendar", // Fontawesome Symbol see http://fontawesome.io/cheatsheet/
+		showLocation: false,
 		displayRepeatingCountTitle: false,
 		defaultRepeatingCountTitle: "",
 		maxTitleLength: 25,
@@ -48,7 +49,9 @@ Module.register("calendar", {
 		},
 		broadcastEvents: true,
 		excludedEvents: [],
-		sliceMultiDayEvents: false
+		sliceMultiDayEvents: false,
+		broadcastPastEvents: false,
+		nextDaysRelative: false
 	},
 
 	// Define required scripts.
@@ -82,7 +85,8 @@ Module.register("calendar", {
 
 			var calendarConfig = {
 				maximumEntries: calendar.maximumEntries,
-				maximumNumberOfDays: calendar.maximumNumberOfDays
+				maximumNumberOfDays: calendar.maximumNumberOfDays,
+				broadcastPastEvents: calendar.broadcastPastEvents,
 			};
 			if (calendar.symbolClass === "undefined" || calendar.symbolClass === null) {
 				calendarConfig.symbolClass = "";
@@ -101,7 +105,7 @@ Module.register("calendar", {
 				calendar.auth = {
 					user: calendar.user,
 					pass: calendar.pass
-				}
+				};
 			}
 
 			this.addCalendar(calendar.url, calendar.auth, calendarConfig);
@@ -131,10 +135,9 @@ Module.register("calendar", {
 			}
 		} else if (notification === "FETCH_ERROR") {
 			Log.error("Calendar Error. Could not fetch calendar: " + payload.url);
+			this.loaded = true;
 		} else if (notification === "INCORRECT_URL") {
 			Log.error("Calendar Error. Incorrect url: " + payload.url);
-		} else {
-			Log.log("Calendar received an unknown socket notification: " + notification);
 		}
 
 		this.updateDom(this.config.animationSpeed);
@@ -175,6 +178,7 @@ Module.register("calendar", {
 
 					dateCell.colSpan = "3";
 					dateCell.innerHTML = dateAsString;
+					dateCell.style.paddingTop = "10px";
 					dateRow.appendChild(dateCell);
 					wrapper.appendChild(dateRow);
 
@@ -187,7 +191,6 @@ Module.register("calendar", {
 				}
 			}
 
-
 			var eventWrapper = document.createElement("tr");
 
 			if (this.config.colored && !this.config.coloredSymbolOnly) {
@@ -220,7 +223,7 @@ Module.register("calendar", {
 					symbolWrapper.appendChild(symbol);
 				}
 				eventWrapper.appendChild(symbolWrapper);
-			}else if(this.config.timeFormat === "dateheaders"){
+			} else if(this.config.timeFormat === "dateheaders"){
 				var blankCell = document.createElement("td");
 				blankCell.innerHTML = "   ";
 				eventWrapper.appendChild(blankCell);
@@ -257,7 +260,7 @@ Module.register("calendar", {
 					titleWrapper.colSpan = "2";
 					titleWrapper.align = "left";
 
-				}else{
+				} else {
 
 					var timeClass = this.timeClassForUrl(event.url);
 					var timeWrapper = document.createElement("td");
@@ -270,7 +273,7 @@ Module.register("calendar", {
 				}
 
 				eventWrapper.appendChild(titleWrapper);
-			}else{
+			} else {
 				var timeWrapper = document.createElement("td");
 
 				eventWrapper.appendChild(titleWrapper);
@@ -315,7 +318,7 @@ Module.register("calendar", {
 					}
 					if(this.config.showEnd){
 						timeWrapper.innerHTML += "-" ;
-						timeWrapper.innerHTML += this.capFirst(moment(event.endDate  , "x").format(this.config.fullDayEventDateFormat));
+						timeWrapper.innerHTML += this.capFirst(moment(event.endDate , "x").format(this.config.fullDayEventDateFormat));
 					}
 				} else {
 					if (event.startDate >= new Date()) {
@@ -325,7 +328,7 @@ Module.register("calendar", {
 								// If event is within 6 hour, display 'in xxx' time format or moment.fromNow()
 								timeWrapper.innerHTML = this.capFirst(moment(event.startDate, "x").fromNow());
 							} else {
-								if(this.config.timeFormat === "absolute") {
+								if(this.config.timeFormat === "absolute" && !this.config.nextDaysRelative) {
 									timeWrapper.innerHTML = this.capFirst(moment(event.startDate, "x").format(this.config.dateFormat));
 								} else {
 									// Otherwise just say 'Today/Tomorrow at such-n-such time'
@@ -379,6 +382,31 @@ Module.register("calendar", {
 				currentFadeStep = e - startFade;
 				eventWrapper.style.opacity = 1 - (1 / fadeSteps * currentFadeStep);
 			}
+
+			if (this.config.showLocation) {
+				if (event.location !== false) {
+					var locationRow = document.createElement("tr");
+					locationRow.className = "normal xsmall light";
+
+					if (this.config.displaySymbol) {
+						var symbolCell = document.createElement("td");
+						locationRow.appendChild(symbolCell);
+					}
+
+					var descCell = document.createElement("td");
+					descCell.className = "location";
+					descCell.colSpan = "2";
+					descCell.innerHTML = event.location;
+					locationRow.appendChild(descCell);
+
+					wrapper.appendChild(locationRow);
+
+					if (e >= startFade) {
+						currentFadeStep = e - startFade;
+						locationRow.style.opacity = 1 - (1 / fadeSteps * currentFadeStep);
+					}
+				}
+			}
 		}
 
 		return wrapper;
@@ -436,10 +464,14 @@ Module.register("calendar", {
 		var events = [];
 		var today = moment().startOf("day");
 		var now = new Date();
+		var future = moment().startOf("day").add(this.config.maximumNumberOfDays, "days").toDate();
 		for (var c in this.calendarData) {
 			var calendar = this.calendarData[c];
 			for (var e in calendar) {
-				var event = calendar[e];
+				var event = JSON.parse(JSON.stringify(calendar[e])); // clone object
+				if(event.endDate < now) {
+					continue;
+				}
 				if(this.config.hidePrivate) {
 					if(event.class === "PRIVATE") {
 						  // do not add the current event, skip it
@@ -460,24 +492,31 @@ Module.register("calendar", {
 				/* if sliceMultiDayEvents is set to true, multiday events (events exceeding at least one midnight) are sliced into days,
 				* otherwise, esp. in dateheaders mode it is not clear how long these events are.
 				*/
-				if (this.config.sliceMultiDayEvents) {
-					var midnight = moment(event.startDate, "x").clone().startOf("day").add(1, "day").format("x");			//next midnight
+				var maxCount = Math.ceil(((event.endDate - 1) - moment(event.startDate, "x").endOf("day").format("x"))/(1000*60*60*24)) + 1;
+				if (this.config.sliceMultiDayEvents && maxCount > 1) {
+					var splitEvents = [];
+					var midnight = moment(event.startDate, "x").clone().startOf("day").add(1, "day").format("x");
 					var count = 1;
-					var maxCount = Math.ceil(((event.endDate - 1) - moment(event.startDate, "x").endOf("day").format("x"))/(1000*60*60*24)) + 1
-					if (event.endDate > midnight) {
-						while (event.endDate > midnight) {
-							var nextEvent = JSON.parse(JSON.stringify(event));	//make a copy without reference to the original event
- 							nextEvent.startDate = midnight;
- 							event.endDate = midnight;
- 							event.title += " (" + count + "/" + maxCount + ")";
- 							events.push(event);
- 							event = nextEvent;
- 							count += 1;
- 							midnight = moment(midnight, "x").add(1, "day").format("x");		//move further one day for next split
- 						}
- 						event.title += " ("+count+"/"+maxCount+")";
- 					}
-					events.push(event);
+					while (event.endDate > midnight) {
+						var thisEvent = JSON.parse(JSON.stringify(event)); // clone object
+						thisEvent.today = thisEvent.startDate >= today && thisEvent.startDate < (today + 24 * 60 * 60 * 1000);
+						thisEvent.endDate = midnight;
+						thisEvent.title += " (" + count + "/" + maxCount + ")";
+						splitEvents.push(thisEvent);
+
+						event.startDate = midnight;
+						count += 1;
+						midnight = moment(midnight, "x").add(1, "day").format("x"); // next day
+					}
+					// Last day
+					event.title += " ("+count+"/"+maxCount+")";
+					splitEvents.push(event);
+
+					for (event of splitEvents) {
+						if ((event.endDate > now) && (event.endDate <= future)) {
+							events.push(event);
+						}
+					}
 				} else {
 					events.push(event);
 				}
@@ -487,11 +526,9 @@ Module.register("calendar", {
 		events.sort(function (a, b) {
 			return a.startDate - b.startDate;
 		});
-
 		return events.slice(0, this.config.maximumEntries);
 	},
 
-
 	listContainsEvent: function(eventList, event){
 		for(var evt of eventList){
 			if(evt.title === event.title && parseInt(evt.startDate) === parseInt(event.startDate)){
@@ -499,7 +536,6 @@ Module.register("calendar", {
 			}
 		}
 		return false;
-
 	},
 
 	/* createEventList(url)
@@ -517,7 +553,8 @@ Module.register("calendar", {
 			symbolClass: calendarConfig.symbolClass,
 			titleClass: calendarConfig.titleClass,
 			timeClass: calendarConfig.timeClass,
-			auth: auth
+			auth: auth,
+			broadcastPastEvents: calendarConfig.broadcastPastEvents || this.config.broadcastPastEvents,
 		});
 	},
 
@@ -678,7 +715,6 @@ Module.register("calendar", {
 	 * Capitalize the first letter of a string
 	 * Return capitalized string
 	 */
-
 	capFirst: function (string) {
 		return string.charAt(0).toUpperCase() + string.slice(1);
 	},

modules/default/calendar/calendarfetcher.js

@@ -8,7 +8,7 @@
 var ical = require("./vendor/ical.js");
 var moment = require("moment");
 
-var CalendarFetcher = function(url, reloadInterval, excludedEvents, maximumEntries, maximumNumberOfDays, auth) {
+var CalendarFetcher = function(url, reloadInterval, excludedEvents, maximumEntries, maximumNumberOfDays, auth, includePastEvents) {
 	var self = this;
 
 	var reloadTimer = null;
@@ -28,7 +28,7 @@ var CalendarFetcher = function(url, reloadInterval, excludedEvents, maximumEntri
 		nodeVersion = Number(process.version.match(/^v(\d+\.\d+)/)[1]);
 		var opts = {
 			headers: {
-				"User-Agent": "Mozilla/5.0 (Node.js "+ nodeVersion + ") MagicMirror/"  + global.version +  " (https://github.com/MichMich/MagicMirror/)"
+				"User-Agent": "Mozilla/5.0 (Node.js "+ nodeVersion + ") MagicMirror/" + global.version + " (https://github.com/MichMich/MagicMirror/)"
 			},
 			gzip: true
 		};
@@ -37,9 +37,9 @@ var CalendarFetcher = function(url, reloadInterval, excludedEvents, maximumEntri
 			if(auth.method === "bearer"){
 				opts.auth = {
 					bearer: auth.pass
-				}
+				};
 
-			}else{
+			} else {
 				opts.auth = {
 					user: auth.user,
 					pass: auth.pass
@@ -47,7 +47,7 @@ var CalendarFetcher = function(url, reloadInterval, excludedEvents, maximumEntri
 
 				if(auth.method === "digest"){
 					opts.auth.sendImmediately = false;
-				}else{
+				} else {
 					opts.auth.sendImmediately = true;
 				}
 			}
@@ -63,7 +63,8 @@ var CalendarFetcher = function(url, reloadInterval, excludedEvents, maximumEntri
 			// console.log(data);
 			newEvents = [];
 
-			var limitFunction = function(date, i) {return i < maximumEntries;};
+			// limitFunction doesn't do much limiting, see comment re: the dates array in rrule section below as to why we need to do the filtering ourselves
+			var limitFunction = function(date, i) {return true;};
 
 			var eventDate = function(event, time) {
 				return (event[time].length === 8) ? moment(event[time], "YYYYMMDD") : moment(new Date(event[time]));
@@ -74,6 +75,11 @@ var CalendarFetcher = function(url, reloadInterval, excludedEvents, maximumEntri
 				var now = new Date();
 				var today = moment().startOf("day").toDate();
 				var future = moment().startOf("day").add(maximumNumberOfDays, "days").subtract(1,"seconds").toDate(); // Subtract 1 second so that events that start on the middle of the night will not repeat.
+				var past = today;
+
+				if (includePastEvents) {
+					past = moment().startOf("day").subtract(maximumNumberOfDays, "days").toDate();
+				}
 
 				// FIXME:
 				// Ugly fix to solve the facebook birthday issue.
@@ -102,7 +108,6 @@ var CalendarFetcher = function(url, reloadInterval, excludedEvents, maximumEntri
 						}
 					}
 
-
 					// calculate the duration f the event for use with recurring events.
 					var duration = parseInt(endDate.format("x")) - parseInt(startDate.format("x"));
 
@@ -110,12 +115,7 @@ var CalendarFetcher = function(url, reloadInterval, excludedEvents, maximumEntri
 						startDate = startDate.startOf("day");
 					}
 
-					var title = "Event";
-					if (event.summary) {
-						title = (typeof event.summary.val !== "undefined") ? event.summary.val : event.summary;
-					} else if(event.description) {
-						title = event.description;
-					}
+					var title = getTitleFromEvent(event);
 
 					var excluded = false,
 						dateFilter = null;
@@ -171,29 +171,105 @@ var CalendarFetcher = function(url, reloadInterval, excludedEvents, maximumEntri
 					var geo = event.geo || false;
 					var description = event.description || false;
 
-					if (typeof event.rrule != "undefined" && event.rrule != null && !isFacebookBirthday) {
+					if (typeof event.rrule !== "undefined" && event.rrule !== null && !isFacebookBirthday) {
 						var rule = event.rrule;
+						var addedEvents = 0;
 
 						// can cause problems with e.g. birthdays before 1900
-						if(rule.origOptions && rule.origOptions.dtstart && rule.origOptions.dtstart.getFullYear() < 1900 ||
+						if(rule.options && rule.origOptions && rule.origOptions.dtstart && rule.origOptions.dtstart.getFullYear() < 1900 ||
 							rule.options && rule.options.dtstart && rule.options.dtstart.getFullYear() < 1900){
 							rule.origOptions.dtstart.setYear(1900);
 							rule.options.dtstart.setYear(1900);
 						}
 
-						var dates = rule.between(today, future, true, limitFunction);
+						// For recurring events, get the set of start dates that fall within the range
+						// of dates we"re looking for.
+						// kblankenship1989 - to fix issue #1798, converting all dates to locale time first, then converting back to UTC time
+						var pastLocal = moment(past).subtract(past.getTimezoneOffset(), "minutes").toDate();
+						var futureLocal = moment(future).subtract(future.getTimezoneOffset(), "minutes").toDate();
+						var datesLocal = rule.between(pastLocal, futureLocal, true, limitFunction);
+						var dates = datesLocal.map(function(dateLocal) {
+							var date = moment(dateLocal).add(dateLocal.getTimezoneOffset(), "minutes").toDate();
+							return date;
+						});
 
+						// The "dates" array contains the set of dates within our desired date range range that are valid
+						// for the recurrence rule.  *However*, it"s possible for us to have a specific recurrence that
+						// had its date changed from outside the range to inside the range.  For the time being,
+						// we"ll handle this by adding *all* recurrence entries into the set of dates that we check,
+						// because the logic below will filter out any recurrences that don"t actually belong within
+						// our display range.
+						// Would be great if there was a better way to handle this.
+						if (event.recurrences != undefined)
+						{
+							var pastMoment = moment(past);
+							var futureMoment = moment(future);
+
+							for (var r in event.recurrences)
+							{
+								// Only add dates that weren't already in the range we added from the rrule so that
+								// we don"t double-add those events.
+								if (moment(new Date(r)).isBetween(pastMoment, futureMoment) != true)
+								{
+									dates.push(new Date(r));
+								}
+							}
+						}
+
+						// Loop through the set of date entries to see which recurrences should be added to our event list.
 						for (var d in dates) {
-							startDate = moment(new Date(dates[d]));
-							endDate  = moment(parseInt(startDate.format("x")) + duration, "x");
+							var date = dates[d];
+							// ical.js started returning recurrences and exdates as ISOStrings without time information.
+							// .toISOString().substring(0,10) is the method they use to calculate keys, so we'll do the same
+							// (see https://github.com/peterbraden/ical.js/pull/84 )
+							var dateKey = date.toISOString().substring(0,10);
+							var curEvent = event;
+							var showRecurrence = true;
 
-							if (timeFilterApplies(now, endDate, dateFilter)) {
-								continue;
+							// Stop parsing this event's recurrences if we've already found maximumEntries worth of recurrences.
+							// (The logic below would still filter the extras, but the check is simple since we're already tracking the count)
+							if (addedEvents >= maximumEntries) {
+								break;
 							}
 
-							if (endDate.format("x") > now) {
+							startDate = moment(date);
+
+							// For each date that we"re checking, it"s possible that there is a recurrence override for that one day.
+							if ((curEvent.recurrences != undefined) && (curEvent.recurrences[dateKey] != undefined))
+							{
+								// We found an override, so for this recurrence, use a potentially different title, start date, and duration.
+								curEvent = curEvent.recurrences[dateKey];
+								startDate = moment(curEvent.start);
+								duration = parseInt(moment(curEvent.end).format("x")) - parseInt(startDate.format("x"));
+							}
+							// If there"s no recurrence override, check for an exception date.  Exception dates represent exceptions to the rule.
+							else if ((curEvent.exdate != undefined) && (curEvent.exdate[dateKey] != undefined))
+							{
+								// This date is an exception date, which means we should skip it in the recurrence pattern.
+								showRecurrence = false;
+							}
+
+							endDate = moment(parseInt(startDate.format("x")) + duration, "x");
+							if (startDate.format("x") == endDate.format("x")) {
+								endDate = endDate.endOf("day");
+							}
+
+							var recurrenceTitle = getTitleFromEvent(curEvent);
+
+							// If this recurrence ends before the start of the date range, or starts after the end of the date range, don"t add
+							// it to the event list.
+							if (endDate.isBefore(past) || startDate.isAfter(future)) {
+								showRecurrence = false;
+							}
+
+							if (timeFilterApplies(now, endDate, dateFilter)) {
+								showRecurrence = false;
+							}
+
+							if ((showRecurrence === true) && (addedEvents < maximumEntries)) {
+								addedEvents++;
 								newEvents.push({
-									title: title,
+									title: recurrenceTitle,
 									startDate: startDate.format("x"),
 									endDate: endDate.format("x"),
 									fullDayEvent: isFullDayEvent(event),
@@ -205,19 +281,27 @@ var CalendarFetcher = function(url, reloadInterval, excludedEvents, maximumEntri
 								});
 							}
 						}
+						// end recurring event parsing
 					} else {
 						// console.log("Single event ...");
 						// Single event.
 						var fullDayEvent = (isFacebookBirthday) ? true : isFullDayEvent(event);
 
-						if (!fullDayEvent && endDate < new Date()) {
-							//console.log("It's not a fullday event, and it is in the past. So skip: " + title);
-							continue;
-						}
+						if (includePastEvents) {
+							if (endDate < past) {
+								//console.log("Past event is too far in the past.  So skip: " + title);
+								continue;
+							}
+						} else {
+							if (!fullDayEvent && endDate < new Date()) {
+								//console.log("It's not a fullday event, and it is in the past. So skip: " + title);
+								continue;
+							}
 
-						if (fullDayEvent && endDate <= today) {
-							//console.log("It's a fullday event, and it is before today. So skip: " + title);
-							continue;
+							if (fullDayEvent && endDate <= today) {
+								//console.log("It's a fullday event, and it is before today. So skip: " + title);
+								continue;
+							}
 						}
 
 						if (startDate > future) {
@@ -229,6 +313,11 @@ var CalendarFetcher = function(url, reloadInterval, excludedEvents, maximumEntri
 							continue;
 						}
 
+						// adjust start date so multiple day events will be displayed as happening today even though they started some days ago already
+						if (fullDayEvent && startDate <= today) {
+							startDate = moment(today);
+						}
+
 						// Every thing is good. Add it to the list.
 
 						newEvents.push({
@@ -278,7 +367,7 @@ var CalendarFetcher = function(url, reloadInterval, excludedEvents, maximumEntri
 	 * return bool - The event is a fullday event.
 	 */
 	var isFullDayEvent = function(event) {
-		if (event.start.length === 8) {
+		if (event.start.length === 8 || event.start.dateOnly) {
 			return true;
 		}
 
@@ -315,6 +404,24 @@ var CalendarFetcher = function(url, reloadInterval, excludedEvents, maximumEntri
 		return false;
 	};
 
+	/* getTitleFromEvent(event)
+	* Gets the title from the event.
+	*
+	* argument event object - The event object to check.
+	*
+	* return string - The title of the event, or "Event" if no title is found.
+	*/
+	var getTitleFromEvent = function (event) {
+		var title = "Event";
+		if (event.summary) {
+			title = (typeof event.summary.val !== "undefined") ? event.summary.val : event.summary;
+		} else if (event.description) {
+			title = event.description;
+		}
+
+		return title;
+	};
+
 	var testTitleByFilter = function (title, filter, useRegex, regexFlags) {
 		if (useRegex) {
 			// Assume if leading slash, there is also trailing slash
@@ -329,7 +436,7 @@ var CalendarFetcher = function(url, reloadInterval, excludedEvents, maximumEntri
 		} else {
 			return title.includes(filter);
 		}
-	}
+	};
 
 	/* public methods */
 
@@ -383,8 +490,6 @@ var CalendarFetcher = function(url, reloadInterval, excludedEvents, maximumEntri
 	this.events = function() {
 		return events;
 	};
-
 };
 
-
 module.exports = CalendarFetcher;

modules/default/calendar/debug.js

@@ -8,13 +8,14 @@
 
 var CalendarFetcher = require("./calendarfetcher.js");
 
-var url = "https://calendar.google.com/calendar/ical/pkm1t2uedjbp0uvq1o7oj1jouo%40group.calendar.google.com/private-08ba559f89eec70dd74bbd887d0a3598/basic.ics";  // Standard test URL
+var url = "https://calendar.google.com/calendar/ical/pkm1t2uedjbp0uvq1o7oj1jouo%40group.calendar.google.com/private-08ba559f89eec70dd74bbd887d0a3598/basic.ics"; // Standard test URL
 // var url = "https://www.googleapis.com/calendar/v3/calendars/primary/events/"; // URL for Bearer auth (must be configured  in Google OAuth2 first)
 var fetchInterval = 60 * 60 * 1000;
 var maximumEntries = 10;
 var maximumNumberOfDays = 365;
 var user = "magicmirror";
 var pass = "MyStrongPass";
+var broadcastPastEvents = false;
 
 var auth = {
 	user: user,
@@ -23,7 +24,7 @@ var auth = {
 
 console.log("Create fetcher ...");
 
-fetcher = new CalendarFetcher(url, fetchInterval, maximumEntries, maximumNumberOfDays, auth);
+fetcher = new CalendarFetcher(url, fetchInterval, [], maximumEntries, maximumNumberOfDays, auth);
 
 fetcher.onReceive(function(fetcher) {
 	console.log(fetcher.events());
@@ -37,4 +38,4 @@ fetcher.onError(function(fetcher, error) {
 
 fetcher.startFetch();
 
-console.log("Create fetcher done! ");
+console.log("Create fetcher done! ");

modules/default/calendar/node_helper.js

@@ -24,7 +24,7 @@ module.exports = NodeHelper.create({
 	socketNotificationReceived: function(notification, payload) {
 		if (notification === "ADD_CALENDAR") {
 			//console.log('ADD_CALENDAR: ');
-			this.createFetcher(payload.url, payload.fetchInterval, payload.excludedEvents, payload.maximumEntries, payload.maximumNumberOfDays, payload.auth);
+			this.createFetcher(payload.url, payload.fetchInterval, payload.excludedEvents, payload.maximumEntries, payload.maximumNumberOfDays, payload.auth, payload.broadcastPastEvents);
 		}
 	},
 
@@ -36,7 +36,7 @@ module.exports = NodeHelper.create({
 	 * attribute reloadInterval number - Reload interval in milliseconds.
 	 */
 
-	createFetcher: function(url, fetchInterval, excludedEvents, maximumEntries, maximumNumberOfDays, auth) {
+	createFetcher: function(url, fetchInterval, excludedEvents, maximumEntries, maximumNumberOfDays, auth, broadcastPastEvents) {
 		var self = this;
 
 		if (!validUrl.isUri(url)) {
@@ -47,7 +47,7 @@ module.exports = NodeHelper.create({
 		var fetcher;
 		if (typeof self.fetchers[url] === "undefined") {
 			console.log("Create new calendar fetcher for url: " + url + " - Interval: " + fetchInterval);
-			fetcher = new CalendarFetcher(url, fetchInterval, excludedEvents, maximumEntries, maximumNumberOfDays, auth);
+			fetcher = new CalendarFetcher(url, fetchInterval, excludedEvents, maximumEntries, maximumNumberOfDays, auth, broadcastPastEvents);
 
 			fetcher.onReceive(function(fetcher) {
 				//console.log('Broadcast events.');
@@ -60,6 +60,7 @@ module.exports = NodeHelper.create({
 			});
 
 			fetcher.onError(function(fetcher, error) {
+				console.error("Calendar Error. Could not fetch calendar: ", fetcher.url(), error);
 				self.sendSocketNotification("FETCH_ERROR", {
 					url: fetcher.url(),
 					error: error

modules/default/calendar/vendor/ical.js/.travis.yml

@@ -1,6 +1,4 @@
 language: node_js
 node_js:
-    - "0.10"
-    - "0.12"
-    - "4.2"
+    - "8.9"
 install: npm install 

modules/default/calendar/vendor/ical.js/example.js

@@ -1,13 +1,16 @@
-var ical = require('ical')
-  , months = ['Jan', 'Feb', 'Mar', 'Apr', 'May', 'Jun', 'Jul', 'Aug', 'Sep', 'Oct', 'Nov', 'Dec']
+'use strict';
 
+const ical = require('ical');
+const months = ['Jan', 'Feb', 'Mar', 'Apr', 'May', 'Jun', 'Jul', 'Aug', 'Sep', 'Oct', 'Nov', 'Dec'];
 
-ical.fromURL('http://lanyrd.com/topics/nodejs/nodejs.ics', {}, function(err, data){
-  for (var k in data){
-    if (data.hasOwnProperty(k)){
-      var ev = data[k]
-      console.log("Conference", ev.summary, 'is in',  ev.location, 'on the', ev.start.getDate(), 'of', months[ev.start.getMonth()] );
-    }
-  }
-})
+ical.fromURL('http://lanyrd.com/topics/nodejs/nodejs.ics', {}, function (err, data) {
+	for (let k in data) {
+		if (data.hasOwnProperty(k)) {
+			var ev = data[k];
+			if (data[k].type == 'VEVENT') {
+				console.log(`${ev.summary} is in ${ev.location} on the ${ev.start.getDate()} of ${months[ev.start.getMonth()]} at ${ev.start.toLocaleTimeString('en-GB')}`);
 
+			}
+		}
+	}
+});

modules/default/calendar/vendor/ical.js/example_rrule.js

@@ -0,0 +1,118 @@
+var ical = require('./node-ical')
+var moment = require('moment')
+
+var data = ical.parseFile('./examples/example_rrule.ics');
+
+// Complicated example demonstrating how to handle recurrence rules and exceptions.
+
+for (var k in data) {
+
+	// When dealing with calendar recurrences, you need a range of dates to query against,
+	// because otherwise you can get an infinite number of calendar events.
+	var rangeStart = moment("2017-01-01");
+	var rangeEnd = moment("2017-12-31");
+
+
+	var event = data[k]
+	if (event.type === 'VEVENT') {
+
+		var title = event.summary;
+		var startDate = moment(event.start);
+		var endDate = moment(event.end);
+
+		// Calculate the duration of the event for use with recurring events.
+		var duration = parseInt(endDate.format("x")) - parseInt(startDate.format("x"));
+
+		// Simple case - no recurrences, just print out the calendar event.
+		if (typeof event.rrule === 'undefined')
+		{
+			console.log('title:' + title);
+			console.log('startDate:' + startDate.format('MMMM Do YYYY, h:mm:ss a'));
+			console.log('endDate:' + endDate.format('MMMM Do YYYY, h:mm:ss a'));
+			console.log('duration:' + moment.duration(duration).humanize());
+			console.log();
+		}
+
+		// Complicated case - if an RRULE exists, handle multiple recurrences of the event.
+		else if (typeof event.rrule !== 'undefined')
+		{
+			// For recurring events, get the set of event start dates that fall within the range
+			// of dates we're looking for.
+			var dates = event.rrule.between(
+			  rangeStart.toDate(),
+			  rangeEnd.toDate(),
+			  true,
+			  function(date, i) {return true;}
+			)
+
+			// The "dates" array contains the set of dates within our desired date range range that are valid
+			// for the recurrence rule.  *However*, it's possible for us to have a specific recurrence that
+			// had its date changed from outside the range to inside the range.  One way to handle this is
+			// to add *all* recurrence override entries into the set of dates that we check, and then later
+			// filter out any recurrences that don't actually belong within our range.
+			if (event.recurrences != undefined)
+			{
+				for (var r in event.recurrences)
+				{
+					// Only add dates that weren't already in the range we added from the rrule so that 
+					// we don't double-add those events.
+					if (moment(new Date(r)).isBetween(rangeStart, rangeEnd) != true)
+					{
+						dates.push(new Date(r));
+					}
+				}
+			}
+
+			// Loop through the set of date entries to see which recurrences should be printed.
+			for(var i in dates) {
+
+				var date = dates[i];
+				var curEvent = event;
+				var showRecurrence = true;
+				var curDuration = duration;
+
+				startDate = moment(date);
+
+				// Use just the date of the recurrence to look up overrides and exceptions (i.e. chop off time information)
+				var dateLookupKey = date.toISOString().substring(0, 10);
+
+				// For each date that we're checking, it's possible that there is a recurrence override for that one day.
+				if ((curEvent.recurrences != undefined) && (curEvent.recurrences[dateLookupKey] != undefined))
+				{
+					// We found an override, so for this recurrence, use a potentially different title, start date, and duration.
+					curEvent = curEvent.recurrences[dateLookupKey];
+					startDate = moment(curEvent.start);
+					curDuration = parseInt(moment(curEvent.end).format("x")) - parseInt(startDate.format("x"));
+				}
+				// If there's no recurrence override, check for an exception date.  Exception dates represent exceptions to the rule.
+				else if ((curEvent.exdate != undefined) && (curEvent.exdate[dateLookupKey] != undefined))
+				{
+					// This date is an exception date, which means we should skip it in the recurrence pattern.
+					showRecurrence = false;
+				}
+
+				// Set the the title and the end date from either the regular event or the recurrence override.
+				var recurrenceTitle = curEvent.summary;
+				endDate = moment(parseInt(startDate.format("x")) + curDuration, 'x');
+
+				// If this recurrence ends before the start of the date range, or starts after the end of the date range, 
+				// don't process it.
+				if (endDate.isBefore(rangeStart) || startDate.isAfter(rangeEnd)) {
+					showRecurrence = false;
+				}
+
+				if (showRecurrence === true) {
+
+					console.log('title:' + recurrenceTitle);
+					console.log('startDate:' + startDate.format('MMMM Do YYYY, h:mm:ss a'));
+					console.log('endDate:' + endDate.format('MMMM Do YYYY, h:mm:ss a'));
+					console.log('duration:' + moment.duration(curDuration).humanize());
+					console.log();
+				}
+
+			}
+		} 
+	}
+}
+
+

modules/default/calendar/vendor/ical.js/examples/example_rrule.ics

@@ -0,0 +1,40 @@
+BEGIN:VCALENDAR
+PRODID:-//Google Inc//Google Calendar 70.9054//EN
+VERSION:2.0
+CALSCALE:GREGORIAN
+METHOD:PUBLISH
+X-WR-CALNAME:ical
+X-WR-TIMEZONE:US/Central
+X-WR-CALDESC:
+BEGIN:VEVENT
+UID:98765432-ABCD-DCBB-999A-987765432123
+DTSTART;TZID=US/Central:20170601T090000
+DTEND;TZID=US/Central:20170601T170000
+DTSTAMP:20170727T044436Z
+EXDATE;TZID=US/Central:20170706T090000,20170713T090000,20170720T090000,20
+ 170803T090000
+LAST-MODIFIED:20170727T044435Z
+RRULE:FREQ=WEEKLY;WKST=SU;UNTIL=20170814T045959Z;BYDAY=TH
+SEQUENCE:0
+SUMMARY:Recurring weekly meeting from June 1 - Aug 14 (except July 6, July 13, July 20, Aug 3)
+END:VEVENT
+BEGIN:VEVENT
+UID:98765432-ABCD-DCBB-999A-987765432123
+RECURRENCE-ID;TZID=US/Central:20170629T090000
+DTSTART;TZID=US/Central:20170703T090000
+DTEND;TZID=US/Central:20170703T120000
+DTSTAMP:20170727T044436Z
+LAST-MODIFIED:20170216T143445Z
+SEQUENCE:0
+SUMMARY:Last meeting in June moved to Monday July 3 and shortened to half day
+END:VEVENT
+BEGIN:VEVENT
+UID:12354454-ABCD-DCBB-999A-2349872354897
+DTSTART;TZID=US/Central:20171201T130000
+DTEND;TZID=US/Central:20171201T150000
+DTSTAMP:20170727T044436Z
+LAST-MODIFIED:20170727T044435Z
+SEQUENCE:0
+SUMMARY:Single event on Dec 1
+END:VEVENT
+END:VCALENDAR

modules/default/calendar/vendor/ical.js/ical.js

@@ -33,9 +33,9 @@
     for (var i = 0; i<p.length; i++){
       if (p[i].indexOf('=') > -1){
         var segs = p[i].split('=');
-        
+
         out[segs[0]] = parseValue(segs.slice(1).join('='));
-        
+
       }
     }
     return out || sp
@@ -44,7 +44,7 @@
   var parseValue = function(val){
     if ('TRUE' === val)
       return true;
-    
+
     if ('FALSE' === val)
       return false;
 
@@ -55,75 +55,52 @@
     return val;
   }
 
-  var storeParam = function(name){
-    return function(val, params, curr){
-      var data;
-      if (params && params.length && !(params.length==1 && params[0]==='CHARSET=utf-8')){
-        data = {params:parseParams(params), val:text(val)}
-      }
-      else
-        data = text(val)
+  var storeValParam = function (name) {
+      return function (val, curr) {
+          var current = curr[name];
+          if (Array.isArray(current)) {
+              current.push(val);
+              return curr;
+          }
 
-      var current = curr[name];
-      if (Array.isArray(current)){
-        current.push(data);
-        return curr;
-      }
+          if (current != null) {
+              curr[name] = [current, val];
+              return curr;
+          }
 
-      if (current != null){
-        curr[name] = [current, data];
-        return curr;
+          curr[name] = val;
+          return curr
       }
-
-      curr[name] = data;
-      return curr
-    }
   }
 
-  var addTZ = function(dt, params){
+  var storeParam = function (name) {
+      return function (val, params, curr) {
+          var data;
+          if (params && params.length && !(params.length == 1 && params[0] === 'CHARSET=utf-8')) {
+              data = { params: parseParams(params), val: text(val) }
+          }
+          else
+              data = text(val)
+
+          return storeValParam(name)(data, curr);
+      }
+  }
+
+  var addTZ = function (dt, params) {
     var p = parseParams(params);
 
-    if (params && p && dt){
+    if (params && p){
       dt.tz = p.TZID
     }
 
     return dt
   }
 
-  var parseTimestamp = function(val){
-    //typical RFC date-time format
-    var comps = /^(\d{4})(\d{2})(\d{2})T(\d{2})(\d{2})(\d{2})(Z)?$/.exec(val);
-    if (comps !== null) {
-      if (comps[7] == 'Z'){ // GMT
-        return new Date(Date.UTC(
-          parseInt(comps[1], 10),
-          parseInt(comps[2], 10)-1,
-          parseInt(comps[3], 10),
-          parseInt(comps[4], 10),
-          parseInt(comps[5], 10),
-          parseInt(comps[6], 10 )
-        ));
-        // TODO add tz
-      } else {
-        return new Date(
-          parseInt(comps[1], 10),
-          parseInt(comps[2], 10)-1,
-          parseInt(comps[3], 10),
-          parseInt(comps[4], 10),
-          parseInt(comps[5], 10),
-          parseInt(comps[6], 10)
-        );
-      }
-    }
-
-    return undefined;
-  }
-
   var dateParam = function(name){
-    return function(val, params, curr){
+      return function (val, params, curr) {
+
+      var newDate = text(val);
 
-      // Store as string - worst case scenario
-      storeParam(name)(val, undefined, curr)
 
       if (params && params[0] === "VALUE=DATE") {
         // Just Date
@@ -131,47 +108,54 @@
         var comps = /^(\d{4})(\d{2})(\d{2})$/.exec(val);
         if (comps !== null) {
           // No TZ info - assume same timezone as this computer
-          curr[name] = new Date(
+          newDate = new Date(
             comps[1],
             parseInt(comps[2], 10)-1,
             comps[3]
           );
 
-          curr[name] = addTZ(curr[name], params);
-	  return curr;
+          newDate = addTZ(newDate, params);
+          newDate.dateOnly = true;
+
+          // Store as string - worst case scenario
+          return storeValParam(name)(newDate, curr)
         }
       }
 
-      curr[name] = []
-      val.split(',').forEach(function(val){
-        var newDate = parseTimestamp(val);
-        curr[name].push(addTZ(newDate, params));
-      });
 
-      if (curr[name].length === 0){
-        delete curr[name];
-      } else if (curr[name].length === 1){
-	 curr[name] = curr[name][0];
-      }
+      //typical RFC date-time format
+      var comps = /^(\d{4})(\d{2})(\d{2})T(\d{2})(\d{2})(\d{2})(Z)?$/.exec(val);
+      if (comps !== null) {
+        if (comps[7] == 'Z'){ // GMT
+          newDate = new Date(Date.UTC(
+            parseInt(comps[1], 10),
+            parseInt(comps[2], 10)-1,
+            parseInt(comps[3], 10),
+            parseInt(comps[4], 10),
+            parseInt(comps[5], 10),
+            parseInt(comps[6], 10 )
+          ));
+          // TODO add tz
+        } else {
+          newDate = new Date(
+            parseInt(comps[1], 10),
+            parseInt(comps[2], 10)-1,
+            parseInt(comps[3], 10),
+            parseInt(comps[4], 10),
+            parseInt(comps[5], 10),
+            parseInt(comps[6], 10)
+          );
+        }
 
-      return curr;
+        newDate = addTZ(newDate, params);
     }
+
+
+          // Store as string - worst case scenario
+      return storeValParam(name)(newDate, curr)
+      }
   }
 
-  var exdateParam = function(name){
-    return function(val, params, curr){
-      var date = dateParam(name)(val, params, curr);
-      if (date.exdates === undefined) {
-        date.exdates = [];
-      }
-      if (Array.isArray(date.exdate)){
-        date.exdates = date.exdates.concat(date.exdate);
-      } else {
-        date.exdates.push(date.exdate);
-      }
-      return date;
-    }
-  }
 
   var geoParam = function(name){
     return function(val, params, curr){
@@ -195,7 +179,52 @@
     }
   }
 
-  var addFBType = function(fb, params){
+  // EXDATE is an entry that represents exceptions to a recurrence rule (ex: "repeat every day except on 7/4").
+  // The EXDATE entry itself can also contain a comma-separated list, so we make sure to parse each date out separately.
+  // There can also be more than one EXDATE entries in a calendar record.
+  // Since there can be multiple dates, we create an array of them.  The index into the array is the ISO string of the date itself, for ease of use.
+  // i.e. You can check if ((curr.exdate != undefined) && (curr.exdate[date iso string] != undefined)) to see if a date is an exception.
+  // NOTE: This specifically uses date only, and not time.  This is to avoid a few problems:
+  //    1. The ISO string with time wouldn't work for "floating dates" (dates without timezones).
+  //       ex: "20171225T060000" - this is supposed to mean 6 AM in whatever timezone you're currently in
+  //    2. Daylight savings time potentially affects the time you would need to look up
+  //    3. Some EXDATE entries in the wild seem to have times different from the recurrence rule, but are still excluded by calendar programs.  Not sure how or why.
+  //       These would fail any sort of sane time lookup, because the time literally doesn't match the event.  So we'll ignore time and just use date.
+  //       ex: DTSTART:20170814T140000Z
+  //             RRULE:FREQ=WEEKLY;WKST=SU;INTERVAL=2;BYDAY=MO,TU
+  //             EXDATE:20171219T060000
+  //       Even though "T060000" doesn't match or overlap "T1400000Z", it's still supposed to be excluded?  Odd. :(
+  // TODO: See if this causes any problems with events that recur multiple times a day.
+  var exdateParam = function (name) {
+    return function (val, params, curr) {
+      var separatorPattern = /\s*,\s*/g;
+      curr[name] = curr[name] || [];
+      var dates = val ? val.split(separatorPattern) : [];
+      dates.forEach(function (entry) {
+          var exdate = new Array();
+          dateParam(name)(entry, params, exdate);
+
+          if (exdate[name])
+          {
+            if (typeof exdate[name].toISOString === 'function') {
+              curr[name][exdate[name].toISOString().substring(0, 10)] = exdate[name];
+            } else {
+              console.error("No toISOString function in exdate[name]", exdate[name]);
+            }
+          }
+        }
+      )
+      return curr;
+    }
+  }
+
+  // RECURRENCE-ID is the ID of a specific recurrence within a recurrence rule.
+  // TODO:  It's also possible for it to have a range, like "THISANDPRIOR", "THISANDFUTURE".  This isn't currently handled.
+  var recurrenceParam = function (name) {
+      return dateParam(name);
+  }
+
+  var addFBType = function (fb, params) {
     var p = parseParams(params);
 
     if (params && p){
@@ -239,7 +268,7 @@
             //scan all high level object in curr and drop all strings
             var key,
                 obj;
-            
+
             for (key in curr) {
                 if(curr.hasOwnProperty(key)) {
                    obj = curr[key];
@@ -248,14 +277,93 @@
                    }
                 }
             }
-            
+
             return curr
         }
-        
+
         var par = stack.pop()
 
         if (curr.uid)
-          par[curr.uid] = curr
+        {
+        	// If this is the first time we run into this UID, just save it.
+        	if (par[curr.uid] === undefined)
+            {
+            	par[curr.uid] = curr;
+            }
+            else
+            {
+                // If we have multiple ical entries with the same UID, it's either going to be a
+                // modification to a recurrence (RECURRENCE-ID), and/or a significant modification
+                // to the entry (SEQUENCE).
+
+                // TODO: Look into proper sequence logic.
+
+                if (curr.recurrenceid === undefined)
+                {
+                    // If we have the same UID as an existing record, and it *isn't* a specific recurrence ID,
+                    // not quite sure what the correct behaviour should be.  For now, just take the new information
+                    // and merge it with the old record by overwriting only the fields that appear in the new record.
+                    var key;
+                    for (key in curr) {
+                    	par[curr.uid][key] = curr[key];
+                    }
+
+                }
+            }
+
+        	// If we have recurrence-id entries, list them as an array of recurrences keyed off of recurrence-id.
+        	// To use - as you're running through the dates of an rrule, you can try looking it up in the recurrences
+        	// array.  If it exists, then use the data from the calendar object in the recurrence instead of the parent
+        	// for that day.
+
+        	// NOTE:  Sometimes the RECURRENCE-ID record will show up *before* the record with the RRULE entry.  In that
+        	// case, what happens is that the RECURRENCE-ID record ends up becoming both the parent record and an entry
+        	// in the recurrences array, and then when we process the RRULE entry later it overwrites the appropriate
+			// fields in the parent record.
+
+        	if (curr.recurrenceid != null)
+        	{
+
+        		// TODO:  Is there ever a case where we have to worry about overwriting an existing entry here?
+
+        		// Create a copy of the current object to save in our recurrences array.  (We *could* just do par = curr,
+        		// except for the case that we get the RECURRENCE-ID record before the RRULE record.  In that case, we
+        		// would end up with a shared reference that would cause us to overwrite *both* records at the point
+				// that we try and fix up the parent record.)
+        		var recurrenceObj = new Object();
+        		var key;
+        		for (key in curr) {
+        			recurrenceObj[key] = curr[key];
+        		}
+
+        		if (recurrenceObj.recurrences != undefined) {
+        			delete recurrenceObj.recurrences;
+        		}
+
+
+				// If we don't have an array to store recurrences in yet, create it.
+        		if (par[curr.uid].recurrences === undefined) {
+        			par[curr.uid].recurrences = new Array();
+            	}
+
+        		// Save off our cloned recurrence object into the array, keyed by date but not time.
+        		// We key by date only to avoid timezone and "floating time" problems (where the time isn't associated with a timezone).
+				// TODO: See if this causes a problem with events that have multiple recurrences per day.
+                if (typeof curr.recurrenceid.toISOString === 'function') {
+                  par[curr.uid].recurrences[curr.recurrenceid.toISOString().substring(0,10)] = recurrenceObj;
+                } else {
+                  console.error("No toISOString function in curr.recurrenceid", curr.recurrenceid);
+                }
+            }
+
+        	// One more specific fix - in the case that an RRULE entry shows up after a RECURRENCE-ID entry,
+        	// let's make sure to clear the recurrenceid off the parent field.
+        	if ((par[curr.uid].rrule != undefined) && (par[curr.uid].recurrenceid != undefined))
+            {
+        		delete par[curr.uid].recurrenceid;
+            }
+
+        }
         else
           par[Math.random()*100000] = curr  // Randomly assign ID : TODO - use true GUID
 
@@ -277,6 +385,11 @@
       , 'COMPLETED': dateParam('completed')
       , 'CATEGORIES': categoriesParam('categories')
       , 'FREEBUSY': freebusyParam('freebusy')
+      , 'DTSTAMP': dateParam('dtstamp')
+      , 'CREATED': dateParam('created')
+      , 'LAST-MODIFIED': dateParam('lastmodified')
+      , 'RECURRENCE-ID': recurrenceParam('recurrenceid')
+
     },
 
 
@@ -292,7 +405,7 @@
           name = name.substring(2);
           return (storeParam(name))(val, params, ctx, stack, line);
       }
-      
+
       return storeParam(name.toLowerCase())(val, params, ctx);
     },
 

modules/default/calendar/vendor/ical.js/node-ical.js

@@ -6,9 +6,16 @@ exports.fromURL = function(url, opts, cb){
   if (!cb)
     return;
   request(url, opts, function(err, r, data){
-    if (err)
-      return cb(err, null);
-    cb(undefined, ical.parseICS(data));
+  	if (err)
+  	{
+  	  return cb(err, null);
+  	}
+  	else if (r.statusCode != 200)
+  	{
+       return cb(r.statusCode + ": " + r.statusMessage, null);
+  	}
+
+  	cb(undefined, ical.parseICS(data));
   })
 }
 
@@ -17,40 +24,54 @@ exports.parseFile = function(filename){
 }
 
 
-var rrule = require('rrule-alt').RRule
-var rrulestr = rrule.rrulestr
+var rrule = require('rrule').RRule
+
+function getLocaleISOString(date) {
+	var year = date.getFullYear().toString(10).padStart(4,'0');
+	var month = (date.getMonth() + 1).toString(10).padStart(2,'0');
+	var day = date.getDate().toString(10).padStart(2,'0');
+	var hour = date.getHours().toString(10).padStart(2,'0');
+	var minute = date.getMinutes().toString(10).padStart(2,'0');
+	var second = date.getSeconds().toString(10).padStart(2,'0');
+
+	return `${year}${month}${day}T${hour}${minute}${second}Z`;
+}
 
 ical.objectHandlers['RRULE'] = function(val, params, curr, stack, line){
   curr.rrule = line;
   return curr
 }
 var originalEnd = ical.objectHandlers['END'];
-ical.objectHandlers['END'] = function(val, params, curr, stack){
-  if (curr.rrule) {
-    var rule = curr.rrule;
-    if (rule.indexOf('DTSTART') === -1) {
+ical.objectHandlers['END'] = function (val, params, curr, stack) {
+	// Recurrence rules are only valid for VEVENT, VTODO, and VJOURNAL.
+	// More specifically, we need to filter the VCALENDAR type because we might end up with a defined rrule
+	// due to the subtypes.
+	if ((val === "VEVENT") || (val === "VTODO") || (val === "VJOURNAL")) {
+		if (curr.rrule) {
+			var rule = curr.rrule.replace('RRULE:', '');
+			if (rule.indexOf('DTSTART') === -1) {
 
-      if (curr.start.length === 8) {
-        var comps = /^(\d{4})(\d{2})(\d{2})$/.exec(curr.start);
-        if (comps) {
-         curr.start = new Date (comps[1], comps[2] - 1, comps[3]);
-        }
-      }
+				if (curr.start.length === 8) {
+					var comps = /^(\d{4})(\d{2})(\d{2})$/.exec(curr.start);
+					if (comps) {
+						curr.start = new Date(comps[1], comps[2] - 1, comps[3]);
+					}
+				}
 
-      rule += ' DTSTART:' + curr.start.toISOString().replace(/[-:]/g, '');
-      rule = rule.replace(/\.[0-9]{3}/, '');
-    }
-    for (var i in curr.exdates) {
-      rule += ' EXDATE:' + curr.exdates[i].toISOString().replace(/[-:]/g, '');
-      rule = rule.replace(/\.[0-9]{3}/, '');
-    }
-    try {
-      curr.rrule = rrulestr(rule);
-    }
-    catch(err) {
-      console.log("Unrecognised element in calendar feed, ignoring: " + rule);
-      curr.rrule = null;
-    }
-  }
+
+				if (typeof curr.start.toISOString === 'function') {
+					try {
+						// kblankenship1989 - to fix issue #1798, converting all dates to locale time first, then converting back to UTC time
+						rule += ';DTSTART=' + getLocaleISOString(curr.start);
+					} catch (error) {
+						console.error("ERROR when trying to convert to ISOString", error);
+					}
+                } else {
+                    console.error("No toISOString function in curr.start", curr.start);
+				}
+			}
+			curr.rrule = rrule.fromString(rule);
+		}
+	}
   return originalEnd.call(this, val, params, curr, stack);
 }

modules/default/calendar/vendor/ical.js/package.json

@@ -10,17 +10,18 @@
   ],
   "homepage": "https://github.com/peterbraden/ical.js",
   "author": "Peter Braden <peterbraden@peterbraden.co.uk> (peterbraden.co.uk)",
+  "license": "Apache-2.0",
   "repository": {
     "type": "git",
     "url": "git://github.com/peterbraden/ical.js.git"
   },
   "dependencies": {
-    "request": "2.68.0",
-    "rrule": "2.0.0"
+    "request": "^2.88.0",
+    "rrule": "2.4.1"
   },
   "devDependencies": {
-    "vows": "0.7.0",
-    "underscore": "1.3.0"
+    "vows": "0.8.2",
+    "underscore": "1.9.1"
   },
   "scripts": {
     "test": "./node_modules/vows/bin/vows ./test/test.js"

modules/default/calendar/vendor/ical.js/readme.md

@@ -7,6 +7,7 @@ A tolerant, minimal icalendar parser for javascript/node
 (http://tools.ietf.org/html/rfc5545)
 
 
+
 ## Install - Node.js ##
 
 ical.js is availble on npm:
@@ -33,19 +34,29 @@ Use the request library to fetch the specified URL (```opts``` gets passed on to
 
 ## Example 1 - Print list of upcoming node conferences (see example.js)
 ```javascript
-    var ical = require('ical')
-  , months = ['Jan', 'Feb', 'Mar', 'Apr', 'May', 'Jun', 'Jul', 'Aug', 'Sep', 'Oct', 'Nov', 'Dec']
+'use strict';
 
-    ical.fromURL('http://lanyrd.com/topics/nodejs/nodejs.ics', {}, function(err, data) {
-      for (var k in data){
-        if (data.hasOwnProperty(k)) {
-          var ev = data[k]
-          console.log("Conference",
-            ev.summary,
-            'is in',
-            ev.location,
-            'on the', ev.start.getDate(), 'of', months[ev.start.getMonth()]);
-        }
-      }
-    });
+const ical = require('ical');
+const months = ['Jan', 'Feb', 'Mar', 'Apr', 'May', 'Jun', 'Jul', 'Aug', 'Sep', 'Oct', 'Nov', 'Dec'];
+
+ical.fromURL('http://lanyrd.com/topics/nodejs/nodejs.ics', {}, function (err, data) {
+	for (let k in data) {
+		if (data.hasOwnProperty(k)) {
+			var ev = data[k];
+			if (data[k].type == 'VEVENT') {
+				console.log(`${ev.summary} is in ${ev.location} on the ${ev.start.getDate()} of ${months[ev.start.getMonth()]} at ${ev.start.toLocaleTimeString('en-GB')}`);
+
+			}
+		}
+	}
+});
 ```
+
+## Recurrences and Exceptions ##
+Calendar events with recurrence rules can be significantly more complicated to handle correctly.  There are three parts to handling them:
+
+ 1. rrule - the recurrence rule specifying the pattern of recurring dates and times for the event.
+ 2. recurrences - an optional array of event data that can override specific occurrences of the event.
+ 3. exdate - an optional array of dates that should be excluded from the recurrence pattern.
+
+See example_rrule.js for an example of handling recurring calendar events.

modules/default/calendar/vendor/ical.js/test/test.js

@@ -43,6 +43,12 @@ vows.describe('node-ical').addBatch({
       , 'has a summary (invalid colon handling tolerance)' : function(topic){
         assert.equal(topic.summary, '[Async]: Everything Express')
       }
+      , 'has a date only start datetime' : function(topic){
+        assert.equal(topic.start.dateOnly, true)
+      }
+      , 'has a date only end datetime' : function(topic){
+        assert.equal(topic.end.dateOnly, true)
+      }
     }
     , 'event d4c8' :{
       topic : function(events){
@@ -108,7 +114,7 @@ vows.describe('node-ical').addBatch({
         assert.equal(topic.end.getFullYear(), 1998);
         assert.equal(topic.end.getUTCMonth(), 2);
         assert.equal(topic.end.getUTCDate(), 15);
-        assert.equal(topic.end.getUTCHours(), 0);
+        assert.equal(topic.end.getUTCHours(), 00);
         assert.equal(topic.end.getUTCMinutes(), 30);
       }
     }
@@ -146,7 +152,7 @@ vows.describe('node-ical').addBatch({
       }
       , 'has a start datetime' : function(topic) {
         assert.equal(topic.start.getFullYear(), 2011);
-        assert.equal(topic.start.getMonth(), 9);
+        assert.equal(topic.start.getMonth(), 09);
         assert.equal(topic.start.getDate(), 11);
       }
 
@@ -192,12 +198,12 @@ vows.describe('node-ical').addBatch({
       }
       , 'has a start' : function(topic){
         assert.equal(topic.start.tz, 'America/Phoenix')
-        assert.equal(topic.start.toISOString(), new Date(2011, 10, 9, 19, 0,0).toISOString())
+        assert.equal(topic.start.toISOString(), new Date(2011, 10, 09, 19, 0,0).toISOString())
       }
     }
   }
 
-  , 'with test6.ics (testing assembly.org)' : {
+  , 'with test6.ics (testing assembly.org)': {
      topic: function () {
         return ical.parseFile('./test/test6.ics')
       }
@@ -208,13 +214,13 @@ vows.describe('node-ical').addBatch({
         })[0];
       }
       , 'has a start' : function(topic){
-        assert.equal(topic.start.toISOString(), new Date(2011, 7, 4, 12, 0,0).toISOString())
+        assert.equal(topic.start.toISOString(), new Date(2011, 07, 04, 12, 0,0).toISOString())
       }
     }
   , 'event with rrule' :{
       topic: function(events){
         return _.select(_.values(events), function(x){
-          return x.summary == "foobarTV broadcast starts"
+          return x.summary === "foobarTV broadcast starts"
         })[0];
       }
       , "Has an RRULE": function(topic){
@@ -249,7 +255,7 @@ vows.describe('node-ical').addBatch({
         },
         'task completed': function(task){
             assert.equal(task.completion, 100);
-            assert.equal(task.completed.toISOString(), new Date(2013, 6, 16, 10, 57, 45).toISOString());
+            assert.equal(task.completed.toISOString(), new Date(2013, 06, 16, 10, 57, 45).toISOString());
         }
     }
   }
@@ -272,7 +278,7 @@ vows.describe('node-ical').addBatch({
       },
       'grabbing custom properties': {
           topic: function(topic) {
-              
+
           }
       }
   },
@@ -367,14 +373,115 @@ vows.describe('node-ical').addBatch({
         assert.equal(topic.end.getFullYear(), 2014);
         assert.equal(topic.end.getMonth(), 3);
         assert.equal(topic.end.getUTCHours(), 19);
-        assert.equal(topic.end.getUTCMinutes(), 0);
+        assert.equal(topic.end.getUTCMinutes(), 00);
       }
     }
-  },
+  }
 
-  'url request errors' : {
+  , 'with test12.ics (testing recurrences and exdates)': {
+	topic: function () {
+		return ical.parseFile('./test/test12.ics')
+	}
+    , 'event with rrule': {
+  			topic: function (events) {
+  				return _.select(_.values(events), function (x) {
+  					return x.uid === '0000001';
+  				})[0];
+  			}
+      , "Has an RRULE": function (topic) {
+      	assert.notEqual(topic.rrule, undefined);
+      }
+      , "Has summary Treasure Hunting": function (topic) {
+      	assert.equal(topic.summary, 'Treasure Hunting');
+      }
+      , "Has two EXDATES": function (topic) {
+      	assert.notEqual(topic.exdate, undefined);
+      	assert.notEqual(topic.exdate[new Date(2015, 06, 08, 12, 0, 0).toISOString().substring(0, 10)], undefined);
+      	assert.notEqual(topic.exdate[new Date(2015, 06, 10, 12, 0, 0).toISOString().substring(0, 10)], undefined);
+      }
+      , "Has a RECURRENCE-ID override": function (topic) {
+      	assert.notEqual(topic.recurrences, undefined);
+      	assert.notEqual(topic.recurrences[new Date(2015, 06, 07, 12, 0, 0).toISOString().substring(0, 10)], undefined);
+      	assert.equal(topic.recurrences[new Date(2015, 06, 07, 12, 0, 0).toISOString().substring(0, 10)].summary, 'More Treasure Hunting');
+      }
+    }
+  }
+
+  , 'with test13.ics (testing recurrence-id before rrule)': {
+  	topic: function () {
+  		return ical.parseFile('./test/test13.ics')
+  	}
+    , 'event with rrule': {
+    	topic: function (events) {
+    		return _.select(_.values(events), function (x) {
+    			return x.uid === '6m2q7kb2l02798oagemrcgm6pk@google.com';
+    		})[0];
+    	}
+      , "Has an RRULE": function (topic) {
+      	assert.notEqual(topic.rrule, undefined);
+      }
+      , "Has summary 'repeated'": function (topic) {
+      	assert.equal(topic.summary, 'repeated');
+      }
+      , "Has a RECURRENCE-ID override": function (topic) {
+      	assert.notEqual(topic.recurrences, undefined);
+      	assert.notEqual(topic.recurrences[new Date(2016, 7, 26, 14, 0, 0).toISOString().substring(0, 10)], undefined);
+      	assert.equal(topic.recurrences[new Date(2016, 7, 26, 14, 0, 0).toISOString().substring(0, 10)].summary, 'bla bla');
+      }
+    }
+  }
+
+  , 'with test14.ics (testing comma-separated exdates)': {
+  	topic: function () {
+  		return ical.parseFile('./test/test14.ics')
+  	}
+    , 'event with comma-separated exdate': {
+    	topic: function (events) {
+    		return _.select(_.values(events), function (x) {
+    			return x.uid === '98765432-ABCD-DCBB-999A-987765432123';
+    		})[0];
+    	}
+      , "Has summary 'Example of comma-separated exdates'": function (topic) {
+      	assert.equal(topic.summary, 'Example of comma-separated exdates');
+      }
+      , "Has four comma-separated EXDATES": function (topic) {
+      	assert.notEqual(topic.exdate, undefined);
+		// Verify the four comma-separated EXDATES are there
+      	assert.notEqual(topic.exdate[new Date(2017, 6, 6, 12, 0, 0).toISOString().substring(0, 10)], undefined);
+      	assert.notEqual(topic.exdate[new Date(2017, 6, 17, 12, 0, 0).toISOString().substring(0, 10)], undefined);
+      	assert.notEqual(topic.exdate[new Date(2017, 6, 20, 12, 0, 0).toISOString().substring(0, 10)], undefined);
+      	assert.notEqual(topic.exdate[new Date(2017, 7, 3, 12, 0, 0).toISOString().substring(0, 10)], undefined);
+		// Verify an arbitrary date isn't there
+      	assert.equal(topic.exdate[new Date(2017, 4, 5, 12, 0, 0).toISOString().substring(0, 10)], undefined);
+      }
+    }
+  }
+
+  , 'with test14.ics (testing exdates with bad times)': {
+  	topic: function () {
+  		return ical.parseFile('./test/test14.ics')
+  	}
+    , 'event with exdates with bad times': {
+    	topic: function (events) {
+    		return _.select(_.values(events), function (x) {
+    			return x.uid === '1234567-ABCD-ABCD-ABCD-123456789012';
+    		})[0];
+    	}
+      , "Has summary 'Example of exdate with bad times'": function (topic) {
+      	assert.equal(topic.summary, 'Example of exdate with bad times');
+      }
+      , "Has two EXDATES even though they have bad times": function (topic) {
+      	assert.notEqual(topic.exdate, undefined);
+      	// Verify the two EXDATES are there, even though they have bad times
+      	assert.notEqual(topic.exdate[new Date(2017, 11, 18, 12, 0, 0).toISOString().substring(0, 10)], undefined);
+      	assert.notEqual(topic.exdate[new Date(2017, 11, 19, 12, 0, 0).toISOString().substring(0, 10)], undefined);
+      }
+    }
+  }
+
+ , 'url request errors': {
     topic : function () {
-      ical.fromURL('http://not.exist/', {}, this.callback);
+      ical.fromURL('http://255.255.255.255/', {}, this.callback);
     }
     , 'are passed back to the callback' : function (err, result) {
       assert.instanceOf(err, Error);

modules/default/calendar/vendor/ical.js/test/test12.ics

@@ -0,0 +1,19 @@
+BEGIN:VCALENDAR
+BEGIN:VEVENT
+UID:0000001
+SUMMARY:Treasure Hunting
+DTSTART;TZID=America/Los_Angeles:20150706T120000
+DTEND;TZID=America/Los_Angeles:20150706T130000
+RRULE:FREQ=DAILY;COUNT=10
+EXDATE;TZID=America/Los_Angeles:20150708T120000
+EXDATE;TZID=America/Los_Angeles:20150710T120000
+END:VEVENT
+BEGIN:VEVENT
+UID:0000001
+SUMMARY:More Treasure Hunting
+LOCATION:The other island
+DTSTART;TZID=America/Los_Angeles:20150709T150000
+DTEND;TZID=America/Los_Angeles:20150707T160000
+RECURRENCE-ID;TZID=America/Los_Angeles:20150707T120000
+END:VEVENT
+END:VCALENDAR

modules/default/calendar/vendor/ical.js/test/test13.ics

@@ -0,0 +1,57 @@
+BEGIN:VCALENDAR
+PRODID:-//Google Inc//Google Calendar 70.9054//EN
+VERSION:2.0
+CALSCALE:GREGORIAN
+METHOD:PUBLISH
+X-WR-CALNAME:ical
+X-WR-TIMEZONE:Europe/Kiev
+X-WR-CALDESC:
+BEGIN:VTIMEZONE
+TZID:Europe/Kiev
+X-LIC-LOCATION:Europe/Kiev
+BEGIN:DAYLIGHT
+TZOFFSETFROM:+0200
+TZOFFSETTO:+0300
+TZNAME:EEST
+DTSTART:19700329T030000
+RRULE:FREQ=YEARLY;BYMONTH=3;BYDAY=-1SU
+END:DAYLIGHT
+BEGIN:STANDARD
+TZOFFSETFROM:+0300
+TZOFFSETTO:+0200
+TZNAME:EET
+DTSTART:19701025T040000
+RRULE:FREQ=YEARLY;BYMONTH=10;BYDAY=-1SU
+END:STANDARD
+END:VTIMEZONE
+BEGIN:VEVENT
+DTSTART;TZID=Europe/Kiev:20160826T140000
+DTEND;TZID=Europe/Kiev:20160826T150000
+DTSTAMP:20160825T061505Z
+UID:6m2q7kb2l02798oagemrcgm6pk@google.com
+RECURRENCE-ID;TZID=Europe/Kiev:20160826T140000
+CREATED:20160823T125221Z
+DESCRIPTION:
+LAST-MODIFIED:20160823T130320Z
+LOCATION:
+SEQUENCE:0
+STATUS:CONFIRMED
+SUMMARY:bla bla
+TRANSP:OPAQUE
+END:VEVENT
+BEGIN:VEVENT
+DTSTART;TZID=Europe/Kiev:20160825T140000
+DTEND;TZID=Europe/Kiev:20160825T150000
+RRULE:FREQ=DAILY;UNTIL=20160828T110000Z
+DTSTAMP:20160825T061505Z
+UID:6m2q7kb2l02798oagemrcgm6pk@google.com
+CREATED:20160823T125221Z
+DESCRIPTION:
+LAST-MODIFIED:20160823T125221Z
+LOCATION:
+SEQUENCE:0
+STATUS:CONFIRMED
+SUMMARY:repeated
+TRANSP:OPAQUE
+END:VEVENT
+END:VCALENDAR

modules/default/calendar/vendor/ical.js/test/test14.ics

@@ -0,0 +1,33 @@
+BEGIN:VCALENDAR
+PRODID:-//Google Inc//Google Calendar 70.9054//EN
+VERSION:2.0
+CALSCALE:GREGORIAN
+METHOD:PUBLISH
+X-WR-CALNAME:ical
+X-WR-TIMEZONE:Europe/Kiev
+X-WR-CALDESC:
+BEGIN:VEVENT
+UID:98765432-ABCD-DCBB-999A-987765432123
+DTSTART;TZID=US/Central:20170216T090000
+DTEND;TZID=US/Central:20170216T190000
+DTSTAMP:20170727T044436Z
+EXDATE;TZID=US/Central:20170706T090000,20170717T090000,20170720T090000,20
+ 170803T090000
+LAST-MODIFIED:20170727T044435Z
+RRULE:FREQ=WEEKLY;WKST=SU;UNTIL=20170814T045959Z;INTERVAL=2;BYDAY=MO,TH
+SEQUENCE:0
+SUMMARY:Example of comma-separated exdates
+END:VEVENT
+BEGIN:VEVENT
+UID:1234567-ABCD-ABCD-ABCD-123456789012
+DTSTART:20170814T140000Z
+DTEND:20170815T000000Z
+DTSTAMP:20171204T134925Z
+EXDATE:20171219T060000
+EXDATE:20171218T060000
+LAST-MODIFIED:20171024T140004Z
+RRULE:FREQ=WEEKLY;WKST=SU;INTERVAL=2;BYDAY=MO,TU
+SEQUENCE:0
+SUMMARY:Example of exdate with bad times
+END:VEVENT
+END:VCALENDAR

modules/default/clock/README.md

@@ -2,45 +2,4 @@
 The `clock` module is one of the default modules of the MagicMirror.
 This module displays the current date and time. The information will be updated realtime.
 
-## Screenshot
-
-- Current time
-![Current time](clock_screenshot.png)
-
-## Using the module
-
-To use this module, add it to the modules array in the `config/config.js` file:
-````javascript
-modules: [
-	{
-		module: "clock",
-		position: "top_left",	// This can be any of the regions.
-		config: {
-			// The config property is optional.
-			// See 'Configuration options' for more information.
-		}
-	}
-]
-````
-
-## Configuration options
-
-The following properties can be configured:
-
-| Option            | Description
-| ----------------- | -----------
-| `timeFormat`      | Use 12 or 24 hour format. <br><br> **Possible values:** `12` or `24` <br> **Default value:** uses value of _config.timeFormat_
-| `displaySeconds`  | Display seconds. <br><br> **Possible values:** `true` or `false` <br> **Default value:** `true`
-| `showPeriod`      | Show the period (am/pm) with 12 hour format. <br><br> **Possible values:** `true` or `false` <br> **Default value:** `true`
-| `showPeriodUpper` | Show the period (AM/PM) with 12 hour format as uppercase. <br><br> **Possible values:** `true` or `false` <br> **Default value:** `false`
-| `clockBold`       | Remove the colon and bold the minutes to make a more modern look. <br><br> **Possible values:** `true` or `false` <br> **Default value:** `false`
-| `showDate`        | Turn off or on the Date section. <br><br> **Possible values:** `true` or `false` <br> **Default value:** `true`
-| `showWeek`        | Turn off or on the Week section. <br><br> **Possible values:** `true` or `false` <br> **Default value:** `false`
-| `dateFormat`      | Configure the date format as you like. <br><br> **Possible values:** [Docs](http://momentjs.com/docs/#/displaying/format/) <br> **Default value:** `"dddd, LL"`
-| `displayType`     | Display a digital clock, analog clock, or both together. <br><br> **Possible values:** `digital`, `analog`, or `both` <br> **Default value:** `digital`
-| `analogSize`      | **Specific to the analog clock.** Defines how large the analog display is. <br><br> **Possible values:** A positive number of pixels` <br> **Default value:** `200px`
-| `analogFace`      | **Specific to the analog clock.** Specifies which clock face to use. <br><br> **Possible values:** `simple` for a simple border, `none` for no face or border, or `face-###` (where ### is currently a value between 001 and 012, inclusive) <br> **Default value:** `simple`
-| `secondsColor`    | **Specific to the analog clock.** Specifies what color to make the 'seconds' hand. <br><br> **Possible values:** `any HTML RGB Color` <br> **Default value:** `#888888`
-| `analogPlacement` | **Specific to the analog clock. _(requires displayType set to `'both'`)_** Specifies where the analog clock is in relation to the digital clock <br><br> **Possible values:** `top`, `right`, `bottom`, or `left` <br> **Default value:** `bottom`
-| `analogShowDate`  | **Specific to the analog clock.** If the clock is used as a separate module and set to analog only, this configures whether a date is also displayed with the clock. <br><br> **Possible values:** `false`, `top`, or `bottom` <br> **Default value:** `top`
-| `timezone`        | Specific a timezone to show clock. <br><br> **Possible examples values:** `America/New_York`, `America/Santiago`, `Etc/GMT+10` <br> **Default value:** `none`. See more informations about configuration value [here](https://momentjs.com/timezone/docs/#/data-formats/packed-format/)
+For configuration options, please check the [MagicMirror² documentation](https://docs.magicmirror.builders/modules/clock.html).

modules/default/clock/clock.js

@@ -26,10 +26,15 @@ Module.register("clock",{
 		analogShowDate: "top", // options: false, 'top', or 'bottom'
 		secondsColor: "#888888",
 		timezone: null,
+
+		showSunTimes: false,
+		showMoonTimes: false,
+		lat: 47.630539,
+		lon: -122.344147,
 	},
 	// Define required scripts.
 	getScripts: function() {
-		return ["moment.js", "moment-timezone.js"];
+		return ["moment.js", "moment-timezone.js", "suncalc.js"];
 	},
 	// Define styles.
 	getStyles: function() {
@@ -41,9 +46,40 @@ Module.register("clock",{
 
 		// Schedule update interval.
 		var self = this;
-		setInterval(function() {
+		self.second = moment().second();
+		self.minute = moment().minute();
+
+		//Calculate how many ms should pass until next update depending on if seconds is displayed or not
+		var delayCalculator = function(reducedSeconds) {
+			if (self.config.displaySeconds) {
+				return 1000 - moment().milliseconds();
+			} else {
+				return ((60 - reducedSeconds) * 1000) - moment().milliseconds();
+			}
+		};
+
+		//A recursive timeout function instead of interval to avoid drifting
+		var notificationTimer = function() {
 			self.updateDom();
-		}, 1000);
+
+			//If seconds is displayed CLOCK_SECOND-notification should be sent (but not when CLOCK_MINUTE-notification is sent)
+			if (self.config.displaySeconds) {
+				self.second = (self.second + 1) % 60;
+				if (self.second !== 0) {
+					self.sendNotification("CLOCK_SECOND", self.second);
+					setTimeout(notificationTimer, delayCalculator(0));
+					return;
+				}
+			}
+
+			//If minute changed or seconds isn't displayed send CLOCK_MINUTE-notification
+			self.minute = (self.minute + 1) % 60;
+			self.sendNotification("CLOCK_MINUTE", self.minute);
+			setTimeout(notificationTimer, delayCalculator(0));
+		};
+
+		//Set the initial timeout with the amount of seconds elapsed as reducedSeconds so it will trigger when the minute changes
+		setTimeout(notificationTimer, delayCalculator(self.second));
 
 		// Set locale.
 		moment.locale(config.language);
@@ -62,12 +98,16 @@ Module.register("clock",{
 		var timeWrapper = document.createElement("div");
 		var secondsWrapper = document.createElement("sup");
 		var periodWrapper = document.createElement("span");
-		var weekWrapper = document.createElement("div")
+		var sunWrapper = document.createElement("div");
+		var moonWrapper = document.createElement("div");
+		var weekWrapper = document.createElement("div");
 		// Style Wrappers
 		dateWrapper.className = "date normal medium";
 		timeWrapper.className = "time bright large light";
 		secondsWrapper.className = "dimmed";
-		weekWrapper.className = "week dimmed medium"
+		sunWrapper.className = "sun dimmed small";
+		moonWrapper.className = "moon dimmed small";
+		weekWrapper.className = "week dimmed medium";
 
 		// Set content of wrappers.
 		// The moment().format("h") method has a bug on the Raspberry Pi.
@@ -75,6 +115,7 @@ Module.register("clock",{
 		// See issue: https://github.com/MichMich/MagicMirror/issues/181
 		var timeString;
 		var now = moment();
+		this.lastDisplayedMinute = now.minute();
 		if (this.config.timezone) {
 			now.tz(this.config.timezone);
 		}
@@ -110,6 +151,49 @@ Module.register("clock",{
 			timeWrapper.appendChild(periodWrapper);
 		}
 
+		function formatTime(config, time) {
+			var formatString = hourSymbol + ":mm";
+			if (config.showPeriod && config.timeFormat !== 24) {
+				formatString += config.showPeriodUpper ? "A" : "a";
+			}
+			return moment(time).format(formatString);
+		}
+		if (this.config.showSunTimes) {
+			const sunTimes = SunCalc.getTimes(now, this.config.lat, this.config.lon);
+			const isVisible = now.isBetween(sunTimes.sunrise, sunTimes.sunset);
+			var nextEvent;
+			if (now.isBefore(sunTimes.sunrise)) {
+				nextEvent = sunTimes.sunrise;
+			} else if (now.isBefore(sunTimes.sunset)) {
+				nextEvent = sunTimes.sunset;
+			} else {
+				const tomorrowSunTimes = SunCalc.getTimes(now.clone().add(1, "day"), this.config.lat, this.config.lon);
+				nextEvent = tomorrowSunTimes.sunrise;
+			}
+			const untilNextEvent = moment.duration(moment(nextEvent).diff(now));
+			const untilNextEventString = untilNextEvent.hours() + "h " + untilNextEvent.minutes() + "m";
+			sunWrapper.innerHTML = "<span class=\"" + (isVisible ? "bright" : "") + "\"><i class=\"fa fa-sun-o\" aria-hidden=\"true\"></i> " + untilNextEventString + "</span>" +
+				"<span><i class=\"fa fa-arrow-up\" aria-hidden=\"true\"></i>" + formatTime(this.config, sunTimes.sunrise) + "</span>" +
+				"<span><i class=\"fa fa-arrow-down\" aria-hidden=\"true\"></i>" + formatTime(this.config, sunTimes.sunset) + "</span>";
+		}
+		if (this.config.showMoonTimes) {
+			const moonIllumination = SunCalc.getMoonIllumination(now.toDate());
+			const moonTimes = SunCalc.getMoonTimes(now, this.config.lat, this.config.lon);
+			const moonRise = moonTimes.rise;
+			var moonSet;
+			if (moment(moonTimes.set).isAfter(moonTimes.rise)) {
+				moonSet = moonTimes.set;
+			} else {
+				const nextMoonTimes = SunCalc.getMoonTimes(now.clone().add(1, "day"), this.config.lat, this.config.lon);
+				moonSet = nextMoonTimes.set;
+			}
+			const isVisible = now.isBetween(moonRise, moonSet) || moonTimes.alwaysUp === true;
+			const illuminatedFractionString = Math.round(moonIllumination.fraction * 100) + "%";
+			moonWrapper.innerHTML = "<span class=\"" + (isVisible ? "bright" : "") + "\"><i class=\"fa fa-moon-o\" aria-hidden=\"true\"></i> " + illuminatedFractionString + "</span>" +
+				"<span><i class=\"fa fa-arrow-up\" aria-hidden=\"true\"></i> " + (moonRise ? formatTime(this.config, moonRise) : "...") + "</span>"+
+				"<span><i class=\"fa fa-arrow-down\" aria-hidden=\"true\"></i> " + (moonSet ? formatTime(this.config, moonSet) : "...") + "</span>";
+		}
+
 		/****************************************************************
 		 * Create wrappers for ANALOG clock, only if specified in config
 		 */
@@ -132,7 +216,7 @@ Module.register("clock",{
 			clockCircle.style.width = this.config.analogSize;
 			clockCircle.style.height = this.config.analogSize;
 
-			if (this.config.analogFace != "" && this.config.analogFace != "simple" && this.config.analogFace != "none") {
+			if (this.config.analogFace !== "" && this.config.analogFace !== "simple" && this.config.analogFace !== "none") {
 				clockCircle.style.background = "url("+ this.data.path + "faces/" + this.config.analogFace + ".svg)";
 				clockCircle.style.backgroundSize = "100%";
 
@@ -140,7 +224,7 @@ Module.register("clock",{
 				// clockCircle.style.border = "1px solid black";
 				clockCircle.style.border = "rgba(0, 0, 0, 0.1)"; //Updated fix for Issue 611 where non-black backgrounds are used
 
-			} else if (this.config.analogFace != "none") {
+			} else if (this.config.analogFace !== "none") {
 				clockCircle.style.border = "2px solid white";
 			}
 			var clockFace = document.createElement("div");
@@ -178,6 +262,8 @@ Module.register("clock",{
 			// Display only a digital clock
 			wrapper.appendChild(dateWrapper);
 			wrapper.appendChild(timeWrapper);
+			wrapper.appendChild(sunWrapper);
+			wrapper.appendChild(moonWrapper);
 			wrapper.appendChild(weekWrapper);
 		} else if (this.config.displayType === "analog") {
 			// Display only an analog clock
@@ -212,6 +298,8 @@ Module.register("clock",{
 			digitalWrapper.style.cssFloat = "none";
 			digitalWrapper.appendChild(dateWrapper);
 			digitalWrapper.appendChild(timeWrapper);
+			digitalWrapper.appendChild(sunWrapper);
+			digitalWrapper.appendChild(moonWrapper);
 			digitalWrapper.appendChild(weekWrapper);
 
 			var appendClocks = function(condition, pos1, pos2) {

modules/default/clock/clock_styles.css

@@ -66,3 +66,13 @@
   -ms-transform-origin: 50% 100%;
   transform-origin: 50% 100%;
 }
+
+.module.clock .sun,
+.module.clock .moon {
+  display: flex;
+}
+
+.module.clock .sun > *,
+.module.clock .moon > * {
+  flex: 1;
+}

modules/default/compliments/README.md

@@ -2,150 +2,4 @@
 The `compliments` module is one of the default modules of the MagicMirror.
 This module displays a random compliment.
 
-## Screenshots
-- Compliments Screenshot
-![Compliments Screenshot](compliments_screenshot.png)
-
-## Using the module
-
-To use this module, add it to the modules array in the `config/config.js` file:
-````javascript
-modules: [
-	{
-		module: "compliments",
-		position: "lower_third",	// This can be any of the regions.
-									// Best results in one of the middle regions like: lower_third
-		config: {
-			// The config property is optional.
-			// If no config is set, the default compliments are shown.
-			// See 'Configuration options' for more information.
-		}
-	}
-]
-````
-
-## Configuration options
-
-The following properties can be configured:
-
-
-| Option           | Description
-| ---------------- | -----------
-| `updateInterval` | How often does the compliment have to change? (Milliseconds) <br><br> **Possible values:** `1000` - `86400000` <br> **Default value:** `30000` (30 seconds)
-| `fadeSpeed`      | Speed of the update animation. (Milliseconds) <br><br> **Possible values:**`0` - `5000` <br> **Default value:** `4000` (4 seconds)
-| `compliments`	   | The list of compliments. <br><br> **Possible values:** An object with four arrays: `morning`, `afternoon`, `evening` and `anytime`. See _compliment configuration_ below. <br> **Default value:** See _compliment configuration_ below.
-| `remoteFile`     | External file from which to load the compliments <br><br> **Possible values:** Path or URL (starting with `http://` or `https://`) to a JSON file containing compliments, configured as per the value of the _compliments configuration_ (see below). An object with four arrays: `morning`, `afternoon`, `evening` and `anytime`. - `compliments.json` <br> **Default value:** `null` (Do not load from file)
-| `classes`        | Override the CSS classes of the div showing the compliments <br><br> **Default value:** `thin xlarge bright`
-| `morningStartTime`        |  Time in hours (in 24 format), after which the mode of "morning" will begin <br> **Possible values:** `0` - `24` <br><br> **Default value:** `3`
-| `morningEndTime`        |  Time in hours (in 24 format), after which the mode of "morning" will end <br> **Possible values:** `0` - `24` <br><br> **Default value:** `12`
-| `afternoonStartTime`        | Time in hours (in 24 format), after which the mode "afternoon" will begin <br> **Possible values:** `0` - `24` <br><br>  **Default value:** `12`
-| `afternoonEndTime`        | Time in hours (in 24 format), after which the mode "afternoon" will end <br> **Possible values:** `0` - `24` <br><br> **Default value:** `17`
-
-All the rest of the time that does not fall into the morningStartTime-morningEndTime and afternoonStartTime-afternoonEndTime ranges is considered "evening".
-
-### Compliment configuration
-
-The `compliments` property contains an object with four arrays: <code>morning</code>, <code>afternoon</code>, <code>evening</code> and <code>anytime</code>. Based on the time of the day, the compliments will be picked out of one of these arrays. The arrays contain one or multiple compliments.
-
-
-If use the currentweather is possible use a actual weather for set compliments. The availables properties are:
-- `day_sunny`
-- `day_cloudy`
-- `cloudy`
-- `cloudy_windy`
-- `showers`
-- `rain`
-- `thunderstorm`
-- `snow`
-- `fog`
-- `night_clear`
-- `night_cloudy`
-- `night_showers`
-- `night_rain`
-- `night_thunderstorm`
-- `night_snow`
-- `night_alt_cloudy_windy`
-
-#### Example use with currentweather module
-````javascript
-config: {
-	compliments: {
-		day_sunny: [
-			"Today is a sunny day",
-			"It's a beautiful day"
-		],
-		snow: [
-			"Snowball battle!"
-		],
-		rain: [
-			"Don't forget your umbrella"
-		]
-	}
-}
-````
-
-
-#### Default value:
-````javascript
-config: {
-	compliments: {
-		anytime: [
-			"Hey there sexy!"
-		],
-		morning: [
-			"Good morning, handsome!",
-			"Enjoy your day!",
-			"How was your sleep?"
-		],
-		afternoon: [
-			"Hello, beauty!",
-			"You look sexy!",
-			"Looking good today!"
-		],
-		evening: [
-			"Wow, you look hot!",
-			"You look nice!",
-			"Hi, sexy!"
-		]
-	}
-}
-````
-
-#### Multi-line compliments:
-Use `\n` to split compliment text into multiple lines, e.g. `First line.\nSecond line.` will be shown as:
-```
-First line.
-Second line.
-```
-
-### External Compliment File
-You may specify an external file that contains the three compliment arrays. This is particularly useful if you have a
-large number of compliments and do not wish to crowd your `config.js` file with a large array of compliments.
-Adding the `remoteFile` variable will override an array you specify in the configuration file.
-
-This file must be straight JSON. Note that the array names need quotes
-around them ("morning", "afternoon", "evening", "snow", "rain", etc.).
-#### Example compliments.json file:
-````json
-{
-    "anytime" : [
-        "Hey there sexy!"
-    ],
-    "morning" : [
-        "Good morning, sunshine!",
-        "Who needs coffee when you have your smile?",
-        "Go get 'em, Tiger!"
-    ],
-    "afternoon" : [
-        "Hitting your stride!",
-        "You are making a difference!",
-        "You're more fun than bubble wrap!"
-    ],
-    "evening" : [
-        "You made someone smile today, I know it.",
-        "You are making a difference.",
-        "The day was better for your efforts."
-    ]
-}
-````
-
+For configuration options, please check the [MagicMirror² documentation](https://docs.magicmirror.builders/modules/compliments.html).

modules/default/compliments/compliments.js

@@ -28,6 +28,9 @@ Module.register("compliments", {
 				"Wow, you look hot!",
 				"You look nice!",
 				"Hi, sexy!"
+			],
+			"....-01-01": [
+				"Happy new year!"
 			]
 		},
 		updateInterval: 30000,
@@ -36,9 +39,11 @@ Module.register("compliments", {
 		morningStartTime: 3,
 		morningEndTime: 12,
 		afternoonStartTime: 12,
-		afternoonEndTime: 17
+		afternoonEndTime: 17,
+		random: true,
+		mockDate: null
 	},
-
+	lastIndexUsed:-1,
 	// Set currentweather from module
 	currentWeatherType: "",
 
@@ -54,7 +59,7 @@ Module.register("compliments", {
 		this.lastComplimentIndex = -1;
 
 		var self = this;
-		if (this.config.remoteFile != null) {
+		if (this.config.remoteFile !== null) {
 			this.complimentFile(function(response) {
 				self.config.compliments = JSON.parse(response);
 				self.updateDom();
@@ -101,6 +106,7 @@ Module.register("compliments", {
 	 */
 	complimentArray: function() {
 		var hour = moment().hour();
+		var date = this.config.mockDate ? this.config.mockDate : moment().format("YYYY-MM-DD");
 		var compliments;
 
 		if (hour >= this.config.morningStartTime && hour < this.config.morningEndTime && this.config.compliments.hasOwnProperty("morning")) {
@@ -121,6 +127,12 @@ Module.register("compliments", {
 
 		compliments.push.apply(compliments, this.config.compliments.anytime);
 
+		for (entry in this.config.compliments) {
+			if (new RegExp(entry).test(date)) {
+				compliments.push.apply(compliments, this.config.compliments[entry]);
+			}
+		}
+
 		return compliments;
 	},
 
@@ -134,7 +146,7 @@ Module.register("compliments", {
 		xobj.overrideMimeType("application/json");
 		xobj.open("GET", path, true);
 		xobj.onreadystatechange = function() {
-			if (xobj.readyState == 4 && xobj.status == "200") {
+			if (xobj.readyState === 4 && xobj.status === 200) {
 				callback(xobj.responseText);
 			}
 		};
@@ -147,25 +159,48 @@ Module.register("compliments", {
 	 * return compliment string - A compliment.
 	 */
 	randomCompliment: function() {
+		// get the current time of day compliments list
 		var compliments = this.complimentArray();
-		var index = this.randomIndex(compliments);
+		// variable for index to next message to display
+		let index = 0;
+		// are we randomizing
+		if(this.config.random){
+			// yes
+			index = this.randomIndex(compliments);
+		}
+		else{
+			// no, sequential
+			// if doing sequential, don't fall off the end
+			index = (this.lastIndexUsed >= (compliments.length-1))?0: ++this.lastIndexUsed;
+		}
 
-		return compliments[index];
+		return compliments[index] || "";
 	},
 
 	// Override dom generator.
 	getDom: function() {
-		var complimentText = this.randomCompliment();
-
-		var compliment = document.createTextNode(complimentText);
 		var wrapper = document.createElement("div");
 		wrapper.className = this.config.classes ? this.config.classes : "thin xlarge bright pre-line";
+		// get the compliment text
+		var complimentText = this.randomCompliment();
+		// split it into parts on newline text
+		var parts = complimentText.split("\n");
+		// create a span to hold it all
+		var compliment = document.createElement("span");
+		// process all the parts of the compliment text
+		for (part of parts){
+			// create a text element for each part
+			compliment.appendChild(document.createTextNode(part));
+			// add a break `
+			compliment.appendChild(document.createElement("BR"));
+		}
+		// remove the last break
+		compliment.lastElementChild.remove();
 		wrapper.appendChild(compliment);
 
 		return wrapper;
 	},
 
-
 	// From data currentweather set weather type
 	setCurrentWeatherType: function(data) {
 		var weatherIconTable = {
@@ -191,10 +226,9 @@ Module.register("compliments", {
 		this.currentWeatherType = weatherIconTable[data.weather[0].icon];
 	},
 
-
 	// Override notification handler.
 	notificationReceived: function(notification, payload, sender) {
-		if (notification == "CURRENTWEATHER_DATA") {
+		if (notification === "CURRENTWEATHER_DATA") {
 			this.setCurrentWeatherType(payload.data);
 		}
 	},

modules/default/currentweather/README.md

@@ -2,87 +2,4 @@
 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.
 
-## Screenshot
-
-- Current weather screenshot
-![Current Weather Screenshot](weather_screenshot.png)
-
-## Using the module
-
-To use this module, add it to the modules array in the `config/config.js` file:
-````javascript
-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. <br><br> **Example:** `'Amsterdam,Netherlands'` <br> **Default value:** `false` <br><br> **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](https://openweathermap.org/find) **This will override anything you put in location.** <br> Leave blank if you want to use location. <br> **Example:** `1234567` <br> **Default value:** `false` <br><br> **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](https://home.openweathermap.org) API key, which can be obtained by creating an OpenWeatherMap account. <br><br>  This value is **REQUIRED**
-| `units`                      | What units to use. Specified by config.js <br><br> **Possible values:** `config.units` = Specified by config.js, `default` = Kelvin, `metric` = Celsius, `imperial` =Fahrenheit <br> **Default value:** `config.units`
-| `roundTemp`                  | Round temperature value to nearest integer. <br><br> **Possible values:** `true` (round to integer) or `false` (display exact value with decimal point) <br> **Default value:** `false`
-| `degreeLabel`                | Show the degree label for your chosen units (Metric = C, Imperial = F, Kelvins = K). <br><br> **Possible values:** `true` or `false` <br> **Default value:** `false`
-| `updateInterval`             | How often does the content needs to be fetched? (Milliseconds) <br><br> **Possible values:** `1000` - `86400000` <br> **Default value:** `600000` (10 minutes)
-| `animationSpeed`             | Speed of the update animation. (Milliseconds) <br><br> **Possible values:**`0` - `5000` <br> **Default value:** `1000` (1 second)
-| `timeFormat`                 | Use 12 or 24 hour format. <br><br> **Possible values:** `12` or `24` <br> **Default value:** uses value of _config.timeFormat_
-| `showPeriod`                 | Show the period (am/pm) with 12 hour format <br><br> **Possible values:** `true` or `false` <br> **Default value:** `true`
-| `showPeriodUpper`	           | Show the period (AM/PM) with 12 hour format as uppercase <br><br> **Possible values:** `true` or `false` <br> **Default value:** `false`
-| `showWindDirection`          | Show the wind direction next to the wind speed. <br><br> **Possible values:** `true` or `false` <br> **Default value:** `true`
-| `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, 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:** `.`
-| `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) <br><br> **Possible values:** `1000` - `5000` <br> **Default value:**  `0`
-| `retryDelay`                 | The delay before retrying after a request failure. (Milliseconds) <br><br> **Possible values:** `1000` - `60000` <br> **Default value:**  `2500`
-| `apiVersion`                 | The OpenWeatherMap API version to use. <br><br> **Default value:**  `2.5`
-| `apiBase`                    | The OpenWeatherMap base URL. <br><br> **Default value:**  `'http://api.openweathermap.org/data/'`
-| `weatherEndpoint`	           | The OpenWeatherMap API endPoint. <br><br> **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. <br><br> **Default value:**  `true`
-| `calendarClass`              | The class for the calender module to base the event based weather information on. <br><br> **Default value:**  `'calendar'`
-| `iconTable`                  | The conversion table to convert the weather conditions to weather-icons. <br><br> **Default value:**  view tabel below.
-
-#### Default Icon Table
-````javascript
-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'
-}
-````
+For configuration options, please check the [MagicMirror² documentation](https://docs.magicmirror.builders/modules/currentweather.html).

modules/default/currentweather/currentweather.js

@@ -23,6 +23,7 @@ Module.register("currentweather",{
 		showWindDirection: true,
 		showWindDirectionAsArrow: false,
 		useBeaufort: true,
+		appendLocationNameToHeader: false,
 		useKMPHwind: false,
 		lang: config.language,
 		decimalSymbol: ".",
@@ -41,8 +42,10 @@ Module.register("currentweather",{
 
 		appendLocationNameToHeader: true,
 		calendarClass: "calendar",
+		tableClass: "large",
 
 		onlyTemp: false,
+		hideTemp: false,
 		roundTemp: false,
 
 		iconTable: {
@@ -173,6 +176,7 @@ Module.register("currentweather",{
 	// Override dom generator.
 	getDom: function() {
 		var wrapper = document.createElement("div");
+		wrapper.className = this.config.tableClass;
 
 		if (this.config.appid === "") {
 			wrapper.innerHTML = "Please set the correct openweather <i>appid</i> in the config for module: " + this.name + ".";
@@ -191,11 +195,7 @@ Module.register("currentweather",{
 		}
 
 		var large = document.createElement("div");
-		large.className = "large light";
-
-		var weatherIcon = document.createElement("span");
-		weatherIcon.className = "wi weathericon " + this.weatherType;
-		large.appendChild(weatherIcon);
+		large.className = "light";
 
 		var degreeLabel = "";
 		if (this.config.units === "metric" || this.config.units === "imperial") {
@@ -219,10 +219,16 @@ Module.register("currentweather",{
 			this.config.decimalSymbol = ".";
 		}
 
-		var temperature = document.createElement("span");
-		temperature.className = "bright";
-		temperature.innerHTML = " " + this.temperature.replace(".", this.config.decimalSymbol) + degreeLabel;
-		large.appendChild(temperature);
+		if (this.config.hideTemp === false) {
+			var weatherIcon = document.createElement("span");
+			weatherIcon.className = "wi weathericon " + this.weatherType;
+			large.appendChild(weatherIcon);
+
+			var temperature = document.createElement("span");
+			temperature.className = "bright";
+			temperature.innerHTML = " " + this.temperature.replace(".", this.config.decimalSymbol) + degreeLabel;
+			large.appendChild(temperature);
+		}
 
 		if (this.config.showIndoorTemperature && this.indoorTemperature) {
 			var indoorIcon = document.createElement("span");
@@ -269,6 +275,10 @@ Module.register("currentweather",{
 			return this.data.header + " " + this.fetchedLocationName;
 		}
 
+		if (this.config.useLocationAsHeader && this.config.location !== false) {
+			return this.config.location;
+		}
+
 		return this.data.header;
 	},
 
@@ -353,7 +363,7 @@ Module.register("currentweather",{
 		} 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
+			params += "lat=" + this.firstEvent.geo.lat + "&lon=" + this.firstEvent.geo.lon;
 		} else if (this.firstEvent && this.firstEvent.location) {
 			params += "q=" + this.firstEvent.location;
 		} else {
@@ -383,6 +393,7 @@ Module.register("currentweather",{
 
 		this.humidity = parseFloat(data.main.humidity);
 		this.temperature = this.roundValue(data.main.temp);
+		this.fetchedLocationName = data.name;
 		this.feelsLike = 0;
 
 		if (this.config.useBeaufort){

modules/default/helloworld/README.md

@@ -1,25 +1,4 @@
 # Module: Hello World
 The `helloworld` module is one of the default modules of the MagicMirror. It is a simple way to display a static text on the mirror.
-## Using the module
 
-To use this module, add it to the modules array in the `config/config.js` file:
-````javascript
-modules: [
-	{
-		module: "helloworld",
-		position: "bottom_bar",	// This can be any of the regions.
-		config: {
-			// See 'Configuration options' for more information.
-			text: "Hello world!"
-		}
-	}
-]
-````
-
-## Configuration options
-
-The following properties can be configured:
-
-| Option | Description
-| ------ | -----------
-| `text` | The text to display. <br><br> **Example:** `'Hello world!'` <br> **Default value:** `'Hello world!'`
+For configuration options, please check the [MagicMirror² documentation](https://docs.magicmirror.builders/modules/helloworld.html).

modules/default/helloworld/helloworld.js

@@ -15,10 +15,10 @@ Module.register("helloworld",{
 	},
 
 	getTemplate: function () {
-		return "helloworld.njk"
+		return "helloworld.njk";
 	},
 
 	getTemplateData: function () {
-		return this.config
+		return this.config;
 	}
 });

modules/default/newsfeed/README.md

@@ -2,96 +2,4 @@
 The `newsfeed ` module is one of the default modules of the MagicMirror.
 This module displays news headlines based on an RSS feed. Scrolling through news headlines happens time-based (````updateInterval````), but can also be controlled by sending news feed specific notifications to the module.
 
-## Screenshot
-- News Feed Screenshot using the NYT
-![NYT News Feed Screenshot](newsfeed_screenshot.png)
-
-## Using the module
-
-### Configuration
-To use this module, add it to the modules array in the `config/config.js` file:
-````javascript
-modules: [
-	{
-		module: "newsfeed",
-		position: "bottom_bar",	// This can be any of the regions. Best results in center regions.
-		config: {
-			// The config property is optional.
-			// If no config is set, an example calendar is shown.
-			// See 'Configuration options' for more information.
-
-			feeds: [
-				{
-					title: "New York Times",
-					url: "http://www.nytimes.com/services/xml/rss/nyt/HomePage.xml",
-				},
-				{
-					title: "BBC",
-					url: "http://feeds.bbci.co.uk/news/video_and_audio/news_front_page/rss.xml?edition=uk",
-				},
-			]
-		}
-	}
-]
-````
-
-### Notifications
-#### Interacting with the module
-MagicMirror's [notification mechanism](https://github.com/MichMich/MagicMirror/tree/master/modules#thissendnotificationnotification-payload) allows to send notifications to the `newsfeed` module. The following notifications are supported:
-
-| Notification Identifier | Description
-| ----------------------- | -----------
-| `ARTICLE_NEXT`          | Shows the next news title (hiding the summary or previously fully displayed article)
-| `ARTICLE_PREVIOUS`      | Shows the previous news title (hiding the summary or previously fully displayed article)
-| `ARTICLE_MORE_DETAILS`  | When received the _first time_, shows the corresponding description of the currently displayed news title. <br> The module expects that the module's configuration option `showDescription` is set to `false` (default value). <br><br> When received a _second consecutive time_, shows the full news article in an IFRAME. <br> This requires that the news page can be embedded in an IFRAME, e.g. doesn't have the HTTP response header [X-Frame-Options](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/X-Frame-Options) set to e.g. `DENY`.<br><br>When received the _next consecutive times_, reloads the page and scrolls down by `scrollLength` pixels to paginate through the article.
-| `ARTICLE_LESS_DETAILS`  | Hides the summary or full news article and only displays the news title of the currently viewed news item.
-| `ARTICLE_TOGGLE_FULL`   | Toogles article in fullscreen.
-| `ARTICLE_INFO_REQUEST`  | Causes `newsfeed` to respond with the notification `ARTICLE_INFO_RESPONSE`, the payload of which provides the `title`, `source`, `date`, `desc` and `url` of the current news title.
-
-Note the payload of the sent notification event is ignored.
-
-#### Example
-The following example shows how the next news article title can be displayed on the MagicMirror.
-````javascript
-this.sendNotification('ARTICLE_NEXT');
-````
-
-#### `newsfeed` specific notification emitting modules
-The third party [MMM-Gestures](https://github.com/thobach/MMM-Gestures) module supports above notifications when moving your hand up, down, left or right in front of a gesture sensor attached to the MagicMirror. See module's readme for more details.
-
-## Configuration options
-
-The following properties can be configured:
-
-| Option             | Description
-| ------------------ | -----------
-| `feeds`            | An array of feed urls that will be used as source. <br> More info about this object can be found below. <br> **Default value:** `[{ title: "New York Times", url: "http://www.nytimes.com/services/xml/rss/nyt/HomePage.xml", encoding: "UTF-8" }]`<br>You can add `reloadInterval` option to set particular reloadInterval to a feed.
-| `showSourceTitle`  | Display the title of the source. <br><br> **Possible values:** `true` or `false` <br> **Default value:** `true`
-| `showPublishDate`  | Display the publish date of an headline. <br><br> **Possible values:** `true` or `false` <br> **Default value:** `true`
-| `showDescription`  | Display the description of an item. <br><br> **Possible values:** `true` or `false` <br> **Default value:** `false`
-| `wrapTitle`        | Wrap the title of the item to multiple lines. <br><br> **Possible values:** `true` or `false` <br> **Default value:** `true`
-| `wrapDescription`  | Wrap the description of the item to multiple lines. <br><br> **Possible values:** `true` or `false` <br> **Default value:** `true`
-| `truncDescription` | Truncate description? <br><br> **Possible values:** `true` or `false` <br> **Default value:** `true`
-| `lengthDescription`| How many characters to be displayed for a truncated description? <br><br> **Possible values:** `1` - `500` <br> **Default value:** `400`
-| `hideLoading`      | Hide module instead of showing LOADING status. <br><br> **Possible values:** `true` or `false` <br> **Default value:** `false`
-| `reloadInterval`   | How often does the content needs to be fetched? (Milliseconds) <br><br> **Possible values:** `1000` - `86400000` <br> **Default value:** `300000` (5 minutes)
-| `updateInterval`   | How often do you want to display a new headline? (Milliseconds) <br><br> **Possible values:**`1000` - `60000` <br> **Default value:** `10000` (10 seconds)
-| `animationSpeed`   | Speed of the update animation. (Milliseconds) <br><br> **Possible values:**`0` - `5000` <br> **Default value:** `2500` (2.5 seconds)
-| `maxNewsItems`     | Total amount of news items to cycle through. (0 for unlimited) <br><br> **Possible values:**`0` - `...` <br> **Default value:** `0`
-| `ignoreOldItems`   | Ignore news items that are outdated. <br><br> **Possible values:**`true` or `false` <br> **Default value:** `false`
-| `ignoreOlderThan`  | How old should news items be before they are considered outdated? (Milliseconds) <br><br> **Possible values:**`1` - `...` <br> **Default value:** `86400000` (1 day)
-| `removeStartTags`  | Some newsfeeds feature tags at the **beginning** of their titles or descriptions, such as _[VIDEO]_. This setting allows for the removal of specified tags from the beginning of an item's description and/or title. <br><br> **Possible values:**`'title'`, `'description'`, `'both'`
-| `startTags`        | List the tags you would like to have removed at the beginning of the feed item <br><br> **Possible values:** `['TAG']` or `['TAG1','TAG2',...]`
-| `removeEndTags`    | Remove specified tags from the **end** of an item's description and/or title. <br><br> **Possible values:**`'title'`, `'description'`, `'both'`
-| `endTags`          | List the tags you would like to have removed at the end of the feed item <br><br> **Possible values:** `['TAG']` or `['TAG1','TAG2',...]`
-| `prohibitedWords` | Remove news feed item if one of these words is found anywhere in the title (case insensitive and greedy matching) <br><br> **Possible values:** `['word']` or `['word1','word2',...]`
-| `scrollLength` | Scrolls the full news article page by a given number of pixels when a `ARTICLE_MORE_DETAILS` notification is received and the full news article is already displayed.<br><br> **Possible values:** `1` or `10000` <br> **Default value:** `500`
-| `logFeedWarnings` | Log warnings when there is an error parsing a news article. <br><br> **Possible values:** `true` or `false` <br> **Default value:** `false`
-
-The `feeds` property contains an array with multiple objects. These objects have the following properties:
-
-| Option     | Description
-| ---------- | -----------
-| `title`    | The name of the feed source to be displayed above the news items. <br><br> This property is optional.
-| `url`      | The url of the feed used for the headlines. <br><br> **Example:** `'http://www.nytimes.com/services/xml/rss/nyt/HomePage.xml'`
-| `encoding` | The encoding of the news feed. <br><br> This property is optional. <br> **Possible values:**`'UTF-8'`, `'ISO-8859-1'`, etc ... <br> **Default value:** `'UTF-8'`
+For configuration options, please check the [MagicMirror² documentation](https://docs.magicmirror.builders/modules/newsfeed.html).

modules/default/newsfeed/fetcher.js

@@ -81,11 +81,10 @@ var Fetcher = function(url, reloadInterval, encoding, logFeedWarnings) {
 			scheduleTimer();
 		});
 
-
 		nodeVersion = Number(process.version.match(/^v(\d+\.\d+)/)[1]);
 		headers =	{"User-Agent": "Mozilla/5.0 (Node.js "+ nodeVersion + ") MagicMirror/"	+ global.version +	" (https://github.com/MichMich/MagicMirror/)",
 			"Cache-Control": "max-age=0, no-cache, no-store, must-revalidate",
-			"Pragma": "no-cache"}
+			"Pragma": "no-cache"};
 
 		request({uri: url, encoding: null, headers: headers})
 			.on("error", function(error) {

modules/default/newsfeed/newsfeed.js

@@ -20,6 +20,8 @@ Module.register("newsfeed",{
 		],
 		showSourceTitle: true,
 		showPublishDate: true,
+		broadcastNewsFeeds: true,
+		broadcastNewsUpdates: true,
 		showDescription: false,
 		wrapTitle: true,
 		wrapDescription: true,
@@ -103,7 +105,7 @@ Module.register("newsfeed",{
 			// this.config.showFullArticle is a run-time configuration, triggered by optional notifications
 			if (!this.config.showFullArticle && (this.config.showSourceTitle || this.config.showPublishDate)) {
 				var sourceAndTimestamp = document.createElement("div");
-				sourceAndTimestamp.className = "light small dimmed";
+				sourceAndTimestamp.className = "newsfeed-source light small dimmed";
 
 				if (this.config.showSourceTitle && this.newsItems[this.activeItem].sourceTitle !== "") {
 					sourceAndTimestamp.innerHTML = this.newsItems[this.activeItem].sourceTitle;
@@ -166,14 +168,14 @@ Module.register("newsfeed",{
 
 			if(!this.config.showFullArticle){
 				var title = document.createElement("div");
-				title.className = "bright medium light" + (!this.config.wrapTitle ? " no-wrap" : "");
+				title.className = "newsfeed-title bright medium light" + (!this.config.wrapTitle ? " no-wrap" : "");
 				title.innerHTML = this.newsItems[this.activeItem].title;
 				wrapper.appendChild(title);
 			}
 
 			if (this.isShowingDescription) {
 				var description = document.createElement("div");
-				description.className = "small light" + (!this.config.wrapDescription ? " no-wrap" : "");
+				description.className = "newsfeed-desc small light" + (!this.config.wrapDescription ? " no-wrap" : "");
 				var txtDesc = this.newsItems[this.activeItem].description;
 				description.innerHTML = (this.config.truncDescription ? (txtDesc.length > this.config.lengthDescription ? txtDesc.substring(0, this.config.lengthDescription) + "..." : txtDesc) : txtDesc);
 				wrapper.appendChild(description);
@@ -189,7 +191,7 @@ Module.register("newsfeed",{
 				fullArticle.style.top = "0";
 				fullArticle.style.left = "0";
 				fullArticle.style.border = "none";
-				fullArticle.src = this.getActiveItemURL()
+				fullArticle.src = this.getActiveItemURL();
 				fullArticle.style.zIndex = 1;
 				wrapper.appendChild(fullArticle);
 			}
@@ -211,7 +213,7 @@ Module.register("newsfeed",{
 	},
 
 	getActiveItemURL: function() {
-		return typeof this.newsItems[this.activeItem].url  === "string" ? this.newsItems[this.activeItem].url : this.newsItems[this.activeItem].url.href;
+		return typeof this.newsItems[this.activeItem].url === "string" ? this.newsItems[this.activeItem].url : this.newsItems[this.activeItem].url.href;
 	},
 
 	/* registerFeeds()
@@ -266,6 +268,20 @@ Module.register("newsfeed",{
 			}, this);
 		}
 
+		// get updated news items and broadcast them
+		var updatedItems = [];
+		newsItems.forEach(value => {
+			if (this.newsItems.findIndex(value1 => value1 === value) === -1) {
+				// Add item to updated items list
+				updatedItems.push(value);
+			}
+		});
+
+		// check if updated items exist, if so and if we should broadcast these updates, then lets do so
+		if (this.config.broadcastNewsUpdates && updatedItems.length > 0) {
+			this.sendNotification("NEWS_FEED_UPDATE", {items: updatedItems});
+		}
+
 		this.newsItems = newsItems;
 	},
 
@@ -311,9 +327,19 @@ Module.register("newsfeed",{
 
 		self.updateDom(self.config.animationSpeed);
 
+		// Broadcast NewsFeed if needed
+		if (self.config.broadcastNewsFeeds) {
+			self.sendNotification("NEWS_FEED", {items: self.newsItems});
+		}
+
 		timer = setInterval(function() {
 			self.activeItem++;
 			self.updateDom(self.config.animationSpeed);
+
+			// Broadcast NewsFeed if needed
+			if (self.config.broadcastNewsFeeds) {
+				self.sendNotification("NEWS_FEED", {items: self.newsItems});
+			}
 		}, this.config.updateInterval);
 	},
 
@@ -341,7 +367,6 @@ Module.register("newsfeed",{
 	},
 
 	notificationReceived: function(notification, payload, sender) {
-		Log.info(this.name + " - received notification: " + notification);
 		if(notification === "ARTICLE_NEXT"){
 			var before = this.activeItem;
 			this.activeItem++;
@@ -398,9 +423,7 @@ Module.register("newsfeed",{
 				date:   this.newsItems[this.activeItem].pubdate,
 				desc:   this.newsItems[this.activeItem].description,
 				url:    this.getActiveItemURL()
-			})
-		} else {
-			Log.info(this.name + " - unknown notification, ignoring: " + notification);
+			});
 		}
 	},
 

modules/default/updatenotification/README.md

@@ -2,26 +2,4 @@
 The `updatenotification` module is one of the default modules of the MagicMirror.
 This will display a message whenever a new version of the MagicMirror application is available.
 
-## Using the module
-
-To use this module, add it to the modules array in the `config/config.js` file:
-````javascript
-modules: [
-	{
-		module: "updatenotification",
-		position: "top_center",	// This can be any of the regions.
-		config: {
-			// The config property is optional.
-			// See 'Configuration options' for more information.
-		}
-	}
-]
-````
-
-## Configuration options
-
-The following properties can be configured:
-
-| Option           | Description
-| ---------------- | -----------
-| `updateInterval` | How often do you want to check for a new version? This value represents the interval in milliseconds. <br><br> **Possible values:** Any value above `60000` (1 minute) <br> **Default value:** `600000` (10 minutes);
+For configuration options, please check the [MagicMirror² documentation](https://docs.magicmirror.builders/modules/updatenotification.html).

modules/default/updatenotification/node_helper.js

@@ -10,61 +10,74 @@ module.exports = NodeHelper.create({
 	config: {},
 
 	updateTimer: null,
+	updateProcessStarted: false,
 
 	start: function () {
 	},
 
 	configureModules: function(modules) {
-		for (moduleName in modules) {
-			if (defaultModules.indexOf(moduleName) < 0) {
-				// Default modules are included in the main MagicMirror repo
-				var moduleFolder =  path.normalize(__dirname + "/../../" + moduleName);
 
-				var stat;
+		// Push MagicMirror itself , biggest chance it'll show up last in UI and isn't overwritten
+		// others will be added in front
+		// this method returns promises so we can't wait for every one to resolve before continuing
+		simpleGits.push({"module": "default", "git": SimpleGit(path.normalize(__dirname + "/../../../"))});
+
+		var promises = [];
+
+		for (moduleName in modules) {
+			if (!this.ignoreUpdateChecking(moduleName)) {
+				// Default modules are included in the main MagicMirror repo
+				var moduleFolder = path.normalize(__dirname + "/../../" + moduleName);
+
 				try {
-					stat = fs.statSync(path.join(moduleFolder, ".git"));
+					//console.log("checking git for module="+moduleName)
+					let stat = fs.statSync(path.join(moduleFolder, ".git"));
+					promises.push(this.resolveRemote(moduleName, moduleFolder));
 				} catch(err) {
 					// Error when directory .git doesn't exist
 					// This module is not managed with git, skip
 					continue;
 				}
-
-				var res = function(mn, mf) {
-					var git = SimpleGit(mf);
-					git.getRemotes(true, function(err, remotes) {
-						if (remotes.length < 1 || remotes[0].name.length < 1) {
-							// No valid remote for folder, skip
-							return;
-						}
-
-						// Folder has .git and has at least one git remote, watch this folder
-						simpleGits.push({"module": mn, "git": git});
-					});
-				}(moduleName, moduleFolder);
 			}
 		}
 
-		// Push MagicMirror itself last, biggest chance it'll show up last in UI and isn't overwritten
-		simpleGits.push({"module": "default", "git": SimpleGit(path.normalize(__dirname + "/../../../"))});
+		return Promise.all(promises);
 	},
 
 	socketNotificationReceived: function (notification, payload) {
 		if (notification === "CONFIG") {
 			this.config = payload;
 		} else if(notification === "MODULES") {
-			this.configureModules(payload);
-			this.preformFetch();
+			// if this is the 1st time thru the update check process
+			if (!this.updateProcessStarted) {
+				this.updateProcessStarted = true;
+				this.configureModules(payload).then(() => this.performFetch());
+			}
 		}
 	},
 
-	preformFetch() {
-		var self = this;
+	resolveRemote: function(moduleName, moduleFolder) {
+		return new Promise((resolve, reject) => {
+			var git = SimpleGit(moduleFolder);
+			git.getRemotes(true, (err, remotes) => {
+				if (remotes.length < 1 || remotes[0].name.length < 1) {
+					// No valid remote for folder, skip
+					return resolve();
+				}
+				// Folder has .git and has at least one git remote, watch this folder
+				simpleGits.unshift({"module": moduleName, "git": git});
+				resolve();
+			});
+		});
+	},
 
-		simpleGits.forEach(function(sg) {
-			sg.git.fetch().status(function(err, data) {
+	performFetch: function() {
+		var self = this;
+		simpleGits.forEach((sg) => {
+			sg.git.fetch().status((err, data) => {
 				data.module = sg.module;
 				if (!err) {
-					sg.git.log({"-1": null}, function(err, data2) {
+					sg.git.log({"-1": null}, (err, data2) => {
 						if (!err && data2.latest && "hash" in data2.latest) {
 							data.hash = data2.latest.hash;
 							self.sendSocketNotification("STATUS", data);
@@ -79,14 +92,29 @@ module.exports = NodeHelper.create({
 
 	scheduleNextFetch: function(delay) {
 		if (delay < 60 * 1000) {
-			delay = 60 * 1000
+			delay = 60 * 1000;
 		}
 
 		var self = this;
 		clearTimeout(this.updateTimer);
 		this.updateTimer = setTimeout(function() {
-			self.preformFetch();
+			self.performFetch();
 		}, delay);
+	},
+
+	ignoreUpdateChecking: function(moduleName) {
+		// Should not check for updates for default modules
+		if (defaultModules.indexOf(moduleName) >= 0) {
+			return true;
+		}
+
+		// Should not check for updates for ignored modules
+		if (this.config.ignoreModules.indexOf(moduleName) >= 0) {
+			return true;
+		}
+
+		// The rest of the modules that passes should check for updates
+		return false;
 	}
 
 });

modules/default/updatenotification/updatenotification.js

@@ -2,41 +2,57 @@ Module.register("updatenotification", {
 
 	defaults: {
 		updateInterval: 10 * 60 * 1000, // every 10 minutes
+		refreshInterval: 24 * 60 * 60 * 1000, // one day
+		ignoreModules: []
 	},
 
-	status: false,
+	suspended: false,
+	moduleList: {},
 
 	start: function () {
+		var self = this;
 		Log.log("Start updatenotification");
-
+		setInterval( () => { self.moduleList = {};self.updateDom(2); } , self.config.refreshInterval);
 	},
 
 	notificationReceived: function (notification, payload, sender) {
 		if (notification === "DOM_OBJECTS_CREATED") {
 			this.sendSocketNotification("CONFIG", this.config);
 			this.sendSocketNotification("MODULES", Module.definitions);
-			this.hide(0, { lockString: self.identifier });
+			//this.hide(0, { lockString: self.identifier });
 		}
 	},
 
 	socketNotificationReceived: function (notification, payload) {
 		if (notification === "STATUS") {
-			this.status = payload;
-			this.updateUI();
+			this.updateUI(payload);
 		}
 	},
 
-	updateUI: function () {
+	updateUI: function (payload) {
 		var self = this;
-		if (this.status && this.status.behind > 0) {
-			self.updateDom(0);
-			self.show(1000, { lockString: self.identifier });
+		if (payload && payload.behind > 0) {
+			// if we haven't seen info for this module
+			if(this.moduleList[payload.module] == undefined){
+				// save it
+				this.moduleList[payload.module]=payload;
+				self.updateDom(2);
+			}
+			//self.show(1000, { lockString: self.identifier });
+
+		} else if (payload && payload.behind == 0){
+			// if the module WAS in the list, but shouldn't be
+			if(this.moduleList[payload.module] != undefined){
+				// remove it
+				delete this.moduleList[payload.module];
+				self.updateDom(2);
+			}
 		}
 	},
 
-	diffLink: function(text) {
-		var localRef = this.status.hash;
-		var remoteRef = this.status.tracking.replace(/.*\//, "");
+	diffLink: function(module, text) {
+		var localRef = module.hash;
+		var remoteRef = module.tracking.replace(/.*\//, "");
 		return "<a href=\"https://github.com/MichMich/MagicMirror/compare/"+localRef+"..."+remoteRef+"\" "+
 			"class=\"xsmall dimmed\" "+
 			"style=\"text-decoration: none;\" "+
@@ -48,41 +64,53 @@ Module.register("updatenotification", {
 	// Override dom generator.
 	getDom: function () {
 		var wrapper = document.createElement("div");
+		if(this.suspended==false){
+			// process the hash of module info found
+			for(key of Object.keys(this.moduleList)){
+				let m= this.moduleList[key];
 
-		if (this.status && this.status.behind > 0) {
-			var message = document.createElement("div");
-			message.className = "small bright";
+				var message = document.createElement("div");
+				message.className = "small bright";
 
-			var icon = document.createElement("i");
-			icon.className = "fa fa-exclamation-circle";
-			icon.innerHTML = "&nbsp;";
-			message.appendChild(icon);
+				var icon = document.createElement("i");
+				icon.className = "fa fa-exclamation-circle";
+				icon.innerHTML = "&nbsp;";
+				message.appendChild(icon);
 
-			var updateInfoKeyName = this.status.behind == 1 ? "UPDATE_INFO_SINGLE" : "UPDATE_INFO_MULTIPLE";
-			var subtextHtml = this.translate(updateInfoKeyName, {
-				COMMIT_COUNT: this.status.behind,
-				BRANCH_NAME: this.status.current
-			});
+				var updateInfoKeyName = m.behind == 1 ? "UPDATE_INFO_SINGLE" : "UPDATE_INFO_MULTIPLE";
 
-			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", {
-					MODULE_NAME: this.status.module
+				var subtextHtml = this.translate(updateInfoKeyName, {
+					COMMIT_COUNT: m.behind,
+					BRANCH_NAME: m.current
 				});
+
+				var text = document.createElement("span");
+				if (m.module == "default") {
+					text.innerHTML = this.translate("UPDATE_NOTIFICATION");
+					subtextHtml = this.diffLink(m,subtextHtml);
+				} else {
+					text.innerHTML = this.translate("UPDATE_NOTIFICATION_MODULE", {
+						MODULE_NAME: m.module
+					});
+				}
+				message.appendChild(text);
+
+				wrapper.appendChild(message);
+
+				var subtext = document.createElement("div");
+				subtext.innerHTML = subtextHtml;
+				subtext.className = "xsmall dimmed";
+				wrapper.appendChild(subtext);
 			}
-			message.appendChild(text);
-
-			wrapper.appendChild(message);
-
-			var subtext = document.createElement("div");
-			subtext.innerHTML = subtextHtml;
-			subtext.className = "xsmall dimmed";
-			wrapper.appendChild(subtext);
 		}
-
 		return wrapper;
+	},
+
+	suspend: function() {
+		this.suspended=true;
+	},
+	resume: function() {
+		this.suspended=false;
+		this.updateDom(2);
 	}
 });

modules/default/weather/README.md

@@ -1,110 +1,5 @@
 # Weather Module
 
-This module is aimed to be the replacement for the current `currentweather` and `weatherforcast` modules. The module will be configurable to be used as a current weather view, or to show the forecast. This way the module can be used twice to fullfil both purposes. 
+This module is aimed to be the replacement for the current `currentweather` and `weatherforcast` modules. The module will be configurable to be used as a current weather view, or to show the forecast. This way the module can be used twice to fullfil both purposes.
 
-The biggest change is the use of weather providers. This way we are not bound to one API source. And users can choose which API they want to use as their source.
-
-The module is in a very early stage, and needs a lot of work. It's API isn't set in stone, so keep that in mind when you want to contribute.
-
-## Example
-
-![Current Weather Screenshot](current.png) ![Weather Forecast Screenshot](forecast.png)
-
-## Usage
-
-To use this module, add it to the modules array in the `config/config.js` file:
-
-````javascript
-modules: [
-	{
-		module: "weather",
-		position: "top_right",
-		config: {
-			// See 'Configuration options' for more information.
-			type: 'current'
-		}
-	}
-]
-````
-
-## Configuration options
-
-The following properties can be configured:
-
-### General options
-
-| Option                       | Description
-| ---------------------------- | -----------
-| `weatherProvider`            | Which weather provider should be used. <br><br> **Possible values:** `openweathermap` , `darksky` , or `weathergov` <br> **Default value:** `openweathermap`
-| `type`                       | Which type of weather data should be displayed. <br><br> **Possible values:** `current` or `forecast` <br> **Default value:** `current`
-| `units`                      | What units to use. Specified by config.js <br><br> **Possible values:** `config.units` = Specified by config.js, `default` = Kelvin, `metric` = Celsius, `imperial` = Fahrenheit <br> **Default value:** `config.units`
-| `roundTemp`                  | Round temperature value to nearest integer. <br><br> **Possible values:** `true` (round to integer) or `false` (display exact value with decimal point) <br> **Default value:** `false`
-| `degreeLabel`                | Show the degree label for your chosen units (Metric = C, Imperial = F, Kelvin = K). <br><br> **Possible values:** `true` or `false` <br> **Default value:** `false`
-| `updateInterval`             | How often does the content needs to be fetched? (Milliseconds) <br><br> **Possible values:** `1000` - `86400000` <br> **Default value:** `600000` (10 minutes)
-| `animationSpeed`             | Speed of the update animation. (Milliseconds) <br><br> **Possible values:** `0` - `5000` <br> **Default value:** `1000` (1 second)
-| `timeFormat`                 | Use 12 or 24 hour format. <br><br> **Possible values:** `12` or `24` <br> **Default value:** uses value of _config.timeFormat_
-| `showPeriod`                 | Show the period (am/pm) with 12 hour format <br><br> **Possible values:** `true` or `false` <br> **Default value:** `true`
-| `showPeriodUpper`	           | Show the period (AM/PM) with 12 hour format as uppercase <br><br> **Possible values:** `true` or `false` <br> **Default value:** `false`
-| `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:** `.`
-| `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) <br><br> **Possible values:** `1000` - `5000` <br> **Default value:** `0`
-| `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 interesting when using calender based weather. <br><br> **Default value:** `true`
-| `calendarClass`              | The class for the calender module to base the event based weather information on. <br><br> **Default value:** `'calendar'`
-
-#### Current weather options
-
-| Option                       | Description
-| ---------------------------- | -----------
-| `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`
-| `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`
-| `showWindDirection`          | Show the wind direction next to the wind speed. <br><br> **Possible values:** `true` or `false` <br> **Default value:** `true`
-| `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`
-| `showIndoorHumidity`         | If you have another module that emits the `INDOOR_HUMIDITY` notification, the indoor humidity will be displayed <br> **Default value:** `false`
-| `showFeelsLike`              | Shows the Feels like temperature weather. <br><br> **Possible values:** `true` or `false`<br>**Default value:** `true`
-
-#### Weather forecast options
-
-| Option                       | Description
-| ---------------------------- | -----------
-| `tableClass`                 | The class for the forecast table. <br><br> **Default value:** `'small'`
-| `colored`                    | If set to `true`, the min and max temperature are color coded. <br><br> **Default value:** `false`
-| `showPrecipitationAmount`    | Show the amount of rain/snow in the forecast <br><br> **Possible values:** `true` or `false` <br> **Default value:** `false`
-| `fade`                       | Fade the future events to black. (Gradient) <br><br> **Possible values:** `true` or `false` <br> **Default value:** `true`
-| `fadePoint`                  | Where to start fade? <br><br> **Possible values:** `0` (top of the list) - `1` (bottom of list) <br> **Default value:** `0.25`
-| `maxNumberOfDays`            | How many days of forecast to return. Specified by config.js <br><br> **Possible values:** `1` - `16` <br> **Default value:** `5` (5 days) <br> This value is optional. By default the weatherforecast module will return 5 days.
-
-### Openweathermap options
-
-| Option                       | Description
-| ---------------------------- | -----------
-| `apiVersion`                 | The OpenWeatherMap API version to use. <br><br> **Default value:** `2.5`
-| `apiBase`                    | The OpenWeatherMap base URL. <br><br> **Default value:** `'http://api.openweathermap.org/data/'`
-| `weatherEndpoint`	           | The OpenWeatherMap API endPoint. <br><br> **Possible values:** `/weather`, `/forecast` (free users) or `/forecast/daily` (paying users or old apiKey only) <br> **Default value:** `'/weather'`
-| `locationID`                 | Location ID from [OpenWeatherMap](https://openweathermap.org/find) **This will override anything you put in location.** <br> Leave blank if you want to use location. <br> **Example:** `1234567` <br> **Default value:** `false` <br><br> **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.
-| `location`                   | The location used for weather information. <br><br> **Example:** `'Amsterdam,Netherlands'` <br> **Default value:** `false` <br><br> **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.
-| `apiKey`                     | The [OpenWeatherMap](https://home.openweathermap.org) API key, which can be obtained by creating an OpenWeatherMap account. <br><br> This value is **REQUIRED**
-
-### Darksky options
-
-| Option                       | Description
-| ---------------------------- | -----------
-| `apiBase`                    | The DarkSky base URL. The darksky api has disabled [cors](https://developer.mozilla.org/en-US/docs/Web/HTTP/CORS), therefore a proxy is required. <br><br> **Possible value:** `'https://cors-anywhere.herokuapp.com/https://api.darksky.net'` <br> This value is **REQUIRED**
-| `weatherEndpoint`	           | The DarkSky API endPoint. <br><br> **Possible values:** `/forecast` <br> This value is **REQUIRED**
-| `apiKey`                     | The [DarkSky](https://darksky.net/dev/register) API key, which can be obtained by creating an DarkSky account. <br><br> This value is **REQUIRED**
-| `lat`                        | The geo coordinate latitude. <br><br> This value is **REQUIRED**
-| `lon`                        | The geo coordinate longitude. <br><br> This value is **REQUIRED**
-
-### Weather.gov options
-
-| Option                       | Description
-| ---------------------------- | -----------
-| `apiBase`                    | The weather.gov base URL. <br><br> **Possible value:** `'https://api.weather.gov/points/'` <br> This value is **REQUIRED**
-| `weatherEndpoint`	           | The weather.gov API endPoint. <br><br> **Possible values:** `/forecast` for forecast and `/forecast/hourly` for current. <br> This value is **REQUIRED**
-| `lat`                        | The geo coordinate latitude. <br><br> This value is **REQUIRED**
-| `lon`                        | The geo coordinate longitude. <br><br> This value is **REQUIRED**
-
-## API Provider Development
-
-If you want to add another API provider checkout the [Guide](providers).
+For configuration options, please check the [MagicMirror² documentation](https://docs.magicmirror.builders/modules/weather.html).

modules/default/weather/current.njk

@@ -9,7 +9,7 @@
                     {{ current.windSpeed | round }}
                 {% endif %}
                 {% if config.showWindDirection %}
-                    <sup> 
+                    <sup>
                         {% if config.showWindDirectionAsArrow %}
                             <i class="fa fa-long-arrow-up" style="transform:rotate({{ current.windDirection }}deg);"></i>
                         {% else %}
@@ -24,7 +24,7 @@
             {% endif %}
             <span class="wi dimmed wi-{{ current.nextSunAction() }}"></span>
             <span>
-                {% if current.nextSunAction() == "sunset" %}
+                {% if current.nextSunAction() === "sunset" %}
                     {{ current.sunset | formatTime }}
                 {% else %}
                     {{ current.sunrise | formatTime }}
@@ -56,11 +56,18 @@
             </div>
         {% endif %}
     </div>
-    {% if config.showFeelsLike and not config.onlyTemp %}
+    {% if (config.showFeelsLike or config.showPrecipitationAmount) and not config.onlyTemp %}
         <div class="normal medium">
-            <span class="dimmed">
-                {{ "FEELS" | translate }} {{ current.feelsLike() | roundValue | unit("temperature") | decimalSymbol }}
-            </span>
+            {% if config.showFeelsLike %}
+                <span class="dimmed">
+                    {{ "FEELS" | translate }} {{ current.feelsLike() | roundValue | unit("temperature") | decimalSymbol }}
+                </span>
+            {% endif %}
+            {% if config.showPrecipitationAmount %}
+                <span class="dimmed">
+                    {{ "PRECIP" | translate }} {{ current.precipitation | unit("precip") }}
+                </span>
+            {% endif %}
         </div>
     {% endif %}
 {% else %}

modules/default/weather/forecast.njk

@@ -28,5 +28,5 @@
     </div>
 {% endif %}
 
-<!-- Uncomment the line below to see the contents of the `current` object. -->
+<!-- Uncomment the line below to see the contents of the `forecast` object. -->
 <!-- <div style="word-wrap:break-word" class="xsmall dimmed">{{forecast | dump}}</div> -->

modules/default/weather/providers/README.md

@@ -18,9 +18,9 @@ This is the script in which the weather provider will be defined. In it's most s
 ````javascript
 WeatherProvider.register("yourprovider", {
 	providerName: "YourProvider",
-	
+
 	fetchCurrentWeather() {},
-	
+
 	fetchWeatherForecast() {}
 });
 ````
@@ -91,7 +91,9 @@ A convenience function to make requests. It returns a promise.
 
 | Property | Type | Value/Unit |
 | --- | --- | --- |
-| units | `string` | Gets initialized with the constructor. <br> Possible values: `metric` and `imperial` |
+| units | `string` | Gets initialized with the constructor. <br> Possible values: `metric`, `imperial` |
+| tempUnits | `string` | Gets initialized with the constructor. <br> Possible values: `metric`, `imperial` |
+| windUnits | `string` | Gets initialized with the constructor. <br> Possible values: `metric`, `imperial` |
 | date | `object` | [Moment.js](https://momentjs.com/) object of the time/date. |
 | windSpeed |`number` | Metric: `meter/second` <br> Imperial: `miles/hour` |
 | windDirection |`number` | Direction of the wind in degrees. |
@@ -104,7 +106,7 @@ A convenience function to make requests. It returns a promise.
 | humidity | `number` | Percentage of humidity |
 | rain | `number` | Metric: `millimeters` <br> Imperial: `inches` |
 | snow | `number` | Metric: `millimeters` <br> Imperial: `inches` |
-| precipitation | `number` | Metric: `millimeters` <br> Imperial: `inches` |
+| precipitation | `number` | Metric: `millimeters` <br> Imperial: `inches` <br> UK Met Office provider: `percent` |
 
 #### Current weather
 

modules/default/weather/providers/darksky.js

@@ -32,7 +32,8 @@ WeatherProvider.register("darksky", {
 				this.setCurrentWeather(currentWeather);
 			}).catch(function(request) {
 				Log.error("Could not load data ... ", request);
-			});
+			})
+			.finally(() => this.updateAvailable())
 	},
 
 	fetchWeatherForecast() {
@@ -47,7 +48,8 @@ WeatherProvider.register("darksky", {
 				this.setWeatherForecast(forecast);
 			}).catch(function(request) {
 				Log.error("Could not load data ... ", request);
-			});
+			})
+			.finally(() => this.updateAvailable())
 	},
 
 	// Create a URL from the config and base URL.
@@ -58,7 +60,7 @@ WeatherProvider.register("darksky", {
 
 	// Implement WeatherDay generator.
 	generateWeatherDayFromCurrentWeather(currentWeatherData) {
-		const currentWeather = new WeatherObject(this.config.units);
+		const currentWeather = new WeatherObject(this.config.units, this.config.tempUnits, this.config.windUnits);
 
 		currentWeather.date = moment();
 		currentWeather.humidity = parseFloat(currentWeatherData.currently.humidity);
@@ -76,7 +78,7 @@ WeatherProvider.register("darksky", {
 		const days = [];
 
 		for (const forecast of forecasts) {
-			const weather = new WeatherObject(this.config.units);
+			const weather = new WeatherObject(this.config.units, this.config.tempUnits, this.config.windUnits);
 
 			weather.date = moment(forecast.time, "X");
 			weather.minTemperature = forecast.temperatureMin;

modules/default/weather/providers/openweathermap.js

@@ -34,6 +34,7 @@ WeatherProvider.register("openweathermap", {
 			.catch(function(request) {
 				Log.error("Could not load data ... ", request);
 			})
+			.finally(() => this.updateAvailable())
 	},
 
 	// Overwrite the fetchCurrentWeather method.
@@ -54,6 +55,7 @@ WeatherProvider.register("openweathermap", {
 			.catch(function(request) {
 				Log.error("Could not load data ... ", request);
 			})
+			.finally(() => this.updateAvailable())
 	},
 
 	/** OpenWeatherMap Specific Methods - These are not part of the default provider methods */
@@ -68,7 +70,7 @@ WeatherProvider.register("openweathermap", {
 	 * Generate a WeatherObject based on currentWeatherInformation
 	 */
 	generateWeatherObjectFromCurrentWeather(currentWeatherData) {
-		const currentWeather = new WeatherObject(this.config.units);
+		const currentWeather = new WeatherObject(this.config.units, this.config.tempUnits, this.config.windUnits);
 
 		currentWeather.humidity = currentWeatherData.main.humidity;
 		currentWeather.temperature = currentWeatherData.main.temp;
@@ -86,13 +88,13 @@ WeatherProvider.register("openweathermap", {
 	 */
 	generateWeatherObjectsFromForecast(forecasts) {
 
-		if (this.config.weatherEndpoint == "/forecast") {
+		if (this.config.weatherEndpoint === "/forecast") {
 			return this.fetchForecastHourly(forecasts);
-		} else if (this.config.weatherEndpoint == "/forecast/daily") {
+		} else if (this.config.weatherEndpoint === "/forecast/daily") {
 			return this.fetchForecastDaily(forecasts);
 		}
 		// if weatherEndpoint does not match forecast or forecast/daily, what should be returned?
-		const days = [new WeatherObject(this.config.units)];
+		const days = [new WeatherObject(this.config.units, this.config.tempUnits, this.config.windUnits)];
 		return days;
 	},
 
@@ -109,7 +111,7 @@ WeatherProvider.register("openweathermap", {
 		let snow = 0;
 		// variable for date
 		let date = "";
-		let weather = new WeatherObject(this.config.units);
+		let weather = new WeatherObject(this.config.units, this.config.tempUnits, this.config.windUnits);
 
 		for (const forecast of forecasts) {
 
@@ -123,7 +125,7 @@ WeatherProvider.register("openweathermap", {
 				// push weather information to days array
 				days.push(weather);
 				// create new weather-object
-				weather = new WeatherObject(this.config.units);
+				weather = new WeatherObject(this.config.units, this.config.tempUnits, this.config.windUnits);
 
 				minTemp = [];
 				maxTemp = [];
@@ -140,7 +142,7 @@ WeatherProvider.register("openweathermap", {
 				weather.weatherType = this.convertWeatherType(forecast.weather[0].icon);
 
 			}
-				
+
 			if (moment(forecast.dt, "X").format("H") >= 8 && moment(forecast.dt, "X").format("H") <= 17) {
 				weather.weatherType = this.convertWeatherType(forecast.weather[0].icon);
 			}
@@ -187,7 +189,7 @@ WeatherProvider.register("openweathermap", {
 		const days = [];
 
 		for (const forecast of forecasts) {
-			const weather = new WeatherObject(this.config.units);
+			const weather = new WeatherObject(this.config.units, this.config.tempUnits, this.config.windUnits);
 
 			weather.date = moment(forecast.dt, "X");
 			weather.minTemperature = forecast.temp.min;

modules/default/weather/providers/ukmetoffice.js

@@ -0,0 +1,264 @@
+/* global WeatherProvider, WeatherObject */
+
+/* Magic Mirror
+ * Module: Weather
+ *
+ * By Malcolm Oakes https://github.com/maloakes
+ * MIT Licensed.
+ *
+ * This class is a provider for UK Met Office Datapoint.
+ */
+
+
+WeatherProvider.register("ukmetoffice", {
+
+	// Set the name of the provider.
+	// This isn't strictly necessary, since it will fallback to the provider identifier
+	// But for debugging (and future alerts) it would be nice to have the real name.
+	providerName: "UK Met Office",
+
+	units: {
+		imperial: "us",
+		metric: "si"
+	},
+
+	// Overwrite the fetchCurrentWeather method.
+	fetchCurrentWeather() {
+		this.fetchData(this.getUrl("3hourly"))
+			.then(data => {
+				if (!data || !data.SiteRep || !data.SiteRep.DV || !data.SiteRep.DV.Location ||
+					  !data.SiteRep.DV.Location.Period || data.SiteRep.DV.Location.Period.length == 0) {
+					// Did not receive usable new data.
+					// Maybe this needs a better check?
+					return;
+				}
+
+				this.setFetchedLocation(`${data.SiteRep.DV.Location.name}, ${data.SiteRep.DV.Location.country}`);
+
+				const currentWeather = this.generateWeatherObjectFromCurrentWeather(data);
+				this.setCurrentWeather(currentWeather);
+			})
+			.catch(function(request) {
+				Log.error("Could not load data ... ", request);
+			})
+			.finally(() => this.updateAvailable())
+	},
+
+	// Overwrite the fetchCurrentWeather method.
+	fetchWeatherForecast() {
+		this.fetchData(this.getUrl("daily"))
+			.then(data => {
+				if (!data || !data.SiteRep || !data.SiteRep.DV || !data.SiteRep.DV.Location ||
+					  !data.SiteRep.DV.Location.Period || data.SiteRep.DV.Location.Period.length == 0) {
+					// Did not receive usable new data.
+					// Maybe this needs a better check?
+					return;
+				}
+
+				this.setFetchedLocation(`${data.SiteRep.DV.Location.name}, ${data.SiteRep.DV.Location.country}`);
+
+				const forecast = this.generateWeatherObjectsFromForecast(data);
+				this.setWeatherForecast(forecast);
+			})
+			.catch(function(request) {
+				Log.error("Could not load data ... ", request);
+			})
+			.finally(() => this.updateAvailable())
+	},
+
+
+
+	/** UK Met Office Specific Methods - These are not part of the default provider methods */
+	/*
+	 * Gets the complete url for the request
+	 */
+	getUrl(forecastType) {
+		return this.config.apiBase + this.config.locationID + this.getParams(forecastType);
+	},
+
+	/*
+	 * Generate a WeatherObject based on currentWeatherInformation
+	 */
+	generateWeatherObjectFromCurrentWeather(currentWeatherData) {
+		const currentWeather = new WeatherObject(this.config.units, this.config.tempUnits, this.config.windUnits);
+
+		// data times are always UTC
+		let nowUtc = moment.utc()
+		let midnightUtc = nowUtc.clone().startOf("day")
+		let timeInMins = nowUtc.diff(midnightUtc, "minutes");
+
+		// loop round each of the (5) periods, look for today (the first period may be yesterday)
+		for (i in currentWeatherData.SiteRep.DV.Location.Period) {
+			let periodDate = moment.utc(currentWeatherData.SiteRep.DV.Location.Period[i].value.substr(0,10), "YYYY-MM-DD")
+
+			// ignore if period is before today
+			if (periodDate.isSameOrAfter(moment.utc().startOf("day"))) {
+
+				// check this is the period we want, after today the diff will be -ve
+				if (moment().diff(periodDate, "minutes") > 0) {
+					// loop round the reports looking for the one we are in
+					// $ value specifies the time in minutes-of-the-day: 0, 180, 360,...1260
+					for (j in currentWeatherData.SiteRep.DV.Location.Period[i].Rep){
+						let p = currentWeatherData.SiteRep.DV.Location.Period[i].Rep[j].$;
+						if (timeInMins >= p && timeInMins-180 < p) {
+							// finally got the one we want, so populate weather object
+							currentWeather.humidity = currentWeatherData.SiteRep.DV.Location.Period[i].Rep[j].H;
+							currentWeather.temperature = this.convertTemp(currentWeatherData.SiteRep.DV.Location.Period[i].Rep[j].T);
+							currentWeather.feelsLikeTemp = this.convertTemp(currentWeatherData.SiteRep.DV.Location.Period[i].Rep[j].F);
+							currentWeather.precipitation = parseInt(currentWeatherData.SiteRep.DV.Location.Period[i].Rep[j].Pp);
+							currentWeather.windSpeed = this.convertWindSpeed(currentWeatherData.SiteRep.DV.Location.Period[i].Rep[j].S);
+							currentWeather.windDirection = this.convertWindDirection(currentWeatherData.SiteRep.DV.Location.Period[i].Rep[j].D);
+							currentWeather.weatherType = this.convertWeatherType(currentWeatherData.SiteRep.DV.Location.Period[i].Rep[j].W);
+						}
+					}
+				}
+			}
+		}
+
+		// determine the sunrise/sunset times - not supplied in UK Met Office data
+		let times = this.calcAstroData(currentWeatherData.SiteRep.DV.Location)
+		currentWeather.sunrise = times[0];
+		currentWeather.sunset = times[1];
+
+		return currentWeather;
+	},
+
+	/*
+	 * Generate WeatherObjects based on forecast information
+	 */
+	generateWeatherObjectsFromForecast(forecasts) {
+
+		const days = [];
+
+		// loop round the (5) periods getting the data
+		// for each period array, Day is [0], Night is [1]
+		for (j in forecasts.SiteRep.DV.Location.Period) {
+			const weather = new WeatherObject(this.config.units, this.config.tempUnits, this.config.windUnits);
+
+			// data times are always UTC
+			dateStr = forecasts.SiteRep.DV.Location.Period[j].value
+			let periodDate = moment.utc(dateStr.substr(0,10), "YYYY-MM-DD")
+
+			// ignore if period is before today
+			if (periodDate.isSameOrAfter(moment.utc().startOf("day"))) {
+				// populate the weather object
+				weather.date = moment.utc(dateStr.substr(0,10), "YYYY-MM-DD");
+				weather.minTemperature = this.convertTemp(forecasts.SiteRep.DV.Location.Period[j].Rep[1].Nm);
+				weather.maxTemperature = this.convertTemp(forecasts.SiteRep.DV.Location.Period[j].Rep[0].Dm);
+				weather.weatherType = this.convertWeatherType(forecasts.SiteRep.DV.Location.Period[j].Rep[0].W);
+				weather.precipitation = parseInt(forecasts.SiteRep.DV.Location.Period[j].Rep[0].PPd);
+
+				days.push(weather);
+			}
+		}
+
+		return days;
+	},
+
+	/*
+	 * calculate the astronomical data
+	 */
+	calcAstroData(location) {
+		const sunTimes = [];
+
+		// determine the sunrise/sunset times
+		let times = SunCalc.getTimes(new Date(), location.lat, location.lon);
+		sunTimes.push(moment(times.sunrise, "X"));
+		sunTimes.push(moment(times.sunset, "X"));
+
+		return sunTimes;
+	},
+
+	/*
+	 * Convert the Met Office icons to a more usable name.
+	 */
+	convertWeatherType(weatherType) {
+		const weatherTypes = {
+			0: "night-clear",
+			1: "day-sunny",
+			2: "night-alt-cloudy",
+			3: "day-cloudy",
+			5: "fog",
+			6: "fog",
+			7: "cloudy",
+			8: "cloud",
+			9: "night-sprinkle",
+			10: "day-sprinkle",
+			11: "raindrops",
+			12: "sprinkle",
+			13: "night-alt-showers",
+			14: "day-showers",
+			15: "rain",
+			16: "night-alt-sleet",
+			17: "day-sleet",
+			18: "sleet",
+			19: "night-alt-hail",
+			20: "day-hail",
+			21: "hail",
+			22: "night-alt-snow",
+			23: "day-snow",
+			24: "snow",
+			25: "night-alt-snow",
+			26: "day-snow",
+			27: "snow",
+			28: "night-alt-thunderstorm",
+			29: "day-thunderstorm",
+			30: "thunderstorm"
+		};
+
+		return weatherTypes.hasOwnProperty(weatherType) ? weatherTypes[weatherType] : null;
+	},
+
+	/*
+	 * Convert temp (from degrees C) if required
+	 */
+	convertTemp(tempInC) {
+		return this.tempUnits === "imperial" ? tempInC * 9 / 5 + 32 : tempInC;
+	},
+
+	/*
+	 * Convert wind speed (from mph) if required
+	 */
+	convertWindSpeed(windInMph) {
+		return this.windUnits === "metric" ? windInMph * 2.23694 : windInMph;
+	},
+
+	/*
+	 * Convert the wind direction cardinal to value
+	 */
+	convertWindDirection(windDirection) {
+		const windCardinals = {
+			"N": 0,
+			"NNE": 22,
+			"NE": 45,
+			"ENE": 67,
+			"E": 90,
+			"ESE": 112,
+			"SE": 135,
+			"SSE": 157,
+			"S": 180,
+			"SSW": 202,
+			"SW": 225,
+			"WSW": 247,
+			"W": 270,
+			"WNW": 292,
+			"NW": 315,
+			"NNW": 337
+		};
+
+		return windCardinals.hasOwnProperty(windDirection) ? windCardinals[windDirection] : null;
+	},
+
+	/*
+	 * Generates an url with api parameters based on the config.
+	 *
+	 * return String - URL params.
+	 */
+	getParams(forecastType) {
+		let params = "?";
+		params += "res=" + forecastType;
+		params += "&key=" + this.config.apiKey;
+
+		return params;
+	}
+});

modules/default/weather/providers/weathergov.js

@@ -35,6 +35,7 @@ WeatherProvider.register("weathergov", {
 			.catch(function(request) {
 				Log.error("Could not load data ... ", request);
 			})
+			.finally(() => this.updateAvailable())
 	},
 
 	// Overwrite the fetchCurrentWeather method.
@@ -53,6 +54,7 @@ WeatherProvider.register("weathergov", {
 			.catch(function(request) {
 				Log.error("Could not load data ... ", request);
 			})
+			.finally(() => this.updateAvailable())
 	},
 
 	/** Weather.gov Specific Methods - These are not part of the default provider methods */
@@ -67,13 +69,18 @@ WeatherProvider.register("weathergov", {
 	 * Generate a WeatherObject based on currentWeatherInformation
 	 */
 	generateWeatherObjectFromCurrentWeather(currentWeatherData) {
-		const currentWeather = new WeatherObject(this.config.units);
+		const currentWeather = new WeatherObject(this.config.units, this.config.tempUnits, this.config.windUnits);
 
 		currentWeather.temperature = currentWeatherData.temperature;
 		currentWeather.windSpeed = currentWeatherData.windSpeed.split(" ", 1);
-		currentWeather.windDirection = this.convertDirectiontoDegrees(currentWeatherData.windDirection);
+		currentWeather.windDirection = this.convertWindDirection(currentWeatherData.windDirection);
 		currentWeather.weatherType = this.convertWeatherType(currentWeatherData.shortForecast, currentWeatherData.isDaytime);
 
+		// determine the sunrise/sunset times - not supplied in weather.gov data
+		let times = this.calcAstroData(this.config.lat, this.config.lon)
+		currentWeather.sunrise = times[0];
+		currentWeather.sunset = times[1];
+
 		return currentWeather;
 	},
 
@@ -95,7 +102,7 @@ WeatherProvider.register("weathergov", {
 		let maxTemp = [];
 		// variable for date
 		let date = "";
-		let weather = new WeatherObject(this.config.units);
+		let weather = new WeatherObject(this.config.units, this.config.tempUnits, this.config.windUnits);
 		weather.precipitation = 0;
 
 		for (const forecast of forecasts) {
@@ -109,7 +116,7 @@ WeatherProvider.register("weathergov", {
 				// push weather information to days array
 				days.push(weather);
 				// create new weather-object
-				weather = new WeatherObject(this.config.units);
+				weather = new WeatherObject(this.config.units, this.config.tempUnits, this.config.windUnits);
 
 				minTemp = [];
 				maxTemp = [];
@@ -134,9 +141,9 @@ WeatherProvider.register("weathergov", {
 			minTemp.push(forecast.temperature);
 			maxTemp.push(forecast.temperature);
 		}
-		
+
 		// last day
-		// calculate minimum/maximum temperature, specify rain amount
+		// calculate minimum/maximum temperature
 		weather.minTemperature = Math.min.apply(null, minTemp);
 		weather.maxTemperature = Math.max.apply(null, maxTemp);
 
@@ -145,6 +152,20 @@ WeatherProvider.register("weathergov", {
 		return days.slice(1);
 	},
 
+	/*
+	 * Calculate the astronomical data
+	 */
+	calcAstroData(lat, lon) {
+		const sunTimes = [];
+
+		// determine the sunrise/sunset times
+		let times = SunCalc.getTimes(new Date(), lat, lon);
+		sunTimes.push(moment(times.sunrise, "X"));
+		sunTimes.push(moment(times.sunset, "X"));
+
+		return sunTimes;
+	},
+
 	/*
 	 * Convert the icons to a more usable name.
 	 */
@@ -202,7 +223,7 @@ WeatherProvider.register("weathergov", {
 			}
 
 			return "night-clear";
-		} else if (weatherType.includes("Dust") || weatherType.includes("Sand")) {	
+		} else if (weatherType.includes("Dust") || weatherType.includes("Sand")) {
 			return "dust";
 		} else if (weatherType.includes("Fog")) {
 			return "fog";
@@ -218,39 +239,26 @@ WeatherProvider.register("weathergov", {
 	/*
 	Convert the direction into Degrees
 	*/
-	convertDirectiontoDegrees(direction) {
-		if (direction === "NNE"){
-			return 33.75;
-		} else if (direction === "NE") {
-			return 56.25;
-		} else if (direction === "ENE") {
-			return 78.75;
-		} else if (direction === "E") {
-			return 101.25;
-		} else if (direction === "ESE") {
-			return 123.75;
-		} else if (direction === "SE") {
-			return 146.25;
-		} else if (direction === "SSE") {
-			return 168.75;
-		} else if (direction === "S") {
-			return 191.25;
-		} else if (direction === "SSW") {
-			return 213.75;
-		} else if (direction === "SW") {
-			return 236.25;
-		} else if (direction === "WSW") {
-			return 258.75;
-		} else if (direction === "W") {
-			return 281.25;
-		} else if (direction === "WNW") {
-			return 303.75;
-		} else if (direction === "NW") {
-			return 326.25;
-		} else if (direction === "NNW") {
-			return 348.75;
-		} else {
-			return 0;
-		}
+	convertWindDirection(windDirection) {
+		const windCardinals = {
+			"N": 0,
+			"NNE": 22,
+			"NE": 45,
+			"ENE": 67,
+			"E": 90,
+			"ESE": 112,
+			"SE": 135,
+			"SSE": 157,
+			"S": 180,
+			"SSW": 202,
+			"SW": 225,
+			"WSW": 247,
+			"W": 270,
+			"WNW": 292,
+			"NW": 315,
+			"NNW": 337
+		};
+
+		return windCardinals.hasOwnProperty(windDirection) ? windCardinals[windDirection] : null;
 	}
 });

modules/default/weather/weather.js

@@ -19,6 +19,10 @@ Module.register("weather",{
 		locationID: false,
 		appid: "",
 		units: config.units,
+
+		tempUnits: config.units,
+		windUnits: config.units,
+
 		updateInterval: 10 * 60 * 1000, // every 10 minutes
 		animationSpeed: 1000,
 		timeFormat: config.timeFormat,
@@ -68,13 +72,14 @@ Module.register("weather",{
 			"moment.js",
 			"weatherprovider.js",
 			"weatherobject.js",
+			"suncalc.js",
 			this.file("providers/" + this.config.weatherProvider.toLowerCase() + ".js")
 		];
 	},
 
 	// Override getHeader method.
 	getHeader: function() {
-		if (this.config.appendLocationNameToHeader && this.weatherProvider) {
+		if (this.config.appendLocationNameToHeader && this.data.header !== undefined && this.weatherProvider) {
 			return this.data.header + " " + this.weatherProvider.fetchedLocation();
 		}
 
@@ -84,6 +89,7 @@ Module.register("weather",{
 	// Start the weather module.
 	start: function () {
 		moment.locale(this.config.lang);
+
 		// Initialize the weather provider.
 		this.weatherProvider = WeatherProvider.initialize(this.config.weatherProvider, this);
 
@@ -137,7 +143,7 @@ Module.register("weather",{
 				humidity: this.indoorHumidity,
 				temperature: this.indoorTemperature
 			}
-		}
+		};
 	},
 
 	// What to do when the weather provider has new information available?
@@ -188,13 +194,13 @@ Module.register("weather",{
 
 		this.nunjucksEnvironment().addFilter("unit", function (value, type) {
 			if (type === "temperature") {
-				if (this.config.units === "metric" || this.config.units === "imperial") {
+				if (this.config.tempUnits === "metric" || this.config.tempUnits === "imperial") {
 					value += "°";
 				}
 				if (this.config.degreeLabel) {
-					if (this.config.units === "metric") {
+					if (this.config.tempUnits === "metric") {
 						value += "C";
-					} else if (this.config.units === "imperial") {
+					} else if (this.config.tempUnits === "imperial") {
 						value += "F";
 					} else {
 						value += "K";
@@ -204,10 +210,14 @@ Module.register("weather",{
 				if (isNaN(value) || value === 0 || value.toFixed(2) === "0.00") {
 					value = "";
 				} else {
-					value = `${value.toFixed(2)} ${this.config.units === "imperial" ? "in" : "mm"}`;
+				    if (this.config.weatherProvider === "ukmetoffice") {
+						value += "%";
+				    } else {
+						value = `${value.toFixed(2)} ${this.config.units === "imperial" ? "in" : "mm"}`;
+				    }
 				}
 			} else if (type === "humidity") {
-				value += "%"
+				value += "%";
 			}
 
 			return value;

modules/default/weather/weatherobject.js

@@ -13,8 +13,11 @@
 // As soon as we start implementing the forecast, mode properties will be added.
 
 class WeatherObject {
-	constructor(units) {
+	constructor(units, tempUnits, windUnits) {
+
 		this.units = units;
+		this.tempUnits = tempUnits;
+		this.windUnits = windUnits;
 		this.date = null;
 		this.windSpeed = null;
 		this.windDirection = null;
@@ -28,6 +31,8 @@ class WeatherObject {
 		this.rain = null;
 		this.snow = null;
 		this.precipitation = null;
+		this.feelsLikeTemp = null;
+
 	}
 
 	cardinalWindDirection() {
@@ -67,7 +72,7 @@ class WeatherObject {
 	}
 
 	beaufortWindSpeed() {
-		const windInKmh = this.units === "imperial" ? this.windSpeed * 1.609344 : this.windSpeed * 60 * 60 / 1000;
+		const windInKmh = (this.windUnits === "imperial") ? this.windSpeed * 1.609344 : this.windSpeed * 60 * 60 / 1000;
 		const speeds = [1, 5, 11, 19, 28, 38, 49, 61, 74, 88, 102, 117, 1000];
 		for (const [index, speed] of speeds.entries()) {
 			if (speed > windInKmh) {
@@ -82,8 +87,11 @@ class WeatherObject {
 	}
 
 	feelsLike() {
-		const windInMph = this.units === "imperial" ? this.windSpeed : this.windSpeed * 2.23694;
-		const tempInF = this.units === "imperial" ? this.temperature : this.temperature * 9 / 5 + 32;
+	  if (this.feelsLikeTemp) {
+		  return this.feelsLikeTemp;
+		}
+		const windInMph = (this.windUnits === "imperial") ? this.windSpeed : this.windSpeed * 2.23694;
+		const tempInF = this.tempUnits === "imperial" ? this.temperature : this.temperature * 9 / 5 + 32;
 		let feelsLike = tempInF;
 
 		if (windInMph > 3 && tempInF < 50) {
@@ -97,6 +105,6 @@ class WeatherObject {
 				- 1.99 * Math.pow(10, -6) * tempInF * tempInF * this.humidity * this.humidity;
 		}
 
-		return this.units === "imperial" ? feelsLike : (feelsLike - 32) * 5 / 9;
+		return this.tempUnits === "imperial" ? feelsLike : (feelsLike - 32) * 5 / 9;
 	}
 }

modules/default/weather/weatherprovider.js

@@ -9,7 +9,6 @@
  * This class is the blueprint for a weather provider.
  */
 
-
 /**
  * Base BluePrint for the WeatherProvider
  */
@@ -23,15 +22,14 @@ var WeatherProvider = Class.extend({
 	weatherForecastArray: null,
 	fetchedLocationName: null,
 
-	// The following properties will be set automaticly.
+	// The following properties will be set automatically.
 	// You do not need to overwrite these properties.
 	config: null,
 	delegate: null,
 	providerIdentifier: null,
 
-
 	// Weather Provider Methods
-	// All the following methods can be overwrited, although most are good as they are.
+	// All the following methods can be overwritten, although most are good as they are.
 
 	// Called when a weather provider is initialized.
 	init: function(config) {
@@ -51,13 +49,13 @@ var WeatherProvider = Class.extend({
 	},
 
 	// This method should start the API request to fetch the current weather.
-	// This method should definetly be overwritten in the provider.
+	// This method should definitely be overwritten in the provider.
 	fetchCurrentWeather: function() {
 		Log.warn(`Weather provider: ${this.providerName} does not subclass the fetchCurrentWeather method.`);
 	},
 
 	// This method should start the API request to fetch the weather forecast.
-	// This method should definetly be overwritten in the provider.
+	// This method should definitely be overwritten in the provider.
 	fetchWeatherForecast: function() {
 		Log.warn(`Weather provider: ${this.providerName} does not subclass the fetchWeatherForecast method.`);
 	},
@@ -81,16 +79,12 @@ var WeatherProvider = Class.extend({
 	setCurrentWeather: function(currentWeatherObject) {
 		// We should check here if we are passing a WeatherDay
 		this.currentWeatherObject = currentWeatherObject;
-
-		this.updateAvailable();
 	},
 
 	// Set the weatherForecastArray and notify the delegate that new information is available.
 	setWeatherForecast: function(weatherForecastArray) {
 		// We should check here if we are passing a WeatherDay
 		this.weatherForecastArray = weatherForecastArray;
-
-		this.updateAvailable();
 	},
 
 	// Set the fetched location name.
@@ -103,7 +97,7 @@ var WeatherProvider = Class.extend({
 		this.delegate.updateAvailable(this);
 	},
 
-	// A convinience function to make requests. It returns a promise.
+	// A convenience function to make requests. It returns a promise.
 	fetchData: function(url, method = "GET", data = null) {
 		return new Promise(function(resolve, reject) {
 			var request = new XMLHttpRequest();
@@ -113,12 +107,12 @@ var WeatherProvider = Class.extend({
 					if (this.status === 200) {
 						resolve(JSON.parse(this.response));
 					} else {
-						reject(request)
+						reject(request);
 					}
 				}
 			};
 			request.send();
-		})
+		});
 	}
 });
 

modules/default/weatherforecast/README.md

@@ -2,81 +2,4 @@
 The `weatherforecast` module is one of the default modules of the MagicMirror.
 This module displays the weather forecast for the coming week, including an an icon to display the current conditions, the minimum temperature and the maximum temperature.
 
-## Screenshots
-
-- 5 day forecast
-![Screenshot of 5 day forecast](forecast_screenshot.png)
-
-## Using the module
-
-To use this module, add it to the modules array in the `config/config.js` file:
-````javascript
-modules: [
-	{
-		module: "weatherforecast",
-		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. <br><br> **Example:** `'Amsterdam,Netherlands'` <br> **Default value:** `false` <br><br> **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](https://openweathermap.org/find) **This will override anything you put in location.** <br> Leave blank if you want to use location. <br> **Example:** `1234567` <br> **Default value:** `false` <br><br> **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](https://home.openweathermap.org) API key, which can be obtained by creating an OpenWeatherMap account. <br><br> This value is **REQUIRED**
-| `units`                      | What units to use. Specified by config.js <br><br> **Possible values:** `config.units` = Specified by config.js, `default` = Kelvin, `metric` = Celsius, `imperial` =Fahrenheit <br> **Default value:** `config.units`
-| `roundTemp`                  | Round temperature values to nearest integer. <br><br> **Possible values:** `true` (round to integer) or `false` (display exact value with decimal point) <br> **Default value:** `false`
-| `maxNumberOfDays`            | How many days of forecast to return. Specified by config.js <br><br> **Possible values:** `1` - `16` <br> **Default value:** `7` (7 days) <br> This value is optional. By default the weatherforecast module will return 7 days.
-| `showRainAmount`             | Should the predicted rain amount be displayed? <br><br> **Possible values:** `true` or `false` <br> **Default value:** `false` <br> This value is optional. By default the weatherforecast module will not display the predicted amount of rain.
-| `updateInterval`             | How often does the content needs to be fetched? (Milliseconds) <br><br> **Possible values:** `1000` - `86400000` <br> **Default value:** `600000` (10 minutes)
-| `animationSpeed`             | Speed of the update animation. (Milliseconds) <br><br> **Possible values:** `0` - `5000` <br> **Default value:** `1000` (1 second)
-| `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:** `.`
-| `fade`                       | Fade the future events to black. (Gradient) <br><br> **Possible values:** `true` or `false` <br> **Default value:** `true`
-| `fadePoint`                  | Where to start fade? <br><br> **Possible values:** `0` (top of the list) - `1` (bottom of list) <br> **Default value:** `0.25`
-| `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) <br><br> **Possible values:** `1000` - `5000` <br> **Default value:**  `2500` (2.5 seconds delay. This delay is used to keep the OpenWeather API happy.)
-| `retryDelay`                 | The delay before retrying after a request failure. (Milliseconds) <br><br> **Possible values:** `1000` - `60000` <br> **Default value:**  `2500`
-| `apiVersion`                 | The OpenWeatherMap API version to use. <br><br> **Default value:**  `2.5`
-| `apiBase`                    | The OpenWeatherMap base URL. <br><br> **Default value:**  `'http://api.openweathermap.org/data/'`
-| `forecastEndpoint`           | The OpenWeatherMap API endPoint. <br><br> **Default value:**  `'forecast/daily'`
-| `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. <br><br> **Default value:**  `true`
-| `calendarClass`              | The class for the calendar module to base the event based weather information on. <br><br> **Default value:** `'calendar'`
-| `tableClass`                  | Name of the classes issued from `main.css`. <br><br> **Possible values:** xsmall, small, medium, large, xlarge. <br> **Default value:** _small._
-| `iconTable`                  | The conversion table to convert the weather conditions to weather-icons. <br><br> **Default value:** view table below
-| `colored`                    | If set `colored` to `true` the min-temp gets a blue tone and the max-temp gets a red tone. <br><br> **Default value:** `'false'`
-| `scale  `                    | If set to `true` the module will display `C` for Celsius degrees and `F` for Fahrenheit degrees after the number, based on the value of the `units` option, otherwise only the &deg; character is displayed. <br><br> **Default value:** `false`
-
-#### Default Icon Table
-````javascript
-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'
-}
-````
+For configuration options, please check the [MagicMirror² documentation](https://docs.magicmirror.builders/modules/weatherforecast.html).

modules/default/weatherforecast/weatherforecast.css

@@ -19,9 +19,9 @@
 }
 
 .weatherforecast tr.colored .min-temp {
-    color: #BCDDFF;
+  color: #BCDDFF;
 }
 
 .weatherforecast tr.colored .max-temp {
-    color: #FF8E99;
+  color: #FF8E99;
 }

modules/default/weatherforecast/weatherforecast.js

@@ -82,7 +82,7 @@ Module.register("weatherforecast",{
 	getTranslations: function() {
 		// The translations for the default modules are defined in the core translation files.
 		// Therefor we can just return false. Otherwise we should have returned a dictionary.
-		// If you're trying to build yiur own module including translations, check out the documentation.
+		// If you're trying to build your own module including translations, check out the documentation.
 		return false;
 	},
 
@@ -180,9 +180,9 @@ Module.register("weatherforecast",{
 					rainCell.innerHTML = "";
 				} else {
 					if(config.units !== "imperial") {
-						rainCell.innerHTML = parseFloat(forecast.rain).toFixed(1) + " mm";
+						rainCell.innerHTML = parseFloat(forecast.rain).toFixed(1).replace(".", this.config.decimalSymbol) + " mm";
 					} else {
-						rainCell.innerHTML = (parseFloat(forecast.rain) / 25.4).toFixed(2) + " in";
+						rainCell.innerHTML = (parseFloat(forecast.rain) / 25.4).toFixed(2).replace(".", this.config.decimalSymbol) + " in";
 					}
 				}
 				rainCell.className = "align-right bright rain";
@@ -240,7 +240,7 @@ Module.register("weatherforecast",{
 
 	/* updateWeather(compliments)
 	 * Requests new data from openweather.org.
-	 * Calls processWeather on succesfull response.
+	 * Calls processWeather on successful response.
 	 */
 	updateWeather: function() {
 		if (this.config.appid === "") {
@@ -261,7 +261,7 @@ Module.register("weatherforecast",{
 				} else if (this.status === 401) {
 					self.updateDom(self.config.animationSpeed);
 
-					if (self.config.forecastEndpoint == "forecast/daily") {
+					if (self.config.forecastEndpoint === "forecast/daily") {
 						self.config.forecastEndpoint = "forecast";
 						Log.warn(self.name + ": Your AppID does not support long term forecasts. Switching to fallback endpoint.");
 					}
@@ -291,7 +291,7 @@ Module.register("weatherforecast",{
 		} 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
+			params += "lat=" + this.firstEvent.geo.lat + "&lon=" + this.firstEvent.geo.lon;
 		} else if (this.firstEvent && this.firstEvent.location) {
 			params += "q=" + this.firstEvent.location;
 		} else {
@@ -315,7 +315,7 @@ Module.register("weatherforecast",{
 	 */
 	parserDataWeather: function(data) {
 		if (data.hasOwnProperty("main")) {
-			data["temp"] = {"min": data.main.temp_min, "max": data.main.temp_max}
+			data["temp"] = {"min": data.main.temp_min, "max": data.main.temp_max};
 		}
 		return data;
 	},
@@ -330,7 +330,7 @@ Module.register("weatherforecast",{
 
 		this.forecast = [];
 		var lastDay = null;
-		var forecastData = {}
+		var forecastData = {};
 
 		for (var i = 0, count = data.list.length; i < count; i++) {
 
@@ -353,7 +353,7 @@ Module.register("weatherforecast",{
 					icon: this.config.iconTable[forecast.weather[0].icon],
 					maxTemp: this.roundValue(forecast.temp.max),
 					minTemp: this.roundValue(forecast.temp.min),
-					rain: forecast.rain
+					rain: this.processRain(forecast, data.list)
 				};
 
 				this.forecast.push(forecastData);
@@ -434,5 +434,38 @@ Module.register("weatherforecast",{
 	roundValue: function(temperature) {
 		var decimals = this.config.roundTemp ? 0 : 1;
 		return parseFloat(temperature).toFixed(decimals);
+	},
+
+	/* processRain(forecast, allForecasts)
+	 * Calculates the amount of rain for a whole day even if long term forecasts isn't available for the appid.
+	 *
+	 * When using the the fallback endpoint forecasts are provided in 3h intervals and the rain-property is an object instead of number.
+	 * That object has a property "3h" which contains the amount of rain since the previous forecast in the list.
+	 * This code finds all forecasts that is for the same day and sums the amount of rain and returns that.
+	 */
+	processRain: function(forecast, allForecasts) {
+		//If the amount of rain actually is a number, return it
+		if (!isNaN(forecast.rain)) {
+			return forecast.rain;
+		}
+
+		//Find all forecasts that is for the same day
+		var checkDateTime = (!!forecast.dt_txt) ? moment(forecast.dt_txt, "YYYY-MM-DD hh:mm:ss") : moment(forecast.dt, "X");
+		var daysForecasts = allForecasts.filter(function(item) {
+			var itemDateTime = (!!item.dt_txt) ? moment(item.dt_txt, "YYYY-MM-DD hh:mm:ss") : moment(item.dt, "X");
+			return itemDateTime.isSame(checkDateTime, "day") && item.rain instanceof Object;
+		});
+
+		//If no rain this day return undefined so it wont be displayed for this day
+		if (daysForecasts.length == 0) {
+			return undefined;
+		}
+
+		//Summarize all the rain from the matching days
+		return daysForecasts.map(function(item) {
+			return Object.values(item.rain)[0];
+		}).reduce(function(a, b) {
+			return a + b;
+		}, 0);
 	}
 });

package.json

@@ -1,18 +1,20 @@
 {
   "name": "magicmirror",
-  "version": "2.7.1",
+  "version": "2.11.0",
   "description": "The open source modular smart mirror platform.",
   "main": "js/electron.js",
   "scripts": {
-    "start": "sh run-start.sh",
-    "install": "cd vendor && npm install",
-    "install-fonts": "cd fonts && npm install",
-    "postinstall": "sh installers/postinstall/postinstall.sh && npm run install-fonts",
+    "start": "DISPLAY=\"${DISPLAY:=:0}\" ./node_modules/.bin/electron js/electron.js",
+    "server": "node ./serveronly",
+    "install": "echo \"Installing vendor files ...\n\" && cd vendor && npm install --loglevel=error",
+    "install-fonts": "echo \"Installing fonts ...\n\" && cd fonts && npm install --loglevel=error",
+    "postinstall": "npm run install-fonts && echo \"MagicMirror installation finished successfully! \n\"",
     "test": "NODE_ENV=test ./node_modules/mocha/bin/mocha tests --recursive",
     "test:unit": "NODE_ENV=test ./node_modules/mocha/bin/mocha tests/unit --recursive",
     "test:e2e": "NODE_ENV=test ./node_modules/mocha/bin/mocha tests/e2e --recursive",
+    "test:lint": "grunt --env=test",
     "config:check": "node tests/configs/check_config.js",
-    "lint": "grunt"
+    "lint": "grunt --env=lint"
   },
   "repository": {
     "type": "git",
@@ -41,37 +43,41 @@
     "grunt": "latest",
     "grunt-eslint": "latest",
     "grunt-jsonlint": "latest",
-    "grunt-markdownlint": "^1.0.43",
+    "grunt-markdownlint": "latest",
     "grunt-stylelint": "latest",
     "grunt-yamllint": "latest",
     "http-auth": "^3.2.3",
     "jsdom": "^11.6.2",
-    "jshint": "^2.9.5",
-    "mocha": "^4.1.0",
+    "mocha": "^7.0.0",
     "mocha-each": "^1.1.0",
-    "spectron": "^3.8.0",
-    "stylelint": "^8.4.0",
+    "mocha-logger": "^1.0.6",
+    "spectron": "^8.0.0",
+    "stylelint": "latest",
     "stylelint-config-standard": "latest",
     "time-grunt": "latest"
   },
+  "optionalDependencies": {
+    "electron": "^6.1.7"
+  },
   "dependencies": {
-    "ajv": "6.5.5",
-    "body-parser": "^1.18.2",
     "colors": "^1.1.2",
-    "electron": "^3.0.13",
+    "console-stamp": "^0.2.9",
     "express": "^4.16.2",
-    "express-ipfilter": "0.3.1",
+    "express-ipfilter": "^1.0.1",
     "feedme": "latest",
-    "helmet": "^3.9.0",
-    "home-path": "^1.0.6",
+    "helmet": "^3.21.2",
     "iconv-lite": "latest",
-    "mocha-logger": "^1.0.6",
+    "lodash": "^4.17.15",
+    "module-alias": "^2.2.2",
     "moment": "latest",
-    "request": "^2.87.0",
+    "request": "^2.88.0",
+    "rrule": "^2.6.2",
     "rrule-alt": "^2.2.8",
     "simple-git": "^1.85.0",
     "socket.io": "^2.1.1",
-    "valid-url": "latest",
-    "walk": "latest"
+    "valid-url": "latest"
+  },
+  "_moduleAliases": {
+    "node_helper": "js/node_helper.js"
   }
 }

run-start.sh

@@ -1,4 +0,0 @@
-if [ -z "$DISPLAY" ]; then #If not set DISPLAY is SSH remote or tty
-	export DISPLAY=:0 # Set by default display
-fi
-electron js/electron.js $1

serveronly/index.js

@@ -1,5 +1,6 @@
 var app = require("../js/app.js");
 app.start(function(config) {
 	var bindAddress = config.address ? config.address : "localhost";
-	console.log("\nReady to go! Please point your browser to: http://" + bindAddress + ":" + config.port);
+	var httpType = config.useHttps ? "https" : "http";
+	console.log("\nReady to go! Please point your browser to: " + httpType + "://" + bindAddress + ":" + config.port);
 });

tests/configs/check_config.js

@@ -9,14 +9,17 @@
  *
  */
 
-var v = require("jshint");
+const Linter = require("eslint").Linter;
+const linter = new Linter();
+const config = require(__dirname + "/../../.eslintrc.json");
+
 var path = require("path");
 var fs = require("fs");
 var Utils = require(__dirname + "/../../js/utils.js");
 
 /* getConfigFile()
  * Return string with path of configuration file
- * Check if set by enviroment variable MM_CONFIG_FILE
+ * Check if set by environment variable MM_CONFIG_FILE
  */
 function getConfigFile() {
 	// FIXME: This function should be in core. Do you want refactor me ;) ?, be good!
@@ -35,7 +38,7 @@ function checkConfigFile() {
 		console.error(Utils.colors.error("File not found: "), configFileName);
 		return;
 	}
-	// check permision
+	// check permission
 	try {
 		fs.accessSync(configFileName, fs.F_OK);
 	} catch (e) {
@@ -50,16 +53,15 @@ function checkConfigFile() {
 	// I'm not sure if all ever is utf-8
 	fs.readFile(configFileName, "utf-8", function (err, data) {
 		if (err) { throw err; }
-		v.JSHINT(data); // Parser by jshint
-
-		if (v.JSHINT.errors.length == 0) {
+		const messages = linter.verify(data, config);
+		if (messages.length === 0) {
 			console.log("Your configuration file doesn't contain syntax errors :)");
 			return true;
 		} else {
-			errors = v.JSHINT.data().errors;
-			for (idx in errors) {
+			errors = messages;
+			for (var idx in errors) {
 				error = errors[idx];
-				console.log("Line", error.line, "col", error.character, error.reason);
+				console.log("Line", error.line, "col", error.column, error.message);
 			}
 		}
 	});
@@ -67,4 +69,4 @@ function checkConfigFile() {
 
 if (process.env.NODE_ENV !== "test") {
 	checkConfigFile();
-};
+}

tests/configs/env.js

@@ -1,4 +1,4 @@
-/* Magic Mirror Test config sample enviroment
+/* Magic Mirror Test config sample environment
  *
  * By Rodrigo Ramírez Norambuena https://rodrigoramirez.com
  * MIT Licensed.

tests/configs/modules/compliments/compliments_date.js

@@ -0,0 +1,41 @@
+/* Magic Mirror Test config compliments with date type
+ *
+ * By Rejas
+ *
+ * MIT Licensed.
+ */
+
+let config = {
+	port: 8080,
+	ipWhitelist: ["127.0.0.1", "::ffff:127.0.0.1", "::1"],
+
+	language: "en",
+	timeFormat: 12,
+	units: "metric",
+	electronOptions: {
+		webPreferences: {
+			nodeIntegration: true,
+		},
+	},
+
+	modules: [
+		{
+			module: "compliments",
+			position: "middle_center",
+			config: {
+				mockDate: "2020-01-01",
+				compliments: {
+					morning: [],
+					afternoon: [],
+					evening: [],
+					"....-01-01": [
+						"Happy new year!"
+					]
+				}
+			}
+		}
+	]
+};
+
+/*************** DO NOT EDIT THE LINE BELOW ***************/
+if (typeof module !== "undefined") {module.exports = config;}

tests/configs/modules/positions.js

@@ -6,7 +6,6 @@
  * MIT Licensed.
  */
 
-
 var config = {
 	port: 8080,
 	ipWhitelist: ["127.0.0.1", "::ffff:127.0.0.1", "::1"],

tests/configs/modules/weather/currentweather_default.js

@@ -0,0 +1,35 @@
+/* Magic Mirror Test config default weather
+ *
+ * By fewieden https://github.com/fewieden
+ *
+ * MIT Licensed.
+ */
+
+let config = {
+	port: 8080,
+	ipWhitelist: ["127.0.0.1", "::ffff:127.0.0.1", "::1"],
+
+	language: "en",
+	timeFormat: 12,
+	units: "metric",
+	electronOptions: {
+		webPreferences: {
+			nodeIntegration: true,
+		},
+	},
+
+	modules: [
+		{
+			module: "weather",
+			position: "bottom_bar",
+			config: {
+				location: "Munich",
+				apiKey: "fake key",
+				initialLoadDelay: 3000
+			}
+		}
+	]
+};
+
+/*************** DO NOT EDIT THE LINE BELOW ***************/
+if (typeof module !== "undefined") {module.exports = config;}

tests/configs/modules/weather/currentweather_options.js

@@ -0,0 +1,40 @@
+/* Magic Mirror Test config default weather
+ *
+ * By fewieden https://github.com/fewieden
+ *
+ * MIT Licensed.
+ */
+
+let config = {
+	port: 8080,
+	ipWhitelist: ["127.0.0.1", "::ffff:127.0.0.1", "::1"],
+
+	language: "en",
+	timeFormat: 24,
+	units: "metric",
+	electronOptions: {
+		webPreferences: {
+			nodeIntegration: true,
+		},
+	},
+
+	modules: [
+		{
+			module: "weather",
+			position: "bottom_bar",
+			config: {
+				location: "Munich",
+				apiKey: "fake key",
+				initialLoadDelay: 3000,
+				useBeaufort: false,
+				showWindDirectionAsArrow: true,
+				showHumidity: true,
+				roundTemp: true,
+				degreeLabel: true
+			}
+		}
+	]
+};
+
+/*************** DO NOT EDIT THE LINE BELOW ***************/
+if (typeof module !== "undefined") {module.exports = config;}

tests/configs/modules/weather/currentweather_units.js

@@ -0,0 +1,37 @@
+/* Magic Mirror Test config default weather
+ *
+ * By fewieden https://github.com/fewieden
+ *
+ * MIT Licensed.
+ */
+
+let config = {
+	port: 8080,
+	ipWhitelist: ["127.0.0.1", "::ffff:127.0.0.1", "::1"],
+
+	language: "en",
+	timeFormat: 24,
+	units: "imperial",
+	electronOptions: {
+		webPreferences: {
+			nodeIntegration: true,
+		},
+	},
+
+	modules: [
+		{
+			module: "weather",
+			position: "bottom_bar",
+			config: {
+				location: "Munich",
+				apiKey: "fake key",
+				initialLoadDelay: 3000,
+				decimalSymbol: ",",
+				showHumidity: true
+			}
+		}
+	]
+};
+
+/*************** DO NOT EDIT THE LINE BELOW ***************/
+if (typeof module !== "undefined") {module.exports = config;}

tests/configs/modules/weather/forecastweather_default.js

@@ -0,0 +1,37 @@
+/* Magic Mirror Test config default weather
+ *
+ * By fewieden https://github.com/fewieden
+ *
+ * MIT Licensed.
+ */
+
+let config = {
+	port: 8080,
+	ipWhitelist: ["127.0.0.1", "::ffff:127.0.0.1", "::1"],
+
+	language: "en",
+	timeFormat: 12,
+	units: "metric",
+	electronOptions: {
+		webPreferences: {
+			nodeIntegration: true,
+		},
+	},
+
+	modules: [
+		{
+			module: "weather",
+			position: "bottom_bar",
+			config: {
+				type: "forecast",
+				location: "Munich",
+				apiKey: "fake key",
+				weatherEndpoint: "/forecast/daily",
+				initialLoadDelay: 3000
+			}
+		}
+	]
+};
+
+/*************** DO NOT EDIT THE LINE BELOW ***************/
+if (typeof module !== "undefined") {module.exports = config;}

tests/configs/modules/weather/forecastweather_options.js

@@ -0,0 +1,40 @@
+/* Magic Mirror Test config default weather
+ *
+ * By fewieden https://github.com/fewieden
+ *
+ * MIT Licensed.
+ */
+
+let config = {
+	port: 8080,
+	ipWhitelist: ["127.0.0.1", "::ffff:127.0.0.1", "::1"],
+
+	language: "en",
+	timeFormat: 12,
+	units: "metric",
+	electronOptions: {
+		webPreferences: {
+			nodeIntegration: true,
+		},
+	},
+
+	modules: [
+		{
+			module: "weather",
+			position: "bottom_bar",
+			config: {
+				type: "forecast",
+				location: "Munich",
+				apiKey: "fake key",
+				weatherEndpoint: "/forecast/daily",
+				initialLoadDelay: 3000,
+				showPrecipitationAmount: true,
+				colored: true,
+				tableClass: "myTableClass"
+			}
+		}
+	]
+};
+
+/*************** DO NOT EDIT THE LINE BELOW ***************/
+if (typeof module !== "undefined") {module.exports = config;}