Merge pull request #811 from MichMich/develop

Release 2.1.1

.dockerignore

@@ -0,0 +1,72 @@
+# Various Node ignoramuses.
+
+logs
+*.log
+npm-debug.log*
+pids
+*.pid
+*.seed
+lib-cov
+coverage
+.grunt
+.lock-wscript
+build/Release
+node_modules
+jspm_modules
+.npm
+.node_repl_history
+
+# Various Windows ignoramuses.
+Thumbs.db
+ehthumbs.db
+Desktop.ini
+$RECYCLE.BIN/
+*.cab
+*.msi
+*.msm
+*.msp
+*.lnk
+
+# Various OSX ignoramuses.
+.DS_Store
+.AppleDouble
+.LSOverride
+Icon
+._*
+.DocumentRevisions-V100
+.fseventsd
+.Spotlight-V100
+.TemporaryItems
+.Trashes
+.VolumeIcon.icns
+.AppleDB
+.AppleDesktop
+Network Trash Folder
+Temporary Items
+.apdisk
+
+# Various Linux ignoramuses.
+
+.fuse_hidden*
+.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/**
+
+# Ignore changes to the custom css files.
+/css/custom.css
+
+# Ignore unnecessary files for docker
+CHANGELOG.md
+LICENSE.md
+README.md
+Gruntfile.js
+.*

.eslintignore

@@ -1,7 +1,6 @@
-vendor/
+vendor/*
 !/vendor/vendor.js
-/modules/**
 !/modules/default/**
 !/modules/node_helper
 !/modules/node_helper/**
-!/modules/default/defaultmodules.js
+!/modules/default/defaultmodules.js

.eslintrc.json

@@ -4,11 +4,13 @@
 		"quotes": ["error", "double"],
 		"max-len": ["error", 250],
 		"curly": "error",
-		"camelcase": ["error", {"properties": "never"}]
+		"camelcase": ["error", {"properties": "never"}],
+		"no-trailing-spaces": ["error"],
+		"no-irregular-whitespace": ["error"]
 	},
 	"env": {
 		"browser": true,
 		"node": true,
 		"es6": true
 	}
-}
+}

.github/CONTRIBUTING.md

@@ -3,57 +3,47 @@ Contribution Policy for MagicMirror²
 
 Thanks for contributing to MagicMirror²!
 
-We hold our code to standard, and these standards are documented below. 
+We hold our code to standard, and these standards are documented below.
 
-First, before you run the linters, you will need to install them all **and** install the development dependencies:
+If you wish to run both linters, use `grunt` without any arguments.
 
-```bash
-(sudo) npm install -g jscs stylelint html-validator-cli
-npm install
-```
+### JavaScript: Run ESLint
 
-### JavaScript: Run JSCS
+We use [ESLint](http://eslint.org) on our JavaScript files.
 
-We use [JSCS](http://jscs.info) on our JavaScript files.
+Our ESLint configuration is in our .eslintrc.json and .eslintignore files.
 
-Our JSCS configuration is in our .jscsrc file.
-
-To run JSCS, use `npm run jscs`.
+To run ESLint, use `grunt eslint`.
 
 ### CSS: Run StyleLint
 
 We use [StyleLint](http://stylelint.io) to lint our CSS. Our configuration is in our .stylelintrc file.
 
-To run StyleLint, use `npm run stylelint`.
+To run StyleLint, use `grunt stylelint`.
 
-### HTML: Run HTML Validator
+### Submitting Issues
 
-We use [NU Validator](https://validator.w3.org/nu) to validate our HTML. The configuration is in the command in the package.json file.
+Please only submit reproducible issues.
 
-To run HTML Validator, use `npm run htmlvalidator`.
-
-## Submitting Issues
-
-Please only submit reproducible issues. 
-
-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 - Problems installing or configuring your MagicMirror? Check out: https://forum.magicmirror.builders/category/10/troubleshooting
+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)
+Problems installing or configuring your MagicMirror? Check out: [https://forum.magicmirror.builders/category/10/troubleshooting](https://forum.magicmirror.builders/category/10/troubleshooting)
 
 When submitting a new issue, please supply the following information:
 
-**Platform** [ Raspberry Pi 2/3, Windows, Mac OS X, Linux, Etc ... ]:
+**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** [ 0.12.13 or later ]:
+**Node Version**: Make sure it's version 0.12.13 or later.
 
-**MagicMirror Version** [ V1 / V2-Beta ]:
+**MagicMirror Version**: Now that the versions have split, tell us if you are using the PHP version (v1) or the newer JavaScript version (v2).
 
-**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.
+**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.
 
-**Steps to Reproduce:** List the step by step process to reproduce the issue.
+**Steps to Reproduce**: List the step by step process to reproduce the issue.
 
-**Expected Results:** Describe what you expected to see.
+**Expected Results**: Describe what you expected to see.
 
-**Actual Results:** Describe what you actually saw.
+**Actual Results**: Describe what you actually saw.
 
-**Configuration:** What does the used config.js file look like? (Don't forget to remove any sensitive information.)
+**Configuration**: What does the used config.js file look like? Don't forget to remove any sensitive information!
 
-**Additional Notes:** Provide any other relevant notes not previously mentioned (optional)
+**Additional Notes**: Provide any other relevant notes not previously mentioned. This is optional.

.github/ISSUE_TEMPLATE.md

@@ -1,21 +1,24 @@
 Please only submit reproducible issues. 
 
-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 - Problems installing or configuring your MagicMirror? Check out: https://forum.magicmirror.builders/category/10/troubleshooting
+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)
+Problems installing or configuring your MagicMirror? Check out: [https://forum.magicmirror.builders/category/10/troubleshooting](https://forum.magicmirror.builders/category/10/troubleshooting)
 
-**Platform** [ Raspberry Pi 2/3, Windows, Mac OS X, Linux, Etc ... ]:
+When submitting a new issue, please supply the following information:
 
-**Node Version** [ 0.12.13 or later ]:
+**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).
 
-**MagicMirror Version** [ V1 / V2-Beta ]:
+**Node Version**: Make sure it's version 0.12.13 or later.
 
-**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.
+**MagicMirror Version**: Now that the versions have split, tell us if you are using the PHP version (v1) or the newer JavaScript version (v2).
 
-**Steps to Reproduce:** List the step by step process to reproduce the issue.
+**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.
 
-**Expected Results:** Describe what you expected to see.
+**Steps to Reproduce**: List the step by step process to reproduce the issue.
 
-**Actual Results:** Describe what you actually saw.
+**Expected Results**: Describe what you expected to see.
 
-**Configuration:** What does the used config.js file look like? (Don't forget to remove any sensitive information.)
+**Actual Results**: Describe what you actually saw.
 
-**Additional Notes:** Provide any other relevant notes not previously mentioned (optional)
+**Configuration**: What does the used config.js file look like? Don't forget to remove any sensitive information!
+
+**Additional Notes**: Provide any other relevant notes not previously mentioned. This is optional.

.github/PULL_REQUEST_TEMPLATE.md

@@ -1,9 +1,14 @@
-> Please send your PR's the develop branch. 
-> Don't forget to add the change to changelog.md.
+> Please send your pull requests the develop branch.
+> Don't forget to add the change to CHANGELOG.md.
 
-* Does the pull request solve a **related** issue? [yes | no]
+**Note**: Sometimes the development moves very fast. It is highly
+recommended that you update your branch of `develop` before creating a
+pull request to send us your changes. This makes everyone's lives
+easier (including yours) and helps us out on the development team.
+Thanks!
+
+
+* Does the pull request solve a **related** issue?
 * If so, can you reference the issue?
-* What does the pull request accomplish? (please list)
+* What does the pull request accomplish? Use a list if needed.
 * If it includes major visual changes please add screenshots.
-
-

.gitignore

@@ -53,12 +53,13 @@ Temporary Items
 
 # Various Magic Mirror ignoramuses and anti-ignoramuses.
 
-# Don't ignore the node_helper nore module.
+# Don't ignore the node_helper core module.
 !/modules/node_helper
 !/modules/node_helper/**
 
 # Ignore all modules except the default modules.
 /modules/**
+!/modules/default
 !/modules/default/**
 !/modules/README.md**
 

.stylelintrc

@@ -1,4 +1,5 @@
 {
 	"extends": "stylelint-config-standard",
-	"font-family-name-quotes": "double-where-recommended"
-}
+	"font-family-name-quotes": "double-where-recommended",
+	"block-no-empty": false
+}

.travis.yml

@@ -1,7 +1,16 @@
 language: node_js
 node_js:
+ - "7"
  - "6"
  - "5.1"
 before_script:
  - npm install grunt-cli -g
-script: grunt
+ - "export DISPLAY=:99.0"
+ - "sh -e /etc/init.d/xvfb start"
+ - sleep 5
+script:
+- grunt
+- npm test
+cache:
+ directories:
+  - node_modules

CHANGELOG.md

@@ -2,11 +2,156 @@
 All notable changes to this project will be documented in this file.
 This project adheres to [Semantic Versioning](http://semver.org/).
 
+
+## [2.1.1] - 2017-04-01
+
+**Note:** This update uses new dependencies. Please update using the following command: `git pull && npm install`
+
+### Changed
+- Add `anytime` group for Compliments module.
+- Compliments module can use remoteFile without default daytime arrays defined
+- Installer: Use init config.js from config.js.sample.
+- Switched out `rrule` package for `rrule-alt` and fixes in `ical.js` in order to fix calendar issues. ([#565](https://github.com/MichMich/MagicMirror/issues/565))
+- Make mouse events pass through the region fullscreen_above to modules below.
+- Scaled the splash screen down to make it a bit more subtle.
+- Replace HTML tables with markdown tables in README files.
+- Added `DAYAFTERTOMORROW`, `UPDATE_NOTIFICATION` and `UPDATE_NOTIFICATION_MODULE` to Finnish translations.
+- Run `npm test` on Travis automatically
+- Show the splash screen image even when is reboot or halted.
+- Added some missing translaton strings in the sv.json file.
+- Run task jsonlint to check translation files.
+- Restructured Test Suite
+
+### Added
+- Added Docker support (Pull Request [#673](https://github.com/MichMich/MagicMirror/pull/673)).
+- Calendar-specific support for `maximumEntries`, and ` maximumNumberOfDays`.
+- Add loaded function to modules, providing an async callback.
+- Made default newsfeed module aware of gesture events from [MMM-Gestures](https://github.com/thobach/MMM-Gestures)
+- Add use pm2 for manager process into Installer RaspberryPi script.
+- Russian Translation.
+- Afrikaans Translation.
+- Add postinstall script to notify user that MagicMirror installed successfully despite warnings from NPM.
+- Init tests using mocha.
+- Option to use RegExp in Calendar's titleReplace.
+- Hungarian Translation.
+- Icelandic Translation.
+- Add use a script to prevent when is run by SSH session set DISPLAY enviroment.
+- Enable ability to set configuration file by the enviroment variable called MM_CONFIG_FILE.
+- Option to give each calendar a different color.
+- Option for colored min-temp and max-temp.
+- Add test e2e helloworld.
+- Add test e2e enviroment.
+- Add `chai-as-promised` npm module to devDependencies.
+- Basic set of tests for clock module.
+- Run e2e test in Travis.
+- Estonian Translation.
+- Add test for compliments module for parts of day.
+- Korean Translation.
+- Added console warning on startup when deprecated config options are used.
+- Add option to display temperature unit label to the current weather module.
+- Added ability to disable wrapping of news items.
+- Added in the ability to hide events in the calendar module based on simple string filters.
+- Updated Norwegian translation.
+- Added hideLoading option for News Feed module.
+- Added configurable dateFormat to clock module.
+- Added multiple calendar icon support.
+- Added tests for Translations, dev argument, version, dev console.
+- Added test anytime feature compliments module.
+- Added test ipwhitelist configuration directive.
+- Added test for calendar module: default, basic-auth, backward compability, fail-basic-auth.
+- Added meta tags to support fullscreen mode on iOS (for server mode)
+- Added `ignoreOldItems` and `ignoreOlderThan` options to the News Feed module
+- Added test for MM_PORT enviroment variable.
+- Added a configurable Week section to the clock module.
+
+### Fixed
+- Update .gitignore to not ignore default modules folder.
+- Remove white flash on boot up.
+- Added `update` in Raspberry Pi installation script.
+- Fix an issue where the analog clock looked scrambled. ([#611](https://github.com/MichMich/MagicMirror/issues/611))
+- If units is set to imperial, the showRainAmount option of weatherforecast will show the correct unit.
+- Module currentWeather: check if temperature received from api is defined.
+- Fix an issue with module hidden status changing to `true` although lock string prevented showing it.
+- Fix newsfeed module bug (removeStartTags)
+- Fix when is set MM_PORT enviroment variable.
+- Fixed missing animation on `this.show(speed)` when module is alone in a region.
+
+## [2.1.0] - 2016-12-31
+
+**Note:** This update uses new dependencies. Please update using the following command: `git pull && npm install`
+
+### Added
+- Finnish translation.
+- Danish translation.
+- Turkish translation.
+- Option to limit access to certain IP addresses based on the value of `ipWhitelist` in the `config.js`, default is access from localhost only (Issue [#456](https://github.com/MichMich/MagicMirror/issues/456)).
+- Added ability to change the point of time when calendar events get relative.
+- Add Splash screen on boot.
+- Add option to show humidity in currentWeather module.
+- Add VSCode IntelliSense support.
+- Module API: Add Visibility locking to module system. [See documentation](https://github.com/MichMich/MagicMirror/tree/develop/modules#visibility-locking) for more information.
+- Module API: Method to overwrite the module's header. [See documentation](https://github.com/MichMich/MagicMirror/tree/develop/modules#getheader) for more information.
+- Module API: Option to define the minimum MagicMirror version to run a module. [See documentation](https://github.com/MichMich/MagicMirror/tree/develop/modules#requiresversion) for more information.
+- Calendar module now broadcasts the event list to all other modules using the notification system. [See documentation](https://github.com/MichMich/MagicMirror/tree/develop/modules/default/calendar) for more information.
+- Possibility to use the the calendar feed as the source for the weather (currentweather & weatherforecast) location data. [See documentation](https://github.com/MichMich/MagicMirror/tree/develop/modules/default/weatherforecast) for more information.
+- Added option to show rain amount in the weatherforecast default module
+- Add module `updatenotification` to get an update whenever a new version is availabe. [See documentation](https://github.com/MichMich/MagicMirror/tree/develop/modules/default/updatenotification) for more information.
+- Add the abilty to set timezone on the date display in the Clock Module
+- Ability to set date format in calendar module
+- Possibility to use currentweather for the compliments
+- Added option `disabled` for modules.
+- Added option `address` to set bind address.
+- Added option `onlyTemp` for currentweather module to show show only current temperature and weather icon.
+- 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 to configure electronOptions
+- Calendar module: option to hide private events
+- Add root_path for global vars
+
+### Updated
+- Modified translations for Frysk.
+- Modified core English translations.
+- Updated package.json as a result of Snyk security update.
+- Improve object instantiation to prevent reference errors.
+- Improve logger. `Log.log()` now accepts multiple arguments.
+- Remove extensive logging in newsfeed node helper.
+- Calendar times are now uniformly capitalized.
+- Modules are now secure, and Helmet is now used to prevent abuse of the Mirror's API.
+
+### Fixed
+- Solve an issue where module margins would appear when the first module of a section was hidden.
+- Solved visual display errors on chrome, if all modules in one of the right sections are hidden.
+- Global and Module default config values are no longer modified when setting config values.
+- Hide a region if all modules in a region are hidden. Prevention unwanted margins.
+- Replaced `electron-prebuilt` package with `electron` in order to fix issues that would happen after 2017.
+- Documentation of alert module
+
+## [2.0.5] - 2016-09-20
+
+### Added
+- Added ability to remove tags from the beginning or end of newsfeed items in 'newsfeed.js'.
+- Added ability to define "the day after tomorrow" for calendar events (Definition for German and Dutch already included).
+- Added CII Badge (we are compliant with the CII Best Practices)
+- Add support for doing http basic auth when loading calendars
+- Add the abilty to turn off and on the date display in the Clock Module
+
+### Fixed
+- Fix typo in installer.
+- Add message to unsupported Pi error to mention that Pi Zeros must use server only mode, as ARMv6 is unsupported. Closes #374.
+- Fix API url for weather API.
+
+### Updated
+- Force fullscreen when kioskmode is active.
+- Update the .github templates and information with more modern information.
+- Update the Gruntfile with a more functional StyleLint implementation.
+
 ## [2.0.4] - 2016-08-07
 
 ### Added
 - Brazilian Portuguese Translation.
-- Option to enable Kios mode.
+- Option to enable Kiosk mode.
 - Added ability to start the app with Dev Tools.
 - Added ability to turn off the date display in `clock.js` when in analog mode.
 - Greek Translation
@@ -47,7 +192,7 @@ This project adheres to [Semantic Versioning](http://semver.org/).
 
 ### Fixed
 - Added reference to Italian Translation.
-- Added the missing NE translation to all languages. [#334](https://github.com/MichMich/MagicMirror/issues/344)
+- Added the missing NE translation to all languages. [#344](https://github.com/MichMich/MagicMirror/issues/344)
 - Added proper User-Agent string to calendar call.
 
 ### Changed
@@ -71,4 +216,4 @@ It includes (but is not limited to) the following features:
 
 ## [1.0.0] - 2014-02-16
 ### Initial release of MagicMirror.
-This was part of the blogpost: http://michaelteeuw.nl/post/83916869600/magic-mirror-part-vi-production-of-the
+This was part of the blogpost: [http://michaelteeuw.nl/post/83916869600/magic-mirror-part-vi-production-of-the](http://michaelteeuw.nl/post/83916869600/magic-mirror-part-vi-production-of-the)

Dockerfile

@@ -0,0 +1,19 @@
+FROM node:latest
+
+RUN apt-get update && apt-get -y install dos2unix
+
+WORKDIR /opt/magic_mirror
+COPY . .
+COPY /modules unmount_modules
+COPY /config unmount_config
+
+ENV NODE_ENV production
+ENV MM_PORT 8080
+
+RUN npm install
+
+RUN ["dos2unix", "docker-entrypoint.sh"]
+RUN ["chmod", "+x", "docker-entrypoint.sh"]
+
+EXPOSE $MM_PORT
+ENTRYPOINT ["/opt/magic_mirror/docker-entrypoint.sh"]

Gruntfile.js

@@ -6,23 +6,69 @@ module.exports = function(grunt) {
 			options: {
 				configFile: ".eslintrc.json"
 			},
-			target: ["js/*.js", "modules/default/*.js", "serveronly/*.js", "*.js"]
+			target: ["js/*.js", "modules/default/*.js", "modules/default/*/*.js",
+				"serveronly/*.js", "*.js", "tests/*/*.js", "!modules/default/alert/notificationFx.js",
+				"!modules/default/alert/modernizr.custom.js", "!modules/default/alert/classie.js",
+				"config/*",
+				"translations/translations.js", "vendor/vendor.js"
+
+			]
 		},
-		postcss: {
-			lint: {
+		stylelint: {
+			simple: {
 				options: {
-					processors: [
-						require("stylelint")({"extends": "stylelint-config-standard", "font-family-name-quotes": "double-where-recommended"}),
-						require("postcss-reporter")({ clearMessages: true })
-					]
+					configFile: ".stylelintrc"
 				},
-				dist: {
-					src: "**/**/**/**/**/**/**/**.css"
+				src: ["css/main.css", "modules/default/calendar/calendar.css", "modules/default/clock/clock_styles.css", "modules/default/currentweather/currentweather.css", "modules/default/weatherforcast/weatherforcast.css"]
+			}
+		},
+		jsonlint: {
+			main: {
+				src: ["package.json", ".eslintrc.json", ".stylelintrc", "translations/*.json",
+					"modules/default/*/translations/*.json", "installers/pm2_MagicMirror.json",
+					"vendor/package.js"],
+				options: {
+					reporter: "jshint"
 				}
 			}
+		},
+		markdownlint: {
+			all: {
+				options: {
+					config: {
+						"default": true,
+						"line-length": false,
+						"blanks-around-headers": false,
+						"no-duplicate-header": false,
+						"no-inline-html": false,
+						"MD010": false,
+						"MD001": false,
+						"MD031": false,
+						"MD040": false,
+						"MD002": false,
+						"MD029": false,
+						"MD041": false,
+						"MD032": false,
+						"MD036": false,
+						"MD037": false,
+						"MD009": false,
+						"MD018": false,
+						"MD012": false,
+						"MD026": false,
+						"MD038": false
+					}
+				},
+				src: ["README.md", "CHANGELOG.md", "LICENSE.md", "modules/README.md", "modules/default/**/*.md", "!modules/default/calendar/vendor/ical.js/readme.md"]
+			}
+		},
+		yamllint: {
+			all: [".travis.yml"]
 		}
 	});
 	grunt.loadNpmTasks("grunt-eslint");
-	grunt.loadNpmTasks("grunt-postcss");
-	grunt.registerTask("default", ["eslint", "postcss:lint"]);
-};
+	grunt.loadNpmTasks("grunt-stylelint");
+	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 Michael Teeuw
+Copyright © 2016-2017 Michael Teeuw
 
 Permission is hereby granted, free of charge, to any person
 obtaining a copy of this software and associated documentation

README.md

@@ -3,7 +3,7 @@
 <p align="center">
 	<a href="https://david-dm.org/MichMich/MagicMirror"><img src="https://david-dm.org/MichMich/MagicMirror.svg" alt="Dependency Status"></a>
 	<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://nodejs.org"><img src="https://img.shields.io/badge/node-v5.10.1-brightgreen.svg" alt="Node Version"></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://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>
@@ -19,25 +19,25 @@ MagicMirror² focuses on a modular plugin system and uses [Electron](http://elec
 - [Configuration](#configuration)
 - [Modules](#modules)
 - [Known Issues](#known-issues)
-- [community](#community)
+- [Community](#community)
 - [Contributing Guidelines](#contributing-guidelines)
 
 ## Usage
 
-#### Raspberry Pi Support
+### Raspberry Pi Support
 Electron, the app wrapper around MagicMirror², only supports the Raspberry Pi 2 & 3. The Raspberry Pi 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.
 
-#### Automatic Installer (Raspberry Pi Only!)
+### Automatic Installer (Raspberry Pi Only!)
 
 Execute the following command on your Raspberry Pi to install MagicMirror²:
 ````
 curl -sL https://raw.githubusercontent.com/MichMich/MagicMirror/master/installers/raspberry.sh | bash
 ````
 
-#### Manual Installation
+### Manual Installation
 
 1. Download and install the latest Node.js version.
-2. Clone the repository and check out the beta branch: `git clone https://github.com/MichMich/MagicMirror`
+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: `npm install && npm start`
 
@@ -45,43 +45,79 @@ curl -sL https://raw.githubusercontent.com/MichMich/MagicMirror/master/installer
 
 **Note:** if you want to debug on Raspberry Pi you can use `npm start dev` which will start the MagicMirror app with Dev Tools enabled.
 
-#### Server Only
+### 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.
 
-In some cases, you want to start the application without an actual app window. In this case, execute the following command from the MagicMirror folder: `node serveronly`. This will start the server, after which you can open the application in your browser of choice.
+#### Docker
 
-#### Raspberry Configuration & Auto Start.
+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 \
+			MichMich/MagicMirror
+```
+
+| **Volumes** | **Description** |
+| --- | --- |
+| `/opt/magic_mirror/config` | Mount this volume to insert your own config into the docker container. |
+| `/opt/magic_mirror/modules` | Mount this volume to add your own custom modules into the docker container. |
+
+You may need to add your Docker Host IP to your `ipWhitelist` option. If you have some issues setting up this configuration, check [this forum post](https://forum.magicmirror.builders/topic/1326/ipwhitelist-howto).
+
+```javascript
+var config = {
+	ipWhitelist: ["127.0.0.1", "::ffff:127.0.0.1", "::1", "::ffff:172.17.0.1"]
+};
+```
+
+#### Manual
+
+1. Download and install the latest Node.js version.
+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: `npm install && node serveronly`
+
+### Raspberry Configuration & Auto Start.
 
 The following wiki links are helpful in the 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)
 
-#### Updating you MagicMirror²
+### Updating your MagicMirror²
 
 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:
 
-````
-git pull
-````
+```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.
 
 ## Configuration
 
-1. Duplicate `config/config.js.sample` to `config/config.js`.
+1. Duplicate `config/config.js.sample` to `config/config.js`. **Note:** If you used the installer script. This step is already done for you.
 2. Modify your required settings.
 
 The following properties can be configured:
 
-
 | **Option** | **Description** |
 | --- | --- |
 | `port` | The port on which the MagicMirror² server will run on. The default value is `8080`. |
-| `kioskmode` | This allows MagicMirror² to run in Kiosk Mode. It protects from other programs popping on top of your screen. The default value is `false`|
+| `address` | The ip address the accept connections. The  default open bind `::` is IPv6 is available or `0.0.0.0` IPv4 run on.  Example config: `192.168.10.100`. |
+| `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"]`. It is possible to specify IPs with subnet masks (`["127.0.0.1", "127.0.0.1/24"]`) or define ip ranges (`["127.0.0.1", ["192.168.0.1", "192.168.0.100"]]`). Set `[]` to allow all IP addresses. For more information about how configure this directive see the [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). |
+
 
 Module configuration:
 
@@ -91,6 +127,7 @@ Module configuration:
 | `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
@@ -129,3 +166,8 @@ Please keep the following in mind:
 - **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!
+
+<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>
+</p>

config/config.js.sample

@@ -6,58 +6,63 @@
 
 var config = {
 	port: 8080,
+	ipWhitelist: ["127.0.0.1", "::ffff:127.0.0.1", "::1"], // Set [] to allow all IP addresses.
 
-	language: 'en',
+	language: "en",
 	timeFormat: 24,
-	units: 'metric',
+	units: "metric",
 
 	modules: [
 		{
-			module: 'alert',
+			module: "alert",
 		},
 		{
-			module: 'clock',
-			position: 'top_left'
+			module: "updatenotification",
+			position: "top_bar"
 		},
 		{
-			module: 'calendar',
-			header: 'US Holidays',
-			position: 'top_left',
+			module: "clock",
+			position: "top_left"
+		},
+		{
+			module: "calendar",
+			header: "US Holidays",
+			position: "top_left",
 			config: {
 				calendars: [
 					{
-						symbol: 'calendar-check-o ',
-						url: 'webcal://www.calendarlabs.com/templates/ical/US-Holidays.ics'
+						symbol: "calendar-check-o ",
+						url: "webcal://www.calendarlabs.com/templates/ical/US-Holidays.ics"
 					}
 				]
 			}
 		},
 		{
-			module: 'compliments',
-			position: 'lower_third'
+			module: "compliments",
+			position: "lower_third"
 		},
 		{
-			module: 'currentweather',
-			position: 'top_right',
+			module: "currentweather",
+			position: "top_right",
 			config: {
-				location: 'New York',
-				locationID: '',  //ID from http://www.openweathermap.org
-				appid: 'YOUR_OPENWEATHER_API_KEY'
+				location: "New York",
+				locationID: "",  //ID from http://www.openweathermap.org/help/city_list.txt
+				appid: "YOUR_OPENWEATHER_API_KEY"
 			}
 		},
 		{
-			module: 'weatherforecast',
-			position: 'top_right',
-			header: 'Weather Forecast',
+			module: "weatherforecast",
+			position: "top_right",
+			header: "Weather Forecast",
 			config: {
-	            location: 'New York',
-				locationID: '5128581',  //ID from http://www.openweathermap.org
-	            appid: 'YOUR_OPENWEATHER_API_KEY'
+				location: "New York",
+				locationID: "5128581",  //ID from http://www.openweathermap.org/help/city_list.txt
+				appid: "YOUR_OPENWEATHER_API_KEY"
 			}
 		},
 		{
-			module: 'newsfeed',
-			position: 'bottom_bar',
+			module: "newsfeed",
+			position: "bottom_bar",
 			config: {
 				feeds: [
 					{
@@ -74,4 +79,4 @@ var config = {
 };
 
 /*************** DO NOT EDIT THE LINE BELOW ***************/
-if (typeof module !== 'undefined') {module.exports = config;}
+if (typeof module !== "undefined") {module.exports = config;}

css/main.css

@@ -1,10 +1,11 @@
 html {
   cursor: none;
-  overflow:hidden;
+  overflow: hidden;
+  background: #000;
 }
 
-::-webkit-scrollbar { 
-    display: none; 
+::-webkit-scrollbar {
+  display: none;
 }
 
 body {
@@ -113,11 +114,18 @@ sup {
  */
 
 .module {
-  margin-top: 30px;
+  margin-bottom: 30px;
 }
 
-.module:first-child {
-  margin-top: 0;
+.region.bottom .module {
+  margin-top: 30px;
+  margin-bottom: 0;
+}
+
+.no-wrap {
+  white-space: nowrap;
+  overflow: hidden;
+  text-overflow: ellipsis;
 }
 
 /**
@@ -134,6 +142,11 @@ sup {
   left: -60px;
   right: -60px;
   bottom: -60px;
+  pointer-events: none;
+}
+
+.region.fullscreen * {
+  pointer-events: auto;
 }
 
 .region.right {

docker-entrypoint.sh

@@ -0,0 +1,11 @@
+#!/bin/bash
+
+if [ ! -f /opt/magic_mirror/modules ]; then
+    cp -R /opt/magic_mirror/unmount_modules/. /opt/magic_mirror/modules
+fi
+
+if [ ! -f /opt/magic_mirror/config ]; then
+    cp -R /opt/magic_mirror/unmount_config/. /opt/magic_mirror/config
+fi
+
+node serveronly

index.html

@@ -4,10 +4,20 @@
 	<title>Magic Mirror</title>
 	<meta name="google" content="notranslate" />
 	<meta http-equiv="Content-type" content="text/html; charset=utf-8" />
+
+	<meta name="apple-mobile-web-app-capable" content="yes">
+	<meta name="apple-mobile-web-app-status-bar-style" content="black">
+	<meta name="format-detection" content="telephone=no">
+	<meta name="mobile-web-app-capable" content="yes">
+
 	<link rel="icon" href="data:;base64,iVBORw0KGgo=">
 	<link rel="stylesheet" type="text/css" href="css/main.css">
 	<link rel="stylesheet" type="text/css" href="fonts/roboto.css">
 	<!-- custom.css is loaded by the loader.js to make sure it's loaded after the module css files. -->
+
+	<script type="text/javascript">
+		var version = "#VERSION#";
+	</script>
 </head>
 <body>
 	<div class="region fullscreen below"><div class="container"></div></div>
@@ -29,7 +39,7 @@
 	<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="js/defaults.js"></script>
-	<script type="text/javascript" src="config/config.js"></script>
+	<script type="text/javascript" src="#CONFIG_FILE#"></script>
 	<script type="text/javascript" src="vendor/vendor.js"></script>
 	<script type="text/javascript" src="modules/default/defaultmodules.js"></script>
 	<script type="text/javascript" src="js/logger.js"></script>

installers/mm.sh

@@ -0,0 +1,2 @@
+cd ~/MagicMirror
+DISPLAY=:0 npm start

installers/pm2_MagicMirror.json

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

installers/postinstall/postinstall.sh

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

installers/raspberry.sh

@@ -18,23 +18,28 @@ echo '                       \$$$$$$  |'
 echo '                        \______/'
 echo -e "\e[0m"
 
-# Define the tested version of Node.js. 
+# Define the tested version of Node.js.
 NODE_TESTED="v5.1.0"
 
-#Determine which Pi is running.
+# Determine which Pi is running.
 ARM=$(uname -m) 
 
-#Check the Raspberry Pi version.
+# 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.
+# 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 install curl wget git build-essential unzip || exit
@@ -48,19 +53,19 @@ if command_exists node; then
 	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
+		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;
+		# 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 nessecery.\e[0m"
+	else
+		echo -e "\e[92mNo Node.js upgrade nessecery.\e[0m"
 	fi
 
 else
@@ -68,14 +73,14 @@ else
 	NODE_INSTALL=true
 fi
 
-# Install or upgare node if nessecery.
+# 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.
+	# 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="6.x"
 	curl -sL https://deb.nodesource.com/setup_$NODE_STABLE_BRANCH | sudo -E bash -
@@ -83,7 +88,7 @@ if $NODE_INSTALL; then
 	echo -e "\e[92mNode.js installation Done!\e[0m"
 fi
 
-#Install magic mirror
+# Install MagicMirror
 cd ~
 if [ -d "$HOME/MagicMirror" ] ; then
 	echo -e "\e[93mIt seems like MagicMirror is already installed."
@@ -112,6 +117,47 @@ else
 	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
+    sudo su -c "env PATH=$PATH:/usr/bin pm2 startup linux -u pi --hp /home/pi"
+    pm2 start ~/MagicMirror/installers/pm2_MagicMirror.json
+    pm2 save
+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 " "

js/app.js

@@ -7,9 +7,27 @@
 
 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");
 
+// Get version number.
+global.version = JSON.parse(fs.readFileSync("package.json", "utf8")).version;
+console.log("Starting MagicMirror: v" + global.version);
+
+// global absolute root path
+global.root_path = path.resolve(__dirname + "/../");
+
+if (process.env.MM_CONFIG_FILE) {
+	global.configuration_file = process.env.MM_CONFIG_FILE;
+}
+
+// FIXME: Hotfix Pull Request
+// https://github.com/MichMich/MagicMirror/pull/673
+if (process.env.MM_PORT) {
+	global.mmPort = process.env.MM_PORT;
+}
+
 // The next part is here to prevent a major exception when there
 // is no internet connection. This could probable be solved better.
 process.on("uncaughtException", function (err) {
@@ -34,32 +52,58 @@ var App = function() {
 	var loadConfig = function(callback) {
 		console.log("Loading config ...");
 		var defaults = require(__dirname + "/defaults.js");
-		var configFilename = path.resolve(__dirname + "/../config/config.js");
+
+		// For this check proposed to TestSuite
+		// https://forum.magicmirror.builders/topic/1456/test-suite-for-magicmirror/8
+		var configFilename = path.resolve(global.root_path + "/config/config.js");
+		if (typeof(global.configuration_file) !== "undefined") {
+		    configFilename = path.resolve(global.configuration_file);
+		}
+
 		try {
 			fs.accessSync(configFilename, fs.F_OK);
 			var c = require(configFilename);
+			checkDeprecatedOptions(c);
 			var config = Object.assign(defaults, c);
 			callback(config);
 		} catch (e) {
 			if (e.code == "ENOENT") {
-				console.error("WARNING! Could not find config file. Please create one. Starting with default configuration.");
-				callback(defaults);
+				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("WARNING! Could not validate config file. Please correct syntax errors. Starting with default configuration.");
-				callback(defaults);
+				console.error(Utils.colors.error("WARNING! Could not validate config file. Please correct syntax errors. Starting with default configuration."));
 			} else {
-				console.error("WARNING! Could not load config file. Starting with default configuration. Error found: " + e);
-				callback(defaults);
+				console.error(Utils.colors.error("WARNING! Could not load config file. Starting with default configuration. Error found: " + e));
 			}
+			callback(defaults);
 		}
 	};
 
+	var checkDeprecatedOptions = function(userConfig) {
+		var deprecated = require(global.root_path + "/js/deprecated.js");
+		var deprecatedOptions = deprecated.configs;
+
+		var usedDeprecated = [];
+
+		deprecatedOptions.forEach(function(option) {
+			if (userConfig.hasOwnProperty(option)) {
+				usedDeprecated.push(option);
+			}
+		});
+		if (usedDeprecated.length > 0) {
+			console.warn(Utils.colors.warn(
+				"WARNING! Your config is using deprecated options: " +
+				usedDeprecated.join(", ") +
+				". Check README and CHANGELOG for more up-to-date ways of getting the same functionality.")
+			);
+		}
+	}
+
 	/* loadModule(module)
 	 * Loads a specific module.
 	 *
 	 * argument module string - The name of the module (including subpath).
 	 */
-	var loadModule = function(module) {
+	var loadModule = function(module, callback) {
 
 		var elements = module.split("/");
 		var moduleName = elements[elements.length - 1];
@@ -82,9 +126,24 @@ var App = function() {
 		if (loadModule) {
 			var Module = require(helperPath);
 			var m = new Module();
+
+			if (m.requiresVersion) {
+				console.log("Check MagicMirror version for node helper '" + moduleName + "' - Minimum version:  " + m.requiresVersion + " - Current version: " + global.version);
+				if (cmpVersions(global.version, m.requiresVersion) >= 0) {
+					console.log("Version is ok!");
+				} else {
+					console.log("Version is incorrect. Skip module: '" + moduleName + "'");
+					return;
+				}
+			}
+
 			m.setName(moduleName);
 			m.setPath(path.resolve(moduleFolder));
 			nodeHelpers.push(m);
+
+			m.loaded(callback);
+		} else {
+			callback();
 		}
 	};
 
@@ -93,16 +152,48 @@ var App = function() {
 	 *
 	 * argument module string - The name of the module (including subpath).
 	 */
-	var loadModules = function(modules) {
+	var loadModules = function(modules, callback) {
 		console.log("Loading module helpers ...");
 
-		for (var m in modules) {
-			loadModule(modules[m]);
-		}
+		var loadNextModule = function() {
+			if (modules.length > 0) {
+				var nextModule = modules[0];
+				loadModule(nextModule, function() {
+					modules = modules.slice(1);
+					loadNextModule();
+				});
+			} else {
+				// All modules are loaded
+				console.log("All module helpers loaded.");
+				callback();
+			}
+		};
 
-		console.log("All module helpers loaded.");
+		loadNextModule();
 	};
 
+	/* cmpVersions(a,b)
+	 * Compare two symantic version numbers and return the difference.
+	 *
+	 * argument a string - Version number a.
+	 * argument a string - Version number b.
+	 */
+	function cmpVersions(a, b) {
+		var i, diff;
+		var regExStrip0 = /(\.0+)+$/;
+		var segmentsA = a.replace(regExStrip0, "").split(".");
+		var segmentsB = b.replace(regExStrip0, "").split(".");
+		var l = Math.min(segmentsA.length, segmentsB.length);
+
+		for (i = 0; i < l; i++) {
+			diff = parseInt(segmentsA[i], 10) - parseInt(segmentsB[i], 10);
+			if (diff) {
+				return diff;
+			}
+		}
+		return segmentsA.length - segmentsB.length;
+	}
+
 	/* start(callback)
 	 * This methods starts the core app.
 	 * It loads the config, then it loads all modules.
@@ -119,32 +210,32 @@ var App = function() {
 
 			for (var m in config.modules) {
 				var module = config.modules[m];
-				if (modules.indexOf(module.module) === -1) {
+				if (modules.indexOf(module.module) === -1 && !module.disabled) {
 					modules.push(module.module);
 				}
 			}
 
-			loadModules(modules);
+			loadModules(modules, function() {
+				var server = new Server(config, function(app, io) {
+					console.log("Server started ...");
 
-			var server = new Server(config, function(app, io) {
-				console.log("Server started ...");
+					for (var h in nodeHelpers) {
+						var nodeHelper = nodeHelpers[h];
+						nodeHelper.setExpressApp(app);
+						nodeHelper.setSocketIO(io);
+						nodeHelper.start();
+					}
 
-				for (var h in nodeHelpers) {
-					var nodeHelper = nodeHelpers[h];
-					nodeHelper.setExpressApp(app);
-					nodeHelper.setSocketIO(io);
-					nodeHelper.start();
-				}
+					console.log("Sockets connected & modules started ...");
 
-				console.log("Sockets connected & modules started ...");
-
-				if (typeof callback === "function") {
-					callback(config);
-				}
+					if (typeof callback === "function") {
+						callback(config);
+					}
 
+				});
 			});
 		});
 	};
 };
 
-module.exports = new App();
+module.exports = new App();

js/class.js

@@ -21,28 +21,32 @@
 		var prototype = new this();
 		initializing = false;
 
+		// Make a copy of all prototype properies, to prevent reference issues.
+		for (var name in prototype) {
+			prototype[name] = cloneObject(prototype[name]);
+		}
+
 		// 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) {
-	return function() {
-		var tmp = this._super;
+			typeof _super[name] == "function" && fnTest.test(prop[name]) ? (function(name, fn) {
+				return function() {
+					var tmp = this._super;
 
-		// Add a new ._super() method that is the same method
-		// but on the super-class
-		this._super = _super[name];
+					// Add a new ._super() method that is the same method
+					// but on the super-class
+					this._super = _super[name];
 
-		// The method only need to be bound temporarily, so we
-		// remove it when we're done executing
-		var ret = fn.apply(this, arguments);
-		this._super = tmp;
+					// The method only need to be bound temporarily, so we
+					// remove it when we're done executing
+					var ret = fn.apply(this, arguments);
+					this._super = tmp;
 
-		return ret;
-	};
-        })(name, prop[name]) :
-        prop[name];
+
+					return ret;
+				};
+			})(name, prop[name]) : prop[name];
 		}
 
 		// The dummy class constructor
@@ -66,5 +70,24 @@
 	};
 })();
 
+//Define the clone method for later use.
+//Helper Method
+function cloneObject(obj) {
+	if (obj === null || typeof obj !== "object") {
+		return obj;
+	}
+
+	var temp = obj.constructor(); // give temp the original obj's constructor
+	for (var key in obj) {
+		temp[key] = cloneObject(obj[key]);
+
+		if (key === "lockStrings") {
+			Log.log(key);
+		}
+	}
+
+	return temp;
+}
+
 /*************** DO NOT EDIT THE LINE BELOW ***************/
 if (typeof module !== "undefined") {module.exports = Class;}

js/defaults.js

@@ -7,15 +7,26 @@
  * MIT Licensed.
  */
 
+var port = 8080;
+if (typeof(mmPort) !== "undefined") {
+	port = mmPort;
+}
 var defaults = {
-	port: 8080,
+	port: port,
 	kioskmode: false,
+	electronOptions: {},
+	ipWhitelist: ["127.0.0.1", "::ffff:127.0.0.1", "::1"],
 
 	language: "en",
 	timeFormat: 24,
 	units: "metric",
+	zoom: 1,
 
 	modules: [
+		{
+			module: "updatenotification",
+			position: "top_center"
+		},
 		{
 			module: "helloworld",
 			position: "upper_third",

js/deprecated.js

@@ -0,0 +1,14 @@
+/* Magic Mirror Deprecated Config Options List
+ *
+ * By Michael Teeuw http://michaelteeuw.nl
+ * MIT Licensed.
+ *
+ * Olex S. original idea this deprecated option
+ */
+
+var deprecated = {
+	configs: ["kioskmode"],
+};
+
+/*************** DO NOT EDIT THE LINE BELOW ***************/
+if (typeof module !== "undefined") {module.exports = deprecated;}

js/electron.js

@@ -1,3 +1,5 @@
+/* jshint esversion: 6 */
+
 "use strict";
 
 const Server = require(__dirname + "/server.js");
@@ -16,29 +18,63 @@ const BrowserWindow = electron.BrowserWindow;
 let mainWindow;
 
 function createWindow() {
-	// Create the browser window.
-	if (config.kioskmode) {
-		mainWindow = new BrowserWindow({width: 800, height: 600, x: 0, y: 0, kiosk:true, darkTheme: true, webPreferences: {nodeIntegration: false}});
-	} else {
-		mainWindow = new BrowserWindow({width: 800, height: 600, x: 0, y: 0, fullscreen: true, autoHideMenuBar: true, darkTheme: true, webPreferences: {nodeIntegration: false}});
+
+	var electronOptionsDefaults = {
+		width: 800,
+		height: 600,
+		x: 0,
+		y: 0,
+		darkTheme: true,
+		webPreferences: {
+			nodeIntegration: false,
+			zoomFactor: config.zoom
+		},
+		backgroundColor: "#000000"
 	}
 
+	// DEPRECATED: "kioskmode" backwards compatibility, to be removed
+	// settings these options directly instead provides cleaner interface
+	if (config.kioskmode) {
+		electronOptionsDefaults.kiosk = true;
+	} else {
+		electronOptionsDefaults.fullscreen = true;
+		electronOptionsDefaults.autoHideMenuBar = true;
+	}
+
+	var electronOptions = Object.assign({}, electronOptionsDefaults, config.electronOptions);
+
+	// Create the browser window.
+	mainWindow = new BrowserWindow(electronOptions);
+
 	// and load the index.html of the app.
 	//mainWindow.loadURL('file://' + __dirname + '../../index.html');
 	mainWindow.loadURL("http://localhost:" + config.port);
 
 	// Open the DevTools if run with "npm start dev"
-	if(process.argv[2] == "dev"){
+	if(process.argv[2] == "dev") {
 		mainWindow.webContents.openDevTools();
 	}
 
-	// Emitted when the window is closed.
+	// Set responders for window events.
 	mainWindow.on("closed", function() {
-		// Dereference the window object, usually you would store windows
-		// in an array if your app supports multi windows, this is the time
-		// when you should delete the corresponding element.
 		mainWindow = null;
 	});
+
+	if (config.kioskmode) {
+		mainWindow.on("blur", function() {
+			mainWindow.focus();
+		});
+
+		mainWindow.on("leave-full-screen", function() {
+			mainWindow.setFullScreen(true);
+		});
+
+		mainWindow.on("resize", function() {
+			setTimeout(function() {
+				mainWindow.reload();
+			}, 1000);
+		});
+	}
 }
 
 // This method will be called when Electron has finished
@@ -50,11 +86,7 @@ app.on("ready", function() {
 
 // Quit when all windows are closed.
 app.on("window-all-closed", function() {
-	// On OS X it is common for applications and their menu bar
-	// to stay active until the user quits explicitly with Cmd + Q
-	if (process.platform !== "darwin") {
-		app.quit();
-	}
+	createWindow();
 });
 
 app.on("activate", function() {

js/loader.js

@@ -89,6 +89,10 @@ var Loader = (function() {
 				moduleFolder =  config.paths.modules + "/default/" + module;
 			}
 
+			if (moduleData.disabled === true) {
+				continue;
+			}
+
 			moduleFiles.push({
 				index: m,
 				identifier: "module_" + m + "_" + module,
@@ -117,9 +121,13 @@ var Loader = (function() {
 
 		var afterLoad = function() {
 			var moduleObject = Module.create(module.name);
-			bootstrapModule(module, moduleObject, function() {
+			if (moduleObject) {
+				bootstrapModule(module, moduleObject, function() {
+					callback();
+				});
+			} else {
 				callback();
-			});
+			}
 		};
 
 		if (loadedModuleFiles.indexOf(url) !== -1) {
@@ -178,6 +186,11 @@ var Loader = (function() {
 			script.onload = function() {
 				if (typeof callback === "function") {callback();}
 			};
+			script.onerror = function() {
+				console.error("Error on loading script:", fileName);
+				if (typeof callback === "function") {callback();}
+			};
+
 			document.getElementsByTagName("body")[0].appendChild(script);
 			break;
 		case "css":
@@ -189,6 +202,11 @@ var Loader = (function() {
 			stylesheet.onload = function() {
 				if (typeof callback === "function") {callback();}
 			};
+			stylesheet.onerror = function() {
+				console.error("Error on loading stylesheet:", fileName);
+				if (typeof callback === "function") {callback();}
+			};
+
 			document.getElementsByTagName("head")[0].appendChild(stylesheet);
 			break;
 		}

js/logger.js

@@ -13,35 +13,15 @@
 
 var Log = (function() {
 	return {
-		info: function(message) {
-			console.info(message);
-		},
-		log: function(message) {
-			console.log(message);
-		},
-		error: function(message) {
-			console.error(message);
-		},
-		warn: function(message) {
-			console.warn(message);	
-		},
-		group: function(message) {
-			console.group(message);	
-		},
-		groupCollapsed: function(message) {
-			console.groupCollapsed(message);
-		},
-		groupEnd: function() {
-			console.groupEnd();
-		},
-		time: function(message) {
-			console.time(message);
-		},
-		timeEnd: function(message) {
-			console.timeEnd(message);
-		},
-		timeStamp: function(message) {
-			console.timeStamp(message);
-		}
+		info: Function.prototype.bind.call(console.info, console),
+		log:  Function.prototype.bind.call(console.log, console),
+		error: Function.prototype.bind.call(console.error, console),
+		warn: Function.prototype.bind.call(console.warn, console),
+		group: Function.prototype.bind.call(console.group, console),
+		groupCollapsed: Function.prototype.bind.call(console.groupCollapsed, console),
+		groupEnd: Function.prototype.bind.call(console.groupEnd, console),
+		time: Function.prototype.bind.call(console.time, console),
+		timeEnd: Function.prototype.bind.call(console.timeEnd, console),
+		timeStamp: Function.prototype.bind.call(console.timeStamp, console)
 	};
 })();

js/main.js

@@ -40,6 +40,7 @@ var MM = (function() {
 				if (typeof module.data.header !== "undefined" && module.data.header !== "") {
 					var moduleHeader = document.createElement("header");
 					moduleHeader.innerHTML = module.data.header;
+					moduleHeader.className = "module-header";
 					dom.appendChild(moduleHeader);
 				}
 
@@ -51,6 +52,8 @@ var MM = (function() {
 			}
 		}
 
+		updateWrapperStates();
+
 		sendNotification("DOM_OBJECTS_CREATED");
 	};
 
@@ -63,7 +66,7 @@ var MM = (function() {
 		var classes = position.replace("_"," ");
 		var parentWrapper = document.getElementsByClassName(classes);
 		if (parentWrapper.length > 0) {
-			var wrapper =  parentWrapper[0].getElementsByClassName("container");
+			var wrapper = parentWrapper[0].getElementsByClassName("container");
 			if (wrapper.length > 0) {
 				return wrapper[0];
 			}
@@ -73,7 +76,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.
 	 */
@@ -94,26 +97,27 @@ var MM = (function() {
 	 */
 	var updateDom = function(module, speed) {
 		var newContent = module.getDom();
+		var newHeader = module.getHeader();
 
 		if (!module.hidden) {
 
-			if (!moduleNeedsUpdate(module, newContent)) {
+			if (!moduleNeedsUpdate(module, newHeader, newContent)) {
 				return;
 			}
 
 			if (!speed) {
-				updateModuleContent(module, newContent);
+				updateModuleContent(module, newHeader, newContent);
 				return;
 			}
 
 			hideModule(module, speed / 2, function() {
-				updateModuleContent(module, newContent);
+				updateModuleContent(module, newHeader, newContent);
 				if (!module.hidden) {
 					showModule(module, speed / 2);
 				}
 			});
 		} else {
-			updateModuleContent(module, newContent);
+			updateModuleContent(module, newHeader, newContent);
 		}
 	};
 
@@ -125,14 +129,23 @@ var MM = (function() {
 	 *
 	 * return bool - Does the module need an update?
 	 */
-	var moduleNeedsUpdate = function(module, newContent) {
+	var moduleNeedsUpdate = function(module, newHeader, newContent) {
 		var moduleWrapper = document.getElementById(module.identifier);
-		var contentWrapper = moduleWrapper.getElementsByClassName("module-content")[0];
+		var contentWrapper = moduleWrapper.getElementsByClassName("module-content");
+		var headerWrapper = moduleWrapper.getElementsByClassName("module-header");
 
-		var tempWrapper = document.createElement("div");
-		tempWrapper.appendChild(newContent);
+		var headerNeedsUpdate = false;
+		var contentNeedsUpdate = false;
 
-		return tempWrapper.innerHTML !== contentWrapper.innerHTML;
+		if (headerWrapper.length > 0) {
+			headerNeedsUpdate = newHeader !== headerWrapper[0].innerHTML;
+		}
+
+		var tempContentWrapper = document.createElement("div");
+		tempContentWrapper.appendChild(newContent);
+		contentNeedsUpdate = tempContentWrapper.innerHTML !== contentWrapper[0].innerHTML;
+
+		return headerNeedsUpdate || contentNeedsUpdate;
 	};
 
 	/* moduleNeedsUpdate(module, newContent)
@@ -141,12 +154,19 @@ var MM = (function() {
 	 * argument module Module - The module to check.
 	 * argument newContent Domobject - The new content that is generated.
 	 */
-	var updateModuleContent = function(module, content) {
+	var updateModuleContent = function(module, newHeader, newContent) {
 		var moduleWrapper = document.getElementById(module.identifier);
-		var contentWrapper = moduleWrapper.getElementsByClassName("module-content")[0];
+		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;
+		}
+
 
-		contentWrapper.innerHTML = "";
-		contentWrapper.appendChild(content);
 	};
 
 	/* hideModule(module, speed, callback)
@@ -156,7 +176,17 @@ var MM = (function() {
 	 * argument speed Number - The speed of the hide animation.
 	 * argument callback function - Called when the animation is done.
 	 */
-	var hideModule = function(module, speed, callback) {
+	var hideModule = function(module, speed, callback, options) {
+		options = options || {};
+
+		// set lockString if set in options.
+		if (options.lockString) {
+			// Log.log("Has lockstring: " + options.lockString);
+			if (module.lockStrings.indexOf(options.lockString) === -1) {
+				module.lockStrings.push(options.lockString);
+			}
+		}
+
 		var moduleWrapper = document.getElementById(module.identifier);
 		if (moduleWrapper !== null) {
 			moduleWrapper.style.transition = "opacity " + speed / 1000 + "s";
@@ -165,10 +195,12 @@ var MM = (function() {
 			clearTimeout(module.showHideTimer);
 			module.showHideTimer = setTimeout(function() {
 				// To not take up any space, we just make the position absolute.
-				// since it"s fade out anyway, we can see it lay above or
+				// since it's fade out anyway, we can see it lay above or
 				// below other modules. This works way better than adjusting
 				// the .display property.
-				moduleWrapper.style.position = "absolute";
+				moduleWrapper.style.position = "fixed";
+
+				updateWrapperStates();
 
 				if (typeof callback === "function") { callback(); }
 			}, speed);
@@ -182,12 +214,42 @@ var MM = (function() {
 	 * argument speed Number - The speed of the show animation.
 	 * argument callback function - Called when the animation is done.
 	 */
-	var showModule = function(module, speed, callback) {
+	var showModule = function(module, speed, callback, options) {
+		options = options || {};
+
+		// remove lockString if set in options.
+		if (options.lockString) {
+			var index = module.lockStrings.indexOf(options.lockString)
+			if ( index !== -1) {
+				module.lockStrings.splice(index, 1);
+			}
+		}
+
+		// Check if there are no more lockstrings set, or the force option is set.
+		// Otherwise cancel show action.
+		if (module.lockStrings.length !== 0 && options.force !== true) {
+			Log.log("Will not show " + module.name + ". LockStrings active: " + module.lockStrings.join(","));
+			return;
+		}
+
+		module.hidden = false;
+
+		// If forced show, clean current lockstrings.
+		if (module.lockStrings.length !== 0 && options.force === true) {
+			Log.log("Force show of module: " + module.name);
+			module.lockStrings = [];
+		}
+
 		var moduleWrapper = document.getElementById(module.identifier);
 		if (moduleWrapper !== null) {
 			moduleWrapper.style.transition = "opacity " + speed / 1000 + "s";
 			// Restore the postition. See hideModule() for more info.
 			moduleWrapper.style.position = "static";
+
+			updateWrapperStates();
+
+			// Waiting for DOM-changes done in updateWrapperStates before we can start the animation.
+			var dummy = moduleWrapper.parentElement.parentElement.offsetHeight;
 			moduleWrapper.style.opacity = 1;
 
 			clearTimeout(module.showHideTimer);
@@ -198,6 +260,36 @@ var MM = (function() {
 		}
 	};
 
+	/* 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.
+	 *
+	 * Example:
+	 * If the top_bar only contains the update notification. And no update is available,
+	 * the update notification is hidden. The top bar still occupies space making for
+	 * 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"];
+
+		positions.forEach(function(position) {
+			var wrapper = selectWrapper(position);
+			var moduleWrappers = wrapper.getElementsByClassName("module");
+
+			var showWrapper = false;
+			Array.prototype.forEach.call(moduleWrappers, function(moduleWrapper) {
+				if (moduleWrapper.style.position == "" || moduleWrapper.style.position == "static") {
+					showWrapper = true;
+				}
+			});
+
+			wrapper.style.display = showWrapper ? "block" : "none";
+		});
+	};
+
 	/* loadConfig()
 	 * Loads the core config and combines it with de system defaults.
 	 */
@@ -208,7 +300,7 @@ var MM = (function() {
 			return;
 		}
 
-		config = Object.assign(defaults, config);
+		config = Object.assign({}, defaults, config);
 	};
 
 	/* setSelectionMethodsForModules()
@@ -219,43 +311,36 @@ var MM = (function() {
 	var setSelectionMethodsForModules = function(modules) {
 
 		/* withClass(className)
-		 * filters a collection of modules based on classname(s).
+		 * calls modulesByClass to filter modules with the specified classes.
 		 *
-		 * argument className string/array - one or multiple classnames. (array or space devided)
+		 * argument className string/array - one or multiple classnames. (array or space divided)
 		 *
 		 * return array - Filtered collection of modules.
 		 */
 		var withClass = function(className) {
-			var searchClasses = className;
-			if (typeof className === "string") {
-				searchClasses = className.split(" ");
-			}
-
-			var newModules = modules.filter(function(module) {
-				var classes = module.data.classes.toLowerCase().split(" ");
-
-				for (var c in searchClasses) {
-					var searchClass = searchClasses[c];
-					if (classes.indexOf(searchClass.toLowerCase()) !== -1) {
-						return true;
-					}
-				}
-
-				return false;
-			});
-
-			setSelectionMethodsForModules(newModules);
-			return newModules;
+			return modulesByClass(className, true);
 		};
 
 		/* exceptWithClass(className)
-		 * filters a collection of modules based on classname(s). (NOT)
+		 * calls modulesByClass to filter modules without the specified classes.
 		 *
-		 * argument className string/array - one or multiple classnames. (array or space devided)
+		 * argument className string/array - one or multiple classnames. (array or space divided)
 		 *
 		 * return array - Filtered collection of modules.
 		 */
 		var exceptWithClass  = function(className) {
+			return modulesByClass(className, false);
+		};
+
+		/* modulesByClass(className, include)
+		 * filters a collection of modules based on classname(s).
+		 *
+		 * argument className string/array - one or multiple classnames. (array or space divided)
+		 * argument include boolean - if the filter should include or exclude the modules with the specific classes.
+		 *
+		 * return array - Filtered collection of modules.
+		 */
+		var modulesByClass = function(className, include) {
 			var searchClasses = className;
 			if (typeof className === "string") {
 				searchClasses = className.split(" ");
@@ -267,11 +352,11 @@ var MM = (function() {
 				for (var c in searchClasses) {
 					var searchClass = searchClasses[c];
 					if (classes.indexOf(searchClass.toLowerCase()) !== -1) {
-						return false;
+						return include;
 					}
 				}
 
-				return true;
+				return !include;
 			});
 
 			setSelectionMethodsForModules(newModules);
@@ -401,10 +486,11 @@ var MM = (function() {
 		 * argument module Module - The module hide.
 		 * argument speed Number - The speed of the hide animation.
 		 * argument callback function - Called when the animation is done.
+		 * argument options object - Optional settings for the hide method.
 		 */
-		hideModule: function(module, speed, callback) {
+		hideModule: function(module, speed, callback, options) {
 			module.hidden = true;
-			hideModule(module, speed, callback);
+			hideModule(module, speed, callback, options);
 		},
 
 		/* showModule(module, speed, callback)
@@ -413,10 +499,11 @@ var MM = (function() {
 		 * argument module Module - The module show.
 		 * argument speed Number - The speed of the show animation.
 		 * argument callback function - Called when the animation is done.
+		 * argument options object - Optional settings for the hide method.
 		 */
-		showModule: function(module, speed, callback) {
-			module.hidden = false;
-			showModule(module, speed, callback);
+		showModule: function(module, speed, callback, options) {
+			// do not change module.hidden yet, only if we really show it later
+			showModule(module, speed, callback, options);
 		}
 	};
 

js/module.js

@@ -14,23 +14,30 @@ var Module = Class.extend({
 	 * All methods (and properties) below can be subclassed. *
 	 *********************************************************/
 
+	// Set the minimum MagicMirror module version for this module.
+	requiresVersion: "2.0.0",
+
 	// Module config defaults.
 	defaults: {},
 
 	// Timer reference used for showHide animation callbacks.
 	showHideTimer: null,
 
+	// Array to store lockStrings. These strings are used to lock
+	// visibility when hiding and showing module.
+	lockStrings: [],
+
 	/* init()
 	 * Is called when the module is instantiated.
 	 */
-	init: function() {
+	init: function () {
 		//Log.log(this.defaults);
 	},
 
 	/* start()
 	 * Is called when the module is started.
 	 */
-	start: function() {
+	start: function () {
 		Log.info("Starting module: " + this.name);
 	},
 
@@ -39,7 +46,7 @@ var Module = Class.extend({
 	 *
 	 * return Array<String> - An array with filenames.
 	 */
-	getScripts: function() {
+	getScripts: function () {
 		return [];
 	},
 
@@ -48,7 +55,7 @@ var Module = Class.extend({
 	 *
 	 * return Array<String> - An array with filenames.
 	 */
-	getStyles: function() {
+	getStyles: function () {
 		return [];
 	},
 
@@ -57,7 +64,7 @@ var Module = Class.extend({
 	 *
 	 * return Map<String, String> - A map with langKeys and filenames.
 	 */
-	getTranslations: function() {
+	getTranslations: function () {
 		return false;
 	},
 
@@ -67,7 +74,7 @@ var Module = Class.extend({
 	 *
 	 * return domobject - The dom to display.
 	 */
-	getDom: function() {
+	getDom: function () {
 		var nameWrapper = document.createElement("div");
 		var name = document.createTextNode(this.name);
 		nameWrapper.appendChild(name);
@@ -84,15 +91,26 @@ var Module = Class.extend({
 		return div;
 	},
 
+	/* getHeader()
+	 * This method generates the header string which needs to be displayed if a user has a header configured for this module.
+	 * This method is called by the Magic Mirror core, but only if the user has configured a default header for the module.
+	 * This method needs to be subclassed if the module wants to display modified headers on the mirror.
+	 *
+	 * return string - The header to display above the header.
+	 */
+	getHeader: function () {
+		return this.data.header;
+	},
+
 	/* notificationReceived(notification, payload, sender)
 	 * This method is called when a notification arrives.
 	 * This method is called by the Magic Mirror core.
 	 *
-	 * 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.
 	 */
-	notificationReceived: function(notification, payload, sender) {
+	notificationReceived: function (notification, payload, sender) {
 		if (sender) {
 			Log.log(this.name + " received a module notification: " + notification + " from sender: " + sender.name);
 		} else {
@@ -103,24 +121,24 @@ var Module = Class.extend({
 	/* socketNotificationReceived(notification, payload)
 	 * This method is called when a socket notification arrives.
 	 *
-	 * argument notification string - The identifier of the noitication.
+	 * argument notification string - The identifier of the notification.
 	 * argument payload mixed - The payload of the notification.
 	 */
-	socketNotificationReceived: function(notification, payload) {
+	socketNotificationReceived: function (notification, payload) {
 		Log.log(this.name + " received a socket notification: " + notification + " - Payload: " + payload);
 	},
 
 	/* suspend()
 	 * This method is called when a module is hidden.
 	 */
-	suspend: function() {
+	suspend: function () {
 		Log.log(this.name + " is suspended.");
 	},
 
 	/* resume()
 	 * This method is called when a module is shown.
 	 */
-	resume: function() {
+	resume: function () {
 		Log.log(this.name + " is resumed.");
 	},
 
@@ -133,7 +151,7 @@ var Module = Class.extend({
 	 *
 	 * argument data obejct - Module data.
 	 */
-	setData: function(data) {
+	setData: function (data) {
 		this.data = data;
 		this.name = data.name;
 		this.identifier = data.identifier;
@@ -147,21 +165,21 @@ var Module = Class.extend({
 	 *
 	 * argument config obejct - Module config.
 	 */
-	setConfig: function(config) {
-		this.config = Object.assign(this.defaults, config);
+	setConfig: function (config) {
+		this.config = Object.assign({}, this.defaults, config);
 	},
 
 	/* socket()
 	 * Returns a socket object. If it doesn"t exist, it"s created.
 	 * It also registers the notification callback.
 	 */
-	socket: function() {
+	socket: function () {
 		if (typeof this._socket === "undefined") {
 			this._socket = this._socket = new MMSocket(this.name);
 		}
 
 		var self = this;
-		this._socket.setNotificationCallback(function(notification, payload) {
+		this._socket.setNotificationCallback(function (notification, payload) {
 			self.socketNotificationReceived(notification, payload);
 		});
 
@@ -175,7 +193,7 @@ var Module = Class.extend({
 	 *
 	 * return string - File path.
 	 */
-	file: function(file) {
+	file: function (file) {
 		return this.data.path + "/" + file;
 	},
 
@@ -184,23 +202,8 @@ var Module = Class.extend({
 	 *
 	 * argument callback function - Function called when done.
 	 */
-	loadStyles: function(callback) {
-		var self = this;
-		var styles = this.getStyles();
-
-		var loadNextStyle = function() {
-			if (styles.length > 0) {
-				var nextStyle = styles[0];
-				Loader.loadFile(nextStyle, self, function() {
-					styles = styles.slice(1);
-					loadNextStyle();
-				});
-			} else {
-				callback();
-			}
-		};
-
-		loadNextStyle();
+	loadStyles: function (callback) {
+		this.loadDependencies("getStyles", callback);
 	},
 
 	/* loadScripts()
@@ -208,23 +211,33 @@ var Module = Class.extend({
 	 *
 	 * argument callback function - Function called when done.
 	 */
-	loadScripts: function(callback) {
-		var self = this;
-		var scripts = this.getScripts();
+	loadScripts: function (callback) {
+		this.loadDependencies("getScripts", callback);
+	},
 
-		var loadNextScript = function() {
-			if (scripts.length > 0) {
-				var nextScript = scripts[0];
-				Loader.loadFile(nextScript, self, function() {
-					scripts = scripts.slice(1);
-					loadNextScript();
+	/* loadDependencies(funcName, callback)
+	 * Helper method to load all dependencies.
+	 *
+	 * argument funcName string - Function name to call to get scripts or styles.
+	 * argument callback function - Function called when done.
+	 */
+	loadDependencies: function (funcName, callback) {
+		var self = this;
+		var dependencies = this[funcName]();
+
+		var loadNextDependency = function () {
+			if (dependencies.length > 0) {
+				var nextDependency = dependencies[0];
+				Loader.loadFile(nextDependency, self, function () {
+					dependencies = dependencies.slice(1);
+					loadNextDependency();
 				});
 			} else {
 				callback();
 			}
 		};
 
-		loadNextScript();
+		loadNextDependency();
 	},
 
 	/* loadScripts()
@@ -232,14 +245,14 @@ var Module = Class.extend({
 	 *
 	 * argument callback function - Function called when done.
 	 */
-	loadTranslations: function(callback) {
+	loadTranslations: function (callback) {
 		var self = this;
 		var translations = this.getTranslations();
 		var lang = config.language.toLowerCase();
 
 		// The variable `first` will contain the first
 		// defined translation after the following line.
-		for (var first in translations) {break;}
+		for (var first in translations) { break; }
 
 		if (translations) {
 			var translationFile = translations[lang] || undefined;
@@ -248,7 +261,7 @@ var Module = Class.extend({
 			// If a translation file is set, load it and then also load the fallback translation file.
 			// Otherwise only load the fallback translation file.
 			if (translationFile !== undefined && translationFile !== translationsFallbackFile) {
-				Translator.load(self, translationFile, false, function() {
+				Translator.load(self, translationFile, false, function () {
 					Translator.load(self, translationsFallbackFile, true, callback);
 				});
 			} else {
@@ -259,13 +272,13 @@ var Module = Class.extend({
 		}
 	},
 
- 	/* translate(key, defaultValue)
- 	 * Request the translation for a given key.
- 	 *
- 	 * argument key string - The key of the string to translage
-	 * argument defaultValue string - The default value if no translation was found. (Optional)
- 	 */
-	translate: function(key, defaultValue) {
+	/* translate(key, defaultValue)
+	 * Request the translation for a given key.
+	 *
+	 * argument key string - The key of the string to translage
+   * argument defaultValue string - The default value if no translation was found. (Optional)
+	 */
+	translate: function (key, defaultValue) {
 		return Translator.translate(this, key) || defaultValue || "";
 	},
 
@@ -274,27 +287,27 @@ var Module = Class.extend({
 	 *
 	 * argument speed Number - The speed of the animation. (Optional)
 	 */
-	updateDom: function(speed) {
+	updateDom: function (speed) {
 		MM.updateDom(this, speed);
 	},
 
 	/* sendNotification(notification, payload)
 	 * 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.
 	 */
-	sendNotification: function(notification, payload) {
+	sendNotification: function (notification, payload) {
 		MM.sendNotification(notification, payload, this);
 	},
 
 	/* sendSocketNotification(notification, payload)
 	 * Send a socket notification to the node helper.
 	 *
-	 * argument notification string - The identifier of the noitication.
+	 * argument notification string - The identifier of the notification.
 	 * argument payload mixed - The payload of the notification.
 	 */
-	sendSocketNotification: function(notification, payload) {
+	sendSocketNotification: function (notification, payload) {
 		this.socket().sendNotification(notification, payload);
 	},
 
@@ -303,15 +316,22 @@ var Module = Class.extend({
 	 *
 	 * argument speed Number - The speed of the hide animation.
 	 * argument callback function - Called when the animation is done.
+	 * argument options object - Optional settings for the hide method.
 	 */
-	hide: function(speed, callback) {
-		callback = callback || function() {};
+	hide: function (speed, callback, options) {
+		if (typeof callback === "object") {
+			options = callback;
+			callback = function () { };
+		}
+
+		callback = callback || function () { };
+		options = options || {};
 
 		var self = this;
-		MM.hideModule(self, speed, function() {
+		MM.hideModule(self, speed, function () {
 			self.suspend();
 			callback();
-		});
+		}, options);
 	},
 
 	/* showModule(module, speed, callback)
@@ -319,29 +339,29 @@ var Module = Class.extend({
 	 *
 	 * argument speed Number - The speed of the show animation.
 	 * argument callback function - Called when the animation is done.
+	 * argument options object - Optional settings for the hide method.
 	 */
-	show: function(speed, callback) {
+	show: function (speed, callback, options) {
+		if (typeof callback === "object") {
+			options = callback;
+			callback = function () { };
+		}
+
+		callback = callback || function () { };
+		options = options || {};
+
 		this.resume();
-		MM.showModule(this, speed, callback);
+		MM.showModule(this, speed, callback, options);
 	}
 });
 
 Module.definitions = {};
 
-Module.create = function(name) {
+Module.create = function (name) {
 
-	//Define the clone method for later use.
-	function cloneObject(obj) {
-		if (obj === null || typeof obj !== "object") {
-			return obj;
-		}
-
-		var temp = obj.constructor(); // give temp the original obj"s constructor
-		for (var key in obj) {
-			temp[key] = cloneObject(obj[key]);
-		}
-
-		return temp;
+	// Make sure module definition is available.
+	if (!Module.definitions[name]) {
+		return;
 	}
 
 	var moduleDefinition = Module.definitions[name];
@@ -354,7 +374,47 @@ Module.create = function(name) {
 
 };
 
-Module.register = function(name, moduleDefinition) {
+/* cmpVersions(a,b)
+* Compare two symantic version numbers and return the difference.
+*
+* argument a string - Version number a.
+* argument a string - Version number b.
+*/
+function cmpVersions(a, b) {
+	var i, diff;
+	var regExStrip0 = /(\.0+)+$/;
+	var segmentsA = a.replace(regExStrip0, "").split(".");
+	var segmentsB = b.replace(regExStrip0, "").split(".");
+	var l = Math.min(segmentsA.length, segmentsB.length);
+
+	for (i = 0; i < l; i++) {
+		diff = parseInt(segmentsA[i], 10) - parseInt(segmentsB[i], 10);
+		if (diff) {
+			return diff;
+		}
+	}
+	return segmentsA.length - segmentsB.length;
+}
+
+Module.register = function (name, moduleDefinition) {
+
+	if (moduleDefinition.requiresVersion) {
+		Log.log("Check MagicMirror version for module '" + name + "' - Minimum version:  " + moduleDefinition.requiresVersion + " - Current version: " + version);
+		if (cmpVersions(version, moduleDefinition.requiresVersion) >= 0) {
+			Log.log("Version is ok!");
+		} else {
+			Log.log("Version is incorrect. Skip module: '" + name + "'");
+			return;
+		}
+	}
 	Log.log("Module registered: " + name);
 	Module.definitions[name] = moduleDefinition;
 };
+
+if (typeof exports != "undefined") { // For testing purpose only
+	// A good a idea move the function cmpversions a helper file.
+	// It's used into other side.
+	exports._test = {
+		cmpVersions: cmpVersions
+	}
+}

js/server.js

@@ -10,21 +10,60 @@ 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");
+var helmet = require("helmet");
 
 var Server = function(config, callback) {
-	console.log("Starting server op port " + config.port + " ... ");
+	console.log("Starting server on port " + config.port + " ... ");
+
+	var port = config.port;
+	if (process.env.MM_PORT) {
+		port = process.env.MM_PORT;
+	}
+
+	console.log("Starting server op port " + port + " ... ");
+
+	server.listen(port, config.address ? config.address : null);
+
+	if (config.ipWhitelist instanceof Array && config.ipWhitelist.length == 0) {
+		console.info("You're using a full whitelist configuration to allow for all IPs")
+	}
+
+	app.use(function(req, res, next) {
+		var result = ipfilter(config.ipWhitelist, {mode: "allow", log: false})(req, res, function(err) {
+			if (err === undefined) {
+				return next();
+			}
+			console.log(err.message);
+			res.status(403).send("This device is not allowed to access your mirror. <br> Please check your config.js or config.js.sample to change this.");
+		});
+	});
+	app.use(helmet());
 
-	server.listen(config.port);
 	app.use("/js", express.static(__dirname));
-	app.use("/config", express.static(path.resolve(__dirname + "/../config")));
-	app.use("/css", express.static(path.resolve(__dirname + "/../css")));
-	app.use("/fonts", express.static(path.resolve(__dirname + "/../fonts")));
-	app.use("/modules", express.static(path.resolve(__dirname + "/../modules")));
-	app.use("/vendor", express.static(path.resolve(__dirname + "/../vendor")));
-	app.use("/translations", express.static(path.resolve(__dirname + "/../translations")));
+	var directories = ["/config", "/css", "/fonts", "/modules", "/vendor", "/translations", "/tests/configs"];
+	var directory;
+	for (i in directories) {
+		directory = directories[i];
+		app.use(directory, express.static(path.resolve(global.root_path + directory)));
+	}
+
+	app.get("/version", function(req,res) {
+		res.send(global.version);
+	});
 
 	app.get("/", function(req, res) {
-		res.sendFile(path.resolve(__dirname + "/../index.html"));
+		var html = fs.readFileSync(path.resolve(global.root_path + "/index.html"), {encoding: "utf8"});
+		html = html.replace("#VERSION#", global.version);
+
+		configFile = "config/config.js";
+		if (typeof(global.configuration_file) !== "undefined") {
+		    configFile = global.configuration_file;
+		}
+		html = html.replace("#CONFIG_FILE#", configFile);
+
+		res.send(html);
 	});
 
 	if (typeof callback === "function") {

js/utils.js

@@ -0,0 +1,18 @@
+/* exported Utils */
+/* Magic Mirror
+ * Utils
+ *
+ * By Rodrigo Ramírez Norambuena https://rodrigoramirez.com
+ * MIT Licensed.
+ */
+
+var colors = require("colors/safe");
+
+var Utils = {
+	colors: {
+		warn: colors.yellow,
+		error: colors.red
+	}
+};
+
+if (typeof module !== "undefined") {module.exports = Utils;}

jsconfig.json

@@ -0,0 +1,13 @@
+{
+	// See https://go.microsoft.com/fwlink/?LinkId=759670
+	// for the documentation about the jsconfig.json format
+	"compilerOptions": {
+		"target": "es6",
+		"module": "commonjs",
+		"allowSyntheticDefaultImports": true
+	},
+	"exclude": [
+		"modules",
+		"node_modules"
+	]
+}

modules/README.md

@@ -4,13 +4,13 @@ This document describes the way to develop your own MagicMirror² modules.
 
 ## Module structure
 
-All modules are loaded in de `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.
+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 subfoler. 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.
+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 whill be loaded by the node script. The node helper and module script can communicate with each other using an intergrated socket system.
+- **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 intergrated socket system.
 - **modulename/public** - Any files in this folder can be accesed via the browser on `/modulename/filename.ext`.
 - **modulename/anyfileorfolder** Any other file or folder in the module folder can be used by the core module script. For example: *modulename/css/modulename.css* would be a good path for your additional module styles.
 
@@ -78,11 +78,39 @@ The data object contains additional metadata about the module instance:
 ####`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's 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 an 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:
 
@@ -104,7 +132,7 @@ The getScripts method is called to request any additional scripts that need to b
 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 avialable in 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.
 	]
@@ -154,7 +182,7 @@ getTranslations: function() {
 ####`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 therefor return a 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
@@ -166,6 +194,23 @@ getDom: function() {
 
 ````
 
+####`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:
@@ -185,7 +230,7 @@ notificationReceived: function(notification, payload, sender) {
 }
 ````
 
-**Note:** the system sends two notifiations when starting up. These notifications could come in handy!
+**Note:** the system sends two 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.
@@ -198,8 +243,8 @@ When using a node_helper, the node helper can send your module notifications. Wh
 - `notification` - String - The notification identifier.
 - `payload` - AnyType - The payload of a notification.
 
-**Note 1:** When a node helper send 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 it's first message using [sendSocketNotification](thissendsocketnotificationnotification-payload).
+**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
@@ -217,7 +262,7 @@ When a module will be shown after it was previously hidden (using the `module.sh
 
 ### Module instance methods
 
-Each module instance has some handy methods which can be helpfull building your module.
+Each module instance has some handy methods which can be helpful building your module.
 
 
 ####`this.file(filename)`
@@ -229,7 +274,7 @@ If you want to create a path to a file in your module folder, use the `file()` m
 ####`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 it's dom object. If you define the speed, the content update will be animated, but only if the content will realy change.
+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:
 
@@ -248,7 +293,7 @@ start: function() {
 ***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 automaticly set to the instance calling the sendNotification method.
+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
@@ -259,33 +304,103 @@ this.sendNotification('MYMODULE_READY_FOR_ACTION', {foo:bar});
 ***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 recieve the socket notification.
+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)`
-***speed* Number** - Optional, The speed of the hide animation in milliseconds.
+####`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.
 
-To hide a module, you can call the `hide(speed, callback)` method. You can call the hide method on the module instance itselve using `this.hide()`, but of course you can also hide an other module using `anOtherModule.hide()`.
 
 **Note 1:** If the hide animation is canceled, 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)`
-***speed* Number** - Optional, The speed of the show animation in milliseconds.
-***callback* Function** - Optional, The callback after the show animation is finished.
 
-To show a module, you can call the `show(speed, callback)` method. You can call the show method on the module instance itselve using `this.show()`, but of course you can also show an other module using `anOtherModule.show()`.
+####`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.*)
+
+Visiblity 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.
 
@@ -328,7 +443,7 @@ var NodeHelper = require("node_helper");
 module.exports = NodeHelper.create({});
 ````
 
-Of course, the above helper would not do anything usefull. So with the information above, you should be able to make it a bit more sophisticated.
+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
 
@@ -356,7 +471,7 @@ start: function() {
 }
 ````
 
-**Note: ** By default, a public path to your module's public folder will be created:
+**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"));
 ````
@@ -366,13 +481,26 @@ this.expressApp.use("/" + this.name, express.static(this.path + "/public"));
 
 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 helper are loaded an the system is ready to boot up. The start method is a perfect place to define any additional module properties:
+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
@@ -383,12 +511,12 @@ start: function() {
 ````
 
 ####`socketNotificationReceived: function(notification, payload)`
-With this method, your node helper can receive notifications form your modules. When this method is called, it has 2 arguments:
+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 it's first message using [sendSocketNotification](thissendsocketnotificationnotification-payload).
+**Note:** The socket connection is established as soon as the module sends its first message using [sendSocketNotification](thissendsocketnotificationnotification-payload).
 
 **Example:**
 ````javascript
@@ -399,15 +527,15 @@ socketNotificationReceived: function(notification, payload) {
 
 ### Module instance methods
 
-Each node helper has some handy methods which can be helpfull building your module.
+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 recieve the socket notification.
+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 you module will receive the notifications, it's your task to make sure the right module responds to your messages.
+**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
@@ -430,10 +558,10 @@ To make a selection of all currently loaded module instances, run the `MM.getMod
 
 
 #####`.withClass(classnames)`
-***classnames* String or Array** - The class names on which you want to filer.
+***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 ore 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.
+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
@@ -459,7 +587,7 @@ var modules = MM.getModules().exceptWithClass(['classname1','classname2']);
 ***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 helpfull if you want to select all module instances except the instance of your module.
+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

modules/default/alert/README.md

@@ -7,10 +7,10 @@ To use this module, add it to the modules array in the config/config.js file:
 ```
 modules: [
 	{
-		module: 'alert',
+		module: "alert",
 		config: {
 			// The config property is optional.
-			// See 'Configuration options' for more information. 
+			// See 'Configuration options' for more information.
 		}
 	}
 ]
@@ -21,145 +21,44 @@ modules: [
 The following properties can be configured:
 
 
-<table width="100%">
-	<!-- why, markdown... -->
-	<thead>
-		<tr>
-			<th>Option</th>
-			<th width="100%">Description</th>
-		</tr>
-	<thead>
-	<tbody>
-		<tr>
-			<td><code>effect</code></td>
-			<td>The animation effect to use for notifications.<br>
-				<br><b>Possible values:</b> <code>scale</code> <code>slide</code> <code>genie</code> <code>jelly</code> <code>flip</code> <code>exploader</code> <code>bouncyflip</code>
-				<br><b>Default value:</b> <code>slide</code>
-			</td>
-		</tr>
-		<td><code>alert_effect</code></td>
-			<td>The animation effect to use for alerts.<br>
-				<br><b>Possible values:</b> <code>scale</code> <code>slide</code> <code>genie</code> <code>jelly</code> <code>flip</code> <code>exploader</code> <code>bouncyflip</code>
-				<br><b>Default value:</b> <code>jelly</code>
-			</td>
-		</tr>
-		<tr>
-			<td><code>display_time</code></td>
-			<td>Time a notification is displayed in seconds.<br>
-				<br><b>Possible values:</b> <code>float</code> <code>int</code>
-				<br><b>Default value:</b> <code>3.5</code>
-			</td>
-		</tr>
-		<tr>
-		<tr>
-			<td><code>position</code></td>
-			<td>Position where the notifications should be displayed.<br>
-				<br><b>Possible values:</b> <code>left</code> <code>center</code> <code>right</code>
-				<br><b>Default value:</b> <code>center</code>
-			</td>
-		</tr>
-		<tr>
-			<td><code>welcome_message</code></td>
-			<td>Message shown at startup.<br>
-				<br><b>Possible values:</b> <code>string</code> <code>false</code>
-				<br><b>Default value:</b> <code>Welcome, start was successfull!</code>
-			</td>
-		</tr>
-	</tbody>
-</table>
+| 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"}); 
+self.sendNotification("SHOW_ALERT", {type: "notification"});
 ```
 For alerts use:
 
 ```
-self.sendNotification("SHOW_ALERT", {}); 
+self.sendNotification("SHOW_ALERT", {});
 ```
 
 ### Notification params
-<table width="100%">
-	<!-- why, markdown... -->
-	<thead>
-		<tr>
-			<th>Option</th>
-			<th width="100%">Description</th>
-		</tr>
-	<thead>
-	<tbody>
-		<tr>
-			<td><code>title</code></td>
-			<td>The title of the notification.<br>
-				<br><b>Possible values:</b> <code>text</code> or <code>html</code>
-			</td>
-		</tr>
-		<tr>
-			<td><code>message</code></td>
-			<td>The message of the notification.<br>
-				<br><b>Possible values:</b> <code>text</code> or <code>html</code>
-			</td>
-		</tr>
-	</tbody>
-</table>
+| 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`
+
 
 ### Alert params
-<table width="100%">
-	<!-- why, markdown... -->
-	<thead>
-		<tr>
-			<th>Option</th>
-			<th width="100%">Description</th>
-		</tr>
-	<thead>
-	<tbody>
-		<tr>
-			<td><code>title</code></td>
-			<td>The title of the alert.<br>
-				<br><b>Possible values:</b> <code>text</code> or <code>html</code>
-			</td>
-		</tr>
-		<tr>
-			<td><code>message</code></td>
-			<td>The message of the alert.<br>
-				<br><b>Possible values:</b> <code>text</code> or <code>html</code>
-			</td>
-		</tr>
-		<tr>
-			<td><code>imageUrl</code> (optional)</td>
-			<td>Image to show in the alert<br>
-				<br><b>Possible values:</b> <code>url</code> <code>path</code>
-				<br><b>Default value:</b> <code>none</code>
-			</td>
-		</tr>
-		<tr>
-			<td><code>imageFA</code> (optional)</td>
-			<td>Font Awesome icon to show in the alert<br>
-				<br><b>Possible values:</b> See <a href="http://fontawesome.io/icons/" target="_blank">Font Awsome</a> website.
-				<br><b>Default value:</b> <code>none</code>
-			</td>
-		</tr>
-		<tr>
-			<td><code>imageHeight</code> (optional even with imageUrl set)</td>
-			<td>Height of the image<br>
-				<br><b>Possible values:</b> <code>intpx</code>
-				<br><b>Default value:</b> <code>80px</code>
-			</td>
-		</tr>
-		<tr>
-			<td><code>timer</code> (optional)</td>
-			<td>How long the alert should stay visible in ms.
-			<br><b>Important:</b> If you do not use the <code>timer</code>, it is your duty to hide the alert by using <code>self.sendNotification("HIDE_ALERT");</code>!<br>
-				<br><b>Possible values:</b> <code>int</code> <code>float</code>
-				<br><b>Default value:</b> <code>none</code>
-			</td>
-		</tr>
-	</tbody>
-</table>
+| 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 [ympanus.net](http://tympanus.net/codrops/licensing/) for license.
+See [ympanus.net](http://tympanus.net/codrops/licensing/) for license.

modules/default/alert/alert.js

@@ -35,7 +35,6 @@ Module.register("alert",{
 	},
 	show_notification: function(message) {
 		if (this.config.effect == "slide") {this.config.effect = this.config.effect + "-" + this.config.position;}
-		
 		msg = "";
 		if (message.title) {
 			msg += "<span class='thin' style='line-height: 35px; font-size:24px' color='#4A4A4A'>" + message.title + "</span>";
@@ -46,7 +45,7 @@ Module.register("alert",{
 			}
 			msg += "<span class='light' style='font-size:28px;line-height: 30px;'>" + message.message + "</span>";
 		}
-		
+
 		new NotificationFx({
 			message: msg,
 			layout: "growl",

modules/default/alert/translations/da.json

@@ -0,0 +1,4 @@
+{
+  "sysTitle": "MagicMirror Notifikation",
+  "welcome": "Velkommen, modulet er succesfuldt startet!"
+}

modules/default/alert/translations/es.json

@@ -0,0 +1,4 @@
+{
+  "sysTitle": "MagicMirror Notificaciones",
+  "welcome": "Bienvenido, ¡se iniciado correctamente!"
+}

modules/default/alert/translations/hu.json

@@ -0,0 +1,4 @@
+{
+  "sysTitle": "MagicMirror értesítés",
+  "welcome": "Üdvözöljük, indulás sikeres!"
+}

modules/default/alert/translations/ru.json

@@ -0,0 +1,4 @@
+{
+  "sysTitle": "MagicMirror Уведомление",
+  "welcome": "Добро пожаловать, старт был успешным!"
+}

modules/default/calendar/README.md

@@ -8,8 +8,8 @@ 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.
+		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.
@@ -24,164 +24,66 @@ modules: [
 The following properties can be configured:
 
 
-<table width="100%">
-	<!-- why, markdown... -->
-	<thead>
-		<tr>
-			<th>Option</th>
-			<th width="100%">Description</th>
-		</tr>
-	<thead>
-	<tbody>
-		<tr>
-			<td><code>maximumEntries</code></td>
-			<td>The maximum number of events shown.<br>
-				<br><b>Possible values:</b> <code>0</code> - <code>100</code>
-				<br><b>Default value:</b> <code>10</code>
-			</td>
-		</tr>
-		<tr>
-			<td><code>maximumNumberOfDays</code></td>
-			<td>The maximum number of days in the future.<br>
-				<br><b>Default value:</b> <code>365</code>
-			</td>
-		</tr>
-		<tr>
-			<td><code>displaySymbol</code></td>
-			<td>Display a symbol in front of an entry.<br>
-				<br><b>Possible values:</b> <code>true</code> or <code>false</code>
-				<br><b>Default value:</b> <code>true</code>
-			</td>
-		</tr>
-		<tr>
-			<td><code>defaultSymbol</code></td>
-			<td>The default symbol.<br>
-				<br><b>Possible values:</b> See <a href="http://fontawesome.io/icons/" target="_blank">Font Awsome</a> website.
-				<br><b>Default value:</b> <code>calendar</code>
-			</td>
-		</tr>
-		<tr>
-			<td><code>maxTitleLength</code></td>
-			<td>The maximum title length.<br>
-				<br><b>Possible values:</b> <code>10</code> - <code>50</code>
-				<br><b>Default value:</b> <code>25</code>
-			</td>
-		</tr>
-		<tr>
-			<td><code>fetchInterval</code></td>
-			<td>How often does the content needs to be fetched? (Milliseconds)<br>
-				<br><b>Possible values:</b> <code>1000</code> - <code>86400000</code>
-				<br><b>Default value:</b> <code>300000</code> (5 minutes)
-			</td>
-		</tr>
-		<tr>
-			<td><code>animationSpeed</code></td>
-			<td>Speed of the update animation. (Milliseconds)<br>
-				<br><b>Possible values:</b><code>0</code> - <code>5000</code>
-				<br><b>Default value:</b> <code>2000</code> (2 seconds)
-			</td>
-		</tr>
-		<tr>
-			<td><code>fade</code></td>
-			<td>Fade the future events to black. (Gradient)<br>
-				<br><b>Possible values:</b> <code>true</code> or <code>false</code>
-				<br><b>Default value:</b> <code>true</code>
-			</td>
-		</tr>
-		<tr>
-			<td><code>fadePoint</code></td>
-			<td>Where to start fade?<br>
-				<br><b>Possible values:</b> <code>0</code> (top of the list) - <code>1</code> (bottom of list)
-				<br><b>Default value:</b> <code>0.25</code>
-			</td>
-		</tr>
-		<tr>
-			<td><code>calendars</code></td>
-			<td>The list of calendars.<br>
-				<br><b>Possible values:</b> An array, see <i>calendar configuration</i> below.
-				<br><b>Default value:</b> <i>An example calendar.</i>
-			</td>
-		</tr>
-		<tr>
-			<td><code>titleReplace</code></td>
-			<td>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><b>Example:</b> <br>
-
-				<code>
-					titleReplace: {'Birthday of ' : '', 'foo':'bar'}
-				</code>
-			</td>
-		</tr>
-		<tr>
-			<td><code>displayRepeatingCountTitle</code></td>
-			<td>Show count title for yearly repeating events (e.g. "X. Birthday", "X. Anniversary")<br>
-				<br><b>Possible values:</b> <code>true</code> or <code>false</code>
-				<br><b>Default value:</b> <code>false</code>
-			</td>
-		</tr>
-		<tr>
-			<td><code>timeFormat</code></td>
-			<td>Display event times as absolute dates, or relative time<br>
-				<br><b>Possible values:</b> <code>absolute</code> or <code>relative</code>
-				<br><b>Default value:</b> <code>relative</code>
-			</td>
-		</tr>
-		<tr>
-			<td><code>urgency</code></td>
-			<td>When using a timeFormat of <code>absolute</code>, the <code>urgency</code> setting allows you to display events within a specific time frame as <code>relative</code>
-			    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><b>Possible values:</b> a positive integer representing the number of days for which you want a relative date, for example <code>7</code> (for 7 days)<br>
-				<br><b>Default value:</b> <code>0</code> (disabled)
-			</td>
-		</tr>
-	</tbody>
-</table>
+| 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`
+| `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`
+| `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)
+| `timeFormat`                 | Display event times as absolute dates, or relative time <br><br> **Possible values:** `absolute` or `relative` <br> **Default value:** `relative`
+| `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`
+| `excludedEvents`             | An array of words / phrases from event titles that will be excluded from being shown. <br><br> **Example:** `['Birthday', 'Hide This Event']` <br> **Default value:** `[]`
 
 ### 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.
 
 #### Default value:
 ````javascript
 config: {
+	colored: false,
 	calendars: [
 		{
 			url: 'http://www.calendarlabs.com/templates/ical/US-Holidays.ics',
 			symbol: 'calendar',
+			auth: {
+			    user: 'username',
+			    pass: 'superstrongpassword',
+			    method: 'basic'
+			}
 		},
 	],
 }
 ````
 
-
 #### Calendar configuration options:
-<table width="100%">
-	<!-- why, markdown... -->
-	<thead>
-		<tr>
-			<th>Option</th>
-			<th width="100%">Description</th>
-		</tr>
-	<thead>
-	<tbody>
-		<tr>
-			<td><code>url</code></td>
-			<td>The url of the calendar .ical. This property is required.<br>
-				<br><b>Possible values:</b> Any public accessble .ical calendar.
-			</td>
-		</tr>
-		<tr>
-			<td><code> symbol </code></td>
-			<td>The symbol to show in front of an event. This property is optional.<br>
-				<br><b>Possible values:</b> See <a href="http://fontawesome.io/icons/" target="_blank">Font Awsome</a> website.
-			</td>
-		</tr>
-		<tr>
-			<td><code> repeatingCountTitle </code></td>
-			<td>The count title for yearly repating events in this calendar. <br>
-				<br><b>Example:</b> <br>
-				<code>'Birthday'</code>
-			</td>
-		</tr>
-		</tbody>
-</table>
+| 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
+| `auth`                | The object containing options for authentication against the calendar.
+
+
+#### 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`

modules/default/calendar/calendar.js

@@ -7,7 +7,7 @@
  * MIT Licensed.
  */
 
-Module.register("calendar",{
+Module.register("calendar", {
 
 	// Define module defaults
 	defaults: {
@@ -16,14 +16,18 @@ Module.register("calendar",{
 		displaySymbol: true,
 		defaultSymbol: "calendar", // Fontawesome Symbol see http://fontawesome.io/cheatsheet/
 		displayRepeatingCountTitle: false,
-		defaultRepeatingCountTitle: '',
+		defaultRepeatingCountTitle: "",
 		maxTitleLength: 25,
 		fetchInterval: 5 * 60 * 1000, // Update every 5 minutes.
 		animationSpeed: 2000,
 		fade: true,
 		urgency: 7,
 		timeFormat: "relative",
+		dateFormat: "MMM Do",
+		getRelative: 6,
 		fadePoint: 0.25, // Start on 1/4th of the list.
+		hidePrivate: false,
+		colored: false,
 		calendars: [
 			{
 				symbol: "calendar",
@@ -34,28 +38,30 @@ Module.register("calendar",{
 			"De verjaardag van ": "",
 			"'s birthday": ""
 		},
+		broadcastEvents: true,
+		excludedEvents: []
 	},
 
 	// Define required scripts.
-	getStyles: function() {
+	getStyles: function () {
 		return ["calendar.css", "font-awesome.css"];
 	},
 
 	// Define required scripts.
-	getScripts: function() {
+	getScripts: function () {
 		return ["moment.js"];
 	},
 
 	// Define required translations.
-	getTranslations: function() {
-		// The translations for the defaut modules are defined in the core translation files.
-		// Therefor we can just return false. Otherwise we should have returned a dictionairy.
+	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 your own module including translations, check out the documentation.
 		return false;
 	},
 
 	// Override start method.
-	start: function() {
+	start: function () {
 		Log.log("Starting module: " + this.name);
 
 		// Set locale.
@@ -64,7 +70,21 @@ Module.register("calendar",{
 		for (var c in this.config.calendars) {
 			var calendar = this.config.calendars[c];
 			calendar.url = calendar.url.replace("webcal://", "http://");
-			this.addCalendar(calendar.url);
+
+			var calendarConfig = {
+				maximumEntries: calendar.maximumEntries,
+				maximumNumberOfDays: calendar.maximumNumberOfDays
+			};
+
+			// we check user and password here for backwards compatibility with old configs
+			if(calendar.user && calendar.pass){
+				calendar.auth = {
+					user: calendar.user,
+					pass: calendar.pass
+				}
+			}
+
+			this.addCalendar(calendar.url, calendar.auth, calendarConfig);
 		}
 
 		this.calendarData = {};
@@ -72,11 +92,15 @@ Module.register("calendar",{
 	},
 
 	// Override socket notification handler.
-	socketNotificationReceived: function(notification, payload) {
+	socketNotificationReceived: function (notification, payload) {
 		if (notification === "CALENDAR_EVENTS") {
 			if (this.hasCalendarURL(payload.url)) {
 				this.calendarData[payload.url] = payload.events;
 				this.loaded = true;
+
+				if (this.config.broadcastEvents) {
+					this.broadcastEvents();
+				}
 			}
 		} else if (notification === "FETCH_ERROR") {
 			Log.error("Calendar Error. Could not fetch calendar: " + payload.url);
@@ -90,7 +114,7 @@ Module.register("calendar",{
 	},
 
 	// Override dom generator.
-	getDom: function() {
+	getDom: function () {
 
 		var events = this.createEventList();
 		var wrapper = document.createElement("table");
@@ -105,51 +129,91 @@ Module.register("calendar",{
 		for (var e in events) {
 			var event = events[e];
 
+			var excluded = false;
+			for (var f in this.config.excludedEvents) {
+				var filter = this.config.excludedEvents[f];
+				if (event.title.toLowerCase().includes(filter.toLowerCase())) {
+					excluded = true;
+					break;
+				}
+			}
+
+			if (excluded) {
+				continue;
+			}
+
 			var eventWrapper = document.createElement("tr");
+
+			if (this.config.colored) {
+				eventWrapper.style.cssText = "color:" + this.colorForUrl(event.url);
+			}
+
 			eventWrapper.className = "normal";
 
 			if (this.config.displaySymbol) {
-				var symbolWrapper =  document.createElement("td");
-				symbolWrapper.className = "symbol";
-				var symbol =  document.createElement("span");
-				symbol.className = "fa fa-" + this.symbolForUrl(event.url);
-				symbolWrapper.appendChild(symbol);
+				var symbolWrapper = document.createElement("td");
+				symbolWrapper.className = "symbol align-right";
+				var symbols = this.symbolsForUrl(event.url);
+				if(typeof symbols === "string") {
+					symbols = [symbols];
+				}
+
+				for(var i = 0; i < symbols.length; i++) {
+					var symbol = document.createElement("span");
+					symbol.className = "fa fa-" + symbols[i];
+					if(i > 0){
+						symbol.style.paddingLeft = "5px";
+					}
+					symbolWrapper.appendChild(symbol);
+				}
 				eventWrapper.appendChild(symbolWrapper);
 			}
 
 			var titleWrapper = document.createElement("td"),
-				repeatingCountTitle = '';
+				repeatingCountTitle = "";
 
 
 			if (this.config.displayRepeatingCountTitle) {
 
 				repeatingCountTitle = this.countTitleForUrl(event.url);
 
-				if(repeatingCountTitle !== '') {
-					var thisYear = new Date().getFullYear(),
+				if (repeatingCountTitle !== "") {
+					var thisYear = new Date(parseInt(event.startDate)).getFullYear(),
 						yearDiff = thisYear - event.firstYear;
 
-					repeatingCountTitle = ', '+ yearDiff + '. ' + repeatingCountTitle;
+					repeatingCountTitle = ", " + yearDiff + ". " + repeatingCountTitle;
 				}
 			}
 
 			titleWrapper.innerHTML = this.titleTransform(event.title) + repeatingCountTitle;
-			titleWrapper.className = "title bright";
+
+			if (!this.config.colored) {
+				titleWrapper.className = "title bright";
+			} else {
+				titleWrapper.className = "title";
+			}
+
 			eventWrapper.appendChild(titleWrapper);
 
-			var timeWrapper =  document.createElement("td");
+			var timeWrapper = document.createElement("td");
 			//console.log(event.today);
 			var now = new Date();
 			// Define second, minute, hour, and day variables
-			var one_second = 1000; // 1,000 milliseconds
-			var one_minute = one_second * 60;
-			var one_hour = one_minute * 60;
-			var one_day = one_hour * 24;
+			var oneSecond = 1000; // 1,000 milliseconds
+			var oneMinute = oneSecond * 60;
+			var oneHour = oneMinute * 60;
+			var oneDay = oneHour * 24;
 			if (event.fullDayEvent) {
 				if (event.today) {
-					timeWrapper.innerHTML = this.translate("TODAY");
-				} else if (event.startDate - now < one_day && event.startDate - now > 0) {
-					timeWrapper.innerHTML = this.translate("TOMORROW");
+					timeWrapper.innerHTML = this.capFirst(this.translate("TODAY"));
+				} else if (event.startDate - now < oneDay && event.startDate - now > 0) {
+					timeWrapper.innerHTML = this.capFirst(this.translate("TOMORROW"));
+				} else if (event.startDate - now < 2 * oneDay && event.startDate - now > 0) {
+					if (this.translate("DAYAFTERTOMORROW") !== "DAYAFTERTOMORROW") {
+						timeWrapper.innerHTML = this.capFirst(this.translate("DAYAFTERTOMORROW"));
+					} else {
+						timeWrapper.innerHTML = this.capFirst(moment(event.startDate, "x").fromNow());
+					}
 				} else {
 					/* Check to see if the user displays absolute or relative dates with their events
 					 * Also check to see if an event is happening within an 'urgency' time frameElement
@@ -159,26 +223,26 @@ Module.register("calendar",{
 					 * Note: this needs to be put in its own function, as the whole thing repeats again verbatim
 					 */
 					if (this.config.timeFormat === "absolute") {
-						if ((this.config.urgency > 1) && (event.startDate - now < (this.config.urgency * one_day))) {
+						if ((this.config.urgency > 1) && (event.startDate - now < (this.config.urgency * oneDay))) {
 							// This event falls within the config.urgency period that the user has set
-							timeWrapper.innerHTML = moment(event.startDate, "x").fromNow();
+							timeWrapper.innerHTML = this.capFirst(moment(event.startDate, "x").fromNow());
 						} else {
-							timeWrapper.innerHTML = moment(event.startDate, "x").format("MMM Do");
+							timeWrapper.innerHTML = this.capFirst(moment(event.startDate, "x").format(this.config.dateFormat));
 						}
 					} else {
-						timeWrapper.innerHTML =  moment(event.startDate, "x").fromNow();
+						timeWrapper.innerHTML = this.capFirst(moment(event.startDate, "x").fromNow());
 					}
 				}
 			} else {
 				if (event.startDate >= new Date()) {
-					if (event.startDate - now < 2 * one_day) {
+					if (event.startDate - now < 2 * oneDay) {
 						// This event is within the next 48 hours (2 days)
-						if (event.startDate - now < 6 * one_hour) {
+						if (event.startDate - now < this.config.getRelative * oneHour) {
 							// If event is within 6 hour, display 'in xxx' time format or moment.fromNow()
-							timeWrapper.innerHTML = moment(event.startDate, "x").fromNow();
+							timeWrapper.innerHTML = this.capFirst(moment(event.startDate, "x").fromNow());
 						} else {
 							// Otherwise just say 'Today/Tomorrow at such-n-such time'
-							timeWrapper.innerHTML = moment(event.startDate, "x").calendar();
+							timeWrapper.innerHTML = this.capFirst(moment(event.startDate, "x").calendar());
 						}
 					} else {
 						/* Check to see if the user displays absolute or relative dates with their events
@@ -189,18 +253,18 @@ Module.register("calendar",{
 						 * Note: this needs to be put in its own function, as the whole thing repeats again verbatim
 						 */
 						if (this.config.timeFormat === "absolute") {
-							if ((this.config.urgency > 1) && (event.startDate - now < (this.config.urgency * one_day))) {
+							if ((this.config.urgency > 1) && (event.startDate - now < (this.config.urgency * oneDay))) {
 								// This event falls within the config.urgency period that the user has set
-								timeWrapper.innerHTML = moment(event.startDate, "x").fromNow();
+								timeWrapper.innerHTML = this.capFirst(moment(event.startDate, "x").fromNow());
 							} else {
-								timeWrapper.innerHTML = moment(event.startDate, "x").format("MMM Do");
+								timeWrapper.innerHTML = this.capFirst(moment(event.startDate, "x").format(this.config.dateFormat));
 							}
 						} else {
-							timeWrapper.innerHTML = moment(event.startDate, "x").fromNow();
+							timeWrapper.innerHTML = this.capFirst(moment(event.startDate, "x").fromNow());
 						}
 					}
 				} else {
-					timeWrapper.innerHTML =  this.translate("RUNNING") + ' ' + moment(event.endDate,"x").fromNow(true);
+					timeWrapper.innerHTML = this.capFirst(this.translate("RUNNING")) + " " + moment(event.endDate, "x").fromNow(true);
 				}
 			}
 			//timeWrapper.innerHTML += ' - '+ moment(event.startDate,'x').format('lll');
@@ -230,11 +294,11 @@ Module.register("calendar",{
 	/* hasCalendarURL(url)
 	 * Check if this config contains the calendar url.
 	 *
-	 * argument url sting - Url to look for.
+	 * argument url string - Url to look for.
 	 *
 	 * return bool - Has calendar url
 	 */
-	hasCalendarURL: function(url) {
+	hasCalendarURL: function (url) {
 		for (var c in this.config.calendars) {
 			var calendar = this.config.calendars[c];
 			if (calendar.url === url) {
@@ -250,20 +314,26 @@ Module.register("calendar",{
 	 *
 	 * return array - Array with events.
 	 */
-	createEventList: function() {
+	createEventList: function () {
 		var events = [];
 		var today = moment().startOf("day");
 		for (var c in this.calendarData) {
 			var calendar = this.calendarData[c];
 			for (var e in calendar) {
 				var event = calendar[e];
+				if(this.config.hidePrivate) {
+					if(event.class === "PRIVATE") {
+						  // do not add the current event, skip it
+						  continue;
+					}
+				}
 				event.url = c;
 				event.today = event.startDate >= today && event.startDate < (today + 24 * 60 * 60 * 1000);
 				events.push(event);
 			}
 		}
 
-		events.sort(function(a, b) {
+		events.sort(function (a, b) {
 			return a.startDate - b.startDate;
 		});
 
@@ -273,69 +343,97 @@ Module.register("calendar",{
 	/* createEventList(url)
 	 * Requests node helper to add calendar url.
 	 *
-	 * argument url sting - Url to add.
+	 * argument url string - Url to add.
 	 */
-	addCalendar: function(url) {
+	addCalendar: function (url, auth, calendarConfig) {
 		this.sendSocketNotification("ADD_CALENDAR", {
 			url: url,
-			maximumEntries: this.config.maximumEntries,
-			maximumNumberOfDays: this.config.maximumNumberOfDays,
-			fetchInterval: this.config.fetchInterval
+			maximumEntries: calendarConfig.maximumEntries || this.config.maximumEntries,
+			maximumNumberOfDays: calendarConfig.maximumNumberOfDays || this.config.maximumNumberOfDays,
+			fetchInterval: this.config.fetchInterval,
+			auth: auth
 		});
 	},
 
-	/* symbolForUrl(url)
-	 * Retrieves the symbol for a specific url.
+	/* symbolsForUrl(url)
+	 * Retrieves the symbols for a specific url.
 	 *
-	 * argument url sting - Url to look for.
+	 * argument url string - Url to look for.
 	 *
-	 * return string - The Symbol
+	 * return string/array - The Symbols
 	 */
-	symbolForUrl: function(url) {
-		for (var c in this.config.calendars) {
-			var calendar = this.config.calendars[c];
-			if (calendar.url === url && typeof calendar.symbol === "string")  {
-				return calendar.symbol;
-			}
-		}
-
-		return this.config.defaultSymbol;
+	symbolsForUrl: function (url) {
+		return this.getCalendarProperty(url, "symbol", this.config.defaultSymbol);
 	},
+
+	/* colorForUrl(url)
+	 * Retrieves the color for a specific url.
+	 *
+	 * argument url string - Url to look for.
+	 *
+	 * return string - The Color
+	 */
+	colorForUrl: function (url) {
+		return this.getCalendarProperty(url, "color", "#fff");
+	},
+
 	/* countTitleForUrl(url)
 	 * Retrieves the name for a specific url.
 	 *
-	 * argument url sting - Url to look for.
+	 * argument url string - Url to look for.
 	 *
 	 * return string - The Symbol
 	 */
-	countTitleForUrl: function(url) {
+	countTitleForUrl: function (url) {
+		return this.getCalendarProperty(url, "repeatingCountTitle", this.config.defaultRepeatingCountTitle);
+	},
+
+	/* getCalendarProperty(url, property, defaultValue)
+	 * Helper method to retrieve the property for a specific url.
+	 *
+	 * argument url string - Url to look for.
+	 * argument property string - Property to look for.
+	 * argument defaultValue string - Value if property is not found.
+	 *
+	 * return string - The Property
+	 */
+	getCalendarProperty: function (url, property, defaultValue) {
 		for (var c in this.config.calendars) {
 			var calendar = this.config.calendars[c];
-			if (calendar.url === url && typeof calendar.repeatingCountTitle === "string")  {
-				return calendar.repeatingCountTitle;
+			if (calendar.url === url && calendar.hasOwnProperty(property)) {
+				return calendar[property];
 			}
 		}
 
-		return this.config.defaultRepeatingCountTitle;
+		return defaultValue;
 	},
 
 	/* shorten(string, maxLength)
-	 * Shortens a sting if it's longer than maxLenthg.
+	 * Shortens a string if it's longer than maxLength.
 	 * Adds an ellipsis to the end.
 	 *
 	 * argument string string - The string to shorten.
-	 * argument maxLength number - The max lenth of the string.
+	 * argument maxLength number - The max length of the string.
 	 *
 	 * return string - The shortened string.
 	 */
-	shorten: function(string, maxLength) {
+	shorten: function (string, maxLength) {
 		if (string.length > maxLength) {
-			return string.slice(0,maxLength) + "&hellip;";
+			return string.slice(0, maxLength) + "&hellip;";
 		}
 
 		return string;
 	},
 
+	/* capFirst(string)
+	 * Capitalize the first letter of a string
+	 * Return capitalized string
+	 */
+
+	capFirst: function (string) {
+		return string.charAt(0).toUpperCase() + string.slice(1);
+	},
+
 	/* titleTransform(title)
 	 * Transforms the title of an event for usage.
 	 * Replaces parts of the text as defined in config.titleReplace.
@@ -345,13 +443,43 @@ Module.register("calendar",{
 	 *
 	 * return string - The transformed title.
 	 */
-	titleTransform: function(title) {
+	titleTransform: function (title) {
 		for (var needle in this.config.titleReplace) {
 			var replacement = this.config.titleReplace[needle];
+
+			var regParts = needle.match(/^\/(.+)\/([gim]*)$/);
+			if (regParts) {
+			  // the parsed pattern is a regexp.
+			  needle = new RegExp(regParts[1], regParts[2]);
+			}
+
 			title = title.replace(needle, replacement);
 		}
 
 		title = this.shorten(title, this.config.maxTitleLength);
 		return title;
+	},
+
+	/* broadcastEvents()
+	 * Broadcasts the events to all other modules for reuse.
+	 * The all events available in one array, sorted on startdate.
+	 */
+	broadcastEvents: function () {
+		var eventList = [];
+		for (url in this.calendarData) {
+			var calendar = this.calendarData[url];
+			for (e in calendar) {
+				var event = cloneObject(calendar[e]);
+				delete event.url;
+				eventList.push(event);
+			}
+		}
+
+		eventList.sort(function(a,b) {
+			return a.startDate - b.startDate;
+		});
+
+		this.sendNotification("CALENDAR_EVENTS", eventList);
+
 	}
 });

modules/default/calendar/calendarfetcher.js

@@ -8,7 +8,7 @@
 var ical = require("./vendor/ical.js");
 var moment = require("moment");
 
-var CalendarFetcher = function(url, reloadInterval, maximumEntries, maximumNumberOfDays) {
+var CalendarFetcher = function(url, reloadInterval, maximumEntries, maximumNumberOfDays, auth) {
 	var self = this;
 
 	var reloadTimer = null;
@@ -25,11 +25,33 @@ var CalendarFetcher = function(url, reloadInterval, maximumEntries, maximumNumbe
 		clearTimeout(reloadTimer);
 		reloadTimer = null;
 
+		nodeVersion = Number(process.version.match(/^v(\d+\.\d+)/)[1]);
 		var opts = {
 			headers: {
-				'User-Agent': 'Mozilla/5.0 (Node.js 6.0.0) MagicMirror/v2 (https://github.com/MichMich/MagicMirror/)'
+				"User-Agent": "Mozilla/5.0 (Node.js "+ nodeVersion + ") MagicMirror/"  + global.version +  " (https://github.com/MichMich/MagicMirror/)"
+			}
+		};
+
+		if (auth) {
+			if(auth.method === "bearer"){
+				opts.auth = {
+					bearer: auth.pass
+				}
+
+			}else{
+				opts.auth = {
+					user: auth.user,
+					pass: auth.pass
+				};
+
+				if(auth.method === "digest"){
+					opts.auth.sendImmediately = false;
+				}else{
+					opts.auth.sendImmediately = true;
+				}
 			}
 		}
+
 		ical.fromURL(url, opts, function(err, data) {
 			if (err) {
 				fetchFailedCallback(self, err);
@@ -37,11 +59,15 @@ var CalendarFetcher = function(url, reloadInterval, maximumEntries, maximumNumbe
 				return;
 			}
 
-			//console.log(data);
+			// console.log(data);
 			newEvents = [];
 
 			var limitFunction = function(date, i) {return i < maximumEntries;};
 
+			var eventDate = function(event, time) {
+				return (event[time].length === 8) ? moment(event[time], "YYYYMMDD") : moment(new Date(event[time]));
+			};
+
 			for (var e in data) {
 				var event = data[e];
 				var now = new Date();
@@ -60,18 +86,19 @@ var CalendarFetcher = function(url, reloadInterval, maximumEntries, maximumNumbe
 
 				if (event.type === "VEVENT") {
 
-					var startDate = (event.start.length === 8) ? moment(event.start, "YYYYMMDD") : moment(new Date(event.start));
+					var startDate = eventDate(event, "start");
 					var endDate;
 					if (typeof event.end !== "undefined") {
-						endDate = (event.end.length === 8) ? moment(event.end, "YYYYMMDD") : moment(new Date(event.end));
+						endDate = eventDate(event, "end");
 					} else {
 						if (!isFacebookBirthday) {
 							endDate = startDate;
 						} else {
-							endDate = moment(startDate).add(1, 'days');
+							endDate = moment(startDate).add(1, "days");
 						}
 					}
 
+
 					// calculate the duration f the event for use with recurring events.
 					var duration = parseInt(endDate.format("x")) - parseInt(startDate.format("x"));
 
@@ -86,20 +113,28 @@ var CalendarFetcher = function(url, reloadInterval, maximumEntries, maximumNumbe
 						title = event.description;
 					}
 
+					var location = event.location || false;
+					var geo = event.geo || false;
+					var description = event.description || false;
+
 					if (typeof event.rrule != "undefined" && !isFacebookBirthday) {
 						var rule = event.rrule;
 						var dates = rule.between(today, future, true, limitFunction);
 
 						for (var d in dates) {
 							startDate = moment(new Date(dates[d]));
-							endDate  = moment(parseInt(startDate.format("x")) + duration, 'x');
+							endDate  = moment(parseInt(startDate.format("x")) + duration, "x");
 							if (endDate.format("x") > now) {
 								newEvents.push({
 									title: title,
 									startDate: startDate.format("x"),
 									endDate: endDate.format("x"),
 									fullDayEvent: isFullDayEvent(event),
-									firstYear: event.start.getFullYear()
+									class: event.class,
+									firstYear: event.start.getFullYear(),
+									location: location,
+									geo: geo,
+									description: description
 								});
 							}
 						}
@@ -123,14 +158,19 @@ var CalendarFetcher = function(url, reloadInterval, maximumEntries, maximumNumbe
 							continue;
 						}
 
-						// Every thing is good. Add it to the list.					
+						// Every thing is good. Add it to the list.
+
 						newEvents.push({
 							title: title,
 							startDate: startDate.format("x"),
 							endDate: endDate.format("x"),
-							fullDayEvent: fullDayEvent
+							fullDayEvent: fullDayEvent,
+							class: event.class,
+							location: location,
+							geo: geo,
+							description: description
 						});
-						
+
 					}
 				}
 			}
@@ -177,7 +217,7 @@ var CalendarFetcher = function(url, reloadInterval, maximumEntries, maximumNumbe
 
 		if (end - start === 24 * 60 * 60 * 1000 && startDate.getHours() === 0 && startDate.getMinutes() === 0) {
 			// Is 24 hours, and starts on the middle of the night.
-			return true;			
+			return true;
 		}
 
 		return false;
@@ -239,4 +279,4 @@ var CalendarFetcher = function(url, reloadInterval, maximumEntries, maximumNumbe
 };
 
 
-module.exports = CalendarFetcher;
+module.exports = CalendarFetcher;

modules/default/calendar/debug.js

@@ -1,5 +1,5 @@
 /* CalendarFetcher Tester
- * use this script with `node debug.js` to test the fetcher without the need 
+ * use this script with `node debug.js` to test the fetcher without the need
  * of starting the MagicMirror core. Adjust the values below to your desire.
  *
  * By Michael Teeuw http://michaelteeuw.nl
@@ -8,18 +8,26 @@
 
 var CalendarFetcher = require("./calendarfetcher.js");
 
-var url = 'https://calendar.google.com/calendar/ical/pkm1t2uedjbp0uvq1o7oj1jouo%40group.calendar.google.com/private-08ba559f89eec70dd74bbd887d0a3598/basic.ics';
+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";
 
-console.log('Create fetcher ...');
+var auth = {
+	user: user,
+	pass: pass
+};
 
-fetcher = new CalendarFetcher(url, fetchInterval, maximumEntries, maximumNumberOfDays);
+console.log("Create fetcher ...");
+
+fetcher = new CalendarFetcher(url, fetchInterval, maximumEntries, maximumNumberOfDays, auth);
 
 fetcher.onReceive(function(fetcher) {
-	console.log(fetcher.events());	
-	console.log('------------------------------------------------------------');
+	console.log(fetcher.events());
+	console.log("------------------------------------------------------------");
 });
 
 fetcher.onError(function(fetcher, error) {
@@ -29,5 +37,4 @@ fetcher.onError(function(fetcher, error) {
 
 fetcher.startFetch();
 
-console.log('Create fetcher done! ');
-
+console.log("Create fetcher done! ");

modules/default/calendar/node_helper.js

@@ -12,7 +12,6 @@ var CalendarFetcher = require("./calendarfetcher.js");
 module.exports = NodeHelper.create({
 	// Override start method.
 	start: function() {
-		var self = this;
 		var events = [];
 
 		this.fetchers = [];
@@ -25,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.maximumEntries, payload.maximumNumberOfDays);
+			this.createFetcher(payload.url, payload.fetchInterval, payload.maximumEntries, payload.maximumNumberOfDays, payload.auth);
 		}
 	},
 
@@ -37,7 +36,7 @@ module.exports = NodeHelper.create({
 	 * attribute reloadInterval number - Reload interval in milliseconds.
 	 */
 
-	createFetcher: function(url, fetchInterval, maximumEntries, maximumNumberOfDays) {
+	createFetcher: function(url, fetchInterval, maximumEntries, maximumNumberOfDays, auth) {
 		var self = this;
 
 		if (!validUrl.isUri(url)) {
@@ -48,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, maximumEntries, maximumNumberOfDays);
+			fetcher = new CalendarFetcher(url, fetchInterval, maximumEntries, maximumNumberOfDays, auth);
 
 			fetcher.onReceive(function(fetcher) {
 				//console.log('Broadcast events.');

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

@@ -90,7 +90,6 @@
     return dt
   }
 
-
   var dateParam = function(name){
     return function(val, params, curr){
 
@@ -143,6 +142,16 @@
     }
   }
 
+  var exdateParam = function(name){
+    return function(val, params, curr){
+      var date = dateParam(name)(val, params, curr);
+      if (date.exdates === undefined) {
+        date.exdates = [];
+      }
+      date.exdates.push(date.exdate);
+      return date;
+    }
+  }
 
   var geoParam = function(name){
     return function(val, params, curr){
@@ -240,6 +249,7 @@
       , 'LOCATION' : storeParam('location')
       , 'DTSTART' : dateParam('start')
       , 'DTEND' : dateParam('end')
+      , 'EXDATE' : exdateParam('exdate')
       ,' CLASS' : storeParam('class')
       , 'TRANSP' : storeParam('transparency')
       , 'GEO' : geoParam('geo')

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

@@ -17,7 +17,8 @@ exports.parseFile = function(filename){
 }
 
 
-var rrule = require('rrule').RRule
+var rrule = require('rrule-alt').RRule
+var rrulestr = rrule.rrulestr
 
 ical.objectHandlers['RRULE'] = function(val, params, curr, stack, line){
   curr.rrule = line;
@@ -26,7 +27,7 @@ ical.objectHandlers['RRULE'] = function(val, params, curr, stack, line){
 var originalEnd = ical.objectHandlers['END'];
 ical.objectHandlers['END'] = function(val, params, curr, stack){
   if (curr.rrule) {
-    var rule = curr.rrule.replace('RRULE:', '');
+    var rule = curr.rrule;
     if (rule.indexOf('DTSTART') === -1) {
 
       if (curr.start.length === 8) {
@@ -36,10 +37,14 @@ ical.objectHandlers['END'] = function(val, params, curr, stack){
         }
       }
 
-      rule += ';DTSTART=' + curr.start.toISOString().replace(/[-:]/g, '');
+      rule += ' DTSTART:' + curr.start.toISOString().replace(/[-:]/g, '');
       rule = rule.replace(/\.[0-9]{3}/, '');
     }
-    curr.rrule = rrule.fromString(rule);
+    for (var i in curr.exdates) {
+      rule += ' EXDATE:' + curr.exdates[i].toISOString().replace(/[-:]/g, '');
+      rule = rule.replace(/\.[0-9]{3}/, '');
+    }
+    curr.rrule = rrulestr(rule);
   }
   return originalEnd.call(this, val, params, curr, stack);
 }

modules/default/clock/README.md

@@ -8,8 +8,8 @@ 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.
+		module: "clock",
+		position: "top_left",	// This can be any of the regions.
 		config: {
 			// The config property is optional.
 			// See 'Configuration options' for more information.
@@ -22,91 +22,20 @@ modules: [
 
 The following properties can be configured:
 
-<table width="100%">
-	<!-- why, markdown... -->
-	<thead>
-		<tr>
-			<th>Option</th>
-			<th width="100%">Description</th>
-		</tr>
-	<thead>
-	<tbody>
-		<tr>
-			<td><code>timeFormat</code></td>
-			<td>Use 12 or 24 hour format.<br>
-				<br><b>Possible values:</b> <code>12</code> or <code>24</code>
-				<br><b>Default value:</b> uses value of <i>config.timeFormat</i>
-			</td>
-		</tr>
-		<tr>
-			<td><code>displaySeconds</code></td>
-			<td>Display seconds.<br>
-				<br><b>Possible values:</b> <code>true</code> or <code>false</code>
-				<br><b>Default value:</b> <code>true</code>
-			</td>
-		</tr>
-		<tr>
-			<td><code>showPeriod</code></td>
-			<td>Show the period (am/pm) with 12 hour format.<br>
-				<br><b>Possible values:</b> <code>true</code> or <code>false</code>
-				<br><b>Default value:</b> <code>true</code>
-			</td>
-		</tr>
-		<tr>
-			<td><code>showPeriodUpper</code></td>
-			<td>Show the period (AM/PM) with 12 hour format as uppercase.<br>
-				<br><b>Possible values:</b> <code>true</code> or <code>false</code>
-				<br><b>Default value:</b> <code>false</code>
-			</td>
-		</tr>
-		<tr>
-			<td><code>clockBold</code></td>
-			<td>Remove the colon and bold the minutes to make a more modern look.<br>
-				<br><b>Possible values:</b> <code>true</code> or <code>false</code>
-				<br><b>Default value:</b> <code>false</code>
-			</td>
-		</tr>
-		<tr>
-			<td><code>displayType</code></td>
-			<td>Display a digital clock, analog clock, or both together.<br>
-				<br><b>Possible values:</b> <code>digital</code>, <code>analog</code>, or <code>both</code>
-				<br><b>Default value:</b> <code>digital</code>
-			</td>
-		</tr>
-		<tr>
-			<td><code>analogSize</code></td>
-			<td><strong>Specific to the analog clock.</strong> Defines how large the analog display is.<br>
-				<br><b>Possible values:</b> A positive number of pixels</code>
-				<br><b>Default value:</b> <code>200px</code>
-			</td>
-		</tr>
-		<tr>
-			<td><code>analogFace</code></td>
-			<td><strong>Specific to the analog clock.</strong> Specifies which clock face to use.<br>
-				<br><b>Possible values:</b> <code>simple</code> for a simple border, <code>none</code> for no face or border, or <code>face-###</code> (where ### is currently a value between 001 and 012, inclusive)
-				<br><b>Default value:</b> <code>simple</code>
-			</td>
-		</tr>
-		<tr>
-			<td><code>secondsColor</code></td>
-			<td><strong>Specific to the analog clock.</strong> Specifies what color to make the 'seconds' hand.<br>
-				<br><b>Possible values:</b> <code>any HTML RGB Color</code>
-				<br><b>Default value:</b> <code>#888888</code>
-			</td>
-		</tr>
-		<tr>
-			<td><code>analogPlacement</code></td>
-			<td><strong>Specific to the analog clock. <em>(requires displayType set to <code>'both'</code>)</em></strong> Specifies where the analog clock is in relation to the digital clock<br>
-				<br><b>Possible values:</b> <code>top</code>, <code>right</code>, <code>bottom</code>, or <code>left</code>
-				<br><b>Default value:</b> <code>bottom</code>
-			</td>
-		</tr>
-		<tr>
-			<td><code>analogShowDate</code></td>
-			<td><strong>Specific to the analog clock.</strong> 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><b>Possible values:</b> <code>false</code>, <code>top</code>, or <code>bottom</code>
-				<br><b>Default value:</b> <code>top</code>
-			</td>
-		</tr>
-	</tbody>
-</table>
+| 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/)

modules/default/clock/clock.js

@@ -8,24 +8,28 @@
 Module.register("clock",{
 	// Module config defaults.
 	defaults: {
-		displayType: 'digital', // options: digital, analog, both
+		displayType: "digital", // options: digital, analog, both
 
 		timeFormat: config.timeFormat,
 		displaySeconds: true,
 		showPeriod: true,
 		showPeriodUpper: false,
 		clockBold: false,
+		showDate: true,
+		showWeek: false,
+		dateFormat: "dddd, LL",
 
 		/* specific to the analog clock */
-		analogSize: '200px',
-		analogFace: 'simple', // options: 'none', 'simple', 'face-###' (where ### is 001 to 012 inclusive)
-		analogPlacement: 'bottom', // options: 'top', 'bottom', 'left', 'right'
-		analogShowDate: 'top', // options: false, 'top', or 'bottom'
-		secondsColor: '#888888',
+		analogSize: "200px",
+		analogFace: "simple", // options: 'none', 'simple', 'face-###' (where ### is 001 to 012 inclusive)
+		analogPlacement: "bottom", // options: 'top', 'bottom', 'left', 'right'
+		analogShowDate: "top", // options: false, 'top', or 'bottom'
+		secondsColor: "#888888",
+		timezone: null,
 	},
 	// Define required scripts.
 	getScripts: function() {
-		return ["moment.js"];
+		return ["moment.js", "moment-timezone.js"];
 	},
 	// Define styles.
 	getStyles: function() {
@@ -58,46 +62,46 @@ Module.register("clock",{
 		var timeWrapper = document.createElement("div");
 		var secondsWrapper = document.createElement("sup");
 		var periodWrapper = document.createElement("span");
+		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"
 
 		// Set content of wrappers.
 		// The moment().format("h") method has a bug on the Raspberry Pi.
 		// So we need to generate the timestring manually.
 		// See issue: https://github.com/MichMich/MagicMirror/issues/181
 		var timeString;
-		if (this.config.clockBold === true) {
-			timeString = moment().format("HH[<span class=\"bold\">]mm[</span>]");
-		} else {
-			timeString = moment().format("HH:mm");
+		var now = moment();
+		if (this.config.timezone) {
+			now.tz(this.config.timezone);
 		}
 
+		var hourSymbol = "HH";
 		if (this.config.timeFormat !== 24) {
-			// var now = new Date();
-			// var hours = now.getHours() % 12 || 12;
-			if (this.config.clockBold === true) {
-				//timeString = hours + moment().format("[<span class=\"bold\">]mm[</span>]");
-				timeString = moment().format("h[<span class=\"bold\">]mm[</span>]");
-			} else {
-				//timeString = hours + moment().format(":mm");
-				timeString = moment().format("h:mm");
-			}
+			hourSymbol = "h";
 		}
-		dateWrapper.innerHTML = moment().format("dddd, LL");
-		timeWrapper.innerHTML = timeString;
-		secondsWrapper.innerHTML = moment().format("ss");
-		if (this.config.showPeriodUpper) {
-			periodWrapper.innerHTML = moment().format("A");
+
+		if (this.config.clockBold === true) {
+			timeString = now.format(hourSymbol + "[<span class=\"bold\">]mm[</span>]");
 		} else {
-			periodWrapper.innerHTML = moment().format("a");
+			timeString = now.format(hourSymbol + ":mm");
 		}
-		if (this.config.displaySeconds) {
-			timeWrapper.appendChild(secondsWrapper);
+
+		if(this.config.showDate){
+			dateWrapper.innerHTML = now.format(this.config.dateFormat);
 		}
-		if (this.config.showPeriod && this.config.timeFormat !== 24) {
-			timeWrapper.appendChild(periodWrapper);
+		if (this.config.showWeek) {
+			weekWrapper.innerHTML = this.translate("WEEK") + " " + now.week();
+		}
+		timeWrapper.innerHTML = timeString;
+		secondsWrapper.innerHTML = now.format("ss");
+		if (this.config.showPeriodUpper) {
+			periodWrapper.innerHTML = now.format("A");
+		} else {
+			periodWrapper.innerHTML = now.format("a");
 		}
 		if (this.config.displaySeconds) {
 			timeWrapper.appendChild(secondsWrapper);
@@ -110,12 +114,15 @@ Module.register("clock",{
 		 * Create wrappers for ANALOG clock, only if specified in config
 		 */
 
-		 if (this.config.displayType !== 'digital') {
+		 if (this.config.displayType !== "digital") {
 			// If it isn't 'digital', then an 'analog' clock was also requested
 
 			// Calculate the degree offset for each hand of the clock
-			var now = moment(),
-				second = now.seconds() * 6,
+			var now = moment();
+			if (this.config.timezone) {
+				now.tz(this.config.timezone);
+			}
+			var	second = now.seconds() * 6,
 				minute = now.minute() * 6 + second / 60,
 				hour = ((now.hours() % 12) / 12) * 360 + 90 + minute / 12;
 
@@ -126,10 +133,14 @@ 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%";
-			} else if (this.config.analogFace != 'none') {
+
+				// The following line solves issue: https://github.com/MichMich/MagicMirror/issues/611
+				clockCircle.style.border = "1px solid black";
+
+			} else if (this.config.analogFace != "none") {
 				clockCircle.style.border = "2px solid white";
 			}
 			var clockFace = document.createElement("div");
@@ -163,20 +174,29 @@ Module.register("clock",{
 		 * Combine wrappers, check for .displayType
 		 */
 
-		if (this.config.displayType === 'digital') {
+		if (this.config.displayType === "digital") {
 			// Display only a digital clock
 			wrapper.appendChild(dateWrapper);
 			wrapper.appendChild(timeWrapper);
-		} else if (this.config.displayType === 'analog') {
+			wrapper.appendChild(weekWrapper);
+		} else if (this.config.displayType === "analog") {
 			// Display only an analog clock
 			dateWrapper.style.textAlign = "center";
-			dateWrapper.style.paddingBottom = "15px";
-			if (this.config.analogShowDate === 'top') {
+
+			if (this.config.showWeek) {
+				weekWrapper.style.paddingBottom = "15px";
+			} else {
+				dateWrapper.style.paddingBottom = "15px";
+			}
+
+			if (this.config.analogShowDate === "top") {
 				wrapper.appendChild(dateWrapper);
+				wrapper.appendChild(weekWrapper);
 				wrapper.appendChild(clockCircle);
-			} else if (this.config.analogShowDate === 'bottom') {
+			} else if (this.config.analogShowDate === "bottom") {
 				wrapper.appendChild(clockCircle);
 				wrapper.appendChild(dateWrapper);
+				wrapper.appendChild(weekWrapper);
 			} else {
 				wrapper.appendChild(clockCircle);
 			}
@@ -193,31 +213,31 @@ Module.register("clock",{
 			digitalWrapper.style.cssFloat = "none";
 			digitalWrapper.appendChild(dateWrapper);
 			digitalWrapper.appendChild(timeWrapper);
+			digitalWrapper.appendChild(weekWrapper);
 
-			if (placement === 'left' || placement === 'right') {
+			var appendClocks = function(condition, pos1, pos2) {
+				var padding = [0,0,0,0];
+				padding[(placement === condition) ? pos1 : pos2] = "20px";
+				analogWrapper.style.padding = padding.join(" ");
+				if (placement === condition) {
+					wrapper.appendChild(analogWrapper);
+					wrapper.appendChild(digitalWrapper);
+				} else {
+					wrapper.appendChild(digitalWrapper);
+					wrapper.appendChild(analogWrapper);
+				}
+			};
+
+			if (placement === "left" || placement === "right") {
 				digitalWrapper.style.display = "inline-block";
 				digitalWrapper.style.verticalAlign = "top";
 				analogWrapper.style.display = "inline-block";
-				if (placement === 'left') {
-					analogWrapper.style.padding = "0 20px 0 0";
-					wrapper.appendChild(analogWrapper);
-					wrapper.appendChild(digitalWrapper);
-				} else {
-					analogWrapper.style.padding = "0 0 0 20px";
-					wrapper.appendChild(digitalWrapper);
-					wrapper.appendChild(analogWrapper);
-				}
+
+				appendClocks("left", 1, 3);
 			} else {
 				digitalWrapper.style.textAlign = "center";
-				if (placement === 'top') {
-					analogWrapper.style.padding = "0 0 20px 0";
-					wrapper.appendChild(analogWrapper);
-					wrapper.appendChild(digitalWrapper);
-				} else {
-					analogWrapper.style.padding = "20px 0 0 0";
-					wrapper.appendChild(digitalWrapper);					
-					wrapper.appendChild(analogWrapper);
-				}
+
+				appendClocks("top", 2, 0);
 			}
 		}
 

modules/default/clock/clock_styles.css

@@ -1,74 +1,68 @@
-#analog {
-}
-
-#digital {
-}
-
 .clockCircle {
-	margin: 0 auto;
-	position: relative;
-	border-radius: 50%;
-	background-size: 100%;
+  margin: 0 auto;
+  position: relative;
+  border-radius: 50%;
+  background-size: 100%;
 }
 
 .clockFace {
-	width: 100%;
-	height: 100%;
+  width: 100%;
+  height: 100%;
 }
 
-.clockFace:after {
-	position: absolute;
-	top: 50%;
-	left: 50%;
-	width: 6px;
-	height: 6px;
-	margin: -3px 0 0 -3px;
-	background: white;
-	border-radius: 3px;
-	content: "";
-	display: block;
+.clockFace::after {
+  position: absolute;
+  top: 50%;
+  left: 50%;
+  width: 6px;
+  height: 6px;
+  margin: -3px 0 0 -3px;
+  background: white;
+  border-radius: 3px;
+  content: "";
+  display: block;
 }
 
 .clockHour {
-	width: 0;
-	height: 0;
-	position: absolute;
-	top: 50%;
-	left: 50%;
-	margin: -2px 0 -2px -25%;	/* numbers much match negative length & thickness */
-	padding: 2px 0 2px 25%;		/* indicator length & thickness */
-	background: white;
-	-webkit-transform-origin: 100% 50%;
-	-ms-transform-origin: 100% 50%;
-	transform-origin: 100% 50%;
-	border-radius: 3px 0 0 3px;
+  width: 0;
+  height: 0;
+  position: absolute;
+  top: 50%;
+  left: 50%;
+  margin: -2px 0 -2px -25%;   /* numbers much match negative length & thickness */
+  padding: 2px 0 2px 25%;     /* indicator length & thickness */
+  background: white;
+  -webkit-transform-origin: 100% 50%;
+  -ms-transform-origin: 100% 50%;
+  transform-origin: 100% 50%;
+  border-radius: 3px 0 0 3px;
 }
 
 .clockMinute {
-	width: 0;
-	height: 0;
-	position: absolute;
-	top: 50%;
-	left: 50%;
-	margin: -35% -2px 0;	/* numbers must match negative length & thickness */
-	padding: 35% 2px 0;	/* indicator length & thickness */
-	background: white;
-	-webkit-transform-origin: 50% 100%;
-	-ms-transform-origin: 50% 100%;
-	transform-origin: 50% 100%;
-	border-radius: 3px 0 0 3px;
+  width: 0;
+  height: 0;
+  position: absolute;
+  top: 50%;
+  left: 50%;
+  margin: -35% -2px 0;    /* numbers must match negative length & thickness */
+  padding: 35% 2px 0; /* indicator length & thickness */
+  background: white;
+  -webkit-transform-origin: 50% 100%;
+  -ms-transform-origin: 50% 100%;
+  transform-origin: 50% 100%;
+  border-radius: 3px 0 0 3px;
 }
 
 .clockSecond {
-	width: 0;
-	height: 0;
-	position: absolute;
-	top: 50%;
-	left: 50%;
-	margin: -38% -1px 0 0;	/* numbers must match negative length & thickness */
-	padding: 38% 1px 0 0;	/* indicator length & thickness */
-	background: #888888;
-	-webkit-transform-origin: 50% 100%;
-	-ms-transform-origin: 50% 100%;
-	transform-origin: 50% 100%;
+  width: 0;
+  height: 0;
+  position: absolute;
+  top: 50%;
+  left: 50%;
+  margin: -38% -1px 0 0;  /* numbers must match negative length & thickness */
+  padding: 38% 1px 0 0;   /* indicator length & thickness */
+  background: #888;
+  -webkit-transform-origin: 50% 100%;
+  -ms-transform-origin: 50% 100%;
+  transform-origin: 50% 100%;
 }

modules/default/compliments/README.md

@@ -8,8 +8,8 @@ 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.
+		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.
@@ -25,63 +25,109 @@ modules: [
 The following properties can be configured:
 
 
-<table width="100%">
-	<!-- why, markdown... -->
-	<thead>
-		<tr>
-			<th>Option</th>
-			<th width="100%">Description</th>
-		</tr>
-	<thead>
-	<tbody>
-
-		<tr>
-			<td><code>updateInterval</code></td>
-			<td>How often does the compliment have to change? (Milliseconds)<br>
-				<br><b>Possible values:</b> <code>1000</code> - <code>86400000</code>
-				<br><b>Default value:</b> <code>30000</code> (30 seconds)
-			</td>
-		</tr>
-		<tr>
-			<td><code>fadeSpeed</code></td>
-			<td>Speed of the update animation. (Milliseconds)<br>
-				<br><b>Possible values:</b><code>0</code> - <code>5000</code>
-				<br><b>Default value:</b> <code>4000</code> (4 seconds)
-			</td>
-		</tr>
-		<tr>
-			<td><code>compliments</code></td>
-			<td>The list of compliments.<br>
-				<br><b>Possible values:</b> An object with three arrays: <code>morning</code>, <code>afternoon</code> and<code>evening</code>. See <i>compliment configuration</i> below.
-				<br><b>Default value:</b> See <i>compliment configuration</i> below.
-			</td>
-		</tr>
-	</tbody>
-</table>
+| 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 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)
 
 ### Compliment configuration
 
-The `compliments` property contains an object with three arrays: <code>morning</code>, <code>afternoon</code> and<code>evening</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.
+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?'
+			"Good morning, handsome!",
+			"Enjoy your day!",
+			"How was your sleep?"
 		],
 		afternoon: [
-			'Hello, beauty!',
+			"Hello, beauty!",
 			'You look sexy!',
-			'Looking good today!'
+			"Looking good today!"
 		],
 		evening: [
-			'Wow, you look hot!',
-			'You look nice!',
-			'Hi, sexy!'
+			"Wow, you look hot!",
+			"You look nice!",
+			"Hi, sexy!"
 		]
 	}
 }
 ````
+
+### 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."
+    ]
+}
+````
+

modules/default/compliments/compliments.js

@@ -6,12 +6,14 @@
  * By Michael Teeuw http://michaelteeuw.nl
  * MIT Licensed.
  */
-
-Module.register("compliments",{
+Module.register("compliments", {
 
 	// Module config defaults.
 	defaults: {
 		compliments: {
+			anytime: [
+				"Hey there sexy!"
+			],
 			morning: [
 				"Good morning, handsome!",
 				"Enjoy your day!",
@@ -29,9 +31,13 @@ Module.register("compliments",{
 			]
 		},
 		updateInterval: 30000,
+		remoteFile: null,
 		fadeSpeed: 4000
 	},
 
+	// Set currentweather from module
+	currentWeatherType: "",
+
 	// Define required scripts.
 	getScripts: function() {
 		return ["moment.js"];
@@ -43,6 +49,12 @@ Module.register("compliments",{
 
 		this.lastComplimentIndex = -1;
 
+		if (this.config.remoteFile != null) {
+			this.complimentFile((response) => {
+				this.config.compliments = JSON.parse(response);
+			});
+		}
+
 		// Schedule update timer.
 		var self = this;
 		setInterval(function() {
@@ -84,14 +96,43 @@ Module.register("compliments",{
 	 */
 	complimentArray: function() {
 		var hour = moment().hour();
+		var compliments = null;
 
 		if (hour >= 3 && hour < 12) {
-			return this.config.compliments.morning;
+			compliments = this.config.compliments.morning;
 		} else if (hour >= 12 && hour < 17) {
-			return this.config.compliments.afternoon;
+			compliments = this.config.compliments.afternoon;
 		} else {
-			return this.config.compliments.evening;
+			compliments = this.config.compliments.evening;
 		}
+
+		if (typeof compliments === "undefined") {
+			compliments = new Array();
+		}
+
+		if (this.currentWeatherType in this.config.compliments) {
+			compliments.push.apply(compliments, this.config.compliments[this.currentWeatherType]);
+		}
+
+		compliments.push.apply(compliments, this.config.compliments.anytime);
+
+		return compliments;
+
+	},
+
+	/* complimentFile(callback)
+	 * Retrieve a file from the local filesystem
+	 */
+	complimentFile: function(callback) {
+		var xobj = new XMLHttpRequest();
+		xobj.overrideMimeType("application/json");
+		xobj.open("GET", this.file(this.config.remoteFile), true);
+		xobj.onreadystatechange = function() {
+			if (xobj.readyState == 4 && xobj.status == "200") {
+				callback(xobj.responseText);
+			}
+		};
+		xobj.send(null);
 	},
 
 	/* complimentArray()
@@ -112,10 +153,44 @@ Module.register("compliments",{
 
 		var compliment = document.createTextNode(complimentText);
 		var wrapper = document.createElement("div");
-		wrapper.className = "thin xlarge bright";
+		wrapper.className = this.config.classes ? this.config.classes : "thin xlarge bright";
 		wrapper.appendChild(compliment);
 
 		return wrapper;
-	}
+	},
 
-});
+
+	// From data currentweather set weather type
+	setCurrentWeatherType: function(data) {
+		var weatherIconTable = {
+			"01d": "day_sunny",
+			"02d": "day_cloudy",
+			"03d": "cloudy",
+			"04d": "cloudy_windy",
+			"09d": "showers",
+			"10d": "rain",
+			"11d": "thunderstorm",
+			"13d": "snow",
+			"50d": "fog",
+			"01n": "night_clear",
+			"02n": "night_cloudy",
+			"03n": "night_cloudy",
+			"04n": "night_cloudy",
+			"09n": "night_showers",
+			"10n": "night_rain",
+			"11n": "night_thunderstorm",
+			"13n": "night_snow",
+			"50n": "night_alt_cloudy_windy"
+		};
+		this.currentWeatherType = weatherIconTable[data.weather[0].icon];
+	},
+
+
+	// Override notification handler.
+	notificationReceived: function(notification, payload, sender) {
+		if (notification == "CURRENTWEATHER_DATA") {
+			this.setCurrentWeatherType(payload.data);
+		}
+	},
+
+});

modules/default/currentweather/README.md

@@ -8,14 +8,14 @@ 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.
+		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://bulk.openweather.org/sample/ 
-			appid: 'abcde12345abcde12345abcde12345ab' //openweathermap.org API key.
+			location: "Amsterdam,Netherlands",
+			locationID: "", //Location ID from http://openweathermap.org/help/city_list.txt
+			appid: "abcde12345abcde12345abcde12345ab" //openweathermap.org API key.
 		}
 	}
 ]
@@ -26,155 +26,53 @@ modules: [
 The following properties can be configured:
 
 
-<table width="100%">
-	<!-- why, markdown... -->
-	<thead>
-		<tr>
-			<th>Option</th>
-			<th width="100%">Description</th>
-		</tr>
-	<thead>
-	<tbody>
-	
-		<tr>
-			<td><code>location</code></td>
-			<td>The location used for weather information.<br>
-				<br><b>Example:</b> <code>Amsterdam,Netherlands</code>
-				<br><b>Default value:</b> <code>New York</code>
-			</td>
-		</tr>
-		<tr>
-			<td><code>locationID</code></td>
-			<td>Location ID from <a href="http://bulk.openweather.org/sample/">OpenWeather</a> <b>This will override anything you put in location.</b><br>Leave blank if you want to use location.
-				<br><b>Example:</b> <code>1234567</code>
-				<br><b>Default value:</b> <code></code>
-			</td>
-		</tr>
-		<tr>
-			<td><code>appid</code></td>
-			<td>The <a href="https://home.openweathermap.org" target="_blank">OpenWeatherMap</a> API key, which can be obtained by creating an OpenWeatherMap account.<br>
-				<br> This value is <b>REQUIRED</b>
-			</td>
-		</tr>
-		<tr>
-			<td><code>units</code></td>
-			<td>What units to use. Specified by config.js<br>
-				<br><b>Possible values:</b> <code>config.units</code> = Specified by config.js, <code>default</code> = Kelvin, <code>metric</code> = Celsius, <code>imperial</code> =Fahrenheit
-				<br><b>Default value:</b> <code>config.units</code>
-			</td>
-		</tr>
-		<tr>
-			<td><code>updateInterval</code></td>
-			<td>How often does the content needs to be fetched? (Milliseconds)<br>
-				<br><b>Possible values:</b> <code>1000</code> - <code>86400000</code>
-				<br><b>Default value:</b> <code>300000</code> (10 minutes)
-			</td>
-		</tr>
-		<tr>
-			<td><code>animationSpeed</code></td>
-			<td>Speed of the update animation. (Milliseconds)<br>
-				<br><b>Possible values:</b><code>0</code> - <code>5000</code>
-				<br><b>Default value:</b> <code>2000</code> (2 seconds)
-			</td>
-		</tr>
-		<tr>
-			<td><code>timeFormat</code></td>
-			<td>Use 12 or 24 hour format.<br>
-				<br><b>Possible values:</b> <code>12</code> or <code>24</code>
-				<br><b>Default value:</b> uses value of <i>config.timeFormat</i>
-			</td>
-		</tr>
-		<tr>
-			<td><code>showPeriod</code></td>
-			<td>Show the period (am/pm) with 12 hour format<br>
-				<br><b>Possible values:</b> <code>true</code> or <code>false</code>
-				<br><b>Default value:</b> <code>true</code>
-			</td>
-		</tr>
-		<tr>
-			<td><code>showPeriodUpper</code></td>
-			<td>Show the period (AM/PM) with 12 hour format as uppercase<br>
-				<br><b>Possible values:</b> <code>true</code> or <code>false</code>
-				<br><b>Default value:</b> <code>false</code>
-			</td>
-		</tr>
-		<tr>
-			<td><code>showWindDirection</code></td>
-			<td>Show the wind direction next to the wind speed.<br>
-				<br><b>Possible values:</b> <code>true</code> or <code>false</code>
-				<br><b>Default value:</b> <code>true</code>
-			</td>
-		</tr>
-		<tr>
-			<td><code>useBeaufort</code></td>
-			<td>Pick between using the Beaufort scale for wind speed or using the default units.<br>
-				<br><b>Possible values:</b> <code>true</code> or <code>false</code>
-				<br><b>Default value:</b> <code>true</code>
-			</td>
-		</tr>
-		<tr>
-			<td><code>lang</code></td>
-			<td>The language of the days.<br>
-				<br><b>Possible values:</b> <code>en</code>, <code>nl</code>, <code>ru</code>, etc ...
-				<br><b>Default value:</b> uses value of <i>config.language</i>
-			</td>
-		</tr>
-		<tr>
-			<td><code>initialLoadDelay</code></td>
-			<td>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><b>Possible values:</b> <code>1000</code> - <code>5000</code>
-				<br><b>Default value:</b>  <code>0</code>
-			</td>
-		</tr>
-		<tr>
-			<td><code>retryDelay</code></td>
-			<td>The delay before retrying after a request failure. (Milliseconds)<br>
-				<br><b>Possible values:</b> <code>1000</code> - <code>60000</code>
-				<br><b>Default value:</b>  <code>2500</code>
-			</td>
-		</tr>
-		<tr>
-			<td><code>apiVersion</code></td>
-			<td>The OpenWeatherMap API version to use.<br>
-				<br><b>Default value:</b>  <code>2.5</code>
-			</td>
-		</tr>
-		<tr>
-			<td><code>apiBase</code></td>
-			<td>The OpenWeatherMap base URL.<br>
-				<br><b>Default value:</b>  <code>'http://api.openweathermap.org/data/'</code>
-			</td>
-		</tr>
-		<tr>
-			<td><code>weatherEndpoint</code></td>
-			<td>The OpenWeatherMap API endPoint.<br>
-				<br><b>Default value:</b>  <code>'weather'</code>
-			</td>
-		</tr>
-		<tr>
-			<td><code>iconTable</code></td>
-			<td>The conversion table to convert the weather conditions to weather-icons.<br>
-				<br><b>Default value:</b>  <code>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'
-		}</code>
-			</td>
-		</tr>
-	</tbody>
-</table>
+| 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](http://openweathermap.org/help/city_list.txt) **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`
+| `showHumidity`               | Show the current humidity <br><br> **Possible values:** `true` or `false` <br> **Default value:** `false`
+| `onlyTemp`                   | Show only current Temperature and weather icon. <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_
+| `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'
+}
+````

modules/default/currentweather/currentweather.css

@@ -6,3 +6,11 @@
   -webkit-transform: translate(0, -3px); /* Safari */
   transform: translate(0, -3px);
 }
+
+.currentweather .humidityIcon {
+  padding-right: 4px;
+}
+
+.currentweather .humidity-padding {
+  padding-bottom: 6px;
+}

modules/default/currentweather/currentweather.js

@@ -11,8 +11,8 @@ Module.register("currentweather",{
 
 	// Default module config.
 	defaults: {
-		location: "",
-		locationID: "",
+		location: false,
+		locationID: false,
 		appid: "",
 		units: config.units,
 		updateInterval: 10 * 60 * 1000, // every 10 minutes
@@ -23,6 +23,8 @@ Module.register("currentweather",{
 		showWindDirection: true,
 		useBeaufort: true,
 		lang: config.language,
+		showHumidity: false,
+		degreeLabel: false,
 
 		initialLoadDelay: 0, // 0 seconds delay
 		retryDelay: 2500,
@@ -31,6 +33,12 @@ Module.register("currentweather",{
 		apiBase: "http://api.openweathermap.org/data/",
 		weatherEndpoint: "weather",
 
+		appendLocationNameToHeader: true,
+		calendarClass: "calendar",
+
+		onlyTemp: false,
+		roundTemp: false,
+
 		iconTable: {
 			"01d": "wi-day-sunny",
 			"02d": "wi-day-cloudy",
@@ -53,6 +61,12 @@ Module.register("currentweather",{
 		},
 	},
 
+	// create a variable for the first upcoming calendaar event. Used if no location is specified.
+	firstEvent: false,
+
+	// create a variable to hold the location name based on the API result.
+	fetchedLocatioName: "",
+
 	// Define required scripts.
 	getScripts: function() {
 		return ["moment.js"];
@@ -65,8 +79,8 @@ Module.register("currentweather",{
 
 	// Define required translations.
 	getTranslations: function() {
-		// The translations for the defaut modules are defined in the core translation files.
-		// Therefor we can just return false. Otherwise we should have returned a dictionairy.
+		// 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.
 		return false;
 	},
@@ -88,35 +102,16 @@ Module.register("currentweather",{
 		this.loaded = false;
 		this.scheduleUpdate(this.config.initialLoadDelay);
 
-		this.updateTimer = null;
-
 	},
 
-	// Override dom generator.
-	getDom: function() {
-		var wrapper = document.createElement("div");
-
-		if (this.config.appid === "") {
-			wrapper.innerHTML = "Please set the correct openweather <i>appid</i> in the config for module: " + this.name + ".";
-			wrapper.className = "dimmed light small";
-			return wrapper;
-		}
-
-		if (this.config.location === "") {
-			wrapper.innerHTML = "Please set the openweather <i>location</i> in the config for module: " + this.name + ".";
-			wrapper.className = "dimmed light small";
-			return wrapper;
-		}
-
-		if (!this.loaded) {
-			wrapper.innerHTML = this.translate('LOADING');
-			wrapper.className = "dimmed light small";
-			return wrapper;
-		}
+	// add extra information of current weather
+	// windDirection, humidity, sunrise and sunset
+	addExtraInfoWeather: function(wrapper) {
 
 		var small = document.createElement("div");
 		small.className = "normal medium";
 
+
 		var windIcon = document.createElement("span");
 		windIcon.className = "wi wi-strong-wind dimmed";
 		small.appendChild(windIcon);
@@ -134,6 +129,22 @@ Module.register("currentweather",{
 		spacer.innerHTML = "&nbsp;";
 		small.appendChild(spacer);
 
+		if (this.config.showHumidity) {
+			var humidity = document.createElement("span");
+			humidity.innerHTML = this.humidity;
+
+			var spacer = document.createElement("sup");
+			spacer.innerHTML = "&nbsp;";
+
+			var humidityIcon = document.createElement("sup");
+			humidityIcon.className = "wi wi-humidity humidityIcon";
+			humidityIcon.innerHTML = "&nbsp;";
+
+			small.appendChild(humidity);
+			small.appendChild(spacer);
+			small.appendChild(humidityIcon);
+		}
+
 		var sunriseSunsetIcon = document.createElement("span");
 		sunriseSunsetIcon.className = "wi dimmed " + this.sunriseSunsetIcon;
 		small.appendChild(sunriseSunsetIcon);
@@ -142,6 +153,29 @@ Module.register("currentweather",{
 		sunriseSunsetTime.innerHTML = " " + this.sunriseSunsetTime;
 		small.appendChild(sunriseSunsetTime);
 
+		wrapper.appendChild(small);
+	},
+
+	// Override dom generator.
+	getDom: function() {
+		var wrapper = document.createElement("div");
+
+		if (this.config.appid === "") {
+			wrapper.innerHTML = "Please set the correct openweather <i>appid</i> in the config for module: " + this.name + ".";
+			wrapper.className = "dimmed light small";
+			return wrapper;
+		}
+
+		if (!this.loaded) {
+			wrapper.innerHTML = this.translate("LOADING");
+			wrapper.className = "dimmed light small";
+			return wrapper;
+		}
+
+		if (this.config.onlyTemp === false) {
+			this.addExtraInfoWeather(wrapper);
+		}
+
 		var large = document.createElement("div");
 		large.className = "large light";
 
@@ -149,22 +183,75 @@ Module.register("currentweather",{
 		weatherIcon.className = "wi weathericon " + this.weatherType;
 		large.appendChild(weatherIcon);
 
+		var degreeLabel = "";
+		if (this.config.degreeLabel) {
+			switch (this.config.units ) {
+			case "metric":
+				degreeLabel = "C";
+				break;
+			case "imperial":
+				degreeLabel = "F";
+				break;
+			case "default":
+				degreeLabel = "K";
+				break;
+			}
+		}
+
 		var temperature = document.createElement("span");
 		temperature.className = "bright";
-		temperature.innerHTML = " " + this.temperature + "&deg;";
+		temperature.innerHTML = " " + this.temperature + "&deg;" + degreeLabel;
 		large.appendChild(temperature);
 
-		wrapper.appendChild(small);
 		wrapper.appendChild(large);
 		return wrapper;
 	},
 
+	// Override getHeader method.
+	getHeader: function() {
+		if (this.config.appendLocationNameToHeader) {
+			return this.data.header + " " + this.fetchedLocatioName;
+		}
+
+		return this.data.header;
+	},
+
+	// Override notification handler.
+	notificationReceived: function(notification, payload, sender) {
+		if (notification === "DOM_OBJECTS_CREATED") {
+			if (this.config.appendLocationNameToHeader) {
+				this.hide(0, {lockString: this.identifier});
+			}
+		}
+		if (notification === "CALENDAR_EVENTS") {
+			var senderClasses = sender.data.classes.toLowerCase().split(" ");
+			if (senderClasses.indexOf(this.config.calendarClass.toLowerCase()) !== -1) {
+				var lastEvent =  this.firstEvent;
+				this.firstEvent = false;
+
+				for (e in payload) {
+					var event = payload[e];
+					if (event.location || event.geo) {
+						this.firstEvent = event;
+						//Log.log("First upcoming event with location: ", event);
+						break;
+					}
+				}
+			}
+		}
+	},
+
 	/* updateWeather(compliments)
 	 * Requests new data from openweather.org.
 	 * Calls processWeather on succesfull response.
 	 */
 	updateWeather: function() {
-		var url = this.config.apiBase + this.config.apiVersion + "/" + this.config.weatherEndpoint + '/' + this.getParams();
+		if (this.config.appid === "") {
+			Log.error("CurrentWeather: APPID not set!");
+			return;
+		}
+
+		var url = this.config.apiBase + this.config.apiVersion + "/" + this.config.weatherEndpoint + this.getParams();
 		var self = this;
 		var retry = true;
 
@@ -175,11 +262,10 @@ Module.register("currentweather",{
 				if (this.status === 200) {
 					self.processWeather(JSON.parse(this.response));
 				} else if (this.status === 401) {
-					self.config.appid = "";
 					self.updateDom(self.config.animationSpeed);
 
 					Log.error(self.name + ": Incorrect APPID.");
-					retry = false;
+					retry = true;
 				} else {
 					Log.error(self.name + ": Could not load weather.");
 				}
@@ -199,11 +285,19 @@ Module.register("currentweather",{
 	 */
 	getParams: function() {
 		var params = "?";
-		if(this.config.locationID !== "") {
+		if(this.config.locationID) {
 			params += "id=" + this.config.locationID;
-		} else {
+		} else if(this.config.location) {
 			params += "q=" + this.config.location;
+		} else if (this.firstEvent && this.firstEvent.geo) {
+			params += "lat=" + this.firstEvent.geo.lat + "&lon=" + this.firstEvent.geo.lon
+		} else if (this.firstEvent && this.firstEvent.location) {
+			params += "q=" + this.firstEvent.location;
+		} else {
+			this.hide(this.config.animationSpeed, {lockString:this.identifier});
+			return;
 		}
+
 		params += "&units=" + this.config.units;
 		params += "&lang=" + this.config.lang;
 		params += "&APPID=" + this.config.appid;
@@ -218,12 +312,13 @@ Module.register("currentweather",{
 	 */
 	processWeather: function(data) {
 
-		if (!data || !data.main || !data.main.temp) {
+		if (!data || !data.main || typeof data.main.temp === "undefined") {
 			// Did not receive usable new data.
 			// Maybe this needs a better check?
 			return;
 		}
 
+		this.humidity = parseFloat(data.main.humidity);
 		this.temperature = this.roundValue(data.main.temp);
 
 		if (this.config.useBeaufort){
@@ -244,20 +339,20 @@ Module.register("currentweather",{
 		// So we need to generate the timestring manually.
 		// See issue: https://github.com/MichMich/MagicMirror/issues/181
 		var sunriseSunsetDateObject = (sunrise < now && sunset > now) ? sunset : sunrise;
-		var timeString = moment(sunriseSunsetDateObject).format('HH:mm');
+		var timeString = moment(sunriseSunsetDateObject).format("HH:mm");
 		if (this.config.timeFormat !== 24) {
 			//var hours = sunriseSunsetDateObject.getHours() % 12 || 12;
 			if (this.config.showPeriod) {
 				if (this.config.showPeriodUpper) {
 					//timeString = hours + moment(sunriseSunsetDateObject).format(':mm A');
-					timeString = moment(sunriseSunsetDateObject).format('h:mm A');
+					timeString = moment(sunriseSunsetDateObject).format("h:mm A");
 				} else {
 					//timeString = hours + moment(sunriseSunsetDateObject).format(':mm a');
-					timeString = moment(sunriseSunsetDateObject).format('h:mm a');
+					timeString = moment(sunriseSunsetDateObject).format("h:mm a");
 				}
 			} else {
 				//timeString = hours + moment(sunriseSunsetDateObject).format(':mm');
-				timeString = moment(sunriseSunsetDateObject).format('h:mm');
+				timeString = moment(sunriseSunsetDateObject).format("h:mm");
 			}
 		}
 
@@ -265,9 +360,10 @@ Module.register("currentweather",{
 		this.sunriseSunsetIcon = (sunrise < now && sunset > now) ? "wi-sunset" : "wi-sunrise";
 
 
-
+		this.show(this.config.animationSpeed, {lockString:this.identifier});
 		this.loaded = true;
 		this.updateDom(this.config.animationSpeed);
+		this.sendNotification("CURRENTWEATHER_DATA", {data: data});
 	},
 
 	/* scheduleUpdate()
@@ -306,52 +402,51 @@ Module.register("currentweather",{
 		return 12;
 	},
 
+	deg2Cardinal: function(deg) {
+		if (deg>11.25 && deg<=33.75){
+			return "NNE";
+		} else if (deg > 33.75 && deg <= 56.25) {
+			return "NE";
+		} else if (deg > 56.25 && deg <= 78.75) {
+			return "ENE";
+		} else if (deg > 78.75 && deg <= 101.25) {
+			return "E";
+		} else if (deg > 101.25 && deg <= 123.75) {
+			return "ESE";
+		} else if (deg > 123.75 && deg <= 146.25) {
+			return "SE";
+		} else if (deg > 146.25 && deg <= 168.75) {
+			return "SSE";
+		} else if (deg > 168.75 && deg <= 191.25) {
+			return "S";
+		} else if (deg > 191.25 && deg <= 213.75) {
+			return "SSW";
+		} else if (deg > 213.75 && deg <= 236.25) {
+			return "SW";
+		} else if (deg > 236.25 && deg <= 258.75) {
+			return "WSW";
+		} else if (deg > 258.75 && deg <= 281.25) {
+			return "W";
+		} else if (deg > 281.25 && deg <= 303.75) {
+			return "WNW";
+		} else if (deg > 303.75 && deg <= 326.25) {
+			return "NW";
+		} else if (deg > 326.25 && deg <= 348.75) {
+			return "NNW";
+		} else {
+			return "N";
+		}
+	},
+
 	/* function(temperature)
-	 * Rounds a temperature to 1 decimal.
+	 * Rounds a temperature to 1 decimal or integer (depending on config.roundTemp).
 	 *
 	 * argument temperature number - Temperature.
 	 *
 	 * return number - Rounded Temperature.
 	 */
-
-	deg2Cardinal: function(deg) {
-                if (deg>11.25 && deg<=33.75){
-                        return "NNE";
-                } else if (deg > 33.75 && deg <= 56.25) {
-                        return "NE";
-                } else if (deg > 56.25 && deg <= 78.75) {
-                        return "ENE";
-                } else if (deg > 78.75 && deg <= 101.25) {
-                        return "E";
-                } else if (deg > 101.25 && deg <= 123.75) {
-                        return "ESE";
-                } else if (deg > 123.75 && deg <= 146.25) {
-                        return "SE";
-                } else if (deg > 146.25 && deg <= 168.75) {
-                        return "SSE";
-                } else if (deg > 168.75 && deg <= 191.25) {
-                        return "S";
-                } else if (deg > 191.25 && deg <= 213.75) {
-                        return "SSW";
-                } else if (deg > 213.75 && deg <= 236.25) {
-                        return "SW";
-                } else if (deg > 236.25 && deg <= 258.75) {
-                        return "WSW";
-                } else if (deg > 258.75 && deg <= 281.25) {
-                        return "W";
-                } else if (deg > 281.25 && deg <= 303.75) {
-                        return "WNW";
-                } else if (deg > 303.75 && deg <= 326.25) {
-                        return "NW";
-                } else if (deg > 326.25 && deg <= 348.75) {
-                        return "NNW";
-                } else {
-                         return "N";
-                }
-	},
-
-
 	roundValue: function(temperature) {
-		return parseFloat(temperature).toFixed(1);
+		var decimals = this.config.roundTemp ? 0 : 1;
+		return parseFloat(temperature).toFixed(decimals);
 	}
 });

modules/default/defaultmodules.js

@@ -15,7 +15,8 @@ var defaultModules = [
 	"currentweather",
 	"helloworld",
 	"newsfeed",
-	"weatherforecast"
+	"weatherforecast",
+	"updatenotification"
 ];
 
 /*************** DO NOT EDIT THE LINE BELOW ***************/

modules/default/helloworld/README.md

@@ -6,11 +6,11 @@ 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.
+		module: "helloworld",
+		position: "bottom_bar",	// This can be any of the regions.
 		config: {
 			// See 'Configuration options' for more information.
-			text: 'Hello world!'
+			text: "Hello world!"
 		}
 	}
 ]
@@ -20,23 +20,6 @@ modules: [
 
 The following properties can be configured:
 
-
-<table width="100%">
-	<!-- why, markdown... -->
-	<thead>
-		<tr>
-			<th>Option</th>
-			<th width="100%">Description</th>
-		</tr>
-	<thead>
-	<tbody>
-
-		<tr>
-			<td><code>text</code></td>
-			<td>The text to display.<br>
-				<br><b>Example:</b> <code>'Hello world!'</code>
-				<br><b>Default value:</b> <code>'Hello world!'</code>
-			</td>
-		</tr>
-	</tbody>
-</table>
+| Option | Description
+| ------ | -----------
+| `text` | The text to display. <br><br> **Example:** `'Hello world!'` <br> **Default value:** `'Hello world!'`

modules/default/newsfeed/README.md

@@ -1,15 +1,16 @@
 # Module: News Feed
 The `newsfeed ` module is one of the default modules of the MagicMirror.
-This module displays news headlines based on an RSS feed.
+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.
 
 ## 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.
+		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.
@@ -30,121 +31,56 @@ modules: [
 ]
 ````
 
+### 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`.
+| `ARTICLE_LESS_DETAILS`  | Hides the summary or full news article and only displays the news title of the currently viewed news item.
+
+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:
 
-
-<table width="100%">
-	<!-- why, markdown... -->
-	<thead>
-		<tr>
-			<th>Option</th>
-			<th width="100%">Description</th>
-		</tr>
-	<thead>
-	<tbody>
-
-		<tr>
-			<td><code>feeds</code></td>
-			<td>An array of feed urls that will be used as source.<br>
-				More info about this object can be found below.
-				<br><b>Default value:</b> <code>[
-					{
-						title: "New York Times",
-						url: "http://www.nytimes.com/services/xml/rss/nyt/HomePage.xml",
-					}
-				]</code>
-			</td>
-		</tr>
-
-		<tr>
-			<td><code>showSourceTitle</code></td>
-			<td>Display the title of the source.<br>
-				<br><b>Possible values:</b> <code>true</code> or <code>false</code>
-				<br><b>Default value:</b> <code>true</code>
-			</td>
-		</tr>
-		<tr>
-			<td><code>showPublishDate</code></td>
-			<td>Display the publish date of an headline.<br>
-				<br><b>Possible values:</b> <code>true</code> or <code>false</code>
-				<br><b>Default value:</b> <code>true</code>
-			</td>
-		</tr>
-		<tr>
-			<td><code>showDescription</code></td>
-			<td>Display the description of an item.<br>
-				<br><b>Possible values:</b> <code>true</code> or <code>false</code>
-				<br><b>Default value:</b> <code>false</code>
-			</td>
-		</tr>
-
-		<tr>
-			<td><code>reloadInterval</code></td>
-			<td>How often does the content needs to be fetched? (Milliseconds)<br>
-				<br><b>Possible values:</b> <code>1000</code> - <code>86400000</code>
-				<br><b>Default value:</b> <code>300000</code> (5 minutes)
-			</td>
-		</tr>
-		<tr>
-			<td><code>updateInterval</code></td>
-			<td>How often do you want to display a new headline? (Milliseconds)<br>
-				<br><b>Possible values:</b><code>1000</code> - <code>60000</code>
-				<br><b>Default value:</b> <code>10000</code> (10 seconds)
-			</td>
-		</tr>
-		<tr>
-			<td><code>animationSpeed</code></td>
-			<td>Speed of the update animation. (Milliseconds)<br>
-				<br><b>Possible values:</b><code>0</code> - <code>5000</code>
-				<br><b>Default value:</b> <code>2000</code> (2.5 seconds)
-			</td>
-		</tr>
-		<tr>
-			<td><code>maxNewsItems</code></td>
-			<td>Total amount of news items to cycle through. (0 for unlimited)<br>
-				<br><b>Possible values:</b><code>0</code> - <code>...</code>
-				<br><b>Default value:</b> <code>0</code>
-			</td>
-		</tr>
-
-	</tbody>
-</table>
+| 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" }]`
+| `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`
+| `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',...]`
 
 The `feeds` property contains an array with multiple objects. These objects have the following properties:
 
-<table width="100%">
-	<!-- why, markdown... -->
-	<thead>
-		<tr>
-			<th>Option</th>
-			<th width="100%">Description</th>
-		</tr>
-	<thead>
-	<tbody>
-
-		<tr>
-			<td><code>title</code></td>
-			<td>The name of the feed source to be displayed above the news items.<br>
-				<br>This property is optional.
-			</td>
-		</tr>
-
-		<tr>
-			<td><code>url</code></td>
-			<td>The url of the feed used for the headlines.<br>
-				<br><b>Example:</b> <code>'http://www.nytimes.com/services/xml/rss/nyt/HomePage.xml'</code>
-			</td>
-		</tr>
-		<tr>
-			<td><code>encoding</code></td>
-			<td>The encoding of the news feed.<br>
-				<br>This property is optional.
-				<br><b>Possible values:</b><code>'UTF-8'</code>, <code>'ISO-8859-1'</code>, etc ...
-				<br><b>Default value:</b> <code>'UTF-8'</code> 
-			</td>
-		</tr>
-
-	</tbody>
-</table>
+| 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'`

modules/default/newsfeed/fetcher.js

@@ -44,8 +44,9 @@ var Fetcher = function(url, reloadInterval, encoding) {
 		parser.on("item", function(item) {
 
 			var title = item.title;
-			var description = item.description || item.summary || item.content || '';
+			var description = item.description || item.summary || item.content || "";
 			var pubdate = item.pubdate || item.published || item.updated;
+			var url = item.url || item.link || "";
 
 			if (title && pubdate) {
 
@@ -56,15 +57,16 @@ var Fetcher = function(url, reloadInterval, encoding) {
 					title: title,
 					description: description,
 					pubdate: pubdate,
+					url: url,
 				});
 
 			} else {
 
-				console.log("Can't parse feed item:");
-				console.log(item);
-				console.log('Title: ' + title);
-				console.log('Description: ' + description);
-				console.log('Pubdate: ' + pubdate);
+				// console.log("Can't parse feed item:");
+				// console.log(item);
+				// console.log('Title: ' + title);
+				// console.log('Description: ' + description);
+				// console.log('Pubdate: ' + pubdate);
 
 			}
 		});
@@ -79,8 +81,16 @@ var Fetcher = function(url, reloadInterval, encoding) {
 			scheduleTimer();
 		});
 
-		var headers = {'User-Agent':'Mozilla/5.0 (Macintosh; Intel Mac OS X 10_9_3) AppleWebKit/537.75.14 (KHTML, like Gecko) Version/7.0.3 Safari/7046A194A'};
-		request({uri: url, encoding: null, headers: headers}).pipe(iconv.decodeStream(encoding)).pipe(parser);
+
+		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/)"}
+
+		request({uri: url, encoding: null, headers: headers})
+			.on("error", function(error) {
+				fetchFailedCallback(self, error);
+				scheduleTimer();
+			})
+			.pipe(iconv.decodeStream(encoding)).pipe(parser);
 
 	};
 

modules/default/newsfeed/newsfeed.js

@@ -21,10 +21,20 @@ Module.register("newsfeed",{
 		showSourceTitle: true,
 		showPublishDate: true,
 		showDescription: false,
+		wrapTitle: true,
+		wrapDescription: true,
+		hideLoading: false,
 		reloadInterval:  5 * 60 * 1000, // every 5 minutes
 		updateInterval: 10 * 1000,
 		animationSpeed: 2.5 * 1000,
-		maxNewsItems: 0 // 0 for unlimited
+		maxNewsItems: 0, // 0 for unlimited
+		ignoreOldItems: false,
+		ignoreOlderThan: 24 * 60 * 60 * 1000, // 1 day
+		removeStartTags: "",
+		removeEndTags: "",
+		startTags: [],
+		endTags: []
+
 	},
 
 	// Define required scripts.
@@ -34,9 +44,9 @@ Module.register("newsfeed",{
 
 	// Define required translations.
 	getTranslations: function() {
-		// The translations for the defaut modules are defined in the core translation files.
-		// Therefor we can just return false. Otherwise we should have returned a dictionairy.
-		// If you're trying to build yiur own module including translations, check out the documentation.
+		// 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 your own module including translations, check out the documentation.
 		return false;
 	},
 
@@ -84,33 +94,108 @@ Module.register("newsfeed",{
 
 		if (this.newsItems.length > 0) {
 
-			if (this.config.showSourceTitle || this.config.showPublishDate) {
+			// 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";
 
-				if (this.config.showSourceTitle && this.newsItems[this.activeItem].sourceTitle !== '') sourceAndTimestamp.innerHTML = this.newsItems[this.activeItem].sourceTitle;
-				if (this.config.showSourceTitle && this.newsItems[this.activeItem].sourceTitle !== '' && this.config.showPublishDate) sourceAndTimestamp.innerHTML += ', ';
-				if (this.config.showPublishDate) sourceAndTimestamp.innerHTML += moment(new Date(this.newsItems[this.activeItem].pubdate)).fromNow();
-				if (this.config.showSourceTitle && this.newsItems[this.activeItem].sourceTitle !== '' || this.config.showPublishDate) sourceAndTimestamp.innerHTML += ':';
+				if (this.config.showSourceTitle && this.newsItems[this.activeItem].sourceTitle !== "") {
+					sourceAndTimestamp.innerHTML = this.newsItems[this.activeItem].sourceTitle;
+				}
+				if (this.config.showSourceTitle && this.newsItems[this.activeItem].sourceTitle !== "" && this.config.showPublishDate) {
+					sourceAndTimestamp.innerHTML += ", ";
+				}
+				if (this.config.showPublishDate) {
+					sourceAndTimestamp.innerHTML += moment(new Date(this.newsItems[this.activeItem].pubdate)).fromNow();
+				}
+				if (this.config.showSourceTitle && this.newsItems[this.activeItem].sourceTitle !== "" || this.config.showPublishDate) {
+					sourceAndTimestamp.innerHTML += ":";
+				}
 
 				wrapper.appendChild(sourceAndTimestamp);
 			}
 
-			var title = document.createElement("div");
-			title.className = "bright medium light";
-			title.innerHTML = this.newsItems[this.activeItem].title;
-			wrapper.appendChild(title);
+			//Remove selected tags from the beginning of rss feed items (title or description)
+
+			if (this.config.removeStartTags == "title" || this.config.removeStartTags == "both") {
+
+				for (f=0; f<this.config.startTags.length;f++) {
+					if (this.newsItems[this.activeItem].title.slice(0,this.config.startTags[f].length) == this.config.startTags[f]) {
+						this.newsItems[this.activeItem].title = this.newsItems[this.activeItem].title.slice(this.config.startTags[f].length,this.newsItems[this.activeItem].title.length);
+					}
+				}
+
+			}
+
+			if (this.config.removeStartTags == "description" || this.config.removeStartTags == "both") {
+
+				if (this.config.showDescription) {
+					for (f=0; f<this.config.startTags.length;f++) {
+						if (this.newsItems[this.activeItem].description.slice(0,this.config.startTags[f].length) == this.config.startTags[f]) {
+							this.newsItems[this.activeItem].title = this.newsItems[this.activeItem].description.slice(this.config.startTags[f].length,this.newsItems[this.activeItem].description.length);
+						}
+					}
+				}
+
+			}
+
+			//Remove selected tags from the end of rss feed items (title or description)
+
+			if (this.config.removeEndTags) {
+				for (f=0; f<this.config.endTags.length;f++) {
+					if (this.newsItems[this.activeItem].title.slice(-this.config.endTags[f].length)==this.config.endTags[f]) {
+						this.newsItems[this.activeItem].title = this.newsItems[this.activeItem].title.slice(0,-this.config.endTags[f].length);
+					}
+				}
+
+				if (this.config.showDescription) {
+					for (f=0; f<this.config.endTags.length;f++) {
+						if (this.newsItems[this.activeItem].description.slice(-this.config.endTags[f].length)==this.config.endTags[f]) {
+							this.newsItems[this.activeItem].description = this.newsItems[this.activeItem].description.slice(0,-this.config.endTags[f].length);
+						}
+					}
+				}
+
+			}
+
+			if(!this.config.showFullArticle){
+				var title = document.createElement("div");
+				title.className = "bright medium light" + (!this.config.wrapTitle ? " no-wrap" : "");
+				title.innerHTML = this.newsItems[this.activeItem].title;
+				wrapper.appendChild(title);
+			}
 
 			if (this.config.showDescription) {
 				var description = document.createElement("div");
-				description.className = "small light";
+				description.className = "small light" + (!this.config.wrapDescription ? " no-wrap" : "");
 				description.innerHTML = this.newsItems[this.activeItem].description;
 				wrapper.appendChild(description);
 			}
 
+			if (this.config.showFullArticle) {
+				var fullArticle = document.createElement("iframe");
+				fullArticle.className = "";
+				fullArticle.style.width = "100%";
+				fullArticle.style.top = "0";
+				fullArticle.style.left = "0";
+				fullArticle.style.position = "fixed";
+				fullArticle.height = window.innerHeight;
+				fullArticle.style.border = "none";
+				fullArticle.src = this.newsItems[this.activeItem].url;
+				wrapper.appendChild(fullArticle);
+			}
+
+			if (this.config.hideLoading) {
+				this.show();
+			}
+
 		} else {
-			wrapper.innerHTML = this.translate("LOADING");
-			wrapper.className = "small dimmed";
+			if (this.config.hideLoading) {
+				this.hide();
+			} else {
+				wrapper.innerHTML = this.translate("LOADING");
+				wrapper.className = "small dimmed";
+			}
 		}
 
 		return wrapper;
@@ -119,7 +204,6 @@ Module.register("newsfeed",{
 	/* registerFeeds()
 	 * registers the feeds to be used by the backend.
 	 */
-
 	registerFeeds: function() {
 		for (var f in this.config.feeds) {
 			var feed = this.config.feeds[f];
@@ -130,10 +214,10 @@ Module.register("newsfeed",{
 		}
 	},
 
-	/* registerFeeds()
+	/* generateFeed()
 	 * Generate an ordered list of items for this configured module.
 	 *
-	 * attribute feeds object - An object with feeds returned by the nod helper.
+	 * attribute feeds object - An object with feeds returned by the node helper.
 	 */
 	generateFeed: function(feeds) {
 		var newsItems = [];
@@ -143,7 +227,9 @@ Module.register("newsfeed",{
 				for (var i in feedItems) {
 					var item = feedItems[i];
 					item.sourceTitle = this.titleForFeed(feed);
-					newsItems.push(item);
+					if (!(this.config.ignoreOldItems && ((Date.now() - new Date(item.pubdate)) > this.config.ignoreOlderThan))) {
+						newsItems.push(item);
+					}
 				}
 			}
 		}
@@ -175,7 +261,7 @@ Module.register("newsfeed",{
 		return false;
 	},
 
-	/* subscribedToFeed(feedUrl)
+	/* titleForFeed(feedUrl)
 	 * Returns title for a specific feed Url.
 	 *
 	 * attribute feedUrl string - Url of the feed to check.
@@ -186,10 +272,10 @@ Module.register("newsfeed",{
 		for (var f in this.config.feeds) {
 			var feed = this.config.feeds[f];
 			if (feed.url === feedUrl) {
-				return feed.title || '';
+				return feed.title || "";
 			}
 		}
-		return '';
+		return "";
 	},
 
 	/* scheduleUpdateInterval()
@@ -200,7 +286,7 @@ Module.register("newsfeed",{
 
 		self.updateDom(self.config.animationSpeed);
 
-		setInterval(function() {
+		timer = setInterval(function() {
 			self.activeItem++;
 			self.updateDom(self.config.animationSpeed);
 		}, this.config.updateInterval);
@@ -215,5 +301,52 @@ Module.register("newsfeed",{
 	 */
 	capitalizeFirstLetter: function(string) {
 		return string.charAt(0).toUpperCase() + string.slice(1);
-	}
+	},
+
+	resetDescrOrFullArticleAndTimer: function() {
+		this.config.showDescription = false;
+		this.config.showFullArticle = false;
+		if(!timer){
+			this.scheduleUpdateInterval();
+		}
+	},
+
+	notificationReceived: function(notification, payload, sender) {
+		Log.info(this.name + " - received notification: " + notification);
+		if(notification == "ARTICLE_NEXT"){
+			var before = this.activeItem;
+			this.activeItem++;
+			if (this.activeItem >= this.newsItems.length) {
+				this.activeItem = 0;
+			}
+			this.resetDescrOrFullArticleAndTimer();
+			Log.info(this.name + " - going from article #" + before + " to #" + this.activeItem + " (of " + this.newsItems.length + ")");
+			this.updateDom(100);
+		} else if(notification == "ARTICLE_PREVIOUS"){
+			var before = this.activeItem;
+			this.activeItem--;
+			if (this.activeItem < 0) {
+				this.activeItem = this.newsItems.length - 1;
+			}
+			this.resetDescrOrFullArticleAndTimer();
+			Log.info(this.name + " - going from article #" + before + " to #" + this.activeItem + " (of " + this.newsItems.length + ")");
+			this.updateDom(100);
+		}
+		// if "more details" is received the first time: show article summary, on second time show full article
+		else if(notification == "ARTICLE_MORE_DETAILS"){
+			this.config.showDescription = !this.config.showDescription;
+			this.config.showFullArticle = !this.config.showDescription;
+			clearInterval(timer);
+			timer = null;
+			Log.info(this.name + " - showing " + this.config.showDescription ? "article description" : "full article");
+			this.updateDom(100);
+		} else if(notification == "ARTICLE_LESS_DETAILS"){
+			this.resetDescrOrFullArticleAndTimer();
+			Log.info(this.name + " - showing only article titles again");
+			this.updateDom(100);
+		} else {
+			Log.info(this.name + " - unknown notification, ignoring: " + notification);
+		}
+	},
+
 });

modules/default/newsfeed/node_helper.js

@@ -24,19 +24,18 @@ module.exports = NodeHelper.create({
 		}
 	},
 
-	/* createFetcher(url, reloadInterval)
-	 * Creates a fetcher for a new url if it doesn't exist yet.
-	 * Otherwise it reoses the existing one.
+	/* createFetcher(feed, config)
+	 * Creates a fetcher for a new feed if it doesn't exist yet.
+	 * Otherwise it reuses the existing one.
 	 *
-	 * attribute url string - URL of the news feed.
-	 * attribute reloadInterval number - Reload interval in milliseconds.
+	 * attribute feed object - A feed object.
+	 * attribute config object - A configuration object containing reload interval in milliseconds.
 	 */
-
 	createFetcher: function(feed, config) {
 		var self = this;
 
-		var url = feed.url || '';
-		var encoding = feed.encoding || 'UTF-8';
+		var url = feed.url || "";
+		var encoding = feed.encoding || "UTF-8";
 		var reloadInterval = config.reloadInterval || 5 * 60 * 1000;
 
 		if (!validUrl.isUri(url)) {
@@ -72,7 +71,7 @@ module.exports = NodeHelper.create({
 	},
 
 	/* broadcastFeeds()
-	 * Creates an object with all feed items of the different registered feeds, 
+	 * Creates an object with all feed items of the different registered feeds,
 	 * and broadcasts these using sendSocketNotification.
 	 */
 	broadcastFeeds: function() {

modules/default/updatenotification/README.md

@@ -0,0 +1,27 @@
+# Module: Update Notification
+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);

modules/default/updatenotification/node_helper.js

@@ -0,0 +1,87 @@
+var SimpleGit = require("simple-git");
+var simpleGits = [];
+var fs = require("fs");
+var path = require("path");
+var defaultModules = require(__dirname + "/../defaultmodules.js");
+var NodeHelper = require("node_helper");
+
+module.exports = NodeHelper.create({
+
+	config: {},
+
+	updateTimer: null,
+
+	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;
+				try {
+					stat = fs.statSync(path.join(moduleFolder, ".git"));
+				} 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 + "/../../../"))});
+	},
+
+	socketNotificationReceived: function (notification, payload) {
+		if (notification === "CONFIG") {
+			this.config = payload;
+		} else if(notification === "MODULES") {
+			this.configureModules(payload);
+			this.preformFetch();
+		}
+	},
+
+	preformFetch() {
+		var self = this;
+
+		simpleGits.forEach(function(sg) {
+			sg.git.fetch().status(function(err, data) {
+				data.module = sg.module;
+				if (!err) {
+					self.sendSocketNotification("STATUS", data);
+				}
+			});
+		});
+
+		this.scheduleNextFetch(this.config.updateInterval);
+	},
+
+	scheduleNextFetch: function(delay) {
+		if (delay < 60 * 1000) {
+			delay = 60 * 1000
+		}
+
+		var self = this;
+		clearTimeout(this.updateTimer);
+		this.updateTimer = setTimeout(function() {
+			self.preformFetch();
+		}, delay);
+	}
+
+});

modules/default/updatenotification/updatenotification.js

@@ -0,0 +1,70 @@
+Module.register("updatenotification", {
+
+	defaults: {
+		updateInterval: 10 * 60 * 1000, // every 10 minutes
+	},
+
+	status: false,
+
+	start: function () {
+		Log.log("Start updatenotification");
+
+	},
+
+	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});
+		}
+	},
+
+	socketNotificationReceived: function (notification, payload) {
+		if (notification === "STATUS") {
+			this.status = payload;
+			this.updateUI();
+		}
+	},
+
+	updateUI: function() {
+		var self = this;
+		if (this.status && this.status.behind > 0) {
+			self.updateDom(0);
+			self.show(1000, {lockString: self.identifier});
+		}
+	},
+
+	// Override dom generator.
+	getDom: function () {
+		var wrapper = document.createElement("div");
+
+		if (this.status && this.status.behind > 0) {
+			var message = document.createElement("div");
+			message.className = "small bright";
+
+			var icon = document.createElement("i");
+			icon.className = "fa fa-exclamation-circle";
+			icon.innerHTML = " ";
+			message.appendChild(icon);
+
+			var text = document.createElement("span");
+			if (this.status.module == "default") {
+				text.innerHTML = this.translate("UPDATE_NOTIFICATION");
+			} else {
+				text.innerHTML = this.translate("UPDATE_NOTIFICATION_MODULE").replace("MODULE_NAME", this.status.module);
+			}
+			message.appendChild(text);
+
+			wrapper.appendChild(message);
+
+			var subtext = document.createElement("div");
+			subtext.innerHTML = this.translate("UPDATE_INFO")
+									.replace("COMMIT_COUNT", this.status.behind + " " + ((this.status.behind == 1)? "commit" : "commits"))
+									.replace("BRANCH_NAME", this.status.current);
+			subtext.className = "xsmall dimmed";
+			wrapper.appendChild(subtext);
+		}
+
+		return wrapper;
+	}
+});

modules/default/weatherforecast/README.md

@@ -8,14 +8,14 @@ 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.
+		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://bulk.openweather.org/sample/ 
-			appid: 'abcde12345abcde12345abcde12345ab' //openweathermap.org API key.
+			location: "Amsterdam,Netherlands",
+			locationID: "", //Location ID from http://openweathermap.org/help/city_list.txt
+			appid: "abcde12345abcde12345abcde12345ab" //openweathermap.org API key.
 		}
 	}
 ]
@@ -25,145 +25,50 @@ modules: [
 
 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](http://openweathermap.org/help/city_list.txt) **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_
+| `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 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 table below
+  `colored`                    | If set 'colored' to true the min-temp get a blue tone and the max-temp get a red tone. <br><br> **Default value:** `'false'`
 
-<table width="100%">
-	<!-- why, markdown... -->
-	<thead>
-		<tr>
-			<th>Option</th>
-			<th width="100%">Description</th>
-		</tr>
-	<thead>
-	<tbody>
-
-		<tr>
-			<td><code>location</code></td>
-			<td>The location used for weather information.<br>
-				<br><b>Example:</b> <code>Amsterdam,Netherlands</code>
-				<br><b>Default value:</b> <code>New York</code>
-			</td>
-		</tr>
-		<tr>
-			<td><code>locationID</code></td>
-			<td>Location ID from <a href="http://bulk.openweather.org/sample/">OpenWeather</a> <b>This will override anything you put in location.</b><br>Leave blank if you want to use location.
-				<br><b>Example:</b> <code>1234567</code>
-				<br><b>Default value:</b> <code></code>
-			</td>
-		</tr>
-		<tr>
-			<td><code>appid</code></td>
-			<td>The <a href="https://home.openweathermap.org" target="_blank">OpenWeatherMap</a> API key, which can be obtained by creating an OpenWeatherMap account.<br>
-				<br> This value is <b>REQUIRED</b>
-			</td>
-		</tr>
-		<tr>
-			<td><code>units</code></td>
-			<td>What units to use. Specified by config.js<br>
-				<br><b>Possible values:</b> <code>config.units</code> = Specified by config.js, <code>default</code> = Kelvin, <code>metric</code> = Celsius, <code>imperial</code> =Fahrenheit
-				<br><b>Default value:</b> <code>config.units</code>
-			</td>
-		</tr>
-		<tr>
-			<td><code>maxNumberOfDays</code></td>
-			<td>How many days of forecast to return. Specified by config.js<br>
-				<br><b>Possible values:</b> <code>1</code> - <code>16</code>
-				<br><b>Default value:</b> <code>7</code> (7 days)
-				<br>This value is optional. By default the weatherforecast module will return 7 days.
-			</td>
-		</tr>
-		<tr>
-			<td><code>updateInterval</code></td>
-			<td>How often does the content needs to be fetched? (Milliseconds)<br>
-				<br><b>Possible values:</b> <code>1000</code> - <code>86400000</code>
-				<br><b>Default value:</b> <code>300000</code> (10 minutes)
-			</td>
-		</tr>
-		<tr>
-			<td><code>animationSpeed</code></td>
-			<td>Speed of the update animation. (Milliseconds)<br>
-				<br><b>Possible values:</b><code>0</code> - <code>5000</code>
-				<br><b>Default value:</b> <code>2000</code> (2 seconds)
-			</td>
-		</tr>
-
-		<tr>
-			<td><code>lang</code></td>
-			<td>The language of the days.<br>
-				<br><b>Possible values:</b> <code>en</code>, <code>nl</code>, <code>ru</code>, etc ...
-				<br><b>Default value:</b> uses value of <i>config.language</i>
-			</td>
-		</tr>
-		<tr>
-			<td><code>fade</code></td>
-			<td>Fade the future events to black. (Gradient)<br>
-				<br><b>Possible values:</b> <code>true</code> or <code>false</code>
-				<br><b>Default value:</b> <code>true</code>
-			</td>
-		</tr>
-		<tr>
-			<td><code>fadePoint</code></td>
-			<td>Where to start fade?<br>
-				<br><b>Possible values:</b> <code>0</code> (top of the list) - <code>1</code> (bottom of list)
-				<br><b>Default value:</b> <code>0.25</code>
-			</td>
-		</tr>
-		<tr>
-			<td><code>initialLoadDelay</code></td>
-			<td>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><b>Possible values:</b> <code>1000</code> - <code>5000</code>
-				<br><b>Default value:</b>  <code>0</code>
-			</td>
-		</tr>
-		<tr>
-			<td><code>retryDelay</code></td>
-			<td>The delay before retrying after a request failure. (Milliseconds)<br>
-				<br><b>Possible values:</b> <code>1000</code> - <code>60000</code>
-				<br><b>Default value:</b>  <code>2500</code>
-			</td>
-		</tr>
-		<tr>
-			<td><code>apiVersion</code></td>
-			<td>The OpenWeatherMap API version to use.<br>
-				<br><b>Default value:</b>  <code>2.5</code>
-			</td>
-		</tr>
-		<tr>
-			<td><code>apiBase</code></td>
-			<td>The OpenWeatherMap base URL.<br>
-				<br><b>Default value:</b>  <code>'http://api.openweathermap.org/data/'</code>
-			</td>
-		</tr>
-		<tr>
-			<td><code>weatherEndpoint</code></td>
-			<td>The OpenWeatherMap API endPoint.<br>
-				<br><b>Default value:</b>  <code>'forecast/daily'</code>
-			</td>
-		</tr>
-		<tr>
-			<td><code>iconTable</code></td>
-			<td>The conversion table to convert the weather conditions to weather-icons.<br>
-				<br><b>Default value:</b>  <code>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'
-		}</code>
-			</td>
-		</tr>
-
-	</tbody>
-</table>
+#### 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'
+}
+````

modules/default/weatherforecast/weatherforecast.css

@@ -12,3 +12,16 @@
   padding-left: 20px;
   padding-right: 0;
 }
+
+.weatherforecast .rain {
+  padding-left: 20px;
+  padding-right: 0;
+}
+
+.weatherforecast tr.colored .min-temp {
+    color: #BCDDFF;
+}
+
+.weatherforecast tr.colored .max-temp {
+    color: #FF8E99;
+}

modules/default/weatherforecast/weatherforecast.js

@@ -11,17 +11,19 @@ Module.register("weatherforecast",{
 
 	// Default module config.
 	defaults: {
-		location: "",
-		locationID: "",
+		location: false,
+		locationID: false,
 		appid: "",
 		units: config.units,
 		maxNumberOfDays: 7,
+		showRainAmount: false,
 		updateInterval: 10 * 60 * 1000, // every 10 minutes
 		animationSpeed: 1000,
 		timeFormat: config.timeFormat,
 		lang: config.language,
 		fade: true,
 		fadePoint: 0.25, // Start on 1/4th of the list.
+		colored: false,
 
 		initialLoadDelay: 2500, // 2.5 seconds delay. This delay is used to keep the OpenWeather API happy.
 		retryDelay: 2500,
@@ -30,6 +32,11 @@ Module.register("weatherforecast",{
 		apiBase: "http://api.openweathermap.org/data/",
 		forecastEndpoint: "forecast/daily",
 
+		appendLocationNameToHeader: true,
+		calendarClass: "calendar",
+
+		roundTemp: false,
+
 		iconTable: {
 			"01d": "wi-day-sunny",
 			"02d": "wi-day-cloudy",
@@ -52,6 +59,12 @@ Module.register("weatherforecast",{
 		},
 	},
 
+	// create a variable for the first upcoming calendaar event. Used if no location is specified.
+	firstEvent: false,
+
+	// create a variable to hold the location name based on the API result.
+	fetchedLocatioName: "",
+
 	// Define required scripts.
 	getScripts: function() {
 		return ["moment.js"];
@@ -64,8 +77,8 @@ Module.register("weatherforecast",{
 
 	// Define required translations.
 	getTranslations: function() {
-		// The translations for the defaut modules are defined in the core translation files.
-		// Therefor we can just return false. Otherwise we should have returned a dictionairy.
+		// 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.
 		return false;
 	},
@@ -95,14 +108,8 @@ Module.register("weatherforecast",{
 			return wrapper;
 		}
 
-		if (this.config.location === "") {
-			wrapper.innerHTML = "Please set the openweather <i>location</i> in the config for module: " + this.name + ".";
-			wrapper.className = "dimmed light small";
-			return wrapper;
-		}
-
 		if (!this.loaded) {
-			wrapper.innerHTML = this.translate('LOADING');
+			wrapper.innerHTML = this.translate("LOADING");
 			wrapper.className = "dimmed light small";
 			return wrapper;
 		}
@@ -114,6 +121,9 @@ Module.register("weatherforecast",{
 			var forecast = this.forecast[f];
 
 			var row = document.createElement("tr");
+			if (this.config.colored) {
+				row.className = "colored";
+			}
 			table.appendChild(row);
 
 			var dayCell = document.createElement("td");
@@ -139,6 +149,21 @@ Module.register("weatherforecast",{
 			minTempCell.className = "align-right min-temp";
 			row.appendChild(minTempCell);
 
+			if (this.config.showRainAmount) {
+				var rainCell = document.createElement("td");
+				if (isNaN(forecast.rain)) {
+					rainCell.innerHTML = "";
+				} else {
+					if(config.units !== "imperial") {
+						rainCell.innerHTML = forecast.rain + " mm";
+					} else {
+						rainCell.innerHTML = (parseFloat(forecast.rain) / 25.4).toFixed(2) + " in";
+					}
+				}
+				rainCell.className = "align-right bright rain";
+				row.appendChild(rainCell);
+			}
+
 			if (this.config.fade && this.config.fadePoint < 1) {
 				if (this.config.fadePoint < 0) {
 					this.config.fadePoint = 0;
@@ -156,12 +181,51 @@ Module.register("weatherforecast",{
 		return table;
 	},
 
+	// Override getHeader method.
+	getHeader: function() {
+		if (this.config.appendLocationNameToHeader) {
+			return this.data.header + " " + this.fetchedLocatioName;
+		}
+
+		return this.data.header;
+	},
+
+	// Override notification handler.
+	notificationReceived: function(notification, payload, sender) {
+		if (notification === "DOM_OBJECTS_CREATED") {
+			if (this.config.appendLocationNameToHeader) {
+				this.hide(0, {lockString: this.identifier});
+			}
+		}
+		if (notification === "CALENDAR_EVENTS") {
+			var senderClasses = sender.data.classes.toLowerCase().split(" ");
+			if (senderClasses.indexOf(this.config.calendarClass.toLowerCase()) !== -1) {
+				var lastEvent =  this.firstEvent;
+				this.firstEvent = false;
+
+				for (e in payload) {
+					var event = payload[e];
+					if (event.location || event.geo) {
+						this.firstEvent = event;
+						//Log.log("First upcoming event with location: ", event);
+						break;
+					}
+				}
+			}
+		}
+	},
+
 	/* updateWeather(compliments)
 	 * Requests new data from openweather.org.
 	 * Calls processWeather on succesfull response.
 	 */
 	updateWeather: function() {
-		var url = this.config.apiBase + this.config.apiVersion + "/" + this.config.forecastEndpoint + '/' + this.getParams();
+		if (this.config.appid === "") {
+			Log.error("WeatherForecast: APPID not set!");
+			return;
+		}
+
+		var url = this.config.apiBase + this.config.apiVersion + "/" + this.config.forecastEndpoint + this.getParams();
 		var self = this;
 		var retry = true;
 
@@ -172,11 +236,10 @@ Module.register("weatherforecast",{
 				if (this.status === 200) {
 					self.processWeather(JSON.parse(this.response));
 				} else if (this.status === 401) {
-					self.config.appid = "";
 					self.updateDom(self.config.animationSpeed);
 
 					Log.error(self.name + ": Incorrect APPID.");
-					retry = false;
+					retry = true;
 				} else {
 					Log.error(self.name + ": Could not load weather.");
 				}
@@ -196,11 +259,19 @@ Module.register("weatherforecast",{
 	 */
 	getParams: function() {
 		var params = "?";
-		if(this.config.locationID !== "") {
+		if(this.config.locationID) {
 			params += "id=" + this.config.locationID;
-		} else {
+		} else if(this.config.location) {
 			params += "q=" + this.config.location;
+		} else if (this.firstEvent && this.firstEvent.geo) {
+			params += "lat=" + this.firstEvent.geo.lat + "&lon=" + this.firstEvent.geo.lon
+		} else if (this.firstEvent && this.firstEvent.location) {
+			params += "q=" + this.firstEvent.location;
+		} else {
+			this.hide(this.config.animationSpeed, {lockString:this.identifier});
+			return;
 		}
+
 		params += "&units=" + this.config.units;
 		params += "&lang=" + this.config.lang;
 		/*
@@ -220,6 +291,7 @@ Module.register("weatherforecast",{
 	 * argument data object - Weather information received form openweather.org.
 	 */
 	processWeather: function(data) {
+		this.fetchedLocatioName = data.city.name + ", " + data.city.country;
 
 		this.forecast = [];
 		for (var i = 0, count = data.list.length; i < count; i++) {
@@ -230,13 +302,14 @@ Module.register("weatherforecast",{
 				day: moment(forecast.dt, "X").format("ddd"),
 				icon: this.config.iconTable[forecast.weather[0].icon],
 				maxTemp: this.roundValue(forecast.temp.max),
-				minTemp: this.roundValue(forecast.temp.min)
+				minTemp: this.roundValue(forecast.temp.min),
+				rain: this.roundValue(forecast.rain)
 
 			});
 		}
 
 		//Log.log(this.forecast);
-
+		this.show(this.config.animationSpeed, {lockString:this.identifier});
 		this.loaded = true;
 		this.updateDom(this.config.animationSpeed);
 	},
@@ -279,13 +352,14 @@ Module.register("weatherforecast",{
 	},
 
 	/* function(temperature)
-	 * Rounds a temperature to 1 decimal.
+	 * Rounds a temperature to 1 decimal or integer (depending on config.roundTemp).
 	 *
 	 * argument temperature number - Temperature.
 	 *
 	 * return number - Rounded Temperature.
 	 */
 	roundValue: function(temperature) {
-		return parseFloat(temperature).toFixed(1);
+		var decimals = this.config.roundTemp ? 0 : 1;
+		return parseFloat(temperature).toFixed(decimals);
 	}
 });

modules/node_modules/node_helper/index.js

@@ -14,6 +14,11 @@ NodeHelper = Class.extend({
 		console.log("Initializing new module helper ...");
 	},
 
+	loaded: function(callback) {
+		console.log("Module helper loaded: " + this.name);
+		callback();
+	},
+
 	start: function() {
 		console.log("Staring module helper: " + this.name);
 	},
@@ -21,7 +26,7 @@ NodeHelper = Class.extend({
 	/* socketNotificationReceived(notification, payload)
 	 * This method is called when a socket notification arrives.
 	 *
-	 * argument notification string - The identifier of the noitication.
+	 * argument notification string - The identifier of the notification.
 	 * argument payload mixed - The payload of the notification.
 	 */
 	socketNotificationReceived: function(notification, payload) {
@@ -49,7 +54,7 @@ NodeHelper = Class.extend({
 	/* sendSocketNotification(notification, payload)
 	 * Send a socket notification to the node helper.
 	 *
-	 * argument notification string - The identifier of the noitication.
+	 * argument notification string - The identifier of the notification.
 	 * argument payload mixed - The payload of the notification.
 	 */
 	sendSocketNotification: function(notification, payload) {

package.json

@@ -1,16 +1,15 @@
 {
   "name": "magicmirror",
-  "version": "2.0.0",
-  "description": "A modular interface for smart mirrors.",
+  "version": "2.1.1",
+  "description": "The open source modular smart mirror platform.",
   "main": "js/electron.js",
   "scripts": {
-    "start": "electron js/electron.js",
-    "jscs": "jscs **/**/**/**/*.js",
-    "stylelint": "stylelint css/main.css fonts/roboto.css",
-    "htmlvalidator": "html-validator --file=index.html",
-    "test": "snyk test",
-    "snyk-protect": "snyk protect",
-    "prepublish": "npm run snyk-protect"
+    "start": "sh run-start.sh",
+    "install": "cd vendor && npm install",
+    "postinstall": "sh installers/postinstall/postinstall.sh",
+    "test": "./node_modules/mocha/bin/mocha tests --recursive",
+    "test:unit": "./node_modules/mocha/bin/mocha tests/unit --recursive",
+    "test:e2e": "./node_modules/mocha/bin/mocha tests/e2e --recursive"
   },
   "repository": {
     "type": "git",
@@ -23,33 +22,43 @@
     "modular"
   ],
   "author": "Michael Teeuw",
-  "contributors": "https://github.com/MichMich/MagicMirror/graphs/contributors",
+  "contributors": [
+    "https://github.com/MichMich/MagicMirror/graphs/contributors"
+  ],
   "license": "MIT",
   "bugs": {
     "url": "https://github.com/MichMich/MagicMirror/issues"
   },
   "homepage": "https://github.com/MichMich/MagicMirror#readme",
   "devDependencies": {
-    "electron-prebuilt": "latest",
+    "chai": "^3.5.0",
+    "chai-as-promised": "^6.0.0",
     "grunt": "latest",
     "grunt-eslint": "latest",
-    "grunt-postcss": "latest",
-    "postcss-reporter": "latest",
-    "stylelint": "latest",
+    "grunt-jsonlint": "latest",
+    "grunt-markdownlint": "^1.0.13",
+    "grunt-stylelint": "latest",
+    "grunt-yamllint": "latest",
+    "http-auth": "^3.1.3",
+    "mocha": "^3.2.0",
+    "spectron": "^3.4.1",
     "stylelint-config-standard": "latest",
     "time-grunt": "latest"
   },
   "dependencies": {
+    "colors": "^1.1.2",
+    "electron": "^1.4.7",
     "express": "^4.14.0",
+    "express-ipfilter": "latest",
     "feedme": "latest",
+    "helmet": "^3.1.0",
     "iconv-lite": "latest",
     "moment": "latest",
-    "request": "^2.74.0",
-    "rrule": "latest",
-    "snyk": "^1.14.1",
-    "socket.io": "^1.4.6",
+    "request": "^2.78.0",
+    "rrule-alt": "^2.2.3",
+    "simple-git": "^1.62.0",
+    "socket.io": "^1.7.3",
     "valid-url": "latest",
     "walk": "latest"
-  },
-  "snyk": true
-}
+  }
+}

run-start.sh

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

serveronly/index.js

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

splashscreen/MagicMirror.plymouth

@@ -0,0 +1,8 @@
+[Plymouth Theme]
+Name=MagicMirror
+Description=Mirror Splash
+ModuleName=script
+
+[script]
+ImageDir=/usr/share/plymouth/themes/MagicMirror
+ScriptFile=/usr/share/plymouth/themes/MagicMirror/MagicMirror.script

splashscreen/MagicMirror.script

@@ -0,0 +1,53 @@
+screen_width = Window.GetWidth();
+screen_height = Window.GetHeight();
+
+if (Plymouth.GetMode() != "shutdown")
+{
+	theme_image = Image("splash.png");
+}
+else
+{
+	theme_image = Image("splash_halt.png");
+}
+
+image_width = theme_image.GetWidth();
+image_height = theme_image.GetHeight();
+
+scale_x = image_width / screen_width;
+scale_y = image_height / screen_height;
+
+if (scale_x > 1 || scale_y > 1)
+{
+	if (scale_x > scale_y)
+	{
+		resized_image = theme_image.Scale (screen_width, image_height / scale_x);
+		image_x = 0;
+		image_y = (screen_height - ((image_height  * screen_width) / image_width)) / 2;
+	}
+	else
+	{
+		resized_image = theme_image.Scale (image_width / scale_y, screen_height);
+		image_x = (screen_width - ((image_width  * screen_height) / image_height)) / 2;
+		image_y = 0;
+	}
+}
+else
+{
+	resized_image = theme_image.Scale (image_width, image_height);
+	image_x = (screen_width - image_width) / 2;
+	image_y = (screen_height - image_height) / 2;
+}
+
+sprite = Sprite (resized_image);
+sprite.SetPosition (image_x, image_y, -100);
+
+message_sprite = Sprite();
+message_sprite.SetPosition(screen_width * 0.1, screen_height * 0.9, 10000);
+
+fun message_callback (text) {
+	my_image = Image.Text(text, 1, 1, 1);
+	message_sprite.SetImage(my_image);
+	sprite.SetImage (resized_image);
+}
+
+Plymouth.SetUpdateStatusFunction(message_callback);

tests/configs/data/calendar_test.ics

@@ -0,0 +1,190 @@
+BEGIN:VCALENDAR
+PRODID:-//Google Inc//Google Calendar 70.9054//EN
+VERSION:2.0
+CALSCALE:GREGORIAN
+METHOD:PUBLISH
+X-WR-CALNAME:MagicMirrorTest
+X-WR-TIMEZONE:America/Santiago
+X-WR-CALDESC:Testing propose MagicMirror
+BEGIN:VTIMEZONE
+TZID:America/Santiago
+X-LIC-LOCATION:America/Santiago
+BEGIN:STANDARD
+TZOFFSETFROM:-0300
+TZOFFSETTO:-0400
+TZNAME:-04
+DTSTART:19700510T000000
+RDATE:19700510T030000
+RDATE:19710509T030000
+RDATE:19720514T030000
+RDATE:19730513T030000
+RDATE:19740512T030000
+RDATE:19750511T030000
+RDATE:19760509T030000
+RDATE:19770515T030000
+RDATE:19780514T030000
+RDATE:19790513T030000
+RDATE:19800511T030000
+RDATE:19810510T030000
+RDATE:19820509T030000
+RDATE:19830515T030000
+RDATE:19840513T030000
+RDATE:19850512T030000
+RDATE:19860511T030000
+RDATE:19870510T030000
+RDATE:19880515T030000
+RDATE:19890514T030000
+RDATE:19900513T030000
+RDATE:19910512T030000
+RDATE:19920510T030000
+RDATE:19930509T030000
+RDATE:19940515T030000
+RDATE:19950514T030000
+RDATE:19960512T030000
+RDATE:19970511T030000
+RDATE:19980510T030000
+RDATE:19990509T030000
+RDATE:20000514T030000
+RDATE:20010513T030000
+RDATE:20020512T030000
+RDATE:20030511T030000
+RDATE:20040509T030000
+RDATE:20050515T030000
+RDATE:20060514T030000
+RDATE:20070513T030000
+RDATE:20080511T030000
+RDATE:20090510T030000
+RDATE:20100509T030000
+RDATE:20110515T030000
+RDATE:20120513T030000
+RDATE:20130512T030000
+RDATE:20140511T030000
+RDATE:20150510T030000
+RDATE:20160515T030000
+RDATE:20170514T030000
+RDATE:20180513T030000
+RDATE:20190512T030000
+RDATE:20200510T030000
+RDATE:20210509T030000
+RDATE:20220515T030000
+RDATE:20230514T030000
+RDATE:20240512T030000
+RDATE:20250511T030000
+RDATE:20260510T030000
+RDATE:20270509T030000
+RDATE:20280514T030000
+RDATE:20290513T030000
+RDATE:20300512T030000
+RDATE:20310511T030000
+RDATE:20320509T030000
+RDATE:20330515T030000
+RDATE:20340514T030000
+RDATE:20350513T030000
+RDATE:20360511T030000
+RDATE:20370510T030000
+END:STANDARD
+BEGIN:STANDARD
+TZOFFSETFROM:-0300
+TZOFFSETTO:-0400
+TZNAME:-04
+DTSTART:20380509T000000
+RRULE:FREQ=YEARLY;BYMONTH=5;BYDAY=2SU
+END:STANDARD
+BEGIN:DAYLIGHT
+TZOFFSETFROM:-0400
+TZOFFSETTO:-0300
+TZNAME:-03
+DTSTART:19700809T000000
+RDATE:19700809T040000
+RDATE:19710815T040000
+RDATE:19720813T040000
+RDATE:19730812T040000
+RDATE:19740811T040000
+RDATE:19750810T040000
+RDATE:19760815T040000
+RDATE:19770814T040000
+RDATE:19780813T040000
+RDATE:19790812T040000
+RDATE:19800810T040000
+RDATE:19810809T040000
+RDATE:19820815T040000
+RDATE:19830814T040000
+RDATE:19840812T040000
+RDATE:19850811T040000
+RDATE:19860810T040000
+RDATE:19870809T040000
+RDATE:19880814T040000
+RDATE:19890813T040000
+RDATE:19900812T040000
+RDATE:19910811T040000
+RDATE:19920809T040000
+RDATE:19930815T040000
+RDATE:19940814T040000
+RDATE:19950813T040000
+RDATE:19960811T040000
+RDATE:19970810T040000
+RDATE:19980809T040000
+RDATE:19990815T040000
+RDATE:20000813T040000
+RDATE:20010812T040000
+RDATE:20020811T040000
+RDATE:20030810T040000
+RDATE:20040815T040000
+RDATE:20050814T040000
+RDATE:20060813T040000
+RDATE:20070812T040000
+RDATE:20080810T040000
+RDATE:20090809T040000
+RDATE:20100815T040000
+RDATE:20110814T040000
+RDATE:20120812T040000
+RDATE:20130811T040000
+RDATE:20140810T040000
+RDATE:20150809T040000
+RDATE:20160814T040000
+RDATE:20170813T040000
+RDATE:20180812T040000
+RDATE:20190811T040000
+RDATE:20200809T040000
+RDATE:20210815T040000
+RDATE:20220814T040000
+RDATE:20230813T040000
+RDATE:20240811T040000
+RDATE:20250810T040000
+RDATE:20260809T040000
+RDATE:20270815T040000
+RDATE:20280813T040000
+RDATE:20290812T040000
+RDATE:20300811T040000
+RDATE:20310810T040000
+RDATE:20320815T040000
+RDATE:20330814T040000
+RDATE:20340813T040000
+RDATE:20350812T040000
+RDATE:20360810T040000
+RDATE:20370809T040000
+END:DAYLIGHT
+BEGIN:DAYLIGHT
+TZOFFSETFROM:-0400
+TZOFFSETTO:-0300
+TZNAME:-03
+DTSTART:20380815T000000
+RRULE:FREQ=YEARLY;BYMONTH=8;BYDAY=2SU
+END:DAYLIGHT
+END:VTIMEZONE
+BEGIN:VEVENT
+DTSTART;TZID=America/Santiago:20170309T100000
+DTEND;TZID=America/Santiago:20170309T110000
+RRULE:FREQ=MONTHLY;INTERVAL=30;BYMONTHDAY=9
+DTSTAMP:20170310T172720Z
+UID:80rl9kuu5bq49gme99eklov27k@google.com
+CREATED:20170310T172400Z
+DESCRIPTION:
+LAST-MODIFIED:20170310T172400Z
+LOCATION:
+SEQUENCE:0
+STATUS:CONFIRMED
+SUMMARY:TestEvent
+TRANSP:OPAQUE
+END:VEVENT
+END:VCALENDAR

tests/configs/empty_ipWhiteList.js

@@ -0,0 +1,25 @@
+/* Magic Mirror Test config sample ipWhitelist
+ *
+ * By Rodrigo Ramírez Norambuena https://rodrigoramirez.com
+ * MIT Licensed.
+ */
+
+var config = {
+	port: 8080,
+	ipWhitelist: [],
+
+	language: "en",
+	timeFormat: 24,
+	units: "metric",
+	electronOptions: {
+		webPreferences: {
+			nodeIntegration: true,
+		},
+	},
+
+	modules: [
+	]
+};
+
+/*************** DO NOT EDIT THE LINE BELOW ***************/
+if (typeof module !== "undefined") {module.exports = config;}

tests/configs/env.js

@@ -0,0 +1,25 @@
+/* Magic Mirror Test config sample enviroment
+ *
+ * By Rodrigo Ramírez Norambuena https://rodrigoramirez.com
+ * MIT Licensed.
+ */
+
+var 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: [
+	]
+};
+
+/*************** DO NOT EDIT THE LINE BELOW ***************/
+if (typeof module !== "undefined") {module.exports = config;}

tests/configs/modules/calendar/auth-default.js

@@ -0,0 +1,41 @@
+/* Magic Mirror Test config default calendar with auth by default
+ *
+ * By Rodrigo Ramírez Norambuena https://rodrigoramirez.com
+ * MIT Licensed.
+ */
+
+var 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: "calendar",
+			position: "bottom_bar",
+			config: {
+				calendars: [
+					{
+						maximumNumberOfDays: 10000,
+						url: "http://localhost:8011/tests/configs/data/calendar_test.ics",
+						auth: {
+							user: "MagicMirror",
+							pass: "CallMeADog"
+						}
+					}
+				]
+			}
+		}
+	]
+};
+
+/*************** DO NOT EDIT THE LINE BELOW ***************/
+if (typeof module !== "undefined") {module.exports = config;}

tests/configs/modules/calendar/basic-auth.js

@@ -0,0 +1,42 @@
+/* Magic Mirror Test config default calendar
+ *
+ * By Rodrigo Ramírez Norambuena https://rodrigoramirez.com
+ * MIT Licensed.
+ */
+
+var 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: "calendar",
+			position: "bottom_bar",
+			config: {
+				calendars: [
+					{
+						maximumNumberOfDays: 10000,
+						url: "http://localhost:8010/tests/configs/data/calendar_test.ics",
+						auth: {
+							user: "MagicMirror",
+							pass: "CallMeADog",
+							method: "basic"
+						}
+					}
+				]
+			}
+		}
+	]
+};
+
+/*************** DO NOT EDIT THE LINE BELOW ***************/
+if (typeof module !== "undefined") {module.exports = config;}

tests/configs/modules/calendar/default.js

@@ -0,0 +1,37 @@
+/* Magic Mirror Test config default calendar
+ *
+ * By Rodrigo Ramírez Norambuena https://rodrigoramirez.com
+ * MIT Licensed.
+ */
+
+var 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: "calendar",
+			position: "bottom_bar",
+			config: {
+				calendars: [
+					{
+						maximumNumberOfDays: 10000,
+						url: "http://localhost:8080/tests/configs/data/calendar_test.ics"
+					}
+				]
+			}
+		}
+	]
+};
+
+/*************** DO NOT EDIT THE LINE BELOW ***************/
+if (typeof module !== "undefined") {module.exports = config;}

tests/configs/modules/calendar/fail-basic-auth.js

@@ -0,0 +1,44 @@
+/* Magic Mirror Test calendar calendar
+ *
+ * This configuration is a wrong authentication
+ *
+ * By Rodrigo Ramírez Norambuena https://rodrigoramirez.com
+ * MIT Licensed.
+ */
+
+var 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: "calendar",
+			position: "bottom_bar",
+			config: {
+				calendars: [
+					{
+						maximumNumberOfDays: 10000,
+						url: "http://localhost:8020/tests/configs/data/calendar_test.ics",
+						auth: {
+							user: "MagicMirror",
+							pass: "StairwayToHeaven",
+							method: "basic"
+						}
+					}
+				]
+			}
+		}
+	]
+};
+
+/*************** DO NOT EDIT THE LINE BELOW ***************/
+if (typeof module !== "undefined") {module.exports = config;}

tests/configs/modules/calendar/old-basic-auth.js

@@ -0,0 +1,39 @@
+/* Magic Mirror Test config default calendar
+ *              with authenticacion old config
+ * By Rodrigo Ramírez Norambuena https://rodrigoramirez.com
+ * MIT Licensed.
+ */
+
+var 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: "calendar",
+			position: "bottom_bar",
+			config: {
+				calendars: [
+					{
+						maximumNumberOfDays: 10000,
+						url: "http://localhost:8012/tests/configs/data/calendar_test.ics",
+						user: "MagicMirror",
+						pass: "CallMeADog"
+					}
+				]
+			}
+		}
+	]
+};
+
+/*************** DO NOT EDIT THE LINE BELOW ***************/
+if (typeof module !== "undefined") {module.exports = config;}

tests/configs/modules/clock/clock_12hr.js

@@ -0,0 +1,29 @@
+/* Magic Mirror Test config for default clock module
+ *
+ * By Sergey Morozov
+ * MIT Licensed.
+ */
+
+var 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: "clock",
+			position: "middle_center"
+		}
+	]
+};
+
+/*************** DO NOT EDIT THE LINE BELOW ***************/
+if (typeof module !== "undefined") {module.exports = config;}

tests/configs/modules/clock/clock_24hr.js

@@ -0,0 +1,29 @@
+/* Magic Mirror Test config for default clock module
+ *
+ * By Sergey Morozov
+ * MIT Licensed.
+ */
+
+var 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: "clock",
+			position: "middle_center"
+		}
+	]
+};
+
+/*************** DO NOT EDIT THE LINE BELOW ***************/
+if (typeof module !== "undefined") {module.exports = config;}

tests/configs/modules/clock/clock_displaySeconds_false.js

@@ -0,0 +1,32 @@
+/* Magic Mirror Test config for default clock module
+ *
+ * By Rodrigo Ramírez Norambuena https://rodrigoramirez.com
+ * MIT Licensed.
+ */
+
+var 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: "clock",
+			position: "middle_center",
+			config: {
+				displaySeconds: false
+			}
+		}
+	]
+};
+
+/*************** DO NOT EDIT THE LINE BELOW ***************/
+if (typeof module !== "undefined") {module.exports = config;}

tests/configs/modules/clock/clock_showPeriodUpper.js

@@ -0,0 +1,32 @@
+/* Magic Mirror Test config for default clock module
+ *
+ * By Sergey Morozov
+ * MIT Licensed.
+ */
+
+var 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: "clock",
+			position: "middle_center",
+			config: {
+				showPeriodUpper: true
+			}
+		}
+	]
+};
+
+/*************** DO NOT EDIT THE LINE BELOW ***************/
+if (typeof module !== "undefined") {module.exports = config;}

tests/configs/modules/clock/clock_showWeek.js

@@ -0,0 +1,32 @@
+/* Magic Mirror Test config for default clock module
+ *
+ * By Johan Hammar
+ * MIT Licensed.
+ */
+
+var 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: "clock",
+			position: "middle_center",
+			config: {
+				showWeek: true
+			}
+		}
+	]
+};
+
+/*************** DO NOT EDIT THE LINE BELOW ***************/
+if (typeof module !== "undefined") {module.exports = config;}

tests/configs/modules/clock/es/clock_12hr.js

@@ -0,0 +1,29 @@
+/* Magic Mirror Test config for default clock module
+ *
+ * By Rodrigo Ramírez Norambuena https://rodrigoramirez.com
+ * MIT Licensed.
+ */
+
+var config = {
+	port: 8080,
+	ipWhitelist: ["127.0.0.1", "::ffff:127.0.0.1", "::1"],
+
+	language: "es",
+	timeFormat: 12,
+	units: "metric",
+	electronOptions: {
+		webPreferences: {
+			nodeIntegration: true,
+		},
+	},
+
+	modules: [
+		{
+			module: "clock",
+			position: "middle_center"
+		}
+	]
+};
+
+/*************** DO NOT EDIT THE LINE BELOW ***************/
+if (typeof module !== "undefined") {module.exports = config;}

tests/configs/modules/clock/es/clock_24hr.js

@@ -0,0 +1,29 @@
+/* Magic Mirror Test config for default clock module
+ *
+ * By Rodrigo Ramírez Norambuena https://rodrigoramirez.com
+ * MIT Licensed.
+ */
+
+var config = {
+	port: 8080,
+	ipWhitelist: ["127.0.0.1", "::ffff:127.0.0.1", "::1"],
+
+	language: "es",
+	timeFormat: 24,
+	units: "metric",
+	electronOptions: {
+		webPreferences: {
+			nodeIntegration: true,
+		},
+	},
+
+	modules: [
+		{
+			module: "clock",
+			position: "middle_center"
+		}
+	]
+};
+
+/*************** DO NOT EDIT THE LINE BELOW ***************/
+if (typeof module !== "undefined") {module.exports = config;}

tests/configs/modules/clock/es/clock_showPeriodUpper.js

@@ -0,0 +1,32 @@
+/* Magic Mirror Test config for default clock module
+ *
+ * By Rodrigo Ramírez Norambuena https://rodrigoramirez.com
+ * MIT Licensed.
+ */
+
+var config = {
+	port: 8080,
+	ipWhitelist: ["127.0.0.1", "::ffff:127.0.0.1", "::1"],
+
+	language: "es",
+	timeFormat: 12,
+	units: "metric",
+	electronOptions: {
+		webPreferences: {
+			nodeIntegration: true,
+		},
+	},
+
+	modules: [
+		{
+			module: "clock",
+			position: "middle_center",
+			config: {
+				showPeriodUpper: true
+			}
+		}
+	]
+};
+
+/*************** DO NOT EDIT THE LINE BELOW ***************/
+if (typeof module !== "undefined") {module.exports = config;}

tests/configs/modules/compliments/compliments_anytime.js

@@ -0,0 +1,38 @@
+/* Magic Mirror Test config compliments with anytime type
+ *
+ * By Rodrigo Ramírez Norambuena https://rodrigoramirez.com
+ * MIT Licensed.
+ */
+
+var 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: {
+				compliments: {
+					morning: [],
+					afternoon: [],
+					evening: [],
+					anytime: ["Anytime here"]
+
+				}
+			}
+		}
+	]
+};
+
+/*************** DO NOT EDIT THE LINE BELOW ***************/
+if (typeof module !== "undefined") {module.exports = config;}

tests/configs/modules/compliments/compliments_only_anytime.js

@@ -0,0 +1,35 @@
+/* Magic Mirror Test config compliments with anytime type
+ *
+ * By Rodrigo Ramírez Norambuena https://rodrigoramirez.com
+ * MIT Licensed.
+ */
+
+var 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: {
+				compliments: {
+					anytime: ["Anytime here"]
+
+				}
+			}
+		}
+	]
+};
+
+/*************** DO NOT EDIT THE LINE BELOW ***************/
+if (typeof module !== "undefined") {module.exports = config;}

tests/configs/modules/compliments/compliments_parts_day.js

@@ -0,0 +1,42 @@
+/* Magic Mirror Test config for default compliments 
+ *
+ * By Rodrigo Ramírez Norambuena https://rodrigoramirez.com
+ * MIT Licensed.
+ */
+
+var 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: {
+				compliments: {
+					morning: [
+						"Hi", "Good Morning", "Morning test"
+					],
+					afternoon: [
+						"Hello", "Good Afternoon", "Afternoon test"
+					],
+					evening: [
+						"Hello There", "Good Evening", "Evening test"
+					]
+				}
+			}
+		}
+	]
+};
+
+/*************** DO NOT EDIT THE LINE BELOW ***************/
+if (typeof module !== "undefined") {module.exports = config;}

tests/configs/modules/helloworld/helloworld.js

@@ -0,0 +1,32 @@
+/* Magic Mirror Test config sample module hello world
+ *
+ * By Rodrigo Ramírez Norambuena https://rodrigoramirez.com
+ * MIT Licensed.
+ */
+
+var 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: "helloworld",
+			position: "bottom_bar",
+			config: {
+				text: "Test HelloWorld Module"
+			}
+		}
+	]
+};
+
+/*************** DO NOT EDIT THE LINE BELOW ***************/
+if (typeof module !== "undefined") {module.exports = config;}

tests/configs/modules/positions.js

@@ -0,0 +1,43 @@
+/* Magic Mirror Test config for position setters module
+ *
+ * For this case is using helloworld module
+ *
+ * By Rodrigo Ramírez Norambuena https://rodrigoramirez.com
+ * MIT Licensed.
+ */
+
+
+var config = {
+	port: 8080,
+	ipWhitelist: ["127.0.0.1", "::ffff:127.0.0.1", "::1"],
+	ipWhitelist: [],
+
+	language: "en",
+	timeFormat: 24,
+	units: "metric",
+	electronOptions: {
+		webPreferences: {
+			nodeIntegration: true,
+		},
+	},
+	modules:
+		// Using exotic content. This is why dont accept go to JSON configuration file
+		(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"];
+			var modules = Array();
+			for (idx in positions) {
+				modules.push({
+					module: "helloworld",
+					position: positions[idx],
+					config: {
+						text: "Text in " + positions[idx]
+					}
+				});
+			}
+			return modules;
+		})(),
+};
+/*************** DO NOT EDIT THE LINE BELOW ***************/
+if (typeof module !== "undefined") {module.exports = config;}

tests/configs/noIpWhiteList.js

@@ -0,0 +1,25 @@
+/* Magic Mirror Test config sample ipWhitelist
+ *
+ * By Rodrigo Ramírez Norambuena https://rodrigoramirez.com
+ * MIT Licensed.
+ */
+
+var config = {
+	port: 8080,
+	ipWhitelist: ["x.x.x.x"],
+
+	language: "en",
+	timeFormat: 24,
+	units: "metric",
+	electronOptions: {
+		webPreferences: {
+			nodeIntegration: true,
+		},
+	},
+
+	modules: [
+	]
+};
+
+/*************** DO NOT EDIT THE LINE BELOW ***************/
+if (typeof module !== "undefined") {module.exports = config;}

tests/configs/port_8090.js

@@ -0,0 +1,25 @@
+/* Magic Mirror Test config sample enviroment set por 8090
+ *
+ * By Rodrigo Ramírez Norambuena https://rodrigoramirez.com
+ * MIT Licensed.
+ */
+
+var config = {
+	port: 8090,
+	ipWhitelist: ["127.0.0.1", "::ffff:127.0.0.1", "::1"],
+
+	language: "en",
+	timeFormat: 24,
+	units: "metric",
+	electronOptions: {
+		webPreferences: {
+			nodeIntegration: true,
+		},
+	},
+
+	modules: [
+	]
+};
+
+/*************** DO NOT EDIT THE LINE BELOW ***************/
+if (typeof module !== "undefined") {module.exports = config;}

tests/configs/without_modules.js

@@ -0,0 +1,23 @@
+/* Magic Mirror Test default config for modules
+ *
+ * By Rodrigo Ramírez Norambuena https://rodrigoramirez.com
+ * MIT Licensed.
+ */
+
+var config = {
+	port: 8080,
+	ipWhitelist: ["127.0.0.1", "::ffff:127.0.0.1", "::1", "::ffff:192.168.10.1"],
+
+	language: "en",
+	timeFormat: 24,
+	units: "metric",
+	electronOptions: {
+		webPreferences: {
+			nodeIntegration: true,
+		},
+	}
+
+};
+
+/*************** DO NOT EDIT THE LINE BELOW ***************/
+if (typeof module !== "undefined") {module.exports = config;}