Merge pull request #2834 from MichMich/develop

Release v2.19.0

.eslintrc.json

@@ -1,10 +1,10 @@
 {
 	"extends": ["eslint:recommended", "plugin:prettier/recommended", "plugin:jsdoc/recommended"],
-	"plugins": ["prettier", "jsdoc"],
+	"plugins": ["prettier", "jsdoc", "jest"],
 	"env": {
 		"browser": true,
 		"es6": true,
-		"mocha": true,
+		"jest/globals": true,
 		"node": true
 	},
 	"globals": {
@@ -16,7 +16,7 @@
 	},
 	"parserOptions": {
 		"sourceType": "module",
-		"ecmaVersion": 2017,
+		"ecmaVersion": 2018,
 		"ecmaFeatures": {
 			"globalReturn": true
 		}
@@ -25,6 +25,7 @@
 		"prettier/prettier": "error",
 		"eqeqeq": "error",
 		"no-prototype-builtins": "off",
-		"no-unused-vars": "off"
+		"no-unused-vars": "off",
+		"no-useless-return": "error"
 	}
 }

.github/CONTRIBUTING.md

@@ -4,13 +4,15 @@ Thanks for contributing to MagicMirror²!
 
 We hold our code to standard, and these standards are documented below.
 
+## Linters
+
 If you wish to run our linters, use `npm run lint` without any arguments.
 
 ### JavaScript: Run ESLint
 
 We use [ESLint](https://eslint.org) on our JavaScript files.
 
-Our ESLint configuration is in our .eslintrc.json and .eslintignore files.
+Our ESLint configuration is in our `.eslintrc.json` and `.eslintignore` files.
 
 To run ESLint, use `npm run lint:js`.
 
@@ -18,9 +20,17 @@ To run ESLint, use `npm run lint:js`.
 
 We use [StyleLint](https://stylelint.io) to lint our CSS. Our configuration is in our .stylelintrc file.
 
-To run StyleLint, use `npm run lint:style`.
+To run StyleLint, use `npm run lint:css`.
 
-### Submitting Issues
+## Testing
+
+We use [Jest](https://jestjs.io) for JavaScript testing.
+
+To run all tests, use `npm run test`.
+
+The specific test commands are defined in `package.json`. So you can also run the specific tests with other commands, e.g. `npm run test:unit` or `npx jest tests/e2e/env_spec.js`.
+
+## Submitting Issues
 
 Please only submit reproducible issues.
 
@@ -32,9 +42,9 @@ When submitting a new issue, please supply the following information:
 
 **Platform**: Place your platform here... give us your web browser/Electron version _and_ your hardware (Raspberry Pi 2/3/4, Windows, Mac, Linux, System V UNIX).
 
-**Node Version**: Make sure it's version 10 or later.
+**Node Version**: Make sure it's version 14 or later (recommended is 16).
 
-**MagicMirror Version**: Now that the versions have split, tell us if you are using the PHP version (v1) or the newer JavaScript version (v2).
+**MagicMirror² Version**: Please let us know which version of MagicMirror² you are running. It can be found in the `package.json` file.
 
 **Description**: Provide a detailed description about the issue and include specific details to help us understand the problem. Adding screenshots will help describing the problem.
 

.github/FUNDING.yml

@@ -1,2 +1,2 @@
 github: MichMich
-custom: ['https://magicmirror.builders/#donate']
+custom: ["https://magicmirror.builders/#donate"]

.github/ISSUE_TEMPLATE.md

@@ -1,3 +1,7 @@
+Hello and thank you for opening an issue.
+
+**Please make sure that you have read the following lines before submitting your Issue:**
+
 ## I'm not sure if this is a bug
 
 If you're not sure if it's a real bug or if it's just you, please open a topic on the forum: [https://forum.magicmirror.builders/category/15/bug-hunt](https://forum.magicmirror.builders/category/15/bug-hunt)
@@ -6,17 +10,19 @@ If you're not sure if it's a real bug or if it's just you, please open a topic o
 
 Problems installing or configuring your MagicMirror? Check out: [https://forum.magicmirror.builders/category/10/troubleshooting](https://forum.magicmirror.builders/category/10/troubleshooting)
 
-A common problem is that your config file could be invalid. Please run in your MagicMirror directory: `npm run config:check` and see if it reports an error.
+A common problem is that your config file could be invalid. Please run in your MagicMirror² directory: `npm run config:check` and see if it reports an error.
 
-## I found a bug in the MagicMirror installer
+## I found a bug in the MagicMirror² installer
 
-If you are facing an issue or found a bug while trying to install MagicMirror via the installer please report it in the respective GitHub repository:
+If you are facing an issue or found a bug while trying to install MagicMirror² via the installer please report it in the respective GitHub repository:
 [https://github.com/sdetweil/MagicMirror_scripts](https://github.com/sdetweil/MagicMirror_scripts)
 
-## I found a bug in the MagicMirror Docker image
+## I found a bug in the MagicMirror² Docker image
 
-If you are facing an issue or found a bug while running MagicMirror inside a Docker container please create an issue in the GitHub repository of the MagicMirror Docker image:
-[https://github.com/bastilimbach/docker-MagicMirror](https://github.com/bastilimbach/docker-MagicMirror)
+If you are facing an issue or found a bug while running MagicMirror² inside a Docker container please create an issue in the corresponding repository:
+
+- karsten13/magicmirror: [https://gitlab.com/khassel/magicmirror](https://gitlab.com/khassel/magicmirror)
+- (deprecated) bastilimbach/docker-magicmirror: [https://github.com/bastilimbach/docker-MagicMirror](https://github.com/bastilimbach/docker-MagicMirror)
 
 ---
 
@@ -27,9 +33,9 @@ When submitting a new issue, please supply the following information:
 
 **Platform**: Place your platform here... give us your web browser/Electron version _and_ your hardware (Raspberry Pi 2/3/4, Windows, Mac, Linux, System V UNIX).
 
-**Node Version**: Make sure it's version 10 or later.
+**Node Version**: Make sure it's version 14 or later (recommended is 16).
 
-**MagicMirror Version**: Please let us now which version of MagicMirror you are running. It can be found in the `package.log` file.
+**MagicMirror² Version**: Please let us know which version of MagicMirror² you are running. It can be found in the `package.json` file.
 
 **Description**: Provide a detailed description about the issue and include specific details to help us understand the problem. Adding screenshots will help describing the problem.
 

.github/PULL_REQUEST_TEMPLATE.md

@@ -1,24 +1,21 @@
-Hello and thank you for wanting to contribute to the MagicMirror project
+Hello and thank you for wanting to contribute to the MagicMirror² project
 
 **Please make sure that you have followed these 4 rules before submitting your Pull Request:**
 
-> 1) Base your pull requests against the `develop` branch.
+> 1. Base your pull requests against the `develop` branch.
 >
+> 2. Include these infos in the description:
 >
-> 2) Include these infos in the description:
->  * Does the pull request solve a **related** issue?
->  * If so, can you reference the issue like this `Fixes #<issue_number>`?
->  * What does the pull request accomplish? Use a list if needed.
->  * If it includes major visual changes please add screenshots.
+> - Does the pull request solve a **related** issue?
+> - If so, can you reference the issue like this `Fixes #<issue_number>`?
+> - What does the pull request accomplish? Use a list if needed.
+> - If it includes major visual changes please add screenshots.
 >
+> 3. Please run `npm run lint:prettier` before submitting so that
+>    style issues are fixed.
 >
-> 3) Please run `npm run lint:prettier` before submitting so that
-> style issues are fixed.
->
->
-> 4) Don't forget to add an entry about your changes to
-> the CHANGELOG.md file.
-
+> 4. Don't forget to add an entry about your changes to
+>    the CHANGELOG.md file.
 
 **Note**: Sometimes the development moves very fast. It is highly
 recommended that you update your branch of `develop` before creating a

.github/codecov.yml

@@ -0,0 +1,6 @@
+coverage:
+  status:
+    project:
+      default:
+        # advanced settings
+        informational: true

.github/workflows/automated-tests.yml

@@ -0,0 +1,36 @@
+# This workflow will do a clean install of node dependencies, build the source code and run tests across different versions of node
+# For more information see: https://help.github.com/actions/language-and-framework-guides/using-nodejs-with-github-actions
+
+name: "Run Automated Tests"
+
+on:
+  push:
+    branches: [master, develop]
+  pull_request:
+    branches: [master, develop]
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    timeout-minutes: 30
+    strategy:
+      matrix:
+        node-version: [14.x, 16.x, 17.x]
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v2
+      - name: Use Node.js ${{ matrix.node-version }}
+        uses: actions/setup-node@v2
+        with:
+          node-version: ${{ matrix.node-version }}
+          cache: "npm"
+      - name: Install dependencies and run tests
+        run: |
+          Xvfb :99 -screen 0 1024x768x16 &
+          export DISPLAY=:99
+          npm install
+          touch css/custom.css
+          npm run test:prettier
+          npm run test:js
+          npm run test:css
+          npm run test

.github/workflows/codecov-test-suites.yml

@@ -4,21 +4,26 @@ name: "Run Codecov Tests"
 
 on:
   push:
-    branches: [ master, develop ]
+    branches: [master, develop]
   pull_request:
-    branches: [ master, develop ]
+    branches: [master, develop]
 
 jobs:
   run-and-upload-coverage-report:
     runs-on: ubuntu-latest
+    timeout-minutes: 30
     steps:
-      - uses: actions/checkout@v2
-      - run: |
+      - name: Checkout code
+        uses: actions/checkout@v2
+      - name: Install dependencies and run coverage
+        run: |
           Xvfb :99 -screen 0 1024x768x16 &
           export DISPLAY=:99
           npm ci
+          touch css/custom.css
           npm run test:coverage
-      - uses: codecov/codecov-action@v1
+      - name: Upload coverage results to codecov
+        uses: codecov/codecov-action@v2
         with:
-          file: ./coverage/lcov.info
+          files: ./coverage/lcov.info
           fail_ci_if_error: true

.github/workflows/enforce-changelog.yml

@@ -4,14 +4,17 @@ name: "Enforce Changelog"
 
 on:
   pull_request:
-      types: [opened, synchronize, reopened, ready_for_review, labeled, unlabeled]
+    types: [opened, synchronize, reopened, ready_for_review, labeled, unlabeled]
 
 jobs:
   check:
     runs-on: ubuntu-latest
+    timeout-minutes: 10
     steps:
-    - uses: actions/checkout@v2
-    - uses: dangoslen/changelog-enforcer@v1.6.1
-      with:
-        changeLogPath: 'CHANGELOG.md'
-        skipLabels: 'Skip Changelog'
+      - name: Checkout code
+        uses: actions/checkout@v2
+      - name: Enforce changelog️
+        uses: dangoslen/changelog-enforcer@v2
+        with:
+          changeLogPath: "CHANGELOG.md"
+          skipLabels: "Skip Changelog"

.github/workflows/node-ci.js.yml

@@ -1,32 +0,0 @@
-# This workflow will do a clean install of node dependencies, build the source code and run tests across different versions of node
-# For more information see: https://help.github.com/actions/language-and-framework-guides/using-nodejs-with-github-actions
-
-name: "Run Automated Tests"
-
-on:
-  push:
-    branches: [ master, develop ]
-  pull_request:
-    branches: [ master, develop ]
-
-jobs:
-  test:
-    runs-on: ubuntu-latest
-    strategy:
-      matrix:
-        node-version: [10.x, 12.x, 14.x]
-    steps:
-    - uses: actions/checkout@v2
-    - name: Use Node.js ${{ matrix.node-version }}
-      uses: actions/setup-node@v1
-      with:
-        node-version: ${{ matrix.node-version }}
-    - run: |
-        Xvfb :99 -screen 0 1024x768x16 &
-        export DISPLAY=:99
-        npm install
-        npm run test:prettier
-        npm run test:js
-        npm run test:css
-        npm run test:e2e
-        npm run test:unit

.husky/pre-commit

@@ -0,0 +1,7 @@
+#!/bin/sh
+
+[ -f "$(dirname "$0")/_/husky.sh" ] && . "$(dirname "$0")/_/husky.sh"
+
+if command -v npm &> /dev/null; then
+  npm run lint:staged
+fi

.prettierignore

@@ -1,5 +1,4 @@
+/config
+/coverage
+.nyc_output
 package-lock.json
-/config/**/*
-/vendor/**/*
-!/vendor/vendor.js
-.github/**/*

CHANGELOG.md

@@ -3,7 +3,178 @@
 All notable changes to this project will be documented in this file.
 This project adheres to [Semantic Versioning](https://semver.org/).
 
-❤️ **Donate:** Enjoying MagicMirror²? [Please consider a donation!](https://magicmirror.builders/donate) With your help we can continue to improve the MagicMirror²
+❤️ **Donate:** Enjoying MagicMirror²? [Please consider a donation!](https://magicmirror.builders/donate) With your help we can continue to improve the MagicMirror².
+
+## [2.19.0] - 2022-04-01
+
+Special thanks to the following contributors: @10bias, @CFenner, @JHWelch, @k1rd3rf, @khassel, @kolbyjack, @krekos, @KristjanESPERANTO, @Nerfzooka, @oraclesean, @oscarb, @philnagel, @rejas, @sdetweil, @shin10, @SiderealArt and @Tom-Hirschberger.
+
+### Added
+
+- Added a config option under the weather module, `absoluteDates`, providing an option to format weather forecast date output with either absolute or relative dates.
+- Added test for new weather forecast `absoluteDates` porperty.
+- The modules get a class hidden added/removed if they get hidden/shown which will also toggle pointer-events.
+- Added new config option `showTitleAsUrl` to newsfeed module. If set, the diplayed title is a link to the article which is useful when running in a browser and you want to read this article.
+- Added internal cors proxy to get weather providers working without public proxies (fixes #2714). The new url `http(s)://address:port/cors?url=https://whatever-to-proxy` can be used in other modules too.
+- Added a WeatherProvider for Weatherflow.
+- Added new env var `ELECTRON_DISABLE_GPU` which disable gpu under electron if set (fixes #2831).
+- Added missing Czech translations.
+
+### Updated
+
+- Deprecated roboto fonts package `roboto-fontface-bower` replaced with `fontsource`.
+- Update `electron` to v17, `helmet` to v5 (use defaults of v4) and other dependencies
+- Updates Font Awesome css class to new default style (fixes #2768)
+- Replaced deprecated modules `currentweather` and `weatherforecast` with dummy modules only displaying that they have to be replaced.
+- Include all calendar events from the configured date range when broadcasting.
+- Update Danish and German translation.
+- Update `node-ical` to v0.15 and added `luxon` as dependency for not breaking the "no-optional" install (see #2718 and #2824).
+
+### Fixed
+
+- Improved and speedup e2e tests, artificial wait after mm start removed.
+- Improved husky setup not blocking `git commit` if `husky` or `npm` is not installed.
+- Using a consistent spelling of MagicMirror².
+- Fix minor console output issue for loading translations (#2814).
+- Don't adjust startDate for full day events if endDate is in the past.
+- Fix windspeed conversion error in openweathermap provider. (#2812)
+- Fix conflicting parms turning off showEnd for full day events. (#2629)
+
+## [2.18.0] - 2022-01-01
+
+Special thanks to the following contributors: @AmpioRosso, @eouia, @fewieden, @jupadin, @khassel, @kolbyjack, @KristjanESPERANTO, @MariusVaice, @rejas, @rico24 and @sdetweil.
+
+### Added
+
+- Added test for calendar recurring event with checks the correct date displayed (related to #2752).
+
+### Updated
+
+- ESLint version supports now ECMAScript 2018.
+- Cleaned up `updatenotification` module and switched to nunjuck template.
+- Moved calendar tests from category `electron` to `e2e`.
+- Update missed translations for Korean language (ko.json).
+- Update missed translations for Dutch language (nl.json).
+- Cleaned up `alert` module and switched to nunjuck template.
+- Moved weather tests from category `electron` to `e2e`.
+- Updated github actions.
+- Replace spectron with playwright, update dependencies including electron update to v16.
+- Added lithuanian language to translations.js.
+- Show info message if newsfeed is empty (fixes #2731).
+- Added dangerouslyDisableAutoEscaping config option for newsfeed templates (fixes #2712).
+- Added missing shebang to `installers/mm.sh`.
+- Node versions in templates and github workflows.
+- Updated translations for Traditional Chinese (Taiwan) (zh-tw.json).
+
+### Fixed
+
+- Fixed wrong file `kr.json` to `ko.json`. Use language code 'ko' instead of 'kr' for Korean language.
+- Fixed `feels_like` data from openweathermaps current weather being ignored (#2678).
+- Fixed chaotic newsfeed display after network connection loss thanks to @jalibu (#2638).
+- Fixed incorrect time zone correction of recurring full day events (#2632 and #2634).
+- Fixed e2e tests by increasing testTimeout.
+- Revert node-ical update due to missing luxon package.
+- Fixed User-Agent-Header for newsfeed and calendar module (#2729).
+- Replace broken shields in Readme and use https for links.
+- Fixed electron tests with retry.
+- Fixed Calendar recurring cross timezone error (add/subtract a day, not just offset hours) (#2632).
+- Fixed Calendar showEnd and Full Date overlay (#2629).
+- Fixed regression on #2632, #2752.
+- Broadcast custom symbols in CALENDAR_EVENTS.
+
+## [2.17.1] - 2021-10-01
+
+### Fixed
+
+- Fixed error when accessing letsencrypt certificates
+- Fixed Calendar module enhancement: displaying full events without time (#2424)
+
+## [2.17.0] - 2021-10-01
+
+Special thanks to the following contributors: @apiontek, @eouia, @jupadin, @khassel and @rejas.
+
+### Added
+
+- Added showTime parameter to clock module for enabling/disabling time display in analog clock.
+- Added custom electron switches from user config (`config.electronSwitches`).
+- Added unit tests for updatenotification module.
+
+### Updated
+
+- Bump electron to v13 (and spectron to v15) and update other dependencies in package.json.
+- Refactor test configs, use default test config for all tests.
+- Updated github templates.
+- Actually test all js and css files when lint script is run.
+- Update jsdocs and print warnings during testing too.
+- Update weathergov provider to try fetching not just current, but also foreacst, when API URLs available.
+- Refactored clock layout.
+- Refactored methods from weatherproviders into weatherobject (isDaytime, updateSunTime).
+- Use of `logger.js` in jest tests.
+- Run prettier over all relevant files.
+- Move tests needing electron in new category `electron`, use `server only` mode in `e2e` tests.
+- Update dependencies in package.json.
+
+### Fixed
+
+- Fix undefined error with ignoreToday option in weather module (#2620).
+- Fix time zone correction in calendar module when the date hour is equal to the time zone correction value (#2632).
+- Fix black cursor on startup when using electron.
+- Fix update notification not working for own repository (#2644).
+
+## [2.16.0] - 2021-07-01
+
+Special thanks to the following contributors: @210954, @B1gG, @codac, @Crazylegstoo, @daniel, @earlman, @ezeholz, @FrancoisRmn, @jupadin, @khassel, @KristjanESPERANTO, @njwilliams, @oemel09, @r3wald, @rejas, @rico24, Faizan Ahmed.
+
+### Added
+
+- Added French translations for "MODULE_CONFIG_ERROR" and "PRECIP".
+- Added German translation for "PRECIP".
+- Added Dutch translation for "WEEK", "PRECIP", "MODULE_CONFIG_CHANGED" and "MODULE_CONFIG_ERROR".
+- Added first test for Alert module.
+- Added support for `dateFormat` when not using `timeFormat: "absolute"`.
+- Added custom-properties for colors and fonts for improved styling experience, see `custom.css.sample` file.
+- Added custom-properties for gaps around body and between modules.
+- Added test case for recurring calendar events.
+- Added new Environment Canada provider for default WEATHER module (weather data for Canadian locations only).
+- Added list view for newsfeed module.
+- Added dev dependency jest, switching from mocha to jest.
+
+### Updated
+
+- Bump node-ical to v0.13.0 (now last runtime dependency using deprecated `request` package is removed).
+- Use codecov in informational mode.
+- Refactor code into es6 where possible (e.g. var -> let/const).
+- Use node v16 in github workflow (replacing node v10).
+- Moved some files into better suited directories.
+- Update dependencies in package.json, require node >= v12, remove `rrule-alt` and `rrule`.
+- Update dependencies in package.json and migrate husky to v6, fix husky setup in prod environment.
+- Cleaned up error handling in newsfeed and calendar modules for real.
+- Updated default WEATHER module such that a provider can optionally set a custom unit-of-measure for precipitation (`weatherObject.precipitationUnits`).
+- Update documentation.
+- Update jest tests: Reset changes on js/logger.js, mock logger.js in global_vars tests.
+- Update dependencies in package.json.
+
+### Removed
+
+- Switching from mocha to jest so removed following dev dependencies: chai, chai-as-promised, mocha, mocha-each, mocha-logger.
+
+### Fixed
+
+- Fix calendar start function logging inconsistency.
+- Fix updatenotification start function logging inconsistency.
+- Checks and applies the showDescription setting for the newsfeed module again.
+- Fix issue with openweathermap not showing current or forecast info when using onecall API.
+- Fix tests in weather module and add one for decimalPoint in forecast.
+- Fix decimalSymbol in the forecast part of the new weather module (#2530).
+- Fix wrong treatment of `appendLocationNameToHeader` when using `ukmetofficedatahub`.
+- Fix alert not recognizing multiple alerts (#2522).
+- Fix fetch option httpsAgent to agent in calendar module (#466).
+- Fix module updatenotification which did not work for repos with many refs (#1907).
+- Fix config check failing when encountering let syntax ("Parsing error: Unexpected token config").
+- Fix calendar debug check.
+- Really run prettier over all files.
+- Fix logger.js after jest changes, use --forceExit running jest.
+- Workaround for dev_console test using getWindowCount.
 
 ## [2.15.0] - 2021-04-01
 
@@ -117,7 +288,7 @@ Special thanks to the following contributors: @Alvinger, @AndyPoms, @ashishtank,
 - Rename Greek translation to correct ISO 639-1 alpha-2 code (gr > el). (#2155)
 - Add a space after icons of sunrise and sunset. (#2169)
 - Fix calendar when no DTEND record found in event, startDate overlay when endDate set. (#2177)
-- Fix windspeed convertion error in ukmetoffice weather provider. (#2189)
+- Fix windspeed conversion error in ukmetoffice weather provider. (#2189)
 - Fix console.debug not having timestamps. (#2199)
 - Fix calendar full day event east of UTC start time. (#2200)
 - Fix non-fullday recurring rule processing. (#2216)
@@ -140,8 +311,8 @@ Special thanks to the following contributors: @bryanzzhu, @bugsounet, @chamakura
 ### Added
 
 - `--dry-run` Added option in fetch call within updatenotification node_helper. This is to prevent
-  MagicMirror from consuming any fetch result. Causes conflict with MMPM when attempting to check
-  for updates to MagicMirror and/or MagicMirror modules.
+  MagicMirror² from consuming any fetch result. Causes conflict with MMPM when attempting to check
+  for updates to MagicMirror² and/or MagicMirror² modules.
 - Test coverage with Istanbul, run it with `npm run test:coverage`.
 - Added lithuanian language.
 - Added support in weatherforecast for OpenWeather onecall API.
@@ -214,7 +385,7 @@ Special thanks to the following contributors: @AndreKoepke, @andrezibaia, @bryan
 
 🚨 READ THIS BEFORE UPDATING 🚨
 
-In the past years the project has grown a lot. This came with a huge downside: poor maintainability. If I let the project continue the way it was, it would eventually crash and burn. More important: I would completely lose the drive and interest to continue the project. Because of this the decision was made to simplify the core by removing all side features like automatic installers and support for exotic platforms. This release (2.11.0) is the first real release that will reflect (parts) of these changes. As a result of this, some things might break. So before you continue make sure to backup your installation. Your config, your modules or better yet: your full MagicMirror folder. In other words: update at your own risk.
+In the past years the project has grown a lot. This came with a huge downside: poor maintainability. If I let the project continue the way it was, it would eventually crash and burn. More important: I would completely lose the drive and interest to continue the project. Because of this the decision was made to simplify the core by removing all side features like automatic installers and support for exotic platforms. This release (2.11.0) is the first real release that will reflect (parts) of these changes. As a result of this, some things might break. So before you continue make sure to backup your installation. Your config, your modules or better yet: your full MagicMirror² folder. In other words: update at your own risk.
 
 For more information regarding this major change, please check issue [#1860](https://github.com/MichMich/MagicMirror/issues/1860).
 
@@ -357,6 +528,7 @@ Special thanks to @sdetweil for all his great contributions!
 - Update `ical.js` to solve various calendar issues.
 - Update weather city list url [#1676](https://github.com/MichMich/MagicMirror/issues/1676)
 - Only update clock once per minute when seconds aren't shown
+- Update weatherprovider documentation.
 
 ### Fixed
 
@@ -414,7 +586,7 @@ Fixed `package.json` version number.
 - Fixed unhandled error on bad git data in updatenotification module [#1285](https://github.com/MichMich/MagicMirror/issues/1285).
 - Weather forecast now works with openweathermap in new weather module. Daily data are displayed, see issue [#1504](https://github.com/MichMich/MagicMirror/issues/1504).
 - Fixed analogue clock border display issue where non-black backgrounds used (previous fix for issue 611)
-- Fixed compatibility issues caused when modules request different versions of Font Awesome, see issue [#1522](https://github.com/MichMich/MagicMirror/issues/1522). MagicMirror now uses [Font Awesome 5 with v4 shims included for backwards compatibility](https://fontawesome.com/how-to-use/on-the-web/setup/upgrading-from-version-4#shims).
+- Fixed compatibility issues caused when modules request different versions of Font Awesome, see issue [#1522](https://github.com/MichMich/MagicMirror/issues/1522). MagicMirror² now uses [Font Awesome 5 with v4 shims included for backwards compatibility](https://fontawesome.com/how-to-use/on-the-web/setup/upgrading-from-version-4#shims).
 - Installation script problems with raspbian
 - Calendar: only show repeating count if the event is actually repeating [#1534](https://github.com/MichMich/MagicMirror/pull/1534)
 - Calendar: Fix exdate handling when multiple values are specified (comma separated)
@@ -526,7 +698,7 @@ A huge, huge, huge thanks to user @fewieden for all his hard work on the new `we
 
 ## [2.4.0] - 2018-07-01
 
-⚠️ **Warning:** This release includes an updated version of Electron. This requires a Raspberry Pi configuration change to allow the best performance and prevent the CPU from overheating. Please read the information on the [MagicMirror Wiki](https://github.com/michmich/magicmirror/wiki/configuring-the-raspberry-pi#enable-the-open-gl-driver-to-decrease-electrons-cpu-usage).
+⚠️ **Warning:** This release includes an updated version of Electron. This requires a Raspberry Pi configuration change to allow the best performance and prevent the CPU from overheating. Please read the information on the [MagicMirror² Wiki](https://github.com/michmich/magicmirror/wiki/configuring-the-raspberry-pi#enable-the-open-gl-driver-to-decrease-electrons-cpu-usage).
 
 ℹ️ **Note:** This update uses new dependencies. Please update using the following command: `git pull && npm install`
 
@@ -767,7 +939,7 @@ A huge, huge, huge thanks to user @fewieden for all his hard work on the new `we
 - 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.
+- 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.
@@ -830,7 +1002,7 @@ A huge, huge, huge thanks to user @fewieden for all his hard work on the new `we
 - 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.
+- 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 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
@@ -977,6 +1149,6 @@ It includes (but is not limited to) the following features:
 
 ## [1.0.0] - 2014-02-16
 
-### Initial release of MagicMirror.
+### Initial release of MagicMirror
 
 This was part of the blogpost: [https://michaelteeuw.nl/post/83916869600/magic-mirror-part-vi-production-of-the](https://michaelteeuw.nl/post/83916869600/magic-mirror-part-vi-production-of-the)

README.md

@@ -1,13 +1,17 @@
 ![MagicMirror²: The open source modular smart mirror platform. ](.github/header.png)
 
 <p style="text-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?type=dev"><img src="https://david-dm.org/MichMich/MagicMirror/dev-status.svg" alt="devDependency Status"></a>
-	<a href="https://bestpractices.coreinfrastructure.org/projects/347"><img src="https://bestpractices.coreinfrastructure.org/projects/347/badge" alt="CLI Best Practices"></a>
-	<a href="https://codecov.io/gh/MichMich/MagicMirror"><img src="https://codecov.io/gh/MichMich/MagicMirror/branch/master/graph/badge.svg?token=LEG1KitZR6" alt="CodeCov Status"/></a>
-	<a href="https://choosealicense.com/licenses/mit"><img src="https://img.shields.io/badge/license-MIT-blue.svg" alt="License"></a>
-	<a href="https://github.com/MichMich/MagicMirror/actions?query=workflow%3A%22Automated+Tests%22"><img src="https://github.com/MichMich/MagicMirror/workflows/Automated%20Tests/badge.svg" alt="Tests"></a>
-  <a href="https://codecov.io/gh/MichMich/MagicMirror"><img src="https://codecov.io/gh/MichMich/MagicMirror/branch/master/graph/badge.svg" /></a>
+  <a href="https://choosealicense.com/licenses/mit">
+		<img src="https://img.shields.io/badge/license-MIT-blue.svg" alt="License">
+	</a>
+	<img src="https://img.shields.io/github/workflow/status/michmich/magicmirror/Run%20Automated%20Tests" alt="GitHub Actions">
+	<img src="https://img.shields.io/github/checks-status/michmich/magicmirror/master" alt="Build Status">
+	<a href="https://codecov.io/gh/MichMich/MagicMirror">
+		<img src="https://codecov.io/gh/MichMich/MagicMirror/branch/master/graph/badge.svg?token=LEG1KitZR6" alt="CodeCov Status"/>
+	</a>
+	<a href="https://github.com/MichMich/MagicMirror">
+		<img src="https://img.shields.io/github/stars/michmich/magicmirror?style=social">
+	</a>
 </p>
 
 **MagicMirror²** is an open source modular smart mirror platform. With a growing list of installable modules, the **MagicMirror²** allows you to convert your hallway or bathroom mirror into your personal assistant. **MagicMirror²** is built by the creator of [the original MagicMirror](https://michaelteeuw.nl/tagged/magicmirror) with the incredible help of a [growing community of contributors](https://github.com/MichMich/MagicMirror/graphs/contributors).
@@ -23,6 +27,7 @@ For the full documentation including **[installation instructions](https://docs.
 - Website: [https://magicmirror.builders](https://magicmirror.builders)
 - Documentation: [https://docs.magicmirror.builders](https://docs.magicmirror.builders)
 - Forum: [https://forum.magicmirror.builders](https://forum.magicmirror.builders)
+  - Technical discussions: https://forum.magicmirror.builders/category/11/core-system
 - Discord: [https://discord.gg/J5BAtvx](https://discord.gg/J5BAtvx)
 - Blog: [https://michaelteeuw.nl/tagged/magicmirror](https://michaelteeuw.nl/tagged/magicmirror)
 - Donations: [https://magicmirror.builders/#donate](https://magicmirror.builders/#donate)
@@ -35,7 +40,7 @@ Contributions of all kinds are welcome, not only in the form of code but also wi
 - documentation
 - translations
 
-For the full contribution guidelines, check out: [https://docs.magicmirror.builders/getting-started/contributing.html](https://docs.magicmirror.builders/getting-started/contributing.html)
+For the full contribution guidelines, check out: [https://docs.magicmirror.builders/about/contributing.html](https://docs.magicmirror.builders/about/contributing.html)
 
 ## Enjoying MagicMirror? Consider a donation!
 

clientonly/index.js

@@ -2,7 +2,7 @@
 
 // Use separate scope to prevent global scope pollution
 (function () {
-	var config = {};
+	const config = {};
 
 	/**
 	 * Helper function to get server address/hostname from either the commandline or env
@@ -17,8 +17,8 @@
 		 * @returns {string} the value of the parameter
 		 */
 		function getCommandLineParameter(key, defaultValue = undefined) {
-			var index = process.argv.indexOf(`--${key}`);
-			var value = index > -1 ? process.argv[index + 1] : undefined;
+			const index = process.argv.indexOf(`--${key}`);
+			const value = index > -1 ? process.argv[index + 1] : undefined;
 			return value !== undefined ? String(value) : defaultValue;
 		}
 
@@ -43,7 +43,7 @@
 			// Select http or https module, depending on requested url
 			const lib = url.startsWith("https") ? require("https") : require("http");
 			const request = lib.get(url, (response) => {
-				var configData = "";
+				let configData = "";
 
 				// Gather incoming data
 				response.on("data", function (chunk) {
@@ -79,15 +79,15 @@
 	getServerAddress();
 
 	(config.address && config.port) || fail();
-	var prefix = config.tls ? "https://" : "http://";
+	const prefix = config.tls ? "https://" : "http://";
 
 	// Only start the client if a non-local server was provided
 	if (["localhost", "127.0.0.1", "::1", "::ffff:127.0.0.1", undefined].indexOf(config.address) === -1) {
 		getServerConfig(`${prefix}${config.address}:${config.port}/config/`)
 			.then(function (configReturn) {
 				// Pass along the server config via an environment variable
-				var env = Object.create(process.env);
-				var options = { env: env };
+				const env = Object.create(process.env);
+				const options = { env: env };
 				configReturn.address = config.address;
 				configReturn.port = config.port;
 				configReturn.tls = config.tls;

config/config.js.sample

@@ -1,21 +1,20 @@
-/* Magic Mirror Config Sample
+/* MagicMirror² Config Sample
  *
  * By Michael Teeuw https://michaelteeuw.nl
  * MIT Licensed.
  *
  * For more information on how you can configure this file
- * See https://github.com/MichMich/MagicMirror#configuration
- *
+ * see https://docs.magicmirror.builders/configuration/introduction.html
+ * and https://docs.magicmirror.builders/modules/configuration.html
  */
-
-var config = {
+let config = {
 	address: "localhost", 	// Address to listen on, can be:
 							// - "localhost", "127.0.0.1", "::1" to listen on loopback interface
 							// - another specific IPv4/6 to listen on a specific interface
 							// - "0.0.0.0", "::" to listen on any interface
 							// Default, when address config is left out or empty, is "localhost"
 	port: 8080,
-	basePath: "/", 	// The URL path where MagicMirror is hosted. If you are using a Reverse proxy
+	basePath: "/", 	// The URL path where MagicMirror² is hosted. If you are using a Reverse proxy
 					// you must set the sub path here. basePath must end with a /
 	ipWhitelist: ["127.0.0.1", "::ffff:127.0.0.1", "::1"], 	// Set [] to allow all IP addresses
 															// or add a specific IPv4 of 192.168.1.5 :
@@ -58,7 +57,8 @@ var config = {
 				calendars: [
 					{
 						symbol: "calendar-check",
-						url: "webcal://www.calendarlabs.com/ical-calendar/ics/76/US_Holidays.ics"					}
+						url: "webcal://www.calendarlabs.com/ical-calendar/ics/76/US_Holidays.ics"
+					}
 				]
 			}
 		},

css/custom.css.sample

@@ -0,0 +1,31 @@
+/* MagicMirror² Custom CSS Sample
+ *
+ * Change color and fonts here.
+ *
+ * Beware that properties cannot be unitless, so for example write '--gap-body: 0px;' instead of just '--gap-body: 0;'
+ *
+ * MIT Licensed.
+ */
+
+/* Uncomment and adjust accordingly if you want to import another font from the google-fonts-api: */
+/* @import url('https://fonts.googleapis.com/css2?family=Poppins:wght@100;300;400;700&display=swap'); */
+
+:root {
+  --color-text: #999;
+  --color-text-dimmed: #666;
+  --color-text-bright: #fff;
+  --color-background: black;
+
+  --font-primary: "Roboto Condensed";
+  --font-secondary: "Roboto";
+  
+  --font-size: 20px;
+  --font-size-small: 0.75rem;
+
+  --gap-body-top: 60px;
+  --gap-body-right: 60px;
+  --gap-body-bottom: 60px;
+  --gap-body-left: 60px;
+  
+  --gap-modules: 30px;
+}

css/main.css

@@ -1,8 +1,29 @@
+:root {
+  --color-text: #999;
+  --color-text-dimmed: #666;
+  --color-text-bright: #fff;
+  --color-background: #000;
+
+  --font-primary: "Roboto Condensed";
+  --font-secondary: "Roboto";
+
+  --font-size: 20px;
+  --font-size-small: 0.75rem;
+
+  --gap-body-top: 60px;
+  --gap-body-right: 60px;
+  --gap-body-bottom: 60px;
+  --gap-body-left: 60px;
+
+  --gap-modules: 30px;
+}
+
 html {
   cursor: none;
   overflow: hidden;
-  background: #000;
+  background: var(--color-background);
   user-select: none;
+  font-size: var(--font-size);
 }
 
 ::-webkit-scrollbar {
@@ -10,16 +31,15 @@ html {
 }
 
 body {
-  margin: 60px;
+  margin: var(--gap-body-top) var(--gap-body-right) var(--gap-body-bottom) var(--gap-body-left);
   position: absolute;
-  height: calc(100% - 120px);
-  width: calc(100% - 120px);
-  background: #000;
-  color: #aaa;
-  font-family: "Roboto Condensed", sans-serif;
+  height: calc(100% - var(--gap-body-top) - var(--gap-body-bottom));
+  width: calc(100% - var(--gap-body-right) - var(--gap-body-left));
+  background: var(--color-background);
+  color: var(--color-text);
+  font-family: var(--font-primary), sans-serif;
   font-weight: 400;
-  font-size: 2em;
-  line-height: 1.5em;
+  line-height: 1.5;
   -webkit-font-smoothing: antialiased;
 }
 
@@ -28,60 +48,60 @@ body {
  */
 
 .dimmed {
-  color: #666;
+  color: var(--color-text-dimmed);
 }
 
 .normal {
-  color: #999;
+  color: var(--color-text);
 }
 
 .bright {
-  color: #fff;
+  color: var(--color-text-bright);
 }
 
 .xsmall {
-  font-size: 15px;
-  line-height: 20px;
+  font-size: var(--font-size-small);
+  line-height: 1.275;
 }
 
 .small {
-  font-size: 20px;
-  line-height: 25px;
+  font-size: 1rem;
+  line-height: 1.25;
 }
 
 .medium {
-  font-size: 30px;
-  line-height: 35px;
+  font-size: 1.5rem;
+  line-height: 1.225;
 }
 
 .large {
-  font-size: 65px;
-  line-height: 65px;
+  font-size: 3.25rem;
+  line-height: 1;
 }
 
 .xlarge {
-  font-size: 75px;
-  line-height: 75px;
+  font-size: 3.75rem;
+  line-height: 1;
   letter-spacing: -3px;
 }
 
 .thin {
-  font-family: Roboto, sans-serif;
+  font-family: var(--font-secondary), sans-serif;
   font-weight: 100;
 }
 
 .light {
-  font-family: "Roboto Condensed", sans-serif;
+  font-family: var(--font-primary), sans-serif;
   font-weight: 300;
 }
 
 .regular {
-  font-family: "Roboto Condensed", sans-serif;
+  font-family: var(--font-primary), sans-serif;
   font-weight: 400;
 }
 
 .bold {
-  font-family: "Roboto Condensed", sans-serif;
+  font-family: var(--font-primary), sans-serif;
   font-weight: 700;
 }
 
@@ -95,14 +115,14 @@ body {
 
 header {
   text-transform: uppercase;
-  font-size: 15px;
-  font-family: "Roboto Condensed", Arial, Helvetica, sans-serif;
+  font-size: var(--font-size-small);
+  font-family: var(--font-primary), Arial, Helvetica, sans-serif;
   font-weight: 400;
-  border-bottom: 1px solid #666;
+  border-bottom: 1px solid var(--color-text-dimmed);
   line-height: 15px;
   padding-bottom: 5px;
   margin-bottom: 10px;
-  color: #999;
+  color: var(--color-text);
 }
 
 sup {
@@ -115,11 +135,19 @@ sup {
  */
 
 .module {
-  margin-bottom: 30px;
+  margin-bottom: var(--gap-modules);
+}
+
+.module.hidden {
+  pointer-events: none;
+}
+
+.module:not(.hidden) {
+  pointer-events: auto;
 }
 
 .region.bottom .module {
-  margin-top: 30px;
+  margin-top: var(--gap-modules);
   margin-bottom: 0;
 }
 
@@ -143,17 +171,13 @@ sup {
 
 .region.fullscreen {
   position: absolute;
-  top: -60px;
-  left: -60px;
-  right: -60px;
-  bottom: -60px;
+  top: calc(-1 * var(--gap-body-top));
+  left: calc(-1 * var(--gap-body-left));
+  right: calc(-1 * var(--gap-body-right));
+  bottom: calc(-1 * var(--gap-body-bottom));
   pointer-events: none;
 }
 
-.region.fullscreen * {
-  pointer-events: auto;
-}
-
 .region.right {
   right: 0;
   text-align: right;
@@ -163,18 +187,6 @@ sup {
   top: 0;
 }
 
-.region.top .container {
-  margin-bottom: 25px;
-}
-
-.region.bottom .container {
-  margin-top: 25px;
-}
-
-.region.top .container:empty {
-  margin-bottom: 0;
-}
-
 .region.top.center,
 .region.bottom.center {
   left: 50%;
@@ -191,10 +203,6 @@ sup {
   bottom: 0;
 }
 
-.region.bottom .container:empty {
-  margin-top: 0;
-}
-
 .region.bottom.right,
 .region.bottom.center,
 .region.bottom.left {

fonts/package-lock.json

@@ -1,12 +1,37 @@
 {
-  "name": "magicmirror-fonts",
-  "requires": true,
-  "lockfileVersion": 1,
-  "dependencies": {
-    "roboto-fontface": {
-      "version": "0.10.0",
-      "resolved": "https://registry.npmjs.org/roboto-fontface/-/roboto-fontface-0.10.0.tgz",
-      "integrity": "sha512-OlwfYEgA2RdboZohpldlvJ1xngOins5d7ejqnIBWr9KaMxsnBqotpptRXTyfNRLnFpqzX6sTDt+X+a+6udnU8g=="
-    }
-  }
+	"name": "magicmirror-fonts",
+	"lockfileVersion": 2,
+	"requires": true,
+	"packages": {
+		"": {
+			"name": "magicmirror-fonts",
+			"license": "MIT",
+			"dependencies": {
+				"@fontsource/roboto": "^4.5.5",
+				"@fontsource/roboto-condensed": "^4.5.6"
+			}
+		},
+		"node_modules/@fontsource/roboto": {
+			"version": "4.5.5",
+			"resolved": "https://registry.npmjs.org/@fontsource/roboto/-/roboto-4.5.5.tgz",
+			"integrity": "sha512-Pe1p+gAO6K0aLxBXlLoJRHVx352tVc/v/7DOnvM3t+FYXb+KUga9aCD1NpnDfd0kKnWXqrZyAXguyyFWDDuphw=="
+		},
+		"node_modules/@fontsource/roboto-condensed": {
+			"version": "4.5.6",
+			"resolved": "https://registry.npmjs.org/@fontsource/roboto-condensed/-/roboto-condensed-4.5.6.tgz",
+			"integrity": "sha512-WDN0RlwXa3ADUDJxrB9HEIhrwYdJFLTNw4YemEYSeIPURU5DAHSx2VFXFv69PbM7kV8At5yMTp8bQkL5TBUP3w=="
+		}
+	},
+	"dependencies": {
+		"@fontsource/roboto": {
+			"version": "4.5.5",
+			"resolved": "https://registry.npmjs.org/@fontsource/roboto/-/roboto-4.5.5.tgz",
+			"integrity": "sha512-Pe1p+gAO6K0aLxBXlLoJRHVx352tVc/v/7DOnvM3t+FYXb+KUga9aCD1NpnDfd0kKnWXqrZyAXguyyFWDDuphw=="
+		},
+		"@fontsource/roboto-condensed": {
+			"version": "4.5.6",
+			"resolved": "https://registry.npmjs.org/@fontsource/roboto-condensed/-/roboto-condensed-4.5.6.tgz",
+			"integrity": "sha512-WDN0RlwXa3ADUDJxrB9HEIhrwYdJFLTNw4YemEYSeIPURU5DAHSx2VFXFv69PbM7kV8At5yMTp8bQkL5TBUP3w=="
+		}
+	}
 }

fonts/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "magicmirror-fonts",
-	"description": "Package for fonts use by MagicMirror Core.",
+	"description": "Package for fonts use by MagicMirror² Core.",
 	"repository": {
 		"type": "git",
 		"url": "git+https://github.com/MichMich/MagicMirror.git"
@@ -10,6 +10,7 @@
 		"url": "https://github.com/MichMich/MagicMirror/issues"
 	},
 	"dependencies": {
-		"roboto-fontface": "^0.10.0"
+		"@fontsource/roboto": "^4.5.5",
+		"@fontsource/roboto-condensed": "^4.5.6"
 	}
 }

fonts/roboto.css

@@ -2,57 +2,57 @@
   font-family: Roboto;
   font-style: normal;
   font-weight: 100;
-  src: local("Roboto Thin"), local("Roboto-Thin"), url("node_modules/roboto-fontface/fonts/roboto/Roboto-Thin.woff2") format("woff2"), url("node_modules/roboto-fontface/fonts/roboto/Roboto-Thin.woff") format("woff");
+  src: local("Roboto Thin"), local("Roboto-Thin"), url("node_modules/@fontsource/roboto/files/roboto-latin-100-normal.woff2") format("woff2"), url("node_modules/@fontsource/roboto/files/roboto-latin-100-normal.woff") format("woff");
 }
 
 @font-face {
   font-family: "Roboto Condensed";
   font-style: normal;
   font-weight: 300;
-  src: local("Roboto Condensed Light"), local("RobotoCondensed-Light"), url("node_modules/roboto-fontface/fonts/roboto-condensed/Roboto-Condensed-Light.woff2") format("woff2"),
-    url("node_modules/roboto-fontface/fonts/roboto-condensed/Roboto-Condensed-Light.woff") format("woff");
+  src: local("Roboto Condensed Light"), local("RobotoCondensed-Light"), url("node_modules/@fontsource/roboto-condensed/files/roboto-condensed-latin-300-normal.woff2") format("woff2"),
+    url("node_modules/@fontsource/roboto-condensed/files/roboto-condensed-latin-300-normal.woff") format("woff");
 }
 
 @font-face {
   font-family: "Roboto Condensed";
   font-style: normal;
   font-weight: 400;
-  src: local("Roboto Condensed"), local("RobotoCondensed-Regular"), url("node_modules/roboto-fontface/fonts/roboto-condensed/Roboto-Condensed-Regular.woff2") format("woff2"),
-    url("node_modules/roboto-fontface/fonts/roboto-condensed/Roboto-Condensed-Regular.woff") format("woff");
+  src: local("Roboto Condensed"), local("RobotoCondensed-Regular"), url("node_modules/@fontsource/roboto-condensed/files/roboto-condensed-latin-400-normal.woff2") format("woff2"),
+    url("node_modules/@fontsource/roboto-condensed/files/roboto-condensed-latin-400-normal.woff") format("woff");
 }
 
 @font-face {
   font-family: "Roboto Condensed";
   font-style: normal;
   font-weight: 700;
-  src: local("Roboto Condensed Bold"), local("RobotoCondensed-Bold"), url("node_modules/roboto-fontface/fonts/roboto-condensed/Roboto-Condensed-Bold.woff2") format("woff2"),
-    url("node_modules/roboto-fontface/fonts/roboto-condensed/Roboto-Condensed-Bold.woff") format("woff");
+  src: local("Roboto Condensed Bold"), local("RobotoCondensed-Bold"), url("node_modules/@fontsource/roboto-condensed/files/roboto-condensed-latin-700-normal.woff2") format("woff2"),
+    url("node_modules/@fontsource/roboto-condensed/files/roboto-condensed-latin-700-normal.woff") format("woff");
 }
 
 @font-face {
   font-family: Roboto;
   font-style: normal;
   font-weight: 400;
-  src: local("Roboto"), local("Roboto-Regular"), url("node_modules/roboto-fontface/fonts/roboto/Roboto-Regular.woff2") format("woff2"), url("node_modules/roboto-fontface/fonts/roboto/Roboto-Regular.woff") format("woff");
+  src: local("Roboto"), local("Roboto-Regular"), url("node_modules/@fontsource/roboto/files/roboto-latin-400-normal.woff2") format("woff2"), url("node_modules/@fontsource/roboto/files/roboto-latin-400-normal.woff") format("woff");
 }
 
 @font-face {
   font-family: Roboto;
   font-style: normal;
   font-weight: 500;
-  src: local("Roboto Medium"), local("Roboto-Medium"), url("node_modules/roboto-fontface/fonts/roboto/Roboto-Medium.woff2") format("woff2"), url("node_modules/roboto-fontface/fonts/roboto/Roboto-Medium.woff") format("woff");
+  src: local("Roboto Medium"), local("Roboto-Medium"), url("node_modules/@fontsource/roboto/files/roboto-latin-500-normal.woff2") format("woff2"), url("node_modules/@fontsource/roboto/files/roboto-latin-500-normal.woff") format("woff");
 }
 
 @font-face {
   font-family: Roboto;
   font-style: normal;
   font-weight: 700;
-  src: local("Roboto Bold"), local("Roboto-Bold"), url("node_modules/roboto-fontface/fonts/roboto/Roboto-Bold.woff2") format("woff2"), url("node_modules/roboto-fontface/fonts/roboto/Roboto-Bold.woff") format("woff");
+  src: local("Roboto Bold"), local("Roboto-Bold"), url("node_modules/@fontsource/roboto/files/roboto-latin-700-normal.woff2") format("woff2"), url("node_modules/@fontsource/roboto/files/roboto-latin-700-normal.woff") format("woff");
 }
 
 @font-face {
   font-family: Roboto;
   font-style: normal;
   font-weight: 300;
-  src: local("Roboto Light"), local("Roboto-Light"), url("node_modules/roboto-fontface/fonts/roboto/Roboto-Light.woff2") format("woff2"), url("node_modules/roboto-fontface/fonts/roboto/Roboto-Light.woff") format("woff");
+  src: local("Roboto Light"), local("Roboto-Light"), url("node_modules/@fontsource/roboto/files/roboto-latin-300-normal.woff2") format("woff2"), url("node_modules/@fontsource/roboto/files/roboto-latin-300-normal.woff") format("woff");
 }

index.html

@@ -1,55 +1,57 @@
 <!DOCTYPE html>
 <html>
-<head>
-	<title>MagicMirror²</title>
-	<meta name="google" content="notranslate" />
-	<meta http-equiv="Content-type" content="text/html; charset=utf-8" />
+  <head>
+    <title>MagicMirror²</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">
+    <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. -->
+    <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>
-	<div class="region top bar">
-		<div class="container"></div>
-		<div class="region top left"><div class="container"></div></div>
-		<div class="region top center"><div class="container"></div></div>
-		<div class="region top right"><div class="container"></div></div>
-	</div>
-	<div class="region upper third"><div class="container"></div></div>
-	<div class="region middle center"><div class="container"></div></div>
-	<div class="region lower third"><div class="container"><br/></div></div>
-	<div class="region bottom bar">
-		<div class="container"></div>
-		<div class="region bottom left"><div class="container"></div></div>
-		<div class="region bottom center"><div class="container"></div></div>
-		<div class="region bottom right"><div class="container"></div></div>
-	</div>
-	<div class="region fullscreen above"><div class="container"></div></div>
-	<script type="text/javascript" src="socket.io/socket.io.js"></script>
-	<script type="text/javascript" src="vendor/node_modules/nunjucks/browser/nunjucks.min.js"></script>
-	<script type="text/javascript" src="js/defaults.js"></script>
-	<script type="text/javascript" src="#CONFIG_FILE#"></script>
-	<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>
-	<script type="text/javascript" src="translations/translations.js"></script>
-	<script type="text/javascript" src="js/translator.js"></script>
-	<script type="text/javascript" src="js/class.js"></script>
-	<script type="text/javascript" src="js/module.js"></script>
-	<script type="text/javascript" src="js/loader.js"></script>
-	<script type="text/javascript" src="js/socketclient.js"></script>
-	<script type="text/javascript" src="js/main.js"></script>
-</body>
+    <script type="text/javascript">
+      window.mmVersion = "#VERSION#";
+    </script>
+  </head>
+  <body>
+    <div class="region fullscreen below"><div class="container"></div></div>
+    <div class="region top bar">
+      <div class="container"></div>
+      <div class="region top left"><div class="container"></div></div>
+      <div class="region top center"><div class="container"></div></div>
+      <div class="region top right"><div class="container"></div></div>
+    </div>
+    <div class="region upper third"><div class="container"></div></div>
+    <div class="region middle center"><div class="container"></div></div>
+    <div class="region lower third">
+      <div class="container"><br /></div>
+    </div>
+    <div class="region bottom bar">
+      <div class="container"></div>
+      <div class="region bottom left"><div class="container"></div></div>
+      <div class="region bottom center"><div class="container"></div></div>
+      <div class="region bottom right"><div class="container"></div></div>
+    </div>
+    <div class="region fullscreen above"><div class="container"></div></div>
+    <script type="text/javascript" src="socket.io/socket.io.js"></script>
+    <script type="text/javascript" src="vendor/node_modules/nunjucks/browser/nunjucks.min.js"></script>
+    <script type="text/javascript" src="js/defaults.js"></script>
+    <script type="text/javascript" src="#CONFIG_FILE#"></script>
+    <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>
+    <script type="text/javascript" src="translations/translations.js"></script>
+    <script type="text/javascript" src="js/translator.js"></script>
+    <script type="text/javascript" src="js/class.js"></script>
+    <script type="text/javascript" src="js/module.js"></script>
+    <script type="text/javascript" src="js/loader.js"></script>
+    <script type="text/javascript" src="js/socketclient.js"></script>
+    <script type="text/javascript" src="js/main.js"></script>
+  </body>
 </html>

installers/mm.sh

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

js/app.js

@@ -1,4 +1,4 @@
-/* Magic Mirror
+/* MagicMirror²
  * The Core App (Server)
  *
  * By Michael Teeuw https://michaelteeuw.nl
@@ -37,7 +37,7 @@ if (process.env.MM_PORT) {
 process.on("uncaughtException", function (err) {
 	Log.error("Whoops! There was an uncaught exception...");
 	Log.error(err);
-	Log.error("MagicMirror will not quit, but it might be a good idea to check why this happened. Maybe no internet connection?");
+	Log.error("MagicMirror² will not quit, but it might be a good idea to check why this happened. Maybe no internet connection?");
 	Log.error("If you think this really is an issue, please open an issue on GitHub: https://github.com/MichMich/MagicMirror/issues");
 });
 
@@ -48,6 +48,7 @@ process.on("uncaughtException", function (err) {
  */
 function App() {
 	let nodeHelpers = [];
+	let httpServer;
 
 	/**
 	 * Loads the config file. Combines it with the defaults, and runs the
@@ -127,7 +128,7 @@ function App() {
 			let m = new Module();
 
 			if (m.requiresVersion) {
-				Log.log(`Check MagicMirror version for node helper '${moduleName}' - Minimum version: ${m.requiresVersion} - Current version: ${global.version}`);
+				Log.log(`Check MagicMirror² version for node helper '${moduleName}' - Minimum version: ${m.requiresVersion} - Current version: ${global.version}`);
 				if (cmpVersions(global.version, m.requiresVersion) >= 0) {
 					Log.log("Version is ok!");
 				} else {
@@ -180,7 +181,6 @@ function App() {
 	 *
 	 * @param {string} a Version number a.
 	 * @param {string} b Version number b.
-	 *
 	 * @returns {number} A positive number if a is larger than b, a negative
 	 * number if a is smaller and 0 if they are the same
 	 */
@@ -223,7 +223,7 @@ function App() {
 			}
 
 			loadModules(modules, function () {
-				const server = new Server(config, function (app, io) {
+				httpServer = new Server(config, function (app, io) {
 					Log.log("Server started ...");
 
 					for (let nodeHelper of nodeHelpers) {
@@ -254,6 +254,7 @@ function App() {
 				nodeHelper.stop();
 			}
 		}
+		httpServer.close();
 	};
 
 	/**

js/check_config.js

@@ -1,4 +1,4 @@
-/* Magic Mirror
+/* MagicMirror²
  *
  * Check the configuration file for errors
  *
@@ -52,7 +52,13 @@ function checkConfigFile() {
 	// I'm not sure if all ever is utf-8
 	const configFile = fs.readFileSync(configFileName, "utf-8");
 
-	const errors = linter.verify(configFile);
+	// Explicitly tell linter that he might encounter es6 syntax ("let config = {...}")
+	const errors = linter.verify(configFile, {
+		env: {
+			es6: true
+		}
+	});
+
 	if (errors.length === 0) {
 		Log.info(Utils.colors.pass("Your configuration file doesn't contain syntax errors :)"));
 	} else {

js/class.js

@@ -8,8 +8,8 @@
  * MIT Licensed.
  */
 (function () {
-	var initializing = false;
-	var fnTest = /xyz/.test(function () {
+	let initializing = false;
+	const fnTest = /xyz/.test(function () {
 		xyz;
 	})
 		? /\b_super\b/
@@ -20,27 +20,27 @@
 
 	// Create a new Class that inherits from this class
 	Class.extend = function (prop) {
-		var _super = this.prototype;
+		let _super = this.prototype;
 
 		// Instantiate a base class (but only create the instance,
 		// don't run the init constructor)
 		initializing = true;
-		var prototype = new this();
+		const prototype = new this();
 		initializing = false;
 
 		// Make a copy of all prototype properties, to prevent reference issues.
-		for (var p in prototype) {
+		for (const p in prototype) {
 			prototype[p] = cloneObject(prototype[p]);
 		}
 
 		// Copy the properties over onto the new prototype
-		for (var name in prop) {
+		for (const 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;
+								const tmp = this._super;
 
 								// Add a new ._super() method that is the same method
 								// but on the super-class
@@ -48,7 +48,7 @@
 
 								// The method only need to be bound temporarily, so we
 								// remove it when we're done executing
-								var ret = fn.apply(this, arguments);
+								const ret = fn.apply(this, arguments);
 								this._super = tmp;
 
 								return ret;
@@ -84,7 +84,6 @@
  * Define the clone method for later use. Helper Method.
  *
  * @param {object} obj Object to be cloned
- *
  * @returns {object} the cloned object
  */
 function cloneObject(obj) {
@@ -92,8 +91,8 @@ function cloneObject(obj) {
 		return obj;
 	}
 
-	var temp = obj.constructor(); // give temp the original obj's constructor
-	for (var key in obj) {
+	const temp = obj.constructor(); // give temp the original obj's constructor
+	for (const key in obj) {
 		temp[key] = cloneObject(obj[key]);
 
 		if (key === "lockStrings") {

js/defaults.js

@@ -1,17 +1,17 @@
 /* global mmPort */
 
-/* Magic Mirror
+/* MagicMirror²
  * Config Defaults
  *
  * By Michael Teeuw https://michaelteeuw.nl
  * MIT Licensed.
  */
-var address = "localhost";
-var port = 8080;
+const address = "localhost";
+let port = 8080;
 if (typeof mmPort !== "undefined") {
 	port = mmPort;
 }
-var defaults = {
+const defaults = {
 	address: address,
 	port: port,
 	basePath: "/",
@@ -36,7 +36,7 @@ var defaults = {
 			position: "upper_third",
 			classes: "large thin",
 			config: {
-				text: "Magic Mirror<sup>2</sup>"
+				text: "MagicMirror²"
 			}
 		},
 		{
@@ -59,7 +59,7 @@ var defaults = {
 			position: "middle_center",
 			classes: "xsmall",
 			config: {
-				text: "If you get this message while your config file is already created,<br>" + "it probably contains an error. To validate your config file run in your MagicMirror directory<br>" + "<pre>npm run config:check</pre>"
+				text: "If you get this message while your config file is already created,<br>" + "it probably contains an error. To validate your config file run in your MagicMirror² directory<br>" + "<pre>npm run config:check</pre>"
 			}
 		},
 		{

js/deprecated.js

@@ -1,4 +1,4 @@
-/* Magic Mirror Deprecated Config Options List
+/* MagicMirror² Deprecated Config Options List
  *
  * By Michael Teeuw https://michaelteeuw.nl
  * MIT Licensed.

js/electron.js

@@ -8,6 +8,12 @@ const Log = require("logger");
 let config = process.env.config ? JSON.parse(process.env.config) : {};
 // Module to control application life.
 const app = electron.app;
+// If ELECTRON_DISABLE_GPU is set electron is startet with --disable-gpu flag.
+// See https://www.electronjs.org/docs/latest/tutorial/offscreen-rendering for more info.
+if (process.env.ELECTRON_DISABLE_GPU !== undefined) {
+	app.disableHardwareAcceleration();
+}
+
 // Module to create native browser window.
 const BrowserWindow = electron.BrowserWindow;
 
@@ -19,7 +25,8 @@ let mainWindow;
  *
  */
 function createWindow() {
-	app.commandLine.appendSwitch("autoplay-policy", "no-user-gesture-required");
+	let electronSwitchesDefaults = ["autoplay-policy", "no-user-gesture-required"];
+	app.commandLine.appendSwitch(...new Set(electronSwitchesDefaults, config.electronSwitches));
 	let electronOptionsDefaults = {
 		width: 800,
 		height: 600,
@@ -52,7 +59,7 @@ function createWindow() {
 	// If config.address is not defined or is an empty string (listening on all interfaces), connect to localhost
 
 	let prefix;
-	if (config["tls"] !== null && config["tls"]) {
+	if ((config["tls"] !== null && config["tls"]) || config.useHttps) {
 		prefix = "https://";
 	} else {
 		prefix = "http://";
@@ -63,9 +70,19 @@ function createWindow() {
 
 	// Open the DevTools if run with "npm start dev"
 	if (process.argv.includes("dev")) {
+		if (process.env.JEST_WORKER_ID !== undefined) {
+			// if we are running with jest
+			const devtools = new BrowserWindow(electronOptions);
+			mainWindow.webContents.setDevToolsWebContents(devtools.webContents);
+		}
 		mainWindow.webContents.openDevTools();
 	}
 
+	// simulate mouse move to hide black cursor on start
+	mainWindow.webContents.on("dom-ready", (event) => {
+		mainWindow.webContents.sendInputEvent({ type: "mouseMove", x: 0, y: 0 });
+	});
+
 	// Set responders for window events.
 	mainWindow.on("closed", function () {
 		mainWindow = null;
@@ -97,7 +114,12 @@ app.on("ready", function () {
 
 // Quit when all windows are closed.
 app.on("window-all-closed", function () {
-	createWindow();
+	if (process.env.JEST_WORKER_ID !== undefined) {
+		// if we are running with jest
+		app.quit();
+	} else {
+		createWindow();
+	}
 });
 
 app.on("activate", function () {
@@ -124,6 +146,13 @@ app.on("before-quit", (event) => {
 	process.exit(0);
 });
 
+/* handle errors from self signed certificates */
+
+app.on("certificate-error", (event, webContents, url, error, certificate, callback) => {
+	event.preventDefault();
+	callback(true);
+});
+
 // Start the core application if server is run on localhost
 // This starts all node helpers and starts the webserver.
 if (["localhost", "127.0.0.1", "::1", "::ffff:127.0.0.1", undefined].includes(config.address)) {

js/loader.js

@@ -1,29 +1,29 @@
 /* global defaultModules, vendor */
 
-/* Magic Mirror
+/* MagicMirror²
  * Module and File loaders.
  *
  * By Michael Teeuw https://michaelteeuw.nl
  * MIT Licensed.
  */
-var Loader = (function () {
+const Loader = (function () {
 	/* Create helper variables */
 
-	var loadedModuleFiles = [];
-	var loadedFiles = [];
-	var moduleObjects = [];
+	const loadedModuleFiles = [];
+	const loadedFiles = [];
+	const moduleObjects = [];
 
 	/* Private Methods */
 
 	/**
 	 * Loops thru all modules and requests load for every module.
 	 */
-	var loadModules = function () {
-		var moduleData = getModuleData();
+	const loadModules = function () {
+		let moduleData = getModuleData();
 
-		var loadNextModule = function () {
+		const loadNextModule = function () {
 			if (moduleData.length > 0) {
-				var nextModule = moduleData[0];
+				const nextModule = moduleData[0];
 				loadModule(nextModule, function () {
 					moduleData = moduleData.slice(1);
 					loadNextModule();
@@ -46,9 +46,8 @@ var Loader = (function () {
 	/**
 	 * Loops thru all modules and requests start for every module.
 	 */
-	var startModules = function () {
-		for (var m in moduleObjects) {
-			var module = moduleObjects[m];
+	const startModules = function () {
+		for (const module of moduleObjects) {
 			module.start();
 		}
 
@@ -56,7 +55,7 @@ var Loader = (function () {
 		MM.modulesStarted(moduleObjects);
 
 		// Starting modules also hides any modules that have requested to be initially hidden
-		for (let thisModule of moduleObjects) {
+		for (const thisModule of moduleObjects) {
 			if (thisModule.data.hiddenOnStartup) {
 				Log.info("Initially hiding " + thisModule.name);
 				thisModule.hide();
@@ -69,7 +68,7 @@ var Loader = (function () {
 	 *
 	 * @returns {object[]} module data as configured in config
 	 */
-	var getAllModules = function () {
+	const getAllModules = function () {
 		return config.modules;
 	};
 
@@ -78,29 +77,28 @@ var Loader = (function () {
 	 *
 	 * @returns {object[]} Module information.
 	 */
-	var getModuleData = function () {
-		var modules = getAllModules();
-		var moduleFiles = [];
+	const getModuleData = function () {
+		const modules = getAllModules();
+		const moduleFiles = [];
 
-		for (var m in modules) {
-			var moduleData = modules[m];
-			var module = moduleData.module;
+		modules.forEach(function (moduleData, index) {
+			const module = moduleData.module;
 
-			var elements = module.split("/");
-			var moduleName = elements[elements.length - 1];
-			var moduleFolder = config.paths.modules + "/" + module;
+			const elements = module.split("/");
+			const moduleName = elements[elements.length - 1];
+			let moduleFolder = config.paths.modules + "/" + module;
 
 			if (defaultModules.indexOf(moduleName) !== -1) {
 				moduleFolder = config.paths.modules + "/default/" + module;
 			}
 
 			if (moduleData.disabled === true) {
-				continue;
+				return;
 			}
 
 			moduleFiles.push({
-				index: m,
-				identifier: "module_" + m + "_" + module,
+				index: index,
+				identifier: "module_" + index + "_" + module,
 				name: moduleName,
 				path: moduleFolder + "/",
 				file: moduleName + ".js",
@@ -111,7 +109,7 @@ var Loader = (function () {
 				config: moduleData.config,
 				classes: typeof moduleData.classes !== "undefined" ? moduleData.classes + " " + module : module
 			});
-		}
+		});
 
 		return moduleFiles;
 	};
@@ -122,11 +120,11 @@ var Loader = (function () {
 	 * @param {object} module Information about the module we want to load.
 	 * @param {Function} callback Function called when done.
 	 */
-	var loadModule = function (module, callback) {
-		var url = module.path + module.file;
+	const loadModule = function (module, callback) {
+		const url = module.path + module.file;
 
-		var afterLoad = function () {
-			var moduleObject = Module.create(module.name);
+		const afterLoad = function () {
+			const moduleObject = Module.create(module.name);
 			if (moduleObject) {
 				bootstrapModule(module, moduleObject, function () {
 					callback();
@@ -153,7 +151,7 @@ var Loader = (function () {
 	 * @param {Module} mObj Modules instance.
 	 * @param {Function} callback Function called when done.
 	 */
-	var bootstrapModule = function (module, mObj, callback) {
+	const bootstrapModule = function (module, mObj, callback) {
 		Log.info("Bootstrapping module: " + module.name);
 
 		mObj.setData(module);
@@ -177,13 +175,14 @@ var Loader = (function () {
 	 * @param {string} fileName Path of the file we want to load.
 	 * @param {Function} callback Function called when done.
 	 */
-	var loadFile = function (fileName, callback) {
-		var extension = fileName.slice((Math.max(0, fileName.lastIndexOf(".")) || Infinity) + 1);
+	const loadFile = function (fileName, callback) {
+		const extension = fileName.slice((Math.max(0, fileName.lastIndexOf(".")) || Infinity) + 1);
+		let script, stylesheet;
 
 		switch (extension.toLowerCase()) {
 			case "js":
 				Log.log("Load script: " + fileName);
-				var script = document.createElement("script");
+				script = document.createElement("script");
 				script.type = "text/javascript";
 				script.src = fileName;
 				script.onload = function () {
@@ -202,7 +201,7 @@ var Loader = (function () {
 				break;
 			case "css":
 				Log.log("Load stylesheet: " + fileName);
-				var stylesheet = document.createElement("link");
+				stylesheet = document.createElement("link");
 				stylesheet.rel = "stylesheet";
 				stylesheet.type = "text/css";
 				stylesheet.href = fileName;

js/logger.js

@@ -1,4 +1,4 @@
-/* Magic Mirror
+/* MagicMirror²
  * Log
  *
  * This logger is very simple, but needs to be extended.
@@ -9,12 +9,13 @@
  */
 (function (root, factory) {
 	if (typeof exports === "object") {
-		// add timestamps in front of log messages
-		require("console-stamp")(console, {
-			pattern: "yyyy-mm-dd HH:MM:ss.l",
-			include: ["debug", "log", "info", "warn", "error"]
-		});
-
+		if (process.env.JEST_WORKER_ID === undefined) {
+			// add timestamps in front of log messages
+			require("console-stamp")(console, {
+				pattern: "yyyy-mm-dd HH:MM:ss.l",
+				include: ["debug", "log", "info", "warn", "error"]
+			});
+		}
 		// Node, CommonJS-like
 		module.exports = factory(root.config);
 	} else {
@@ -22,29 +23,57 @@
 		root.Log = factory(root.config);
 	}
 })(this, function (config) {
-	const logLevel = {
-		debug: Function.prototype.bind.call(console.debug, console),
-		log: Function.prototype.bind.call(console.log, console),
-		info: Function.prototype.bind.call(console.info, console),
-		warn: Function.prototype.bind.call(console.warn, console),
-		error: Function.prototype.bind.call(console.error, 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)
-	};
+	let logLevel;
+	let enableLog;
+	if (typeof exports === "object") {
+		// in nodejs and not running with jest
+		enableLog = process.env.JEST_WORKER_ID === undefined;
+	} else {
+		// in browser and not running with jsdom
+		enableLog = typeof window === "object" && window.name !== "jsdom";
+	}
 
-	logLevel.setLogLevel = function (newLevel) {
-		if (newLevel) {
-			Object.keys(logLevel).forEach(function (key, index) {
-				if (!newLevel.includes(key.toLocaleUpperCase())) {
-					logLevel[key] = function () {};
-				}
-			});
-		}
-	};
+	if (enableLog) {
+		logLevel = {
+			debug: Function.prototype.bind.call(console.debug, console),
+			log: Function.prototype.bind.call(console.log, console),
+			info: Function.prototype.bind.call(console.info, console),
+			warn: Function.prototype.bind.call(console.warn, console),
+			error: Function.prototype.bind.call(console.error, 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)
+		};
+
+		logLevel.setLogLevel = function (newLevel) {
+			if (newLevel) {
+				Object.keys(logLevel).forEach(function (key, index) {
+					if (!newLevel.includes(key.toLocaleUpperCase())) {
+						logLevel[key] = function () {};
+					}
+				});
+			}
+		};
+	} else {
+		logLevel = {
+			debug: function () {},
+			log: function () {},
+			info: function () {},
+			warn: function () {},
+			error: function () {},
+			group: function () {},
+			groupCollapsed: function () {},
+			groupEnd: function () {},
+			time: function () {},
+			timeEnd: function () {},
+			timeStamp: function () {}
+		};
+
+		logLevel.setLogLevel = function () {};
+	}
 
 	return logLevel;
 });

js/main.js

@@ -1,30 +1,30 @@
 /* global Loader, defaults, Translator */
 
-/* Magic Mirror
+/* MagicMirror²
  * Main System
  *
  * By Michael Teeuw https://michaelteeuw.nl
  * MIT Licensed.
  */
-var MM = (function () {
-	var modules = [];
+const MM = (function () {
+	let modules = [];
 
 	/* Private Methods */
 
 	/**
 	 * Create dom objects for all modules that are configured for a specific position.
 	 */
-	var createDomObjects = function () {
-		var domCreationPromises = [];
+	const createDomObjects = function () {
+		const domCreationPromises = [];
 
 		modules.forEach(function (module) {
 			if (typeof module.data.position !== "string") {
 				return;
 			}
 
-			var wrapper = selectWrapper(module.data.position);
+			const wrapper = selectWrapper(module.data.position);
 
-			var dom = document.createElement("div");
+			const dom = document.createElement("div");
 			dom.id = module.identifier;
 			dom.className = module.name;
 
@@ -35,7 +35,7 @@ var MM = (function () {
 			dom.opacity = 0;
 			wrapper.appendChild(dom);
 
-			var moduleHeader = document.createElement("header");
+			const moduleHeader = document.createElement("header");
 			moduleHeader.innerHTML = module.getHeader();
 			moduleHeader.className = "module-header";
 			dom.appendChild(moduleHeader);
@@ -46,11 +46,11 @@ var MM = (function () {
 				moduleHeader.style.display = "block;";
 			}
 
-			var moduleContent = document.createElement("div");
+			const moduleContent = document.createElement("div");
 			moduleContent.className = "module-content";
 			dom.appendChild(moduleContent);
 
-			var domCreationPromise = updateDom(module, 0);
+			const domCreationPromise = updateDom(module, 0);
 			domCreationPromises.push(domCreationPromise);
 			domCreationPromise
 				.then(function () {
@@ -70,14 +70,13 @@ var MM = (function () {
 	 * Select the wrapper dom object for a specific position.
 	 *
 	 * @param {string} position The name of the position.
-	 *
 	 * @returns {HTMLElement} the wrapper element
 	 */
-	var selectWrapper = function (position) {
-		var classes = position.replace("_", " ");
-		var parentWrapper = document.getElementsByClassName(classes);
+	const selectWrapper = function (position) {
+		const classes = position.replace("_", " ");
+		const parentWrapper = document.getElementsByClassName(classes);
 		if (parentWrapper.length > 0) {
-			var wrapper = parentWrapper[0].getElementsByClassName("container");
+			const wrapper = parentWrapper[0].getElementsByClassName("container");
 			if (wrapper.length > 0) {
 				return wrapper[0];
 			}
@@ -92,9 +91,9 @@ var MM = (function () {
 	 * @param {Module} sender The module that sent the notification.
 	 * @param {Module} [sendTo] The (optional) module to send the notification to.
 	 */
-	var sendNotification = function (notification, payload, sender, sendTo) {
-		for (var m in modules) {
-			var module = modules[m];
+	const sendNotification = function (notification, payload, sender, sendTo) {
+		for (const m in modules) {
+			const module = modules[m];
 			if (module !== sender && (!sendTo || module === sendTo)) {
 				module.notificationReceived(notification, payload, sender);
 			}
@@ -106,13 +105,12 @@ var MM = (function () {
 	 *
 	 * @param {Module} module The module that needs an update.
 	 * @param {number} [speed] The (optional) number of microseconds for the animation.
-	 *
 	 * @returns {Promise} Resolved when the dom is fully updated.
 	 */
-	var updateDom = function (module, speed) {
+	const updateDom = function (module, speed) {
 		return new Promise(function (resolve) {
-			var newContentPromise = module.getDom();
-			var newHeader = module.getHeader();
+			const newHeader = module.getHeader();
+			let newContentPromise = module.getDom();
 
 			if (!(newContentPromise instanceof Promise)) {
 				// convert to a promise if not already one to avoid if/else's everywhere
@@ -121,7 +119,7 @@ var MM = (function () {
 
 			newContentPromise
 				.then(function (newContent) {
-					var updatePromise = updateDomWithContent(module, speed, newHeader, newContent);
+					const updatePromise = updateDomWithContent(module, speed, newHeader, newContent);
 
 					updatePromise.then(resolve).catch(Log.error);
 				})
@@ -136,10 +134,9 @@ var MM = (function () {
 	 * @param {number} [speed] The (optional) number of microseconds for the animation.
 	 * @param {string} newHeader The new header that is generated.
 	 * @param {HTMLElement} newContent The new content that is generated.
-	 *
 	 * @returns {Promise} Resolved when the module dom has been updated.
 	 */
-	var updateDomWithContent = function (module, speed, newHeader, newContent) {
+	const updateDomWithContent = function (module, speed, newHeader, newContent) {
 		return new Promise(function (resolve) {
 			if (module.hidden || !speed) {
 				updateModuleContent(module, newHeader, newContent);
@@ -174,26 +171,25 @@ var MM = (function () {
 	 * @param {Module} module The module to check.
 	 * @param {string} newHeader The new header that is generated.
 	 * @param {HTMLElement} newContent The new content that is generated.
-	 *
 	 * @returns {boolean} True if the module need an update, false otherwise
 	 */
-	var moduleNeedsUpdate = function (module, newHeader, newContent) {
-		var moduleWrapper = document.getElementById(module.identifier);
+	const moduleNeedsUpdate = function (module, newHeader, newContent) {
+		const moduleWrapper = document.getElementById(module.identifier);
 		if (moduleWrapper === null) {
 			return false;
 		}
 
-		var contentWrapper = moduleWrapper.getElementsByClassName("module-content");
-		var headerWrapper = moduleWrapper.getElementsByClassName("module-header");
+		const contentWrapper = moduleWrapper.getElementsByClassName("module-content");
+		const headerWrapper = moduleWrapper.getElementsByClassName("module-header");
 
-		var headerNeedsUpdate = false;
-		var contentNeedsUpdate = false;
+		let headerNeedsUpdate = false;
+		let contentNeedsUpdate;
 
 		if (headerWrapper.length > 0) {
 			headerNeedsUpdate = newHeader !== headerWrapper[0].innerHTML;
 		}
 
-		var tempContentWrapper = document.createElement("div");
+		const tempContentWrapper = document.createElement("div");
 		tempContentWrapper.appendChild(newContent);
 		contentNeedsUpdate = tempContentWrapper.innerHTML !== contentWrapper[0].innerHTML;
 
@@ -207,13 +203,13 @@ var MM = (function () {
 	 * @param {string} newHeader The new header that is generated.
 	 * @param {HTMLElement} newContent The new content that is generated.
 	 */
-	var updateModuleContent = function (module, newHeader, newContent) {
-		var moduleWrapper = document.getElementById(module.identifier);
+	const updateModuleContent = function (module, newHeader, newContent) {
+		const moduleWrapper = document.getElementById(module.identifier);
 		if (moduleWrapper === null) {
 			return;
 		}
-		var headerWrapper = moduleWrapper.getElementsByClassName("module-header");
-		var contentWrapper = moduleWrapper.getElementsByClassName("module-content");
+		const headerWrapper = moduleWrapper.getElementsByClassName("module-header");
+		const contentWrapper = moduleWrapper.getElementsByClassName("module-content");
 
 		contentWrapper[0].innerHTML = "";
 		contentWrapper[0].appendChild(newContent);
@@ -234,7 +230,7 @@ var MM = (function () {
 	 * @param {Function} callback Called when the animation is done.
 	 * @param {object} [options] Optional settings for the hide method.
 	 */
-	var hideModule = function (module, speed, callback, options) {
+	const hideModule = function (module, speed, callback, options) {
 		options = options || {};
 
 		// set lockString if set in options.
@@ -245,10 +241,11 @@ var MM = (function () {
 			}
 		}
 
-		var moduleWrapper = document.getElementById(module.identifier);
+		const moduleWrapper = document.getElementById(module.identifier);
 		if (moduleWrapper !== null) {
 			moduleWrapper.style.transition = "opacity " + speed / 1000 + "s";
 			moduleWrapper.style.opacity = 0;
+			moduleWrapper.classList.add("hidden");
 
 			clearTimeout(module.showHideTimer);
 			module.showHideTimer = setTimeout(function () {
@@ -280,12 +277,12 @@ var MM = (function () {
 	 * @param {Function} callback Called when the animation is done.
 	 * @param {object} [options] Optional settings for the show method.
 	 */
-	var showModule = function (module, speed, callback, options) {
+	const showModule = function (module, speed, callback, options) {
 		options = options || {};
 
 		// remove lockString if set in options.
 		if (options.lockString) {
-			var index = module.lockStrings.indexOf(options.lockString);
+			const index = module.lockStrings.indexOf(options.lockString);
 			if (index !== -1) {
 				module.lockStrings.splice(index, 1);
 			}
@@ -309,16 +306,17 @@ var MM = (function () {
 			module.lockStrings = [];
 		}
 
-		var moduleWrapper = document.getElementById(module.identifier);
+		const moduleWrapper = document.getElementById(module.identifier);
 		if (moduleWrapper !== null) {
 			moduleWrapper.style.transition = "opacity " + speed / 1000 + "s";
 			// Restore the position. See hideModule() for more info.
 			moduleWrapper.style.position = "static";
+			moduleWrapper.classList.remove("hidden");
 
 			updateWrapperStates();
 
 			// Waiting for DOM-changes done in updateWrapperStates before we can start the animation.
-			var dummy = moduleWrapper.parentElement.parentElement.offsetHeight;
+			const dummy = moduleWrapper.parentElement.parentElement.offsetHeight;
 			moduleWrapper.style.opacity = 1;
 
 			clearTimeout(module.showHideTimer);
@@ -346,14 +344,14 @@ var MM = (function () {
 	 * an ugly top margin. By using this function, the top bar will be hidden if the
 	 * update notification is not visible.
 	 */
-	var updateWrapperStates = function () {
-		var positions = ["top_bar", "top_left", "top_center", "top_right", "upper_third", "middle_center", "lower_third", "bottom_left", "bottom_center", "bottom_right", "bottom_bar", "fullscreen_above", "fullscreen_below"];
+	const updateWrapperStates = function () {
+		const 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");
+			const wrapper = selectWrapper(position);
+			const moduleWrappers = wrapper.getElementsByClassName("module");
 
-			var showWrapper = false;
+			let showWrapper = false;
 			Array.prototype.forEach.call(moduleWrappers, function (moduleWrapper) {
 				if (moduleWrapper.style.position === "" || moduleWrapper.style.position === "static") {
 					showWrapper = true;
@@ -367,7 +365,7 @@ var MM = (function () {
 	/**
 	 * Loads the core config and combines it with the system defaults.
 	 */
-	var loadConfig = function () {
+	const loadConfig = function () {
 		// FIXME: Think about how to pass config around without breaking tests
 		/* eslint-disable */
 		if (typeof config === "undefined") {
@@ -385,15 +383,14 @@ var MM = (function () {
 	 *
 	 * @param {Module[]} modules Array of modules.
 	 */
-	var setSelectionMethodsForModules = function (modules) {
+	const setSelectionMethodsForModules = function (modules) {
 		/**
 		 * Filter modules with the specified classes.
 		 *
 		 * @param {string|string[]} className one or multiple classnames (array or space divided).
-		 *
 		 * @returns {Module[]} Filtered collection of modules.
 		 */
-		var withClass = function (className) {
+		const withClass = function (className) {
 			return modulesByClass(className, true);
 		};
 
@@ -401,10 +398,9 @@ var MM = (function () {
 		 * Filter modules without the specified classes.
 		 *
 		 * @param {string|string[]} className one or multiple classnames (array or space divided).
-		 *
 		 * @returns {Module[]} Filtered collection of modules.
 		 */
-		var exceptWithClass = function (className) {
+		const exceptWithClass = function (className) {
 			return modulesByClass(className, false);
 		};
 
@@ -413,20 +409,18 @@ var MM = (function () {
 		 *
 		 * @param {string|string[]} className one or multiple classnames (array or space divided).
 		 * @param {boolean} include if the filter should include or exclude the modules with the specific classes.
-		 *
 		 * @returns {Module[]} Filtered collection of modules.
 		 */
-		var modulesByClass = function (className, include) {
-			var searchClasses = className;
+		const modulesByClass = function (className, include) {
+			let searchClasses = className;
 			if (typeof className === "string") {
 				searchClasses = className.split(" ");
 			}
 
-			var newModules = modules.filter(function (module) {
-				var classes = module.data.classes.toLowerCase().split(" ");
+			const newModules = modules.filter(function (module) {
+				const classes = module.data.classes.toLowerCase().split(" ");
 
-				for (var c in searchClasses) {
-					var searchClass = searchClasses[c];
+				for (const searchClass of searchClasses) {
 					if (classes.indexOf(searchClass.toLowerCase()) !== -1) {
 						return include;
 					}
@@ -445,8 +439,8 @@ var MM = (function () {
 		 * @param {object} module The module instance to remove from the collection.
 		 * @returns {Module[]} Filtered collection of modules.
 		 */
-		var exceptModule = function (module) {
-			var newModules = modules.filter(function (mod) {
+		const exceptModule = function (module) {
+			const newModules = modules.filter(function (mod) {
 				return mod.identifier !== module.identifier;
 			});
 
@@ -459,7 +453,7 @@ var MM = (function () {
 		 *
 		 * @param {Function} callback The function to execute with the module as an argument.
 		 */
-		var enumerate = function (callback) {
+		const enumerate = function (callback) {
 			modules.map(function (module) {
 				callback(module);
 			});
@@ -486,7 +480,7 @@ var MM = (function () {
 		 * Main init method.
 		 */
 		init: function () {
-			Log.info("Initializing MagicMirror.");
+			Log.info("Initializing MagicMirror².");
 			loadConfig();
 
 			Log.setLogLevel(config.logLevel);
@@ -604,11 +598,11 @@ if (typeof Object.assign !== "function") {
 			if (target === undefined || target === null) {
 				throw new TypeError("Cannot convert undefined or null to object");
 			}
-			var output = Object(target);
-			for (var index = 1; index < arguments.length; index++) {
-				var source = arguments[index];
+			const output = Object(target);
+			for (let index = 1; index < arguments.length; index++) {
+				const source = arguments[index];
 				if (source !== undefined && source !== null) {
-					for (var nextKey in source) {
+					for (const nextKey in source) {
 						if (source.hasOwnProperty(nextKey)) {
 							output[nextKey] = source[nextKey];
 						}

js/module.js

@@ -1,19 +1,18 @@
 /* global Class, cloneObject, Loader, MMSocket, nunjucks, Translator */
 
-/* Magic Mirror
+/* MagicMirror²
  * Module Blueprint.
  * @typedef {Object} Module
  *
  * By Michael Teeuw https://michaelteeuw.nl
  * MIT Licensed.
- *
  */
-var Module = Class.extend({
+const Module = Class.extend({
 	/*********************************************************
 	 * All methods (and properties) below can be subclassed. *
 	 *********************************************************/
 
-	// Set the minimum MagicMirror module version for this module.
+	// Set the minimum MagicMirror² module version for this module.
 	requiresVersion: "2.0.0",
 
 	// Module config defaults.
@@ -75,23 +74,22 @@ var Module = Class.extend({
 	},
 
 	/**
-	 * Generates the dom which needs to be displayed. This method is called by the Magic Mirror core.
+	 * Generates the dom which needs to be displayed. This method is called by the MagicMirror² core.
 	 * This method can to be subclassed if the module wants to display info on the mirror.
 	 * Alternatively, the getTemplate method could be subclassed.
 	 *
 	 * @returns {HTMLElement|Promise} The dom or a promise with the dom to display.
 	 */
 	getDom: function () {
-		var self = this;
-		return new Promise(function (resolve) {
-			var div = document.createElement("div");
-			var template = self.getTemplate();
-			var templateData = self.getTemplateData();
+		return new Promise((resolve) => {
+			const div = document.createElement("div");
+			const template = this.getTemplate();
+			const templateData = this.getTemplateData();
 
 			// Check to see if we need to render a template string or a file.
 			if (/^.*((\.html)|(\.njk))$/.test(template)) {
 				// the template is a filename
-				self.nunjucksEnvironment().render(template, templateData, function (err, res) {
+				this.nunjucksEnvironment().render(template, templateData, function (err, res) {
 					if (err) {
 						Log.error(err);
 					}
@@ -102,7 +100,7 @@ var Module = Class.extend({
 				});
 			} else {
 				// the template is a template string.
-				div.innerHTML = self.nunjucksEnvironment().renderString(template, templateData);
+				div.innerHTML = this.nunjucksEnvironment().renderString(template, templateData);
 
 				resolve(div);
 			}
@@ -111,7 +109,7 @@ var Module = Class.extend({
 
 	/**
 	 * 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 is called by the MagicMirror² 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.
 	 *
 	 * @returns {string} The header to display above the header.
@@ -143,7 +141,7 @@ var Module = Class.extend({
 	},
 
 	/**
-	 * Called by the Magic Mirror core when a notification arrives.
+	 * Called by the MagicMirror² core when a notification arrives.
 	 *
 	 * @param {string} notification The identifier of the notification.
 	 * @param {*} payload The payload of the notification.
@@ -168,15 +166,13 @@ var Module = Class.extend({
 			return this._nunjucksEnvironment;
 		}
 
-		var self = this;
-
 		this._nunjucksEnvironment = new nunjucks.Environment(new nunjucks.WebLoader(this.file(""), { async: true }), {
 			trimBlocks: true,
 			lstripBlocks: true
 		});
 
-		this._nunjucksEnvironment.addFilter("translate", function (str, variables) {
-			return nunjucks.runtime.markSafe(self.translate(str, variables));
+		this._nunjucksEnvironment.addFilter("translate", (str, variables) => {
+			return nunjucks.runtime.markSafe(this.translate(str, variables));
 		});
 
 		return this._nunjucksEnvironment;
@@ -192,14 +188,14 @@ var Module = Class.extend({
 		Log.log(this.name + " received a socket notification: " + notification + " - Payload: " + payload);
 	},
 
-	/*
+	/**
 	 * Called when the module is hidden.
 	 */
 	suspend: function () {
 		Log.log(this.name + " is suspended.");
 	},
 
-	/*
+	/**
 	 * Called when the module is shown.
 	 */
 	resume: function () {
@@ -213,7 +209,7 @@ var Module = Class.extend({
 	/**
 	 * Set the module data.
 	 *
-	 * @param {Module} data The module data
+	 * @param {object} data The module data
 	 */
 	setData: function (data) {
 		this.data = data;
@@ -245,9 +241,8 @@ var Module = Class.extend({
 			this._socket = new MMSocket(this.name);
 		}
 
-		var self = this;
-		this._socket.setNotificationCallback(function (notification, payload) {
-			self.socketNotificationReceived(notification, payload);
+		this._socket.setNotificationCallback((notification, payload) => {
+			this.socketNotificationReceived(notification, payload);
 		});
 
 		return this._socket;
@@ -288,13 +283,12 @@ var Module = Class.extend({
 	 * @param {Function} callback Function called when done.
 	 */
 	loadDependencies: function (funcName, callback) {
-		var self = this;
-		var dependencies = this[funcName]();
+		let dependencies = this[funcName]();
 
-		var loadNextDependency = function () {
+		const loadNextDependency = () => {
 			if (dependencies.length > 0) {
-				var nextDependency = dependencies[0];
-				Loader.loadFile(nextDependency, self, function () {
+				const nextDependency = dependencies[0];
+				Loader.loadFile(nextDependency, this, () => {
 					dependencies = dependencies.slice(1);
 					loadNextDependency();
 				});
@@ -400,12 +394,11 @@ var Module = Class.extend({
 		callback = callback || function () {};
 		options = options || {};
 
-		var self = this;
 		MM.hideModule(
-			self,
+			this,
 			speed,
-			function () {
-				self.suspend();
+			() => {
+				this.suspend();
 				callback();
 			},
 			options
@@ -441,7 +434,7 @@ var Module = Class.extend({
 });
 
 /**
- * Merging MagicMirror (or other) default/config script by @bugsounet
+ * Merging MagicMirror² (or other) default/config script by @bugsounet
  * Merge 2 objects or/with array
  *
  * Usage:
@@ -464,9 +457,9 @@ var Module = Class.extend({
  * @returns {object} the merged config
  */
 function configMerge(result) {
-	var stack = Array.prototype.slice.call(arguments, 1);
-	var item;
-	var key;
+	const stack = Array.prototype.slice.call(arguments, 1);
+	let item, key;
+
 	while (stack.length) {
 		item = stack.shift();
 		for (key in item) {
@@ -494,19 +487,19 @@ Module.create = function (name) {
 		return;
 	}
 
-	var moduleDefinition = Module.definitions[name];
-	var clonedDefinition = cloneObject(moduleDefinition);
+	const moduleDefinition = Module.definitions[name];
+	const clonedDefinition = cloneObject(moduleDefinition);
 
 	// Note that we clone the definition. Otherwise the objects are shared, which gives problems.
-	var ModuleClass = Module.extend(clonedDefinition);
+	const ModuleClass = Module.extend(clonedDefinition);
 
 	return new ModuleClass();
 };
 
 Module.register = function (name, moduleDefinition) {
 	if (moduleDefinition.requiresVersion) {
-		Log.log("Check MagicMirror version for module '" + name + "' - Minimum version:  " + moduleDefinition.requiresVersion + " - Current version: " + window.version);
-		if (cmpVersions(window.version, moduleDefinition.requiresVersion) >= 0) {
+		Log.log("Check MagicMirror² version for module '" + name + "' - Minimum version:  " + moduleDefinition.requiresVersion + " - Current version: " + window.mmVersion);
+		if (cmpVersions(window.mmVersion, moduleDefinition.requiresVersion) >= 0) {
 			Log.log("Version is ok!");
 		} else {
 			Log.warn("Version is incorrect. Skip module: '" + name + "'");
@@ -517,6 +510,8 @@ Module.register = function (name, moduleDefinition) {
 	Module.definitions[name] = moduleDefinition;
 };
 
+window.Module = Module;
+
 /**
  * Compare two semantic version numbers and return the difference.
  *
@@ -526,14 +521,13 @@ Module.register = function (name, moduleDefinition) {
  * number if a is smaller and 0 if they are the same
  */
 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);
+	const regExStrip0 = /(\.0+)+$/;
+	const segmentsA = a.replace(regExStrip0, "").split(".");
+	const segmentsB = b.replace(regExStrip0, "").split(".");
+	const l = Math.min(segmentsA.length, segmentsB.length);
 
-	for (i = 0; i < l; i++) {
-		diff = parseInt(segmentsA[i], 10) - parseInt(segmentsB[i], 10);
+	for (let i = 0; i < l; i++) {
+		let diff = parseInt(segmentsA[i], 10) - parseInt(segmentsB[i], 10);
 		if (diff) {
 			return diff;
 		}

js/node_helper.js

@@ -1,4 +1,4 @@
-/* Magic Mirror
+/* MagicMirror²
  * Node Helper Superclass
  *
  * By Michael Teeuw https://michaelteeuw.nl
@@ -23,7 +23,7 @@ const NodeHelper = Class.extend({
 	},
 
 	/* stop()
-	 * Called when the MagicMirror server receives a `SIGINT`
+	 * Called when the MagicMirror² server receives a `SIGINT`
 	 * Close any open connections, stop any sub-processes and
 	 * gracefully exit the module.
 	 *
@@ -113,6 +113,32 @@ const NodeHelper = Class.extend({
 	}
 });
 
+NodeHelper.checkFetchStatus = function (response) {
+	// response.status >= 200 && response.status < 300
+	if (response.ok) {
+		return response;
+	} else {
+		throw Error(response.statusText);
+	}
+};
+
+/**
+ * Look at the specified error and return an appropriate error type, that
+ * can be translated to a detailed error message
+ *
+ * @param {Error} error the error from fetching something
+ * @returns {string} the string of the detailed error message in the translations
+ */
+NodeHelper.checkFetchError = function (error) {
+	let error_type = "MODULE_ERROR_UNSPECIFIED";
+	if (error.code === "EAI_AGAIN") {
+		error_type = "MODULE_ERROR_NO_CONNECTION";
+	} else if (error.message === "Unauthorized") {
+		error_type = "MODULE_ERROR_UNAUTHORIZED";
+	}
+	return error_type;
+};
+
 NodeHelper.create = function (moduleDefinition) {
 	return NodeHelper.extend(moduleDefinition);
 };

js/server.js

@@ -1,4 +1,4 @@
-/* Magic Mirror
+/* MagicMirror²
  * Server
  *
  * By Michael Teeuw https://michaelteeuw.nl
@@ -10,6 +10,7 @@ const path = require("path");
 const ipfilter = require("express-ipfilter").IpFilter;
 const fs = require("fs");
 const helmet = require("helmet");
+const fetch = require("node-fetch");
 
 const Log = require("logger");
 const Utils = require("./utils.js");
@@ -23,6 +24,7 @@ const Utils = require("./utils.js");
  */
 function Server(config, callback) {
 	const port = process.env.MM_PORT || config.port;
+	const serverSockets = new Set();
 
 	let server = null;
 	if (config.useHttps) {
@@ -42,6 +44,13 @@ function Server(config, callback) {
 		allowEIO3: true
 	});
 
+	server.on("connection", (socket) => {
+		serverSockets.add(socket);
+		socket.on("close", () => {
+			serverSockets.delete(socket);
+		});
+	});
+
 	Log.log(`Starting server on port ${port} ... `);
 
 	server.listen(port, config.address || "localhost");
@@ -53,13 +62,14 @@ function Server(config, callback) {
 	app.use(function (req, res, next) {
 		ipfilter(config.ipWhitelist, { mode: config.ipWhitelist.length === 0 ? "deny" : "allow", log: false })(req, res, function (err) {
 			if (err === undefined) {
+				res.header("Access-Control-Allow-Origin", "*");
 				return next();
 			}
 			Log.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({ contentSecurityPolicy: false }));
+	app.use(helmet({ contentSecurityPolicy: false, crossOriginOpenerPolicy: false, crossOriginEmbedderPolicy: false, crossOriginResourcePolicy: false, originAgentCluster: false }));
 
 	app.use("/js", express.static(__dirname));
 
@@ -68,6 +78,33 @@ function Server(config, callback) {
 		app.use(directory, express.static(path.resolve(global.root_path + directory)));
 	}
 
+	app.get("/cors", async function (req, res) {
+		// example: http://localhost:8080/cors?url=https://google.de
+
+		try {
+			const reg = "^/cors.+url=(.*)";
+			let url = "";
+
+			let match = new RegExp(reg, "g").exec(req.url);
+			if (!match) {
+				url = "invalid url: " + req.url;
+				Log.error(url);
+				res.send(url);
+			} else {
+				url = match[1];
+				Log.log("cors url: " + url);
+				const response = await fetch(url, { headers: { "User-Agent": "Mozilla/5.0 MagicMirror/" + global.version } });
+				const header = response.headers.get("Content-Type");
+				const data = await response.text();
+				if (header) res.set("Content-Type", header);
+				res.send(data);
+			}
+		} catch (error) {
+			Log.error(error);
+			res.send(error);
+		}
+	});
+
 	app.get("/version", function (req, res) {
 		res.send(global.version);
 	});
@@ -92,6 +129,13 @@ function Server(config, callback) {
 	if (typeof callback === "function") {
 		callback(app, io);
 	}
+
+	this.close = function () {
+		for (const socket of serverSockets.values()) {
+			socket.destroy();
+		}
+		server.close();
+	};
 }
 
 module.exports = Server;

js/socketclient.js

@@ -1,54 +1,53 @@
 /* global io */
 
-/* Magic Mirror
+/* MagicMirror²
  * TODO add description
  *
  * By Michael Teeuw https://michaelteeuw.nl
  * MIT Licensed.
  */
-var MMSocket = function (moduleName) {
-	var self = this;
-
+const MMSocket = function (moduleName) {
 	if (typeof moduleName !== "string") {
 		throw new Error("Please set the module name for the MMSocket.");
 	}
 
-	self.moduleName = moduleName;
+	this.moduleName = moduleName;
 
 	// Private Methods
-	var base = "/";
+	let base = "/";
 	if (typeof config !== "undefined" && typeof config.basePath !== "undefined") {
 		base = config.basePath;
 	}
-	self.socket = io("/" + self.moduleName, {
+	this.socket = io("/" + this.moduleName, {
 		path: base + "socket.io"
 	});
-	var notificationCallback = function () {};
 
-	var onevent = self.socket.onevent;
-	self.socket.onevent = function (packet) {
-		var args = packet.data || [];
-		onevent.call(this, packet); // original call
+	let notificationCallback = function () {};
+
+	const onevent = this.socket.onevent;
+	this.socket.onevent = (packet) => {
+		const args = packet.data || [];
+		onevent.call(this.socket, packet); // original call
 		packet.data = ["*"].concat(args);
-		onevent.call(this, packet); // additional call to catch-all
+		onevent.call(this.socket, packet); // additional call to catch-all
 	};
 
 	// register catch all.
-	self.socket.on("*", function (notification, payload) {
+	this.socket.on("*", (notification, payload) => {
 		if (notification !== "*") {
 			notificationCallback(notification, payload);
 		}
 	});
 
 	// Public Methods
-	this.setNotificationCallback = function (callback) {
+	this.setNotificationCallback = (callback) => {
 		notificationCallback = callback;
 	};
 
-	this.sendNotification = function (notification, payload) {
+	this.sendNotification = (notification, payload) => {
 		if (typeof payload === "undefined") {
 			payload = {};
 		}
-		self.socket.emit(notification, payload);
+		this.socket.emit(notification, payload);
 	};
 };

js/translator.js

@@ -1,12 +1,12 @@
 /* global translations */
 
-/* Magic Mirror
+/* MagicMirror²
  * Translator (l10n)
  *
  * By Christopher Fenner https://github.com/CFenner
  * MIT Licensed.
  */
-var Translator = (function () {
+const Translator = (function () {
 	/**
 	 * Load a JSON file via XHR.
 	 *
@@ -104,7 +104,7 @@ var Translator = (function () {
 		 * @param {Function} callback Function called when done.
 		 */
 		load(module, file, isFallback, callback) {
-			Log.log(`${module.name} - Load translation${isFallback && " fallback"}: ${file}`);
+			Log.log(`${module.name} - Load translation${isFallback ? " fallback" : ""}: ${file}`);
 
 			if (this.translationsFallback[module.name]) {
 				callback();
@@ -141,12 +141,7 @@ var Translator = (function () {
 		 * The first language defined in translations.js will be used.
 		 */
 		loadCoreTranslationsFallback: function () {
-			// The variable `first` will contain the first
-			// defined translation after the following line.
-			for (var first in translations) {
-				break;
-			}
-
+			let first = Object.keys(translations)[0];
 			if (first) {
 				Log.log("Loading core translation fallback file: " + translations[first]);
 				loadJSON(translations[first], (translations) => {
@@ -156,3 +151,5 @@ var Translator = (function () {
 		}
 	};
 })();
+
+window.Translator = Translator;

js/utils.js

@@ -1,4 +1,4 @@
-/* Magic Mirror
+/* MagicMirror²
  * Utils
  *
  * By Rodrigo Ramírez Norambuena https://rodrigoramirez.com

module-types.ts

@@ -1,16 +1,16 @@
 type ModuleProperties = {
-  defaults?: object,
-  start?(): void,
-  getHeader?(): string,
-  getTemplate?(): string,
-  getTemplateData?(): object,
-  notificationReceived?(notification: string, payload: any, sender: object): void,
-  socketNotificationReceived?(notification: string, payload: any): void,
-  suspend?(): void,
-  resume?(): void,
-  getDom?(): HTMLElement,
-  getStyles?(): string[],
-  [key: string]: any,
+  defaults?: object;
+  start?(): void;
+  getHeader?(): string;
+  getTemplate?(): string;
+  getTemplateData?(): object;
+  notificationReceived?(notification: string, payload: any, sender: object): void;
+  socketNotificationReceived?(notification: string, payload: any): void;
+  suspend?(): void;
+  resume?(): void;
+  getDom?(): HTMLElement;
+  getStyles?(): string[];
+  [key: string]: any;
 };
 
 export declare const Module: {
@@ -18,14 +18,14 @@ export declare const Module: {
 };
 
 export declare const Log: {
-  info(message?: any, ...optionalParams: any[]): void,
-  log(message?: any, ...optionalParams: any[]): void,
-  error(message?: any, ...optionalParams: any[]): void,
-  warn(message?: any, ...optionalParams: any[]): void,
-  group(groupTitle?: string, ...optionalParams: any[]): void,
-  groupCollapsed(groupTitle?: string, ...optionalParams: any[]): void,
-  groupEnd(): void,
-  time(timerName?: string): void,
-  timeEnd(timerName?: string): void,
-  timeStamp(timerName?: string): void,
-};
+  info(message?: any, ...optionalParams: any[]): void;
+  log(message?: any, ...optionalParams: any[]): void;
+  error(message?: any, ...optionalParams: any[]): void;
+  warn(message?: any, ...optionalParams: any[]): void;
+  group(groupTitle?: string, ...optionalParams: any[]): void;
+  groupCollapsed(groupTitle?: string, ...optionalParams: any[]): void;
+  groupEnd(): void;
+  time(timerName?: string): void;
+  timeEnd(timerName?: string): void;
+  timeStamp(timerName?: string): void;
+};

modules/default/alert/README.md

@@ -1,5 +1,5 @@
 # Module: Alert
 
-The alert module is one of the default modules of the MagicMirror. This module displays notifications from other modules.
+The alert module is one of the default modules of the MagicMirror². This module displays notifications from other modules.
 
 For configuration options, please check the [MagicMirror² documentation](https://docs.magicmirror.builders/modules/alert.html).

modules/default/alert/alert.js

@@ -1,167 +1,146 @@
 /* global NotificationFx */
 
-/* Magic Mirror
+/* MagicMirror²
  * Module: alert
  *
  * By Paul-Vincent Roll https://paulvincentroll.com/
  * MIT Licensed.
  */
 Module.register("alert", {
+	alerts: {},
+
 	defaults: {
-		// scale|slide|genie|jelly|flip|bouncyflip|exploader
-		effect: "slide",
-		// scale|slide|genie|jelly|flip|bouncyflip|exploader
-		alert_effect: "jelly",
-		//time a notification is displayed in seconds
-		display_time: 3500,
-		//Position
+		effect: "slide", // scale|slide|genie|jelly|flip|bouncyflip|exploader
+		alert_effect: "jelly", // scale|slide|genie|jelly|flip|bouncyflip|exploader
+		display_time: 3500, // time a notification is displayed in seconds
 		position: "center",
-		//shown at startup
-		welcome_message: false
+		welcome_message: false // shown at startup
 	},
-	getScripts: function () {
+
+	getScripts() {
 		return ["notificationFx.js"];
 	},
-	getStyles: function () {
-		return ["notificationFx.css", "font-awesome.css"];
+
+	getStyles() {
+		return ["font-awesome.css", this.file(`./styles/notificationFx.css`), this.file(`./styles/${this.config.position}.css`)];
 	},
-	// Define required translations.
-	getTranslations: function () {
+
+	getTranslations() {
 		return {
-			en: "translations/en.json",
+			bg: "translations/bg.json",
+			da: "translations/da.json",
 			de: "translations/de.json",
-			nl: "translations/nl.json"
+			en: "translations/en.json",
+			es: "translations/es.json",
+			fr: "translations/fr.json",
+			hu: "translations/hu.json",
+			nl: "translations/nl.json",
+			ru: "translations/ru.json"
 		};
 	},
-	show_notification: function (message) {
+
+	getTemplate(type) {
+		return `templates/${type}.njk`;
+	},
+
+	start() {
+		Log.info(`Starting module: ${this.name}`);
+
 		if (this.config.effect === "slide") {
-			this.config.effect = this.config.effect + "-" + this.config.position;
+			this.config.effect = `${this.config.effect}-${this.config.position}`;
 		}
-		let msg = "";
-		if (message.title) {
-			msg += "<span class='thin dimmed medium'>" + message.title + "</span>";
+
+		if (this.config.welcome_message) {
+			const message = this.config.welcome_message === true ? this.translate("welcome") : this.config.welcome_message;
+			this.showNotification({ title: this.translate("sysTitle"), message });
 		}
-		if (message.message) {
-			if (msg !== "") {
-				msg += "<br />";
+	},
+
+	notificationReceived(notification, payload, sender) {
+		if (notification === "SHOW_ALERT") {
+			if (payload.type === "notification") {
+				this.showNotification(payload);
+			} else {
+				this.showAlert(payload, sender);
 			}
-			msg += "<span class='light bright small'>" + message.message + "</span>";
+		} else if (notification === "HIDE_ALERT") {
+			this.hideAlert(sender);
 		}
+	},
+
+	async showNotification(notification) {
+		const message = await this.renderMessage("notification", notification);
 
 		new NotificationFx({
-			message: msg,
+			message,
 			layout: "growl",
 			effect: this.config.effect,
-			ttl: message.timer !== undefined ? message.timer : this.config.display_time
+			ttl: notification.timer || this.config.display_time
 		}).show();
 	},
-	show_alert: function (params, sender) {
-		let image = "";
-		//Set standard params if not provided by module
-		if (typeof params.timer === "undefined") {
-			params.timer = null;
-		}
-		if (typeof params.imageHeight === "undefined") {
-			params.imageHeight = "80px";
-		}
-		if (typeof params.imageUrl === "undefined" && typeof params.imageFA === "undefined") {
-			params.imageUrl = null;
-		} else if (typeof params.imageFA === "undefined") {
-			image = "<img src='" + params.imageUrl.toString() + "' height='" + params.imageHeight.toString() + "' style='margin-bottom: 10px;'/><br />";
-		} else if (typeof params.imageUrl === "undefined") {
-			image = "<span class='bright " + "fa fa-" + params.imageFA + "' style='margin-bottom: 10px;font-size:" + params.imageHeight.toString() + ";'/></span><br />";
-		}
-		//Create overlay
-		const overlay = document.createElement("div");
-		overlay.id = "overlay";
-		overlay.innerHTML += '<div class="black_overlay"></div>';
-		document.body.insertBefore(overlay, document.body.firstChild);
 
-		//If module already has an open alert close it
+	async showAlert(alert, sender) {
+		// If module already has an open alert close it
 		if (this.alerts[sender.name]) {
-			this.hide_alert(sender);
+			this.hideAlert(sender, false);
 		}
 
-		//Display title and message only if they are provided in notification parameters
-		let message = "";
-		if (params.title) {
-			message += "<span class='light dimmed medium'>" + params.title + "</span>";
-		}
-		if (params.message) {
-			if (message !== "") {
-				message += "<br />";
-			}
-
-			message += "<span class='thin bright small'>" + params.message + "</span>";
+		// Add overlay
+		if (!Object.keys(this.alerts).length) {
+			this.toggleBlur(true);
 		}
 
-		//Store alert in this.alerts
+		const message = await this.renderMessage("alert", alert);
+
+		// Store alert in this.alerts
 		this.alerts[sender.name] = new NotificationFx({
-			message: image + message,
+			message,
 			effect: this.config.alert_effect,
-			ttl: params.timer,
-			onClose: () => this.hide_alert(sender),
+			ttl: alert.timer,
+			onClose: () => this.hideAlert(sender),
 			al_no: "ns-alert"
 		});
 
-		//Show alert
+		// Show alert
 		this.alerts[sender.name].show();
 
-		//Add timer to dismiss alert and overlay
-		if (params.timer) {
+		// Add timer to dismiss alert and overlay
+		if (alert.timer) {
 			setTimeout(() => {
-				this.hide_alert(sender);
-			}, params.timer);
+				this.hideAlert(sender);
+			}, alert.timer);
 		}
 	},
-	hide_alert: function (sender) {
-		//Dismiss alert and remove from this.alerts
+
+	hideAlert(sender, close = true) {
+		// Dismiss alert and remove from this.alerts
 		if (this.alerts[sender.name]) {
-			this.alerts[sender.name].dismiss();
-			this.alerts[sender.name] = null;
-			//Remove overlay
-			const overlay = document.getElementById("overlay");
-			overlay.parentNode.removeChild(overlay);
-		}
-	},
-	setPosition: function (pos) {
-		//Add css to body depending on the set position for notifications
-		const sheet = document.createElement("style");
-		if (pos === "center") {
-			sheet.innerHTML = ".ns-box {margin-left: auto; margin-right: auto;text-align: center;}";
-		}
-		if (pos === "right") {
-			sheet.innerHTML = ".ns-box {margin-left: auto;text-align: right;}";
-		}
-		if (pos === "left") {
-			sheet.innerHTML = ".ns-box {margin-right: auto;text-align: left;}";
-		}
-		document.body.appendChild(sheet);
-	},
-	notificationReceived: function (notification, payload, sender) {
-		if (notification === "SHOW_ALERT") {
-			if (typeof payload.type === "undefined") {
-				payload.type = "alert";
-			}
-			if (payload.type === "alert") {
-				this.show_alert(payload, sender);
-			} else if (payload.type === "notification") {
-				this.show_notification(payload);
-			}
-		} else if (notification === "HIDE_ALERT") {
-			this.hide_alert(sender);
-		}
-	},
-	start: function () {
-		this.alerts = {};
-		this.setPosition(this.config.position);
-		if (this.config.welcome_message) {
-			if (this.config.welcome_message === true) {
-				this.show_notification({ title: this.translate("sysTitle"), message: this.translate("welcome") });
-			} else {
-				this.show_notification({ title: this.translate("sysTitle"), message: this.config.welcome_message });
+			this.alerts[sender.name].dismiss(close);
+			delete this.alerts[sender.name];
+			// Remove overlay
+			if (!Object.keys(this.alerts).length) {
+				this.toggleBlur(false);
 			}
 		}
-		Log.info("Starting module: " + this.name);
+	},
+
+	renderMessage(type, data) {
+		return new Promise((resolve) => {
+			this.nunjucksEnvironment().render(this.getTemplate(type), data, function (err, res) {
+				if (err) {
+					Log.error("Failed to render alert", err);
+				}
+
+				resolve(res);
+			});
+		});
+	},
+
+	toggleBlur(add = false) {
+		const method = add ? "add" : "remove";
+		const modules = document.querySelectorAll(".module");
+		for (const module of modules) {
+			module.classList[method]("alert-blur");
+		}
 	}
 });

modules/default/alert/notificationFx.js

@@ -9,6 +9,8 @@
  *
  * Copyright 2014, Codrops
  * https://tympanus.net/codrops/
+ *
+ * @param {object} window The window object
  */
 (function (window) {
 	/**
@@ -122,8 +124,10 @@
 
 	/**
 	 * Dismiss the notification
+	 *
+	 * @param {boolean} [close] call the onClose callback at the end
 	 */
-	NotificationFx.prototype.dismiss = function () {
+	NotificationFx.prototype.dismiss = function (close = true) {
 		this.active = false;
 		clearTimeout(this.dismissttl);
 		this.ntf.classList.remove("ns-show");
@@ -131,7 +135,7 @@
 			this.ntf.classList.add("ns-hide");
 
 			// callback
-			this.options.onClose();
+			if (close) this.options.onClose();
 		}, 25);
 
 		// after animation ends remove ntf from the DOM

modules/default/alert/styles/center.css

@@ -0,0 +1,5 @@
+.ns-box {
+  margin-left: auto;
+  margin-right: auto;
+  text-align: center;
+}

modules/default/alert/styles/left.css

@@ -0,0 +1,4 @@
+.ns-box {
+  margin-right: auto;
+  text-align: left;
+}

modules/default/alert/styles/notificationFx.css

@@ -6,7 +6,6 @@
   line-height: 1.4;
   margin-bottom: 10px;
   z-index: 1;
-  color: black;
   font-size: 70%;
   position: relative;
   display: table;
@@ -15,17 +14,17 @@
   border-width: 1px;
   border-radius: 5px;
   border-style: solid;
-  border-color: #666;
+  border-color: var(--color-text-dimmed);
 }
 
 .ns-alert {
   border-style: solid;
-  border-color: #fff;
+  border-color: var(--color-text-bright);
   padding: 17px;
   line-height: 1.4;
   margin-bottom: 10px;
   z-index: 3;
-  color: white;
+  color: var(--color-text-bright);
   font-size: 70%;
   position: fixed;
   text-align: center;
@@ -40,12 +39,8 @@
   border-radius: 20px;
 }
 
-.black_overlay {
-  position: fixed;
-  z-index: 2;
-  background-color: rgba(0, 0, 0, 0.93);
-  width: 100%;
-  height: 100%;
+.alert-blur {
+  filter: blur(2px) brightness(50%);
 }
 
 [class^="ns-effect-"].ns-growl.ns-hide,

modules/default/alert/styles/right.css

@@ -0,0 +1,4 @@
+.ns-box {
+  margin-left: auto;
+  text-align: right;
+}

modules/default/alert/templates/alert.njk

@@ -0,0 +1,18 @@
+{% if imageUrl or imageFA %}
+  {% set imageHeight = imageHeight if imageHeight else "80px" %}
+  {% if imageUrl %}
+    <img src="{{ imageUrl }}" height="{{ imageHeight }}" style="margin-bottom: 10px;"/>
+  {% else %}
+    <span class="bright fas fa-{{ imageFA }}" style='margin-bottom: 10px; font-size: {{ imageHeight }};'/></span>
+  {% endif %}
+  <br/>
+{% endif %}
+{% if title %}
+  <span class="thin dimmed medium">{{ title }}</span>
+{% endif %}
+{% if message %}
+  {% if title %}
+    <br/>
+  {% endif %}
+  <span class="light bright small">{{ message }}</span>
+{% endif %}

modules/default/alert/templates/notification.njk

@@ -0,0 +1,9 @@
+{% if title %}
+  <span class="thin dimmed medium">{{ title }}</span>
+{% endif %}
+{% if message %}
+  {% if title %}
+    <br/>
+  {% endif %}
+  <span class="light bright small">{{ message }}</span>
+{% endif %}

modules/default/alert/translations/bg.json

@@ -1,4 +1,4 @@
 {
-	"sysTitle": "MagicMirror нотификация",
+	"sysTitle": "MagicMirror² нотификация",
 	"welcome": "Добре дошли, стартирането беше успешно"
 }

modules/default/alert/translations/da.json

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

modules/default/alert/translations/de.json

@@ -1,4 +1,4 @@
 {
-	"sysTitle": "MagicMirror Benachrichtigung",
+	"sysTitle": "MagicMirror² Benachrichtigung",
 	"welcome": "Willkommen, Start war erfolgreich!"
 }

modules/default/alert/translations/en.json

@@ -1,4 +1,4 @@
 {
-	"sysTitle": "MagicMirror Notification",
+	"sysTitle": "MagicMirror² Notification",
 	"welcome": "Welcome, start was successful!"
 }

modules/default/alert/translations/es.json

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

modules/default/alert/translations/fr.json

@@ -1,4 +1,4 @@
 {
-	"sysTitle": "MagicMirror Notification",
+	"sysTitle": "MagicMirror² Notification",
 	"welcome": "Bienvenue, le démarrage a été un succès!"
 }

modules/default/alert/translations/hu.json

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

modules/default/alert/translations/nl.json

@@ -1,4 +1,4 @@
 {
-	"sysTitle": "MagicMirror Notificatie",
+	"sysTitle": "MagicMirror² Notificatie",
 	"welcome": "Welkom, Succesvol gestart!"
 }

modules/default/alert/translations/ru.json

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

modules/default/calendar/README.md

@@ -1,6 +1,6 @@
 # Module: Calendar
 
-The `calendar` module is one of the default modules of the MagicMirror.
+The `calendar` module is one of the default modules of the MagicMirror².
 This module displays events from a public .ical calendar. It can combine multiple calendars.
 
 For configuration options, please check the [MagicMirror² documentation](https://docs.magicmirror.builders/modules/calendar.html).

modules/default/calendar/calendar.css

@@ -1,13 +1,14 @@
 .calendar .symbol {
+  display: flex;
+  flex-direction: row;
+  justify-content: flex-end;
   padding-left: 0;
   padding-right: 10px;
-  font-size: 80%;
-  vertical-align: top;
+  font-size: var(--font-size-small);
 }
 
 .calendar .symbol span {
-  display: inline-block;
-  transform: translate(0, 2px);
+  padding-top: 4px;
 }
 
 .calendar .title {

modules/default/calendar/calendar.js

@@ -1,6 +1,6 @@
 /* global cloneObject */
 
-/* Magic Mirror
+/* MagicMirror²
  * Module: Calendar
  *
  * By Michael Teeuw https://michaelteeuw.nl
@@ -13,7 +13,7 @@ Module.register("calendar", {
 		maximumNumberOfDays: 365,
 		limitDays: 0, // Limit the number of days shown, 0 = no limit
 		displaySymbol: true,
-		defaultSymbol: "calendar", // Fontawesome Symbol see https://fontawesome.com/cheatsheet?from=io
+		defaultSymbol: "calendar-alt", // Fontawesome Symbol see https://fontawesome.com/cheatsheet?from=io
 		showLocation: false,
 		displayRepeatingCountTitle: false,
 		defaultRepeatingCountTitle: "",
@@ -43,7 +43,7 @@ Module.register("calendar", {
 		tableClass: "small",
 		calendars: [
 			{
-				symbol: "calendar",
+				symbol: "calendar-alt",
 				url: "https://www.calendarlabs.com/templates/ical/US-Holidays.ics"
 			}
 		],
@@ -84,7 +84,7 @@ Module.register("calendar", {
 
 	// Override start method.
 	start: function () {
-		Log.log("Starting module: " + this.name);
+		Log.info("Starting module: " + this.name);
 
 		// Set locale.
 		moment.updateLocale(config.language, this.getLocaleSpecification(config.timeFormat));
@@ -140,17 +140,17 @@ Module.register("calendar", {
 		if (notification === "CALENDAR_EVENTS") {
 			if (this.hasCalendarURL(payload.url)) {
 				this.calendarData[payload.url] = payload.events;
+				this.error = null;
 				this.loaded = true;
 
 				if (this.config.broadcastEvents) {
 					this.broadcastEvents();
 				}
 			}
-		} else if (notification === "FETCH_ERROR") {
-			Log.error("Calendar Error. Could not fetch calendar: " + payload.url);
+		} else if (notification === "CALENDAR_ERROR") {
+			let error_message = this.translate(payload.error_type);
+			this.error = this.translate("MODULE_CONFIG_ERROR", { MODULE_NAME: this.name, ERROR: error_message });
 			this.loaded = true;
-		} else if (notification === "INCORRECT_URL") {
-			Log.error("Calendar Error. Incorrect url: " + payload.url);
 		}
 
 		this.updateDom(this.config.animationSpeed);
@@ -164,10 +164,16 @@ Module.register("calendar", {
 		const oneHour = oneMinute * 60;
 		const oneDay = oneHour * 24;
 
-		const events = this.createEventList();
+		const events = this.createEventList(true);
 		const wrapper = document.createElement("table");
 		wrapper.className = this.config.tableClass;
 
+		if (this.error) {
+			wrapper.innerHTML = this.error;
+			wrapper.className = this.config.tableClass + " dimmed";
+			return wrapper;
+		}
+
 		if (events.length === 0) {
 			wrapper.innerHTML = this.loaded ? this.translate("EMPTY") : this.translate("LOADING");
 			wrapper.className = this.config.tableClass + " dimmed";
@@ -231,21 +237,9 @@ Module.register("calendar", {
 				symbolWrapper.className = "symbol align-right " + symbolClass;
 
 				const symbols = this.symbolsForEvent(event);
-				// If symbols are displayed and custom symbol is set, replace event symbol
-				if (this.config.displaySymbol && this.config.customEvents.length > 0) {
-					for (let ev in this.config.customEvents) {
-						if (typeof this.config.customEvents[ev].symbol !== "undefined" && this.config.customEvents[ev].symbol !== "") {
-							let needle = new RegExp(this.config.customEvents[ev].keyword, "gi");
-							if (needle.test(event.title)) {
-								symbols[0] = this.config.customEvents[ev].symbol;
-								break;
-							}
-						}
-					}
-				}
 				symbols.forEach((s, index) => {
 					const symbol = document.createElement("span");
-					symbol.className = "fa fa-fw fa-" + s;
+					symbol.className = "fas fa-fw fa-" + s;
 					if (index > 0) {
 						symbol.style.paddingLeft = "5px";
 					}
@@ -305,15 +299,14 @@ Module.register("calendar", {
 			if (this.config.timeFormat === "dateheaders") {
 				if (event.fullDayEvent) {
 					titleWrapper.colSpan = "2";
-					titleWrapper.align = "left";
+					titleWrapper.classList.add("align-left");
 				} else {
 					const timeWrapper = document.createElement("td");
-					timeWrapper.className = "time light " + this.timeClassForUrl(event.url);
-					timeWrapper.align = "left";
+					timeWrapper.className = "time light align-left " + this.timeClassForUrl(event.url);
 					timeWrapper.style.paddingLeft = "2px";
 					timeWrapper.innerHTML = moment(event.startDate, "x").format("LT");
 					eventWrapper.appendChild(timeWrapper);
-					titleWrapper.align = "right";
+					titleWrapper.classList.add("align-right");
 				}
 
 				eventWrapper.appendChild(titleWrapper);
@@ -336,8 +329,7 @@ Module.register("calendar", {
 						//subtract one second so that fullDayEvents end at 23:59:59, and not at 0:00:00 one the next day
 						event.endDate -= oneSecond;
 						timeWrapper.innerHTML = this.capFirst(moment(event.startDate, "x").format(this.config.fullDayEventDateFormat));
-					}
-					if (this.config.getRelative > 0 && event.startDate < now) {
+					} else if (this.config.getRelative > 0 && event.startDate < now) {
 						// Ongoing and getRelative is set
 						timeWrapper.innerHTML = this.capFirst(
 							this.translate("RUNNING", {
@@ -363,20 +355,32 @@ Module.register("calendar", {
 					}
 				} else {
 					// Show relative times
-					if (event.startDate >= now) {
+					if (event.startDate >= now || (event.fullDayEvent && event.today)) {
 						// Use relative  time
-						if (!this.config.hideTime) {
-							timeWrapper.innerHTML = this.capFirst(moment(event.startDate, "x").calendar());
+						if (!this.config.hideTime && !event.fullDayEvent) {
+							timeWrapper.innerHTML = this.capFirst(moment(event.startDate, "x").calendar(null, { sameElse: this.config.dateFormat }));
 						} else {
 							timeWrapper.innerHTML = this.capFirst(
 								moment(event.startDate, "x").calendar(null, {
 									sameDay: "[" + this.translate("TODAY") + "]",
 									nextDay: "[" + this.translate("TOMORROW") + "]",
-									nextWeek: "dddd"
+									nextWeek: "dddd",
+									sameElse: event.fullDayEvent ? this.config.fullDayEventDateFormat : this.config.dateFormat
 								})
 							);
 						}
-						if (event.startDate - now < this.config.getRelative * oneHour) {
+						if (event.fullDayEvent) {
+							// Full days events within the next two days
+							if (event.today) {
+								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 if (event.startDate - now < this.config.getRelative * oneHour) {
 							// If event is within getRelative  hours, display 'in xxx' time format or moment.fromNow()
 							timeWrapper.innerHTML = this.capFirst(moment(event.startDate, "x").fromNow());
 						}
@@ -472,9 +476,10 @@ Module.register("calendar", {
 	/**
 	 * Creates the sorted list of all events.
 	 *
+	 * @param {boolean} limitNumberOfEntries Whether to filter returned events for display.
 	 * @returns {object[]} Array with events.
 	 */
-	createEventList: function () {
+	createEventList: function (limitNumberOfEntries) {
 		const now = new Date();
 		const today = moment().startOf("day");
 		const future = moment().startOf("day").add(this.config.maximumNumberOfDays, "days").toDate();
@@ -485,7 +490,7 @@ Module.register("calendar", {
 			for (const e in calendar) {
 				const event = JSON.parse(JSON.stringify(calendar[e])); // clone object
 
-				if (event.endDate < now) {
+				if (event.endDate < now && limitNumberOfEntries) {
 					continue;
 				}
 				if (this.config.hidePrivate) {
@@ -494,7 +499,7 @@ Module.register("calendar", {
 						continue;
 					}
 				}
-				if (this.config.hideOngoing) {
+				if (this.config.hideOngoing && limitNumberOfEntries) {
 					if (event.startDate < now) {
 						continue;
 					}
@@ -543,6 +548,10 @@ Module.register("calendar", {
 			return a.startDate - b.startDate;
 		});
 
+		if (!limitNumberOfEntries) {
+			return events;
+		}
+
 		// Limit the number of days displayed
 		// If limitDays is set > 0, limit display to that number of days
 		if (this.config.limitDays > 0) {
@@ -623,6 +632,17 @@ Module.register("calendar", {
 			symbols = this.mergeUnique(this.getCalendarPropertyAsArray(event.url, "fullDaySymbol", this.config.defaultSymbol), symbols);
 		}
 
+		// If custom symbol is set, replace event symbol
+		for (let ev of this.config.customEvents) {
+			if (typeof ev.symbol !== "undefined" && ev.symbol !== "") {
+				let needle = new RegExp(ev.keyword, "gi");
+				if (needle.test(event.title)) {
+					symbols[0] = ev.symbol;
+					break;
+				}
+			}
+		}
+
 		return symbols;
 	},
 
@@ -819,22 +839,14 @@ Module.register("calendar", {
 	 * The all events available in one array, sorted on startdate.
 	 */
 	broadcastEvents: function () {
-		const eventList = [];
-		for (const url in this.calendarData) {
-			for (const ev of this.calendarData[url]) {
-				const event = cloneObject(ev);
-				event.symbol = this.symbolsForEvent(event);
-				event.calendarName = this.calendarNameForUrl(url);
-				event.color = this.colorForUrl(url);
-				delete event.url;
-				eventList.push(event);
-			}
+		const eventList = this.createEventList(false);
+		for (const event of eventList) {
+			event.symbol = this.symbolsForEvent(event);
+			event.calendarName = this.calendarNameForUrl(event.url);
+			event.color = this.colorForUrl(event.url);
+			delete event.url;
 		}
 
-		eventList.sort(function (a, b) {
-			return a.startDate - b.startDate;
-		});
-
 		this.sendNotification("CALENDAR_EVENTS", eventList);
 	}
 });

modules/default/calendar/calendarfetcher.js

@@ -1,4 +1,4 @@
-/* Magic Mirror
+/* MagicMirror²
  * Node Helper: Calendar - CalendarFetcher
  *
  * By Michael Teeuw https://michaelteeuw.nl
@@ -6,6 +6,7 @@
  */
 const CalendarUtils = require("./calendarutils");
 const Log = require("logger");
+const NodeHelper = require("node_helper");
 const ical = require("node-ical");
 const fetch = require("node-fetch");
 const digest = require("digest-fetch");
@@ -40,7 +41,7 @@ const CalendarFetcher = function (url, reloadInterval, excludedEvents, maximumEn
 		let fetcher = null;
 		let httpsAgent = null;
 		let headers = {
-			"User-Agent": "Mozilla/5.0 (Node.js " + nodeVersion + ") MagicMirror/" + global.version + " (https://github.com/MichMich/MagicMirror/)"
+			"User-Agent": "Mozilla/5.0 (Node.js " + nodeVersion + ") MagicMirror/" + global.version
 		};
 
 		if (selfSignedCert) {
@@ -52,27 +53,17 @@ const CalendarFetcher = function (url, reloadInterval, excludedEvents, maximumEn
 			if (auth.method === "bearer") {
 				headers.Authorization = "Bearer " + auth.pass;
 			} else if (auth.method === "digest") {
-				fetcher = new digest(auth.user, auth.pass).fetch(url, { headers: headers, httpsAgent: httpsAgent });
+				fetcher = new digest(auth.user, auth.pass).fetch(url, { headers: headers, agent: httpsAgent });
 			} else {
 				headers.Authorization = "Basic " + Buffer.from(auth.user + ":" + auth.pass).toString("base64");
 			}
 		}
 		if (fetcher === null) {
-			fetcher = fetch(url, { headers: headers, httpsAgent: httpsAgent });
+			fetcher = fetch(url, { headers: headers, agent: httpsAgent });
 		}
 
 		fetcher
-			.catch((error) => {
-				fetchFailedCallback(this, error);
-				scheduleTimer();
-			})
-			.then((response) => {
-				if (response.status !== 200) {
-					fetchFailedCallback(this, response.statusText);
-					scheduleTimer();
-				}
-				return response;
-			})
+			.then(NodeHelper.checkFetchStatus)
 			.then((response) => response.text())
 			.then((responseData) => {
 				let data = [];
@@ -87,12 +78,16 @@ const CalendarFetcher = function (url, reloadInterval, excludedEvents, maximumEn
 						maximumNumberOfDays
 					});
 				} catch (error) {
-					fetchFailedCallback(this, error.message);
+					fetchFailedCallback(this, error);
 					scheduleTimer();
 					return;
 				}
 				this.broadcastEvents();
 				scheduleTimer();
+			})
+			.catch((error) => {
+				fetchFailedCallback(this, error);
+				scheduleTimer();
 			});
 	};
 

modules/default/calendar/calendarutils.js

@@ -1,4 +1,4 @@
-/* Magic Mirror
+/* MagicMirror²
  * Calendar Util Methods
  *
  * By Michael Teeuw https://michaelteeuw.nl
@@ -18,8 +18,8 @@ const CalendarUtils = {
 	 * Calculate the time correction, either dst/std or full day in cases where
 	 * utc time is day before plus offset
 	 *
-	 * @param {object} event
-	 * @param {Date} date
+	 * @param {object} event the event which needs adjustement
+	 * @param {Date} date the date on which this event happens
 	 * @returns {number} the necessary adjustment in hours
 	 */
 	calculateTimezoneAdjustment: function (event, date) {
@@ -98,7 +98,7 @@ const CalendarUtils = {
 				if (h > 0 && h < Math.abs(current_offset) / 60) {
 					// if so, rrule created a wrong date (utc day, oops, with utc yesterday adjusted time)
 					// we need to fix that
-					adjustHours = 24;
+					//adjustHours = 24;
 					// Log.debug("adjusting date")
 				}
 				//-300 > -240
@@ -117,6 +117,13 @@ const CalendarUtils = {
 		return adjustHours;
 	},
 
+	/**
+	 * Filter the events from ical according to the given config
+	 *
+	 * @param {object} data the calendar data from ical
+	 * @param {object} config The configuration object
+	 * @returns {string[]} the filtered events
+	 */
 	filterEvents: function (data, config) {
 		const newEvents = [];
 
@@ -131,13 +138,14 @@ const CalendarUtils = {
 			return CalendarUtils.isFullDayEvent(event) ? moment(event[time], "YYYYMMDD") : moment(new Date(event[time]));
 		};
 
-		Log.debug("there are " + Object.entries(data).length + " calendar entries");
+		Log.debug("There are " + Object.entries(data).length + " calendar entries.");
 		Object.entries(data).forEach(([key, event]) => {
+			Log.debug("Processing entry...");
 			const now = new Date();
 			const today = moment().startOf("day").toDate();
 			const future = moment().startOf("day").add(config.maximumNumberOfDays, "days").subtract(1, "seconds").toDate(); // Subtract 1 second so that events that start on the middle of the night will not repeat.
 			let past = today;
-			Log.debug("have entries ");
+
 			if (config.includePastEvents) {
 				past = moment().startOf("day").subtract(config.maximumNumberOfDays, "days").toDate();
 			}
@@ -152,10 +160,10 @@ const CalendarUtils = {
 			}
 
 			if (event.type === "VEVENT") {
+				Log.debug("Event:\n" + JSON.stringify(event));
 				let startDate = eventDate(event, "start");
 				let endDate;
 
-				Log.debug("\nevent=" + JSON.stringify(event));
 				if (typeof event.end !== "undefined") {
 					endDate = eventDate(event, "end");
 				} else if (typeof event.duration !== "undefined") {
@@ -169,16 +177,21 @@ const CalendarUtils = {
 					}
 				}
 
-				Log.debug(" start=" + startDate.toDate() + " end=" + endDate.toDate());
+				Log.debug("start: " + startDate.toDate());
+				Log.debug("end:: " + endDate.toDate());
 
-				// calculate the duration of the event for use with recurring events.
+				// Calculate the duration of the event for use with recurring events.
 				let duration = parseInt(endDate.format("x")) - parseInt(startDate.format("x"));
+				Log.debug("duration: " + duration);
 
+				// FIXME: Since the parsed json object from node-ical comes with time information
+				// this check could be removed (?)
 				if (event.start.length === 8) {
 					startDate = startDate.startOf("day");
 				}
 
 				const title = CalendarUtils.getTitleFromEvent(event);
+				Log.debug("title: " + title);
 
 				let excluded = false,
 					dateFilter = null;
@@ -253,9 +266,13 @@ const CalendarUtils = {
 					let pastLocal = 0;
 					let futureLocal = 0;
 					if (CalendarUtils.isFullDayEvent(event)) {
+						Log.debug("fullday");
 						// if full day event, only use the date part of the ranges
 						pastLocal = pastMoment.toDate();
 						futureLocal = futureMoment.toDate();
+
+						Log.debug("pastLocal: " + pastLocal);
+						Log.debug("futureLocal: " + futureLocal);
 					} else {
 						// if we want past events
 						if (config.includePastEvents) {
@@ -267,9 +284,9 @@ const CalendarUtils = {
 						}
 						futureLocal = futureMoment.toDate(); // future
 					}
-					Log.debug(" between=" + pastLocal + " to " + futureLocal);
+					Log.debug("Search for recurring events between: " + pastLocal + " and " + futureLocal);
 					const dates = rule.between(pastLocal, futureLocal, true, limitFunction);
-					Log.debug("title=" + event.summary + " dates=" + JSON.stringify(dates));
+					Log.debug("Title: " + event.summary + ", with dates: " + JSON.stringify(dates));
 					// The "dates" array contains the set of dates within our desired date range range that are valid
 					// for the recurrence rule. *However*, it's possible for us to have a specific recurrence that
 					// had its date changed from outside the range to inside the range.  For the time being,
@@ -277,6 +294,7 @@ const CalendarUtils = {
 					// because the logic below will filter out any recurrences that don't actually belong within
 					// our display range.
 					// Would be great if there was a better way to handle this.
+					Log.debug("event.recurrences: " + event.recurrences);
 					if (event.recurrences !== undefined) {
 						for (let r in event.recurrences) {
 							// Only add dates that weren't already in the range we added from the rrule so that
@@ -289,62 +307,63 @@ const CalendarUtils = {
 					// Loop through the set of date entries to see which recurrences should be added to our event list.
 					for (let d in dates) {
 						let date = dates[d];
-						// ical.js started returning recurrences and exdates as ISOStrings without time information.
-						// .toISOString().substring(0,10) is the method they use to calculate keys, so we'll do the same
-						// (see https://github.com/peterbraden/ical.js/pull/84 )
+						// Remove the time information of each date by using its substring, using the following method:
+						// .toISOString().substring(0,10).
+						// since the date is given as ISOString with YYYY-MM-DDTHH:MM:SS.SSSZ
+						// (see https://momentjs.com/docs/#/displaying/as-iso-string/).
 						const dateKey = date.toISOString().substring(0, 10);
 						let curEvent = event;
 						let showRecurrence = true;
 
-						// get the offset of today where we are processing
-						// this will be the correction we need to apply
+						// Get the offset of today where we are processing
+						// This will be the correction, we need to apply.
 						let nowOffset = new Date().getTimezoneOffset();
-						// for full day events, the time might be off from RRULE/Luxon problem
-						// get time zone offset of the rule calculated event
+						// For full day events, the time might be off from RRULE/Luxon problem
+						// Get time zone offset of the rule calculated event
 						let dateoffset = date.getTimezoneOffset();
-						// reduce the time by the offset
+
+						// Reduce the time by the following offset.
 						Log.debug(" recurring date is " + date + " offset is " + dateoffset);
+
 						let dh = moment(date).format("HH");
 						Log.debug(" recurring date is " + date + " offset is " + dateoffset / 60 + " Hour is " + dh);
+
 						if (CalendarUtils.isFullDayEvent(event)) {
-							Log.debug("fullday");
-							// if the offset is  negative, east of GMT where the problem is
+							Log.debug("Fullday");
+							// If the offset is negative (east of GMT), where the problem is
 							if (dateoffset < 0) {
-								// if the date hour is less than the offset
 								if (dh < Math.abs(dateoffset / 60)) {
 									// reduce the time by the offset
-									Log.debug(" recurring date is " + date + " offset is " + dateoffset);
-									// apply the correction to the date/time to get it UTC relative
-									date = new Date(date.getTime() - Math.abs(nowOffset) * 60000);
+									// Apply the correction to the date/time to get it UTC relative
+									date = new Date(date.getTime() - Math.abs(24 * 60) * 60000);
 									// the duration was calculated way back at the top before we could correct the start time..
 									// fix it for this event entry
 									//duration = 24 * 60 * 60 * 1000;
-									Log.debug("new recurring date1 is " + date);
+									Log.debug("new recurring date1 fulldate is " + date);
 								}
 							} else {
 								// if the timezones are the same, correct date if needed
-								if (event.start.tz === moment.tz.guess()) {
-									// if the date hour is less than the offset
-									if (24 - dh < Math.abs(dateoffset / 60)) {
-										// apply the correction to the date/time back to right day
-										date = new Date(date.getTime() + Math.abs(24 * 60) * 60000);
-										// the duration was calculated way back at the top before we could correct the start time..
-										// fix it for this event entry
-										//duration = 24 * 60 * 60 * 1000;
-										Log.debug("new recurring date2 is " + date);
-									}
+								//if (event.start.tz === moment.tz.guess()) {
+								// if the date hour is less than the offset
+								if (24 - dh <= Math.abs(dateoffset / 60)) {
+									// apply the correction to the date/time back to right day
+									date = new Date(date.getTime() + Math.abs(24 * 60) * 60000);
+									// the duration was calculated way back at the top before we could correct the start time..
+									// fix it for this event entry
+									//duration = 24 * 60 * 60 * 1000;
+									Log.debug("new recurring date2 fulldate is " + date);
 								}
+								//}
 							}
 						} else {
 							// not full day, but luxon can still screw up the date on the rule processing
 							// we need to correct the date to get back to the right event for
 							if (dateoffset < 0) {
 								// if the date hour is less than the offset
-								if (dh < Math.abs(dateoffset / 60)) {
-									// reduce the time by the offset
-									Log.debug(" recurring date is " + date + " offset is " + dateoffset);
-									// apply the correction to the date/time to get it UTC relative
-									date = new Date(date.getTime() - Math.abs(nowOffset) * 60000);
+								if (dh <= Math.abs(dateoffset / 60)) {
+									// Reduce the time by the offset:
+									// Apply the correction to the date/time to get it UTC relative
+									date = new Date(date.getTime() - Math.abs(24 * 60) * 60000);
 									// the duration was calculated way back at the top before we could correct the start time..
 									// fix it for this event entry
 									//duration = 24 * 60 * 60 * 1000;
@@ -352,20 +371,21 @@ const CalendarUtils = {
 								}
 							} else {
 								// if the timezones are the same, correct date if needed
-								if (event.start.tz === moment.tz.guess()) {
-									// if the date hour is less than the offset
-									if (24 - dh < Math.abs(dateoffset / 60)) {
-										// apply the correction to the date/time back to right day
-										date = new Date(date.getTime() + Math.abs(24 * 60) * 60000);
-										// the duration was calculated way back at the top before we could correct the start time..
-										// fix it for this event entry
-										//duration = 24 * 60 * 60 * 1000;
-										Log.debug("new recurring date2 is " + date);
-									}
+								//if (event.start.tz === moment.tz.guess()) {
+								// if the date hour is less than the offset
+								if (24 - dh <= Math.abs(dateoffset / 60)) {
+									// apply the correction to the date/time back to right day
+									date = new Date(date.getTime() + Math.abs(24 * 60) * 60000);
+									// the duration was calculated way back at the top before we could correct the start time..
+									// fix it for this event entry
+									//duration = 24 * 60 * 60 * 1000;
+									Log.debug("new recurring date2 is " + date);
 								}
+								//}
 							}
 						}
 						startDate = moment(date);
+						Log.debug("Corrected startDate: " + startDate.toDate());
 
 						let adjustDays = CalendarUtils.calculateTimezoneAdjustment(event, date);
 
@@ -381,7 +401,7 @@ const CalendarUtils = {
 							// This date is an exception date, which means we should skip it in the recurrence pattern.
 							showRecurrence = false;
 						}
-						Log.debug("duration=" + duration);
+						Log.debug("duration: " + duration);
 
 						endDate = moment(parseInt(startDate.format("x")) + duration, "x");
 						if (startDate.format("x") === endDate.format("x")) {
@@ -401,7 +421,7 @@ const CalendarUtils = {
 						}
 
 						if (showRecurrence === true) {
-							Log.debug("saving event =" + description);
+							Log.debug("saving event: " + description);
 							addedEvents++;
 							newEvents.push({
 								title: recurrenceTitle,
@@ -417,7 +437,7 @@ const CalendarUtils = {
 							});
 						}
 					}
-					// end recurring event parsing
+					// End recurring event parsing.
 				} else {
 					// Single event.
 					const fullDayEvent = isFacebookBirthday ? true : CalendarUtils.isFullDayEvent(event);
@@ -450,7 +470,7 @@ const CalendarUtils = {
 					}
 
 					// Adjust start date so multiple day events will be displayed as happening today even though they started some days ago already
-					if (fullDayEvent && startDate <= today) {
+					if (fullDayEvent && startDate <= today && endDate > today) {
 						startDate = moment(today);
 					}
 					// if the start and end are the same, then make end the 'end of day' value (start is at 00:00:00)
@@ -478,30 +498,14 @@ const CalendarUtils = {
 			return a.startDate - b.startDate;
 		});
 
-		// include up to maximumEntries current or upcoming events
-		// If past events should be included, include all past events
-		const now = moment();
-		let entries = 0;
-		let events = [];
-		for (let ne of newEvents) {
-			if (moment(ne.endDate, "x").isBefore(now)) {
-				if (config.includePastEvents) events.push(ne);
-				continue;
-			}
-			entries++;
-			// If max events has been saved, skip the rest
-			if (entries > config.maximumEntries) break;
-			events.push(ne);
-		}
-
-		return events;
+		return newEvents;
 	},
 
 	/**
 	 * Lookup iana tz from windows
 	 *
-	 * @param msTZName
-	 * @returns {*|null}
+	 * @param {string} msTZName the timezone name to lookup
+	 * @returns {string|null} the iana name or null of none is found
 	 */
 	getIanaTZFromMS: function (msTZName) {
 		// Get hash entry
@@ -571,12 +575,13 @@ const CalendarUtils = {
 	},
 
 	/**
+	 * Determines if the user defined title filter should apply
 	 *
-	 * @param title
-	 * @param filter
-	 * @param useRegex
-	 * @param regexFlags
-	 * @returns {boolean|*}
+	 * @param {string} title the title of the event
+	 * @param {string} filter the string to look for, can be a regex also
+	 * @param {boolean} useRegex true if a regex should be used, otherwise it just looks for the filter as a string
+	 * @param {string} regexFlags flags that should be applied to the regex
+	 * @returns {boolean} True if the title should be filtered out, false otherwise
 	 */
 	titleFilterApplies: function (title, filter, useRegex, regexFlags) {
 		if (useRegex) {

modules/default/calendar/debug.js

@@ -1,10 +1,13 @@
 /* CalendarFetcher Tester
  * 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.
+ * of starting the MagicMirror² core. Adjust the values below to your desire.
  *
  * By Michael Teeuw https://michaelteeuw.nl
  * MIT Licensed.
  */
+// Alias modules mentioned in package.js under _moduleAliases.
+require("module-alias/register");
+
 const CalendarFetcher = require("./calendarfetcher.js");
 
 const url = "https://calendar.google.com/calendar/ical/pkm1t2uedjbp0uvq1o7oj1jouo%40group.calendar.google.com/private-08ba559f89eec70dd74bbd887d0a3598/basic.ics"; // Standard test URL
@@ -26,11 +29,13 @@ const fetcher = new CalendarFetcher(url, fetchInterval, [], maximumEntries, maxi
 fetcher.onReceive(function (fetcher) {
 	console.log(fetcher.events());
 	console.log("------------------------------------------------------------");
+	process.exit(0);
 });
 
 fetcher.onError(function (fetcher, error) {
 	console.log("Fetcher error:");
 	console.log(error);
+	process.exit(1);
 });
 
 fetcher.startFetch();

modules/default/calendar/node_helper.js

@@ -1,4 +1,4 @@
-/* Magic Mirror
+/* MagicMirror²
  * Node Helper: Calendar
  *
  * By Michael Teeuw https://michaelteeuw.nl
@@ -40,13 +40,14 @@ module.exports = NodeHelper.create({
 		try {
 			new URL(url);
 		} catch (error) {
-			this.sendSocketNotification("INCORRECT_URL", { id: identifier, url: url });
+			Log.error("Calendar Error. Malformed calendar url: ", url, error);
+			this.sendSocketNotification("CALENDAR_ERROR", { error_type: "MODULE_ERROR_MALFORMED_URL" });
 			return;
 		}
 
 		let fetcher;
 		if (typeof this.fetchers[identifier + url] === "undefined") {
-			Log.log("Create new calendar fetcher for url: " + url + " - Interval: " + fetchInterval);
+			Log.log("Create new calendarfetcher for url: " + url + " - Interval: " + fetchInterval);
 			fetcher = new CalendarFetcher(url, fetchInterval, excludedEvents, maximumEntries, maximumNumberOfDays, auth, broadcastPastEvents, selfSignedCert);
 
 			fetcher.onReceive((fetcher) => {
@@ -55,16 +56,16 @@ module.exports = NodeHelper.create({
 
 			fetcher.onError((fetcher, error) => {
 				Log.error("Calendar Error. Could not fetch calendar: ", fetcher.url(), error);
-				this.sendSocketNotification("FETCH_ERROR", {
+				let error_type = NodeHelper.checkFetchError(error);
+				this.sendSocketNotification("CALENDAR_ERROR", {
 					id: identifier,
-					url: fetcher.url(),
-					error: error
+					error_type
 				});
 			});
 
 			this.fetchers[identifier + url] = fetcher;
 		} else {
-			Log.log("Use existing calendar fetcher for url: " + url);
+			Log.log("Use existing calendarfetcher for url: " + url);
 			fetcher = this.fetchers[identifier + url];
 			fetcher.broadcastEvents();
 		}

modules/default/clock/README.md

@@ -1,6 +1,6 @@
 # Module: Clock
 
-The `clock` module is one of the default modules of the MagicMirror.
+The `clock` module is one of the default modules of the MagicMirror².
 This module displays the current date and time. The information will be updated realtime.
 
 For configuration options, please check the [MagicMirror² documentation](https://docs.magicmirror.builders/modules/clock.html).

modules/default/clock/clock.js

@@ -1,6 +1,6 @@
 /* global SunCalc */
 
-/* Magic Mirror
+/* MagicMirror²
  * Module: Clock
  *
  * By Michael Teeuw https://michaelteeuw.nl
@@ -12,11 +12,14 @@ Module.register("clock", {
 		displayType: "digital", // options: digital, analog, both
 
 		timeFormat: config.timeFormat,
+		timezone: null,
+
 		displaySeconds: true,
 		showPeriod: true,
 		showPeriodUpper: false,
 		clockBold: false,
 		showDate: true,
+		showTime: true,
 		showWeek: false,
 		dateFormat: "dddd, LL",
 
@@ -24,9 +27,8 @@ Module.register("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'
+		analogShowDate: "top", // OBSOLETE, can be replaced with analogPlacement and showTime, options: false, 'top', or 'bottom'
 		secondsColor: "#888888",
-		timezone: null,
 
 		showSunTimes: false,
 		showMoonTimes: false,
@@ -46,66 +48,75 @@ Module.register("clock", {
 		Log.info("Starting module: " + this.name);
 
 		// Schedule update interval.
-		var self = this;
-		self.second = moment().second();
-		self.minute = moment().minute();
+		this.second = moment().second();
+		this.minute = moment().minute();
 
-		//Calculate how many ms should pass until next update depending on if seconds is displayed or not
-		var delayCalculator = function (reducedSeconds) {
-			var EXTRA_DELAY = 50; //Deliberate imperceptable delay to prevent off-by-one timekeeping errors
+		// Calculate how many ms should pass until next update depending on if seconds is displayed or not
+		const delayCalculator = (reducedSeconds) => {
+			const EXTRA_DELAY = 50; // Deliberate imperceptible delay to prevent off-by-one timekeeping errors
 
-			if (self.config.displaySeconds) {
+			if (this.config.displaySeconds) {
 				return 1000 - moment().milliseconds() + EXTRA_DELAY;
 			} else {
 				return (60 - reducedSeconds) * 1000 - moment().milliseconds() + EXTRA_DELAY;
 			}
 		};
 
-		//A recursive timeout function instead of interval to avoid drifting
-		var notificationTimer = function () {
-			self.updateDom();
+		// A recursive timeout function instead of interval to avoid drifting
+		const notificationTimer = () => {
+			this.updateDom();
 
-			//If seconds is displayed CLOCK_SECOND-notification should be sent (but not when CLOCK_MINUTE-notification is sent)
-			if (self.config.displaySeconds) {
-				self.second = moment().second();
-				if (self.second !== 0) {
-					self.sendNotification("CLOCK_SECOND", self.second);
+			// If seconds is displayed CLOCK_SECOND-notification should be sent (but not when CLOCK_MINUTE-notification is sent)
+			if (this.config.displaySeconds) {
+				this.second = moment().second();
+				if (this.second !== 0) {
+					this.sendNotification("CLOCK_SECOND", this.second);
 					setTimeout(notificationTimer, delayCalculator(0));
 					return;
 				}
 			}
 
-			//If minute changed or seconds isn't displayed send CLOCK_MINUTE-notification
-			self.minute = moment().minute();
-			self.sendNotification("CLOCK_MINUTE", self.minute);
+			// If minute changed or seconds isn't displayed send CLOCK_MINUTE-notification
+			this.minute = moment().minute();
+			this.sendNotification("CLOCK_MINUTE", this.minute);
 			setTimeout(notificationTimer, delayCalculator(0));
 		};
 
-		//Set the initial timeout with the amount of seconds elapsed as reducedSeconds so it will trigger when the minute changes
-		setTimeout(notificationTimer, delayCalculator(self.second));
+		// Set the initial timeout with the amount of seconds elapsed as reducedSeconds so it will trigger when the minute changes
+		setTimeout(notificationTimer, delayCalculator(this.second));
 
 		// Set locale.
 		moment.locale(config.language);
 	},
 	// Override dom generator.
 	getDom: function () {
-		var wrapper = document.createElement("div");
+		const wrapper = document.createElement("div");
+		wrapper.classList.add("clockGrid");
+
+		/************************************
+		 * Create wrappers for analog and digital clock
+		 */
+		const analogWrapper = document.createElement("div");
+		analogWrapper.className = "clockCircle";
+		const digitalWrapper = document.createElement("div");
+		digitalWrapper.className = "digital";
+		digitalWrapper.style.gridArea = "center";
 
 		/************************************
 		 * Create wrappers for DIGITAL clock
 		 */
+		const dateWrapper = document.createElement("div");
+		const timeWrapper = document.createElement("div");
+		const secondsWrapper = document.createElement("sup");
+		const periodWrapper = document.createElement("span");
+		const sunWrapper = document.createElement("div");
+		const moonWrapper = document.createElement("div");
+		const weekWrapper = document.createElement("div");
 
-		var dateWrapper = document.createElement("div");
-		var timeWrapper = document.createElement("div");
-		var secondsWrapper = document.createElement("sup");
-		var periodWrapper = document.createElement("span");
-		var sunWrapper = document.createElement("div");
-		var moonWrapper = document.createElement("div");
-		var weekWrapper = document.createElement("div");
 		// Style Wrappers
 		dateWrapper.className = "date normal medium";
 		timeWrapper.className = "time bright large light";
-		secondsWrapper.className = "dimmed";
+		secondsWrapper.className = "seconds dimmed";
 		sunWrapper.className = "sun dimmed small";
 		moonWrapper.className = "moon dimmed small";
 		weekWrapper.className = "week dimmed medium";
@@ -114,19 +125,18 @@ Module.register("clock", {
 		// 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;
-		var now = moment();
-		this.lastDisplayedMinute = now.minute();
+		let timeString;
+		const now = moment();
 		if (this.config.timezone) {
 			now.tz(this.config.timezone);
 		}
 
-		var hourSymbol = "HH";
+		let hourSymbol = "HH";
 		if (this.config.timeFormat !== 24) {
 			hourSymbol = "h";
 		}
 
-		if (this.config.clockBold === true) {
+		if (this.config.clockBold) {
 			timeString = now.format(hourSymbol + '[<span class="bold">]mm[</span>]');
 		} else {
 			timeString = now.format(hourSymbol + ":mm");
@@ -134,22 +144,24 @@ Module.register("clock", {
 
 		if (this.config.showDate) {
 			dateWrapper.innerHTML = now.format(this.config.dateFormat);
+			digitalWrapper.appendChild(dateWrapper);
 		}
-		if (this.config.showWeek) {
-			weekWrapper.innerHTML = this.translate("WEEK", { weekNumber: 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);
-		}
-		if (this.config.showPeriod && this.config.timeFormat !== 24) {
-			timeWrapper.appendChild(periodWrapper);
+
+		if (this.config.displayType !== "analog" && this.config.showTime) {
+			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);
+			}
+			if (this.config.showPeriod && this.config.timeFormat !== 24) {
+				timeWrapper.appendChild(periodWrapper);
+			}
+			digitalWrapper.appendChild(timeWrapper);
 		}
 
 		/**
@@ -160,17 +172,20 @@ Module.register("clock", {
 		 * @returns {string} The formatted time string
 		 */
 		function formatTime(config, time) {
-			var formatString = hourSymbol + ":mm";
+			let formatString = hourSymbol + ":mm";
 			if (config.showPeriod && config.timeFormat !== 24) {
 				formatString += config.showPeriodUpper ? "A" : "a";
 			}
 			return moment(time).format(formatString);
 		}
 
+		/****************************************************************
+		 * Create wrappers for Sun Times, only if specified in config
+		 */
 		if (this.config.showSunTimes) {
 			const sunTimes = SunCalc.getTimes(now, this.config.lat, this.config.lon);
 			const isVisible = now.isBetween(sunTimes.sunrise, sunTimes.sunset);
-			var nextEvent;
+			let nextEvent;
 			if (now.isBefore(sunTimes.sunrise)) {
 				nextEvent = sunTimes.sunrise;
 			} else if (now.isBefore(sunTimes.sunset)) {
@@ -184,21 +199,26 @@ Module.register("clock", {
 			sunWrapper.innerHTML =
 				'<span class="' +
 				(isVisible ? "bright" : "") +
-				'"><i class="fa fa-sun-o" aria-hidden="true"></i> ' +
+				'"><i class="fas fa-sun" aria-hidden="true"></i> ' +
 				untilNextEventString +
 				"</span>" +
-				'<span><i class="fa fa-arrow-up" aria-hidden="true"></i> ' +
+				'<span><i class="fas fa-arrow-up" aria-hidden="true"></i> ' +
 				formatTime(this.config, sunTimes.sunrise) +
 				"</span>" +
-				'<span><i class="fa fa-arrow-down" aria-hidden="true"></i> ' +
+				'<span><i class="fas fa-arrow-down" aria-hidden="true"></i> ' +
 				formatTime(this.config, sunTimes.sunset) +
 				"</span>";
+			digitalWrapper.appendChild(sunWrapper);
 		}
+
+		/****************************************************************
+		 * Create wrappers for Moon Times, only if specified in config
+		 */
 		if (this.config.showMoonTimes) {
 			const moonIllumination = SunCalc.getMoonIllumination(now.toDate());
 			const moonTimes = SunCalc.getMoonTimes(now, this.config.lat, this.config.lon);
 			const moonRise = moonTimes.rise;
-			var moonSet;
+			let moonSet;
 			if (moment(moonTimes.set).isAfter(moonTimes.rise)) {
 				moonSet = moonTimes.set;
 			} else {
@@ -210,21 +230,26 @@ Module.register("clock", {
 			moonWrapper.innerHTML =
 				'<span class="' +
 				(isVisible ? "bright" : "") +
-				'"><i class="fa fa-moon-o" aria-hidden="true"></i> ' +
+				'"><i class="fas fa-moon" aria-hidden="true"></i> ' +
 				illuminatedFractionString +
 				"</span>" +
-				'<span><i class="fa fa-arrow-up" aria-hidden="true"></i> ' +
+				'<span><i class="fas fa-arrow-up" aria-hidden="true"></i> ' +
 				(moonRise ? formatTime(this.config, moonRise) : "...") +
 				"</span>" +
-				'<span><i class="fa fa-arrow-down" aria-hidden="true"></i> ' +
+				'<span><i class="fas fa-arrow-down" aria-hidden="true"></i> ' +
 				(moonSet ? formatTime(this.config, moonSet) : "...") +
 				"</span>";
+			digitalWrapper.appendChild(moonWrapper);
+		}
+
+		if (this.config.showWeek) {
+			weekWrapper.innerHTML = this.translate("WEEK", { weekNumber: now.week() });
+			digitalWrapper.appendChild(weekWrapper);
 		}
 
 		/****************************************************************
 		 * Create wrappers for ANALOG clock, only if specified in config
 		 */
-
 		if (this.config.displayType !== "digital") {
 			// If it isn't 'digital', then an 'analog' clock was also requested
 
@@ -232,34 +257,32 @@ Module.register("clock", {
 			if (this.config.timezone) {
 				now.tz(this.config.timezone);
 			}
-			var second = now.seconds() * 6,
+			const second = now.seconds() * 6,
 				minute = now.minute() * 6 + second / 60,
 				hour = ((now.hours() % 12) / 12) * 360 + 90 + minute / 12;
 
 			// Create wrappers
-			var clockCircle = document.createElement("div");
-			clockCircle.className = "clockCircle";
-			clockCircle.style.width = this.config.analogSize;
-			clockCircle.style.height = this.config.analogSize;
+			analogWrapper.style.width = this.config.analogSize;
+			analogWrapper.style.height = this.config.analogSize;
 
 			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%";
+				analogWrapper.style.background = "url(" + this.data.path + "faces/" + this.config.analogFace + ".svg)";
+				analogWrapper.style.backgroundSize = "100%";
 
 				// The following line solves issue: https://github.com/MichMich/MagicMirror/issues/611
-				// clockCircle.style.border = "1px solid black";
-				clockCircle.style.border = "rgba(0, 0, 0, 0.1)"; //Updated fix for Issue 611 where non-black backgrounds are used
+				// analogWrapper.style.border = "1px solid black";
+				analogWrapper.style.border = "rgba(0, 0, 0, 0.1)"; //Updated fix for Issue 611 where non-black backgrounds are used
 			} else if (this.config.analogFace !== "none") {
-				clockCircle.style.border = "2px solid white";
+				analogWrapper.style.border = "2px solid white";
 			}
-			var clockFace = document.createElement("div");
+			const clockFace = document.createElement("div");
 			clockFace.className = "clockFace";
 
-			var clockHour = document.createElement("div");
+			const clockHour = document.createElement("div");
 			clockHour.id = "clockHour";
 			clockHour.style.transform = "rotate(" + hour + "deg)";
 			clockHour.className = "clockHour";
-			var clockMinute = document.createElement("div");
+			const clockMinute = document.createElement("div");
 			clockMinute.id = "clockMinute";
 			clockMinute.style.transform = "rotate(" + minute + "deg)";
 			clockMinute.className = "clockMinute";
@@ -269,91 +292,35 @@ Module.register("clock", {
 			clockFace.appendChild(clockMinute);
 
 			if (this.config.displaySeconds) {
-				var clockSecond = document.createElement("div");
+				const clockSecond = document.createElement("div");
 				clockSecond.id = "clockSecond";
 				clockSecond.style.transform = "rotate(" + second + "deg)";
 				clockSecond.className = "clockSecond";
 				clockSecond.style.backgroundColor = this.config.secondsColor;
 				clockFace.appendChild(clockSecond);
 			}
-			clockCircle.appendChild(clockFace);
+			analogWrapper.appendChild(clockFace);
 		}
 
 		/*******************************************
-		 * Combine wrappers, check for .displayType
+		 * Update placement, respect old analogShowDate even if its not needed anymore
 		 */
-
-		if (this.config.displayType === "digital") {
-			// Display only a digital clock
-			wrapper.appendChild(dateWrapper);
-			wrapper.appendChild(timeWrapper);
-			wrapper.appendChild(sunWrapper);
-			wrapper.appendChild(moonWrapper);
-			wrapper.appendChild(weekWrapper);
-		} else if (this.config.displayType === "analog") {
+		if (this.config.displayType === "analog") {
 			// Display only an analog clock
-
-			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);
+				wrapper.classList.add("clockGrid--bottom");
 			} else if (this.config.analogShowDate === "bottom") {
-				wrapper.appendChild(clockCircle);
-				wrapper.appendChild(dateWrapper);
-				wrapper.appendChild(weekWrapper);
+				wrapper.classList.add("clockGrid--top");
 			} else {
-				wrapper.appendChild(clockCircle);
-			}
-		} else {
-			// Both clocks have been configured, check position
-			var placement = this.config.analogPlacement;
-
-			var analogWrapper = document.createElement("div");
-			analogWrapper.id = "analog";
-			analogWrapper.style.cssFloat = "none";
-			analogWrapper.appendChild(clockCircle);
-
-			var digitalWrapper = document.createElement("div");
-			digitalWrapper.id = "digital";
-			digitalWrapper.style.cssFloat = "none";
-			digitalWrapper.appendChild(dateWrapper);
-			digitalWrapper.appendChild(timeWrapper);
-			digitalWrapper.appendChild(sunWrapper);
-			digitalWrapper.appendChild(moonWrapper);
-			digitalWrapper.appendChild(weekWrapper);
-
-			var appendClocks = function (condition, pos1, pos2) {
-				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";
-
-				appendClocks("left", 1, 3);
-			} else {
-				digitalWrapper.style.textAlign = "center";
-
-				appendClocks("top", 2, 0);
+				//analogWrapper.style.gridArea = "center";
 			}
+		} else if (this.config.displayType === "both") {
+			wrapper.classList.add("clockGrid--" + this.config.analogPlacement);
 		}
 
+		wrapper.appendChild(analogWrapper);
+		wrapper.appendChild(digitalWrapper);
+
 		// Return the wrapper to the dom.
 		return wrapper;
 	}

modules/default/clock/clock_styles.css

@@ -1,5 +1,26 @@
+.clockGrid {
+  display: inline-flex;
+  gap: 15px;
+}
+
+.clockGrid--left {
+  flex-direction: row;
+}
+
+.clockGrid--right {
+  flex-direction: row-reverse;
+}
+
+.clockGrid--top {
+  flex-direction: column;
+}
+
+.clockGrid--bottom {
+  flex-direction: column-reverse;
+}
+
 .clockCircle {
-  margin: 0 auto;
+  place-self: center;
   position: relative;
   border-radius: 50%;
   background-size: 100%;
@@ -17,7 +38,7 @@
   width: 6px;
   height: 6px;
   margin: -3px 0 0 -3px;
-  background: white;
+  background: var(--color-text-bright);
   border-radius: 3px;
   content: "";
   display: block;
@@ -29,9 +50,9 @@
   position: absolute;
   top: 50%;
   left: 50%;
-  margin: -2px 0 -2px -25%; /* numbers much match negative length & thickness */
+  margin: -2px 0 -2px -25%; /* numbers must match negative length & thickness */
   padding: 2px 0 2px 25%; /* indicator length & thickness */
-  background: white;
+  background: var(--color-text-bright);
   transform-origin: 100% 50%;
   border-radius: 3px 0 0 3px;
 }
@@ -44,7 +65,7 @@
   left: 50%;
   margin: -35% -2px 0; /* numbers must match negative length & thickness */
   padding: 35% 2px 0; /* indicator length & thickness */
-  background: white;
+  background: var(--color-text-bright);
   transform-origin: 50% 100%;
   border-radius: 3px 0 0 3px;
 }
@@ -57,7 +78,7 @@
   left: 50%;
   margin: -38% -1px 0 0; /* numbers must match negative length & thickness */
   padding: 38% 1px 0 0; /* indicator length & thickness */
-  background: #888;
+  background: var(--color-text);
   transform-origin: 50% 100%;
 }
 

modules/default/compliments/README.md

@@ -1,6 +1,6 @@
 # Module: Compliments
 
-The `compliments` module is one of the default modules of the MagicMirror.
+The `compliments` module is one of the default modules of the MagicMirror².
 This module displays a random compliment.
 
 For configuration options, please check the [MagicMirror² documentation](https://docs.magicmirror.builders/modules/compliments.html).

modules/default/compliments/compliments.js

@@ -1,4 +1,4 @@
-/* Magic Mirror
+/* MagicMirror²
  * Module: Compliments
  *
  * By Michael Teeuw https://michaelteeuw.nl
@@ -39,37 +39,35 @@ Module.register("compliments", {
 
 		this.lastComplimentIndex = -1;
 
-		var self = this;
 		if (this.config.remoteFile !== null) {
-			this.complimentFile(function (response) {
-				self.config.compliments = JSON.parse(response);
-				self.updateDom();
+			this.complimentFile((response) => {
+				this.config.compliments = JSON.parse(response);
+				this.updateDom();
 			});
 		}
 
 		// Schedule update timer.
-		setInterval(function () {
-			self.updateDom(self.config.fadeSpeed);
+		setInterval(() => {
+			this.updateDom(this.config.fadeSpeed);
 		}, this.config.updateInterval);
 	},
 
-	/* randomIndex(compliments)
+	/**
 	 * Generate a random index for a list of compliments.
 	 *
-	 * argument compliments Array<String> - Array with compliments.
-	 *
-	 * return Number - Random index.
+	 * @param {string[]} compliments Array with compliments.
+	 * @returns {number} a random index of given array
 	 */
 	randomIndex: function (compliments) {
 		if (compliments.length === 1) {
 			return 0;
 		}
 
-		var generate = function () {
+		const generate = function () {
 			return Math.floor(Math.random() * compliments.length);
 		};
 
-		var complimentIndex = generate();
+		let complimentIndex = generate();
 
 		while (complimentIndex === this.lastComplimentIndex) {
 			complimentIndex = generate();
@@ -80,15 +78,15 @@ Module.register("compliments", {
 		return complimentIndex;
 	},
 
-	/* complimentArray()
+	/**
 	 * Retrieve an array of compliments for the time of the day.
 	 *
-	 * return compliments Array<String> - Array with compliments for the time of the day.
+	 * @returns {string[]} array with compliments for the time of the day.
 	 */
 	complimentArray: function () {
-		var hour = moment().hour();
-		var date = this.config.mockDate ? this.config.mockDate : moment().format("YYYY-MM-DD");
-		var compliments;
+		const hour = moment().hour();
+		const date = this.config.mockDate ? this.config.mockDate : moment().format("YYYY-MM-DD");
+		let compliments;
 
 		if (hour >= this.config.morningStartTime && hour < this.config.morningEndTime && this.config.compliments.hasOwnProperty("morning")) {
 			compliments = this.config.compliments.morning.slice(0);
@@ -99,7 +97,7 @@ Module.register("compliments", {
 		}
 
 		if (typeof compliments === "undefined") {
-			compliments = new Array();
+			compliments = [];
 		}
 
 		if (this.currentWeatherType in this.config.compliments) {
@@ -108,7 +106,7 @@ Module.register("compliments", {
 
 		compliments.push.apply(compliments, this.config.compliments.anytime);
 
-		for (var entry in this.config.compliments) {
+		for (let entry in this.config.compliments) {
 			if (new RegExp(entry).test(date)) {
 				compliments.push.apply(compliments, this.config.compliments[entry]);
 			}
@@ -117,11 +115,13 @@ Module.register("compliments", {
 		return compliments;
 	},
 
-	/* complimentFile(callback)
+	/**
 	 * Retrieve a file from the local filesystem
+	 *
+	 * @param {Function} callback Called when the file is retrieved.
 	 */
 	complimentFile: function (callback) {
-		var xobj = new XMLHttpRequest(),
+		const xobj = new XMLHttpRequest(),
 			isRemote = this.config.remoteFile.indexOf("http://") === 0 || this.config.remoteFile.indexOf("https://") === 0,
 			path = isRemote ? this.config.remoteFile : this.file(this.config.remoteFile);
 		xobj.overrideMimeType("application/json");
@@ -134,16 +134,16 @@ Module.register("compliments", {
 		xobj.send(null);
 	},
 
-	/* complimentArray()
+	/**
 	 * Retrieve a random compliment.
 	 *
-	 * return compliment string - A compliment.
+	 * @returns {string} a compliment
 	 */
 	randomCompliment: function () {
 		// get the current time of day compliments list
-		var compliments = this.complimentArray();
+		const compliments = this.complimentArray();
 		// variable for index to next message to display
-		let index = 0;
+		let index;
 		// are we randomizing
 		if (this.config.random) {
 			// yes
@@ -159,16 +159,16 @@ Module.register("compliments", {
 
 	// Override dom generator.
 	getDom: function () {
-		var wrapper = document.createElement("div");
+		const wrapper = document.createElement("div");
 		wrapper.className = this.config.classes ? this.config.classes : "thin xlarge bright pre-line";
 		// get the compliment text
-		var complimentText = this.randomCompliment();
+		const complimentText = this.randomCompliment();
 		// split it into parts on newline text
-		var parts = complimentText.split("\n");
+		const parts = complimentText.split("\n");
 		// create a span to hold it all
-		var compliment = document.createElement("span");
+		const compliment = document.createElement("span");
 		// process all the parts of the compliment text
-		for (var part of parts) {
+		for (const part of parts) {
 			// create a text element for each part
 			compliment.appendChild(document.createTextNode(part));
 			// add a break `

modules/default/currentweather/README.md

@@ -1,8 +0,0 @@
-# Module: Current Weather
-
-> :warning: **This module is deprecated in favor of the [weather](https://docs.magicmirror.builders/modules/weather.html) module.**
-
-The `currentweather` module is one of the default modules of the MagicMirror.
-This module displays the current weather, including the windspeed, the sunset or sunrise time, the temperature and an icon to display the current conditions.
-
-For configuration options, please check the [MagicMirror² documentation](https://docs.magicmirror.builders/modules/currentweather.html).

modules/default/currentweather/currentweather.css

@@ -1,15 +0,0 @@
-.currentweather .weathericon,
-.currentweather .fa-home {
-  font-size: 75%;
-  line-height: 65px;
-  display: inline-block;
-  transform: translate(0, -3px);
-}
-
-.currentweather .humidityIcon {
-  padding-right: 4px;
-}
-
-.currentweather .humidity-padding {
-  padding-bottom: 6px;
-}

modules/default/currentweather/currentweather.js

@@ -1,4 +1,6 @@
-/* Magic Mirror
+/* eslint-disable */
+
+/* MagicMirror²
  * Module: CurrentWeather
  *
  * By Michael Teeuw https://michaelteeuw.nl
@@ -7,592 +9,25 @@
  * This module is deprecated. Any additional feature will no longer be merged.
  */
 Module.register("currentweather", {
-	// Default module config.
-	defaults: {
-		location: false,
-		locationID: false,
-		appid: "",
-		units: config.units,
-		updateInterval: 10 * 60 * 1000, // every 10 minutes
-		animationSpeed: 1000,
-		timeFormat: config.timeFormat,
-		showPeriod: true,
-		showPeriodUpper: false,
-		showWindDirection: true,
-		showWindDirectionAsArrow: false,
-		useBeaufort: true,
-		useKMPHwind: false,
-		lang: config.language,
-		decimalSymbol: ".",
-		showHumidity: false,
-		showSun: true,
-		degreeLabel: false,
-		showIndoorTemperature: false,
-		showIndoorHumidity: false,
-		showFeelsLike: true,
-
-		initialLoadDelay: 0, // 0 seconds delay
-		retryDelay: 2500,
-
-		apiVersion: "2.5",
-		apiBase: "https://api.openweathermap.org/data/",
-		weatherEndpoint: "weather",
-
-		appendLocationNameToHeader: true,
-		useLocationAsHeader: false,
-
-		calendarClass: "calendar",
-		tableClass: "large",
-
-		onlyTemp: false,
-		hideTemp: false,
-		roundTemp: false,
-
-		iconTable: {
-			"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"
-		}
-	},
-
-	// create a variable for the first upcoming calendar event. Used if no location is specified.
-	firstEvent: false,
-
-	// create a variable to hold the location name based on the API result.
-	fetchedLocationName: "",
-
-	// Define required scripts.
-	getScripts: function () {
-		return ["moment.js"];
-	},
-
-	// Define required scripts.
-	getStyles: function () {
-		return ["weather-icons.css", "currentweather.css"];
-	},
-
-	// Define required translations.
-	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;
-	},
-
 	// Define start sequence.
 	start: function () {
 		Log.info("Starting module: " + this.name);
-
-		// Set locale.
-		moment.locale(config.language);
-
-		this.windSpeed = null;
-		this.windDirection = null;
-		this.windDeg = null;
-		this.sunriseSunsetTime = null;
-		this.sunriseSunsetIcon = null;
-		this.temperature = null;
-		this.indoorTemperature = null;
-		this.indoorHumidity = null;
-		this.weatherType = null;
-		this.feelsLike = null;
-		this.loaded = false;
-		this.scheduleUpdate(this.config.initialLoadDelay);
-	},
-
-	// 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);
-
-		var windSpeed = document.createElement("span");
-		windSpeed.innerHTML = " " + this.windSpeed;
-		small.appendChild(windSpeed);
-
-		if (this.config.showWindDirection) {
-			var windDirection = document.createElement("sup");
-			if (this.config.showWindDirectionAsArrow) {
-				if (this.windDeg !== null) {
-					windDirection.innerHTML = ' &nbsp;<i class="fa fa-long-arrow-down" style="transform:rotate(' + this.windDeg + 'deg);"></i>&nbsp;';
-				}
-			} else {
-				windDirection.innerHTML = " " + this.translate(this.windDirection);
-			}
-			small.appendChild(windDirection);
-		}
-		var spacer = document.createElement("span");
-		spacer.innerHTML = "&nbsp;";
-		small.appendChild(spacer);
-
-		if (this.config.showHumidity) {
-			var humidity = document.createElement("span");
-			humidity.innerHTML = this.humidity;
-
-			var supspacer = document.createElement("sup");
-			supspacer.innerHTML = "&nbsp;";
-
-			var humidityIcon = document.createElement("sup");
-			humidityIcon.className = "wi wi-humidity humidityIcon";
-			humidityIcon.innerHTML = "&nbsp;";
-
-			small.appendChild(humidity);
-			small.appendChild(supspacer);
-			small.appendChild(humidityIcon);
-		}
-
-		if (this.config.showSun) {
-			var sunriseSunsetIcon = document.createElement("span");
-			sunriseSunsetIcon.className = "wi dimmed " + this.sunriseSunsetIcon;
-			small.appendChild(sunriseSunsetIcon);
-
-			var sunriseSunsetTime = document.createElement("span");
-			sunriseSunsetTime.innerHTML = " " + this.sunriseSunsetTime;
-			small.appendChild(sunriseSunsetTime);
-		}
-
-		wrapper.appendChild(small);
 	},
 
 	// Override dom generator.
 	getDom: function () {
 		var wrapper = document.createElement("div");
 		wrapper.className = this.config.tableClass;
-
-		if (this.config.appid === "") {
-			wrapper.innerHTML = "Please set the correct openweather <i>appid</i> in the config for module: " + this.name + ".";
-			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 = "light";
-
-		var degreeLabel = "";
-		if (this.config.units === "metric" || this.config.units === "imperial") {
-			degreeLabel += "°";
-		}
-		if (this.config.degreeLabel) {
-			switch (this.config.units) {
-				case "metric":
-					degreeLabel += "C";
-					break;
-				case "imperial":
-					degreeLabel += "F";
-					break;
-				case "default":
-					degreeLabel += "K";
-					break;
-			}
-		}
-
-		if (this.config.decimalSymbol === "") {
-			this.config.decimalSymbol = ".";
-		}
-
-		if (this.config.hideTemp === false) {
-			var weatherIcon = document.createElement("span");
-			weatherIcon.className = "wi weathericon wi-" + this.weatherType;
-			large.appendChild(weatherIcon);
-
-			var temperature = document.createElement("span");
-			temperature.className = "bright";
-			temperature.innerHTML = " " + this.temperature.replace(".", this.config.decimalSymbol) + degreeLabel;
-			large.appendChild(temperature);
-		}
-
-		if (this.config.showIndoorTemperature && this.indoorTemperature) {
-			var indoorIcon = document.createElement("span");
-			indoorIcon.className = "fa fa-home";
-			large.appendChild(indoorIcon);
-
-			var indoorTemperatureElem = document.createElement("span");
-			indoorTemperatureElem.className = "bright";
-			indoorTemperatureElem.innerHTML = " " + this.indoorTemperature.replace(".", this.config.decimalSymbol) + degreeLabel;
-			large.appendChild(indoorTemperatureElem);
-		}
-
-		if (this.config.showIndoorHumidity && this.indoorHumidity) {
-			var indoorHumidityIcon = document.createElement("span");
-			indoorHumidityIcon.className = "fa fa-tint";
-			large.appendChild(indoorHumidityIcon);
-
-			var indoorHumidityElem = document.createElement("span");
-			indoorHumidityElem.className = "bright";
-			indoorHumidityElem.innerHTML = " " + this.indoorHumidity + "%";
-			large.appendChild(indoorHumidityElem);
-		}
-
-		wrapper.appendChild(large);
-
-		if (this.config.showFeelsLike && this.config.onlyTemp === false) {
-			var small = document.createElement("div");
-			small.className = "normal medium";
-
-			var feelsLike = document.createElement("span");
-			feelsLike.className = "dimmed";
-			feelsLike.innerHTML = this.translate("FEELS", {
-				DEGREE: this.feelsLike + degreeLabel
-			});
-			small.appendChild(feelsLike);
-
-			wrapper.appendChild(small);
-		}
-
+		wrapper.innerHTML =
+			"<style>text-decoration: none</style>" +
+			"This module is deprecated since release v2.15 and removed with v2.19." +
+			'<br>Please use the `weather` module as replacement, more info in the <a href="https://docs.magicmirror.builders/modules/weather.html" style="color: #ffffff">documentation</a>.';
+		wrapper.className = "dimmed light small";
 		return wrapper;
 	},
 
 	// Override getHeader method.
 	getHeader: function () {
-		if (this.config.useLocationAsHeader && this.config.location !== false) {
-			return this.config.location;
-		}
-
-		if (this.config.appendLocationNameToHeader) {
-			if (this.data.header) return this.data.header + " " + this.fetchedLocationName;
-			else return this.fetchedLocationName;
-		}
-
-		return this.data.header ? 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) {
-				this.firstEvent = false;
-
-				for (var e in payload) {
-					var event = payload[e];
-					if (event.location || event.geo) {
-						this.firstEvent = event;
-						//Log.log("First upcoming event with location: ", event);
-						break;
-					}
-				}
-			}
-		}
-		if (notification === "INDOOR_TEMPERATURE") {
-			this.indoorTemperature = this.roundValue(payload);
-			this.updateDom(this.config.animationSpeed);
-		}
-		if (notification === "INDOOR_HUMIDITY") {
-			this.indoorHumidity = this.roundValue(payload);
-			this.updateDom(this.config.animationSpeed);
-		}
-	},
-
-	/* updateWeather(compliments)
-	 * Requests new data from openweather.org.
-	 * Calls processWeather on succesfull response.
-	 */
-	updateWeather: function () {
-		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;
-
-		var weatherRequest = new XMLHttpRequest();
-		weatherRequest.open("GET", url, true);
-		weatherRequest.onreadystatechange = function () {
-			if (this.readyState === 4) {
-				if (this.status === 200) {
-					self.processWeather(JSON.parse(this.response));
-				} else if (this.status === 401) {
-					self.updateDom(self.config.animationSpeed);
-
-					Log.error(self.name + ": Incorrect APPID.");
-					retry = true;
-				} else {
-					Log.error(self.name + ": Could not load weather.");
-				}
-
-				if (retry) {
-					self.scheduleUpdate(self.loaded ? -1 : self.config.retryDelay);
-				}
-			}
-		};
-		weatherRequest.send();
-	},
-
-	/* getParams(compliments)
-	 * Generates an url with api parameters based on the config.
-	 *
-	 * return String - URL params.
-	 */
-	getParams: function () {
-		var params = "?";
-		if (this.config.locationID) {
-			params += "id=" + this.config.locationID;
-		} 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;
-
-		return params;
-	},
-
-	/* processWeather(data)
-	 * Uses the received data to set the various values.
-	 *
-	 * argument data object - Weather information received form openweather.org.
-	 */
-	processWeather: function (data) {
-		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);
-		this.fetchedLocationName = data.name;
-		this.feelsLike = 0;
-
-		if (this.config.useBeaufort) {
-			this.windSpeed = this.ms2Beaufort(this.roundValue(data.wind.speed));
-		} else if (this.config.useKMPHwind) {
-			this.windSpeed = parseFloat((data.wind.speed * 60 * 60) / 1000).toFixed(0);
-		} else {
-			this.windSpeed = parseFloat(data.wind.speed).toFixed(0);
-		}
-
-		// ONLY WORKS IF TEMP IN C //
-		var windInMph = parseFloat(data.wind.speed * 2.23694);
-
-		var tempInF = 0;
-		switch (this.config.units) {
-			case "metric":
-				tempInF = 1.8 * this.temperature + 32;
-				break;
-			case "imperial":
-				tempInF = this.temperature;
-				break;
-			case "default":
-				tempInF = 1.8 * (this.temperature - 273.15) + 32;
-				break;
-		}
-
-		if (windInMph > 3 && tempInF < 50) {
-			// windchill
-			var windChillInF = Math.round(35.74 + 0.6215 * tempInF - 35.75 * Math.pow(windInMph, 0.16) + 0.4275 * tempInF * Math.pow(windInMph, 0.16));
-			var windChillInC = (windChillInF - 32) * (5 / 9);
-			// this.feelsLike = windChillInC.toFixed(0);
-
-			switch (this.config.units) {
-				case "metric":
-					this.feelsLike = windChillInC.toFixed(0);
-					break;
-				case "imperial":
-					this.feelsLike = windChillInF.toFixed(0);
-					break;
-				case "default":
-					this.feelsLike = (windChillInC + 273.15).toFixed(0);
-					break;
-			}
-		} else if (tempInF > 80 && this.humidity > 40) {
-			// heat index
-			var Hindex =
-				-42.379 +
-				2.04901523 * tempInF +
-				10.14333127 * this.humidity -
-				0.22475541 * tempInF * this.humidity -
-				6.83783 * Math.pow(10, -3) * tempInF * tempInF -
-				5.481717 * Math.pow(10, -2) * this.humidity * this.humidity +
-				1.22874 * Math.pow(10, -3) * tempInF * tempInF * this.humidity +
-				8.5282 * Math.pow(10, -4) * tempInF * this.humidity * this.humidity -
-				1.99 * Math.pow(10, -6) * tempInF * tempInF * this.humidity * this.humidity;
-
-			switch (this.config.units) {
-				case "metric":
-					this.feelsLike = parseFloat((Hindex - 32) / 1.8).toFixed(0);
-					break;
-				case "imperial":
-					this.feelsLike = Hindex.toFixed(0);
-					break;
-				case "default":
-					var tc = parseFloat((Hindex - 32) / 1.8) + 273.15;
-					this.feelsLike = tc.toFixed(0);
-					break;
-			}
-		} else {
-			this.feelsLike = parseFloat(this.temperature).toFixed(0);
-		}
-
-		this.windDirection = this.deg2Cardinal(data.wind.deg);
-		this.windDeg = data.wind.deg;
-		this.weatherType = this.config.iconTable[data.weather[0].icon];
-
-		var now = new Date();
-		var sunrise = new Date(data.sys.sunrise * 1000);
-		var sunset = new Date(data.sys.sunset * 1000);
-
-		// 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 sunriseSunsetDateObject = sunrise < now && sunset > now ? sunset : sunrise;
-		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");
-				} else {
-					//timeString = hours + moment(sunriseSunsetDateObject).format(':mm a');
-					timeString = moment(sunriseSunsetDateObject).format("h:mm a");
-				}
-			} else {
-				//timeString = hours + moment(sunriseSunsetDateObject).format(':mm');
-				timeString = moment(sunriseSunsetDateObject).format("h:mm");
-			}
-		}
-
-		this.sunriseSunsetTime = timeString;
-		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 });
-		this.sendNotification("CURRENTWEATHER_TYPE", { type: this.config.iconTable[data.weather[0].icon].replace("-", "_") });
-	},
-
-	/* scheduleUpdate()
-	 * Schedule next update.
-	 *
-	 * argument delay number - Milliseconds before next update. If empty, this.config.updateInterval is used.
-	 */
-	scheduleUpdate: function (delay) {
-		var nextLoad = this.config.updateInterval;
-		if (typeof delay !== "undefined" && delay >= 0) {
-			nextLoad = delay;
-		}
-
-		var self = this;
-		setTimeout(function () {
-			self.updateWeather();
-		}, nextLoad);
-	},
-
-	/* ms2Beaufort(ms)
-	 * Converts m2 to beaufort (windspeed).
-	 *
-	 * see:
-	 *  https://www.spc.noaa.gov/faq/tornado/beaufort.html
-	 *  https://en.wikipedia.org/wiki/Beaufort_scale#Modern_scale
-	 *
-	 * argument ms number - Windspeed in m/s.
-	 *
-	 * return number - Windspeed in beaufort.
-	 */
-	ms2Beaufort: function (ms) {
-		var kmh = (ms * 60 * 60) / 1000;
-		var speeds = [1, 5, 11, 19, 28, 38, 49, 61, 74, 88, 102, 117, 1000];
-		for (var beaufort in speeds) {
-			var speed = speeds[beaufort];
-			if (speed > kmh) {
-				return beaufort;
-			}
-		}
-		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 or integer (depending on config.roundTemp).
-	 *
-	 * argument temperature number - Temperature.
-	 *
-	 * return string - Rounded Temperature.
-	 */
-	roundValue: function (temperature) {
-		var decimals = this.config.roundTemp ? 0 : 1;
-		var roundValue = parseFloat(temperature).toFixed(decimals);
-		return roundValue === "-0" ? 0 : roundValue;
+		return "deprecated currentweather";
 	}
 });

modules/default/currentweather/node_helper.js

@@ -1,9 +0,0 @@
-const NodeHelper = require("node_helper");
-const Log = require("logger");
-
-module.exports = NodeHelper.create({
-	// Override start method.
-	start: function () {
-		Log.warn(`The module '${this.name}' is deprecated in favor of the 'weather'-module, please refer to the documentation for a migration path`);
-	}
-});

modules/default/defaultmodules.js

@@ -1,13 +1,10 @@
-/* Magic Mirror
- * Default Modules List
+/* MagicMirror² Default Modules List
+ * Modules listed below can be loaded without the 'default/' prefix. Omitting the default folder name.
  *
  * By Michael Teeuw https://michaelteeuw.nl
  * MIT Licensed.
  */
-
-// Modules listed below can be loaded without the 'default/' prefix. Omitting the default folder name.
-
-var defaultModules = ["alert", "calendar", "clock", "compliments", "currentweather", "helloworld", "newsfeed", "weatherforecast", "updatenotification", "weather"];
+const defaultModules = ["alert", "calendar", "clock", "compliments", "currentweather", "helloworld", "newsfeed", "weatherforecast", "updatenotification", "weather"];
 
 /*************** DO NOT EDIT THE LINE BELOW ***************/
 if (typeof module !== "undefined") {

modules/default/helloworld/README.md

@@ -1,5 +1,5 @@
 # Module: Hello World
 
-The `helloworld` module is one of the default modules of the MagicMirror. It is a simple way to display a static text on the mirror.
+The `helloworld` module is one of the default modules of the MagicMirror². It is a simple way to display a static text on the mirror.
 
 For configuration options, please check the [MagicMirror² documentation](https://docs.magicmirror.builders/modules/helloworld.html).

modules/default/helloworld/helloworld.js

@@ -1,4 +1,4 @@
-/* Magic Mirror
+/* MagicMirror²
  * Module: HelloWorld
  *
  * By Michael Teeuw https://michaelteeuw.nl

modules/default/newsfeed/README.md

@@ -1,6 +1,6 @@
 # Module: News Feed
 
-The `newsfeed` module is one of the default modules of the MagicMirror.
+The `newsfeed` module is one of the default modules of the MagicMirror².
 This module displays news headlines based on an RSS feed. Scrolling through news headlines happens time-based (`updateInterval`), but can also be controlled by sending news feed specific notifications to the module.
 
 For configuration options, please check the [MagicMirror² documentation](https://docs.magicmirror.builders/modules/newsfeed.html).

modules/default/newsfeed/newsfeed.css

@@ -12,3 +12,12 @@ iframe.newsfeed-fullarticle {
   bottom: inherit;
   top: -90px;
 }
+
+.newsfeed-list {
+  list-style: none;
+}
+
+.newsfeed-list li {
+  text-align: justify;
+  margin-bottom: 0.5em;
+}

modules/default/newsfeed/newsfeed.js

@@ -1,4 +1,4 @@
-/* Magic Mirror
+/* MagicMirror²
  * Module: NewsFeed
  *
  * By Michael Teeuw https://michaelteeuw.nl
@@ -14,11 +14,13 @@ Module.register("newsfeed", {
 				encoding: "UTF-8" //ISO-8859-1
 			}
 		],
+		showAsList: false,
 		showSourceTitle: true,
 		showPublishDate: true,
 		broadcastNewsFeeds: true,
 		broadcastNewsUpdates: true,
 		showDescription: false,
+		showTitleAsUrl: false,
 		wrapTitle: true,
 		wrapDescription: true,
 		truncDescription: true,
@@ -36,7 +38,8 @@ Module.register("newsfeed", {
 		endTags: [],
 		prohibitedWords: [],
 		scrollLength: 500,
-		logFeedWarnings: false
+		logFeedWarnings: false,
+		dangerouslyDisableAutoEscaping: false
 	},
 
 	// Define required scripts.
@@ -89,8 +92,8 @@ Module.register("newsfeed", {
 
 			this.loaded = true;
 			this.error = null;
-		} else if (notification === "INCORRECT_URL") {
-			this.error = `Incorrect url: ${payload.url}`;
+		} else if (notification === "NEWSFEED_ERROR") {
+			this.error = this.translate(payload.error_type);
 			this.scheduleUpdateInterval();
 		}
 	},
@@ -120,7 +123,7 @@ Module.register("newsfeed", {
 		}
 		if (this.newsItems.length === 0) {
 			return {
-				loaded: false
+				empty: true
 			};
 		}
 		if (this.activeItem >= this.newsItems.length) {
@@ -128,6 +131,10 @@ Module.register("newsfeed", {
 		}
 
 		const item = this.newsItems[this.activeItem];
+		const items = this.newsItems.map(function (item) {
+			item.publishDate = moment(new Date(item.pubdate)).fromNow();
+			return item;
+		});
 
 		return {
 			loaded: true,
@@ -135,7 +142,9 @@ Module.register("newsfeed", {
 			sourceTitle: item.sourceTitle,
 			publishDate: moment(new Date(item.pubdate)).fromNow(),
 			title: item.title,
-			description: item.description
+			url: item.url,
+			description: item.description,
+			items: items
 		};
 	},
 
@@ -178,21 +187,21 @@ Module.register("newsfeed", {
 			const dateB = new Date(b.pubdate);
 			return dateB - dateA;
 		});
+
 		if (this.config.maxNewsItems > 0) {
 			newsItems = newsItems.slice(0, this.config.maxNewsItems);
 		}
 
 		if (this.config.prohibitedWords.length > 0) {
-			newsItems = newsItems.filter(function (value) {
+			newsItems = newsItems.filter(function (item) {
 				for (let word of this.config.prohibitedWords) {
-					if (value["title"].toLowerCase().indexOf(word.toLowerCase()) > -1) {
+					if (item.title.toLowerCase().indexOf(word.toLowerCase()) > -1) {
 						return false;
 					}
 				}
 				return true;
 			}, this);
 		}
-
 		newsItems.forEach((item) => {
 			//Remove selected tags from the beginning of rss feed items (title or description)
 			if (this.config.removeStartTags === "title" || this.config.removeStartTags === "both") {
@@ -214,7 +223,6 @@ Module.register("newsfeed", {
 			}
 
 			//Remove selected tags from the end of rss feed items (title or description)
-
 			if (this.config.removeEndTags) {
 				for (let endTag of this.config.endTags) {
 					if (item.title.slice(-endTag.length) === endTag) {
@@ -290,6 +298,9 @@ Module.register("newsfeed", {
 			this.sendNotification("NEWS_FEED", { items: this.newsItems });
 		}
 
+		// #2638 Clear timer if it already exists
+		if (this.timer) clearInterval(this.timer);
+
 		this.timer = setInterval(() => {
 			this.activeItem++;
 			this.updateDom(this.config.animationSpeed);

modules/default/newsfeed/newsfeed.njk

@@ -1,25 +1,86 @@
+{% macro escapeText(text, dangerouslyDisableAutoEscaping=false) %}
+  {% if dangerouslyDisableAutoEscaping %}
+    {{ text | safe}}
+  {% else %}
+    {{ text }}
+  {% endif %}
+{% endmacro %}
+
+{% macro escapeTitle(title, url, dangerouslyDisableAutoEscaping=false, showTitleAsUrl=false) %}
+  {% if dangerouslyDisableAutoEscaping %}
+    {% if showTitleAsUrl %}
+      <a href="{{ url }}" style="text-decoration:none;color:#ffffff" target="_blank">{{ title | safe }}</a>
+    {% else %}
+      {{ title | safe}}
+    {% endif %}
+  {% else %}
+    {% if showTitleAsUrl %}
+      <a href="{{ url }}" style="text-decoration:none;color:#ffffff" target="_blank">{{ title }}</a>
+    {% else %}
+      {{ title }}
+    {% endif %}
+  {% endif %}
+{% endmacro %}
+
 {% if loaded %}
-    <div>
-        {% if (config.showSourceTitle and sourceTitle) or config.showPublishDate %}
-            <div class="newsfeed-source light small dimmed">
-                {% if sourceTitle and config.showSourceTitle %}
-                    {{ sourceTitle }}{% if config.showPublishDate %}, {% else %}: {% endif %}
-                {% endif %}
-                {% if config.showPublishDate %}
-                    {{ publishDate }}:
-                {% endif %}
+    {% if config.showAsList %}
+        <ul class="newsfeed-list">
+            {% for item in items %}
+                <li>
+                    {% if (config.showSourceTitle and item.sourceTitle) or config.showPublishDate %}
+                        <div class="newsfeed-source light small dimmed">
+                            {% if item.sourceTitle and config.showSourceTitle %}
+                                {{ item.sourceTitle }}{% if config.showPublishDate %}, {% else %}: {% endif %}
+                            {% endif %}
+                            {% if config.showPublishDate %}
+                                {{ item.publishDate }}:
+                            {% endif %}
+                        </div>
+                    {% endif %}
+                    <div class="newsfeed-title bright medium light{{ ' no-wrap' if not config.wrapTitle }}">
+                        {{ escapeTitle(item.title, item.url, config.dangerouslyDisableAutoEscaping, config.showTitleAsUrl) }}
+                    </div>
+                    {% if config.showDescription %}
+                        <div class="newsfeed-desc small light{{ ' no-wrap' if not config.wrapDescription }}">
+                            {% if config.truncDescription %}
+                                {{ escapeText(item.description | truncate(config.lengthDescription), config.dangerouslyDisableAutoEscaping) }}
+                            {% else %}
+                                {{ escapeText(item.description, config.dangerouslyDisableAutoEscaping) }}
+                            {% endif %}
+                        </div>
+                    {% endif %}
+                </li>
+            {% endfor %}
+        </ul>
+    {% else %}
+        <div>
+            {% if (config.showSourceTitle and sourceTitle) or config.showPublishDate %}
+                <div class="newsfeed-source light small dimmed">
+                    {% if sourceTitle and config.showSourceTitle %}
+                        {{ escapeText(sourceTitle, config.dangerouslyDisableAutoEscaping) }}{% if config.showPublishDate %}, {% else %}: {% endif %}
+                    {% endif %}
+                    {% if config.showPublishDate %}
+                        {{ publishDate }}:
+                    {% endif %}
+                </div>
+            {% endif %}
+            <div class="newsfeed-title bright medium light{{ ' no-wrap' if not config.wrapTitle }}">
+                {{ escapeTitle(title, url, config.dangerouslyDisableAutoEscaping, config.showTitleAsUrl) }}
             </div>
-        {% endif %}
-        <div class="newsfeed-title bright medium light{{ ' no-wrap' if not config.wrapTitle }}">
-            {{ title }}
-        </div>
-        <div class="newsfeed-desc small light{{ ' no-wrap' if not config.wrapDescription }}">
-            {% if config.truncDescription %}
-                {{ description | truncate(config.lengthDescription) }}
-            {% else %}
-                {{ description }}
+            {% if config.showDescription %}
+                <div class="newsfeed-desc small light{{ ' no-wrap' if not config.wrapDescription }}">
+                    {% if config.truncDescription %}
+                        {{ escapeText(description | truncate(config.lengthDescription), config.dangerouslyDisableAutoEscaping) }}
+                    {% else %}
+                        {{ escapeText(description, config.dangerouslyDisableAutoEscaping) }}
+                    {% endif %}
+                </div>
             {% endif %}
         </div>
+    {% endif %}
+{% elseif empty %}
+    <div class="small dimmed">
+        {{ "NEWSFEED_NO_ITEMS" | translate | safe }}
     </div>
 {% elseif error %}
     <div class="small dimmed">

modules/default/newsfeed/newsfeedfetcher.js

@@ -1,4 +1,4 @@
-/* Magic Mirror
+/* MagicMirror²
  * Node Helper: Newsfeed - NewsfeedFetcher
  *
  * By Michael Teeuw https://michaelteeuw.nl
@@ -6,6 +6,7 @@
  */
 const Log = require("logger");
 const FeedMe = require("feedme");
+const NodeHelper = require("node_helper");
 const fetch = require("node-fetch");
 const iconv = require("iconv-lite");
 
@@ -78,18 +79,19 @@ const NewsfeedFetcher = function (url, reloadInterval, encoding, logFeedWarnings
 
 		const nodeVersion = Number(process.version.match(/^v(\d+\.\d+)/)[1]);
 		const headers = {
-			"User-Agent": "Mozilla/5.0 (Node.js " + nodeVersion + ") MagicMirror/" + global.version + " (https://github.com/MichMich/MagicMirror/)",
+			"User-Agent": "Mozilla/5.0 (Node.js " + nodeVersion + ") MagicMirror/" + global.version,
 			"Cache-Control": "max-age=0, no-cache, no-store, must-revalidate",
 			Pragma: "no-cache"
 		};
 
 		fetch(url, { headers: headers })
+			.then(NodeHelper.checkFetchStatus)
+			.then((response) => {
+				response.body.pipe(iconv.decodeStream(encoding)).pipe(parser);
+			})
 			.catch((error) => {
 				fetchFailedCallback(this, error);
 				scheduleTimer();
-			})
-			.then((res) => {
-				res.body.pipe(iconv.decodeStream(encoding)).pipe(parser);
 			});
 	};
 

modules/default/newsfeed/node_helper.js

@@ -1,4 +1,4 @@
-/* Magic Mirror
+/* MagicMirror²
  * Node Helper: Newsfeed
  *
  * By Michael Teeuw https://michaelteeuw.nl
@@ -27,8 +27,8 @@ module.exports = NodeHelper.create({
 	 * Creates a fetcher for a new feed if it doesn't exist yet.
 	 * Otherwise it reuses the existing one.
 	 *
-	 * @param {object} feed The feed object.
-	 * @param {object} config The configuration object.
+	 * @param {object} feed The feed object
+	 * @param {object} config The configuration object
 	 */
 	createFetcher: function (feed, config) {
 		const url = feed.url || "";
@@ -38,13 +38,14 @@ module.exports = NodeHelper.create({
 		try {
 			new URL(url);
 		} catch (error) {
-			this.sendSocketNotification("INCORRECT_URL", { url: url });
+			Log.error("Newsfeed Error. Malformed newsfeed url: ", url, error);
+			this.sendSocketNotification("NEWSFEED_ERROR", { error_type: "MODULE_ERROR_MALFORMED_URL" });
 			return;
 		}
 
 		let fetcher;
 		if (typeof this.fetchers[url] === "undefined") {
-			Log.log("Create new news fetcher for url: " + url + " - Interval: " + reloadInterval);
+			Log.log("Create new newsfetcher for url: " + url + " - Interval: " + reloadInterval);
 			fetcher = new NewsfeedFetcher(url, reloadInterval, encoding, config.logFeedWarnings);
 
 			fetcher.onReceive(() => {
@@ -52,15 +53,16 @@ module.exports = NodeHelper.create({
 			});
 
 			fetcher.onError((fetcher, error) => {
-				this.sendSocketNotification("FETCH_ERROR", {
-					url: fetcher.url(),
-					error: error
+				Log.error("Newsfeed Error. Could not fetch newsfeed: ", url, error);
+				let error_type = NodeHelper.checkFetchError(error);
+				this.sendSocketNotification("NEWSFEED_ERROR", {
+					error_type
 				});
 			});
 
 			this.fetchers[url] = fetcher;
 		} else {
-			Log.log("Use existing news fetcher for url: " + url);
+			Log.log("Use existing newsfetcher for url: " + url);
 			fetcher = this.fetchers[url];
 			fetcher.setReloadInterval(reloadInterval);
 			fetcher.broadcastItems();

modules/default/updatenotification/README.md

@@ -1,6 +1,6 @@
 # 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.
+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.
 
 For configuration options, please check the [MagicMirror² documentation](https://docs.magicmirror.builders/modules/updatenotification.html).

modules/default/updatenotification/git_helper.js

@@ -0,0 +1,169 @@
+const util = require("util");
+const exec = util.promisify(require("child_process").exec);
+const fs = require("fs");
+const path = require("path");
+const Log = require("logger");
+
+const BASE_DIR = path.normalize(`${__dirname}/../../../`);
+
+class GitHelper {
+	constructor() {
+		this.gitRepos = [];
+	}
+
+	getRefRegex(branch) {
+		return new RegExp(`s*([a-z,0-9]+[.][.][a-z,0-9]+)  ${branch}`, "g");
+	}
+
+	async execShell(command) {
+		const { stdout = "", stderr = "" } = await exec(command);
+
+		return { stdout, stderr };
+	}
+
+	async isGitRepo(moduleFolder) {
+		const { stderr } = await this.execShell(`cd ${moduleFolder} && git remote -v`);
+
+		if (stderr) {
+			Log.error(`Failed to fetch git data for ${moduleFolder}: ${stderr}`);
+
+			return false;
+		}
+
+		return true;
+	}
+
+	async add(moduleName) {
+		let moduleFolder = BASE_DIR;
+
+		if (moduleName !== "default") {
+			moduleFolder = `${moduleFolder}modules/${moduleName}`;
+		}
+
+		try {
+			Log.info(`Checking git for module: ${moduleName}`);
+			// Throws error if file doesn't exist
+			fs.statSync(path.join(moduleFolder, ".git"));
+
+			// Fetch the git or throw error if no remotes
+			const isGitRepo = await this.isGitRepo(moduleFolder);
+
+			if (isGitRepo) {
+				// Folder has .git and has at least one git remote, watch this folder
+				this.gitRepos.push({ module: moduleName, folder: moduleFolder });
+			}
+		} catch (err) {
+			// Error when directory .git doesn't exist or doesn't have any remotes
+			// This module is not managed with git, skip
+		}
+	}
+
+	async getStatusInfo(repo) {
+		let gitInfo = {
+			module: repo.module,
+			behind: 0, // commits behind
+			current: "", // branch name
+			hash: "", // current hash
+			tracking: "", // remote branch
+			isBehindInStatus: false
+		};
+
+		if (repo.module === "default") {
+			// the hash is only needed for the mm repo
+			const { stderr, stdout } = await this.execShell(`cd ${repo.folder} && git rev-parse HEAD`);
+
+			if (stderr) {
+				Log.error(`Failed to get current commit hash for ${repo.module}: ${stderr}`);
+			}
+
+			gitInfo.hash = stdout;
+		}
+
+		const { stderr, stdout } = await this.execShell(`cd ${repo.folder} && git status -sb`);
+
+		if (stderr) {
+			Log.error(`Failed to get git status for ${repo.module}: ${stderr}`);
+			// exit without git status info
+			return;
+		}
+
+		// only the first line of stdout is evaluated
+		let status = stdout.split("\n")[0];
+		// examples for status:
+		// ## develop...origin/develop
+		// ## master...origin/master [behind 8]
+		status = status.match(/(?![.#])([^.]*)/g);
+		// examples for status:
+		// [ ' develop', 'origin/develop', '' ]
+		// [ ' master', 'origin/master [behind 8]', '' ]
+		gitInfo.current = status[0].trim();
+		status = status[1].split(" ");
+		// examples for status:
+		// [ 'origin/develop' ]
+		// [ 'origin/master', '[behind', '8]' ]
+		gitInfo.tracking = status[0].trim();
+
+		if (status[2]) {
+			// git fetch was already called before so `git status -sb` delivers already the behind number
+			gitInfo.behind = parseInt(status[2].substring(0, status[2].length - 1));
+			gitInfo.isBehindInStatus = true;
+		}
+
+		return gitInfo;
+	}
+
+	async getRepoInfo(repo) {
+		const gitInfo = await this.getStatusInfo(repo);
+
+		if (!gitInfo) {
+			return;
+		}
+
+		if (gitInfo.isBehindInStatus) {
+			return gitInfo;
+		}
+
+		const { stderr } = await this.execShell(`cd ${repo.folder} && git fetch --dry-run`);
+
+		// example output:
+		// From https://github.com/MichMich/MagicMirror
+		//    e40ddd4..06389e3  develop    -> origin/develop
+		// here the result is in stderr (this is a git default, don't ask why ...)
+		const matches = stderr.match(this.getRefRegex(gitInfo.current));
+
+		if (!matches || !matches[0]) {
+			// no refs found, nothing to do
+			return;
+		}
+
+		// get behind with refs
+		try {
+			const { stdout } = await this.execShell(`cd ${repo.folder} && git rev-list --ancestry-path --count ${matches[0]}`);
+			gitInfo.behind = parseInt(stdout);
+
+			return gitInfo;
+		} catch (err) {
+			Log.error(`Failed to get git revisions for ${repo.module}: ${err}`);
+		}
+	}
+
+	async getRepos() {
+		const gitResultList = [];
+
+		for (const repo of this.gitRepos) {
+			try {
+				const gitInfo = await this.getRepoInfo(repo);
+
+				if (gitInfo) {
+					gitResultList.push(gitInfo);
+				}
+			} catch (e) {
+				Log.error(`Failed to retrieve repo info for ${repo.module}: ${e}`);
+			}
+		}
+
+		return gitResultList;
+	}
+}
+
+module.exports = GitHelper;

modules/default/updatenotification/node_helper.js

@@ -1,117 +1,66 @@
-const SimpleGit = require("simple-git");
-const simpleGits = [];
-const fs = require("fs");
-const path = require("path");
-const defaultModules = require(__dirname + "/../defaultmodules.js");
-const Log = require("logger");
+const GitHelper = require("./git_helper");
+const defaultModules = require("../defaultmodules");
 const NodeHelper = require("node_helper");
 
+const ONE_MINUTE = 60 * 1000;
+
 module.exports = NodeHelper.create({
 	config: {},
 
 	updateTimer: null,
 	updateProcessStarted: false,
 
-	start: function () {},
+	gitHelper: new GitHelper(),
 
-	configureModules: async function (modules) {
-		// Push MagicMirror itself , biggest chance it'll show up last in UI and isn't overwritten
-		// others will be added in front
-		// this method returns promises so we can't wait for every one to resolve before continuing
-		simpleGits.push({ module: "default", git: this.createGit(path.normalize(__dirname + "/../../../")) });
-
-		for (let moduleName in modules) {
+	async configureModules(modules) {
+		for (const moduleName of modules) {
 			if (!this.ignoreUpdateChecking(moduleName)) {
-				// Default modules are included in the main MagicMirror repo
-				let moduleFolder = path.normalize(__dirname + "/../../" + moduleName);
-
-				try {
-					Log.info("Checking git for module: " + moduleName);
-					// Throws error if file doesn't exist
-					fs.statSync(path.join(moduleFolder, ".git"));
-					// Fetch the git or throw error if no remotes
-					let git = await this.resolveRemote(moduleFolder);
-					// Folder has .git and has at least one git remote, watch this folder
-					simpleGits.unshift({ module: moduleName, git: git });
-				} catch (err) {
-					// Error when directory .git doesn't exist or doesn't have any remotes
-					// This module is not managed with git, skip
-					continue;
-				}
+				await this.gitHelper.add(moduleName);
 			}
 		}
+
+		await this.gitHelper.add("default");
 	},
 
-	socketNotificationReceived: function (notification, payload) {
+	async socketNotificationReceived(notification, payload) {
 		if (notification === "CONFIG") {
 			this.config = payload;
 		} else if (notification === "MODULES") {
 			// if this is the 1st time thru the update check process
 			if (!this.updateProcessStarted) {
 				this.updateProcessStarted = true;
-				this.configureModules(payload).then(() => this.performFetch());
+				await this.configureModules(payload);
+				await this.performFetch();
 			}
 		}
 	},
 
-	resolveRemote: async function (moduleFolder) {
-		let git = this.createGit(moduleFolder);
-		let remotes = await git.getRemotes(true);
+	async performFetch() {
+		const repos = await this.gitHelper.getRepos();
 
-		if (remotes.length < 1 || remotes[0].name.length < 1) {
-			throw new Error("No valid remote for folder " + moduleFolder);
-		}
-
-		return git;
-	},
-
-	performFetch: async function () {
-		for (let sg of simpleGits) {
-			try {
-				let fetchData = await sg.git.fetch(["--dry-run"]).status();
-				let logData = await sg.git.log({ "-1": null });
-
-				if (logData.latest && "hash" in logData.latest) {
-					this.sendSocketNotification("STATUS", {
-						module: sg.module,
-						behind: fetchData.behind,
-						current: fetchData.current,
-						hash: logData.latest.hash,
-						tracking: fetchData.tracking
-					});
-				}
-			} catch (err) {
-				Log.error("Failed to fetch git data for " + sg.module + ": " + err);
-			}
+		for (const repo of repos) {
+			this.sendSocketNotification("STATUS", repo);
 		}
 
 		this.scheduleNextFetch(this.config.updateInterval);
 	},
 
-	scheduleNextFetch: function (delay) {
-		if (delay < 60 * 1000) {
-			delay = 60 * 1000;
-		}
-
-		let self = this;
+	scheduleNextFetch(delay) {
 		clearTimeout(this.updateTimer);
-		this.updateTimer = setTimeout(function () {
-			self.performFetch();
-		}, delay);
+
+		this.updateTimer = setTimeout(() => {
+			this.performFetch();
+		}, Math.max(delay, ONE_MINUTE));
 	},
 
-	createGit: function (folder) {
-		return SimpleGit({ baseDir: folder, timeout: { block: this.config.timeout } });
-	},
-
-	ignoreUpdateChecking: function (moduleName) {
+	ignoreUpdateChecking(moduleName) {
 		// Should not check for updates for default modules
-		if (defaultModules.indexOf(moduleName) >= 0) {
+		if (defaultModules.includes(moduleName)) {
 			return true;
 		}
 
 		// Should not check for updates for ignored modules
-		if (this.config.ignoreModules.indexOf(moduleName) >= 0) {
+		if (this.config.ignoreModules.includes(moduleName)) {
 			return true;
 		}
 

modules/default/updatenotification/updatenotification.css

@@ -0,0 +1,3 @@
+.module.updatenotification a.difflink {
+  text-decoration: none;
+}

modules/default/updatenotification/updatenotification.js

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

modules/default/updatenotification/updatenotification.njk

@@ -0,0 +1,15 @@
+{% if not suspended %}
+  {% for name, status in moduleList %}
+    <div class="small bright">
+      <i class="fas fa-exclamation-circle"></i>
+      <span>
+        {% set mainTextLabel = "UPDATE_NOTIFICATION" if name === "default" else "UPDATE_NOTIFICATION_MODULE" %}
+        {{ mainTextLabel | translate({MODULE_NAME: name}) }}
+      </span>
+    </div>
+    <div class="xsmall dimmed">
+      {% set subTextLabel = "UPDATE_INFO_SINGLE" if status.behind === 1 else "UPDATE_INFO_MULTIPLE" %}
+      {{ subTextLabel | translate({COMMIT_COUNT: status.behind, BRANCH_NAME: status.current}) | diffLink(status) | safe }}
+    </div>
+  {% endfor %}
+{% endif %}

modules/default/weather/current.njk

@@ -15,7 +15,7 @@
                 {% if config.showWindDirection %}
                     <sup>
                         {% if config.showWindDirectionAsArrow %}
-                            <i class="fa fa-long-arrow-up" style="transform:rotate({{ current.windDirection }}deg);"></i>
+                            <i class="fas fa-long-arrow-alt-up" style="transform:rotate({{ current.windDirection }}deg);"></i>
                         {% else %}
                             {{ current.cardinalWindDirection() | translate }}
                         {% endif %}
@@ -47,7 +47,7 @@
     <div class="normal light indoor">
         {% if config.showIndoorTemperature and indoor.temperature %}
             <div>
-                <span class="fa fa-home"></span>
+                <span class="fas fa-home"></span>
                 <span class="bright">
                     {{ indoor.temperature | roundValue | unit("temperature") | decimalSymbol }}
                 </span>
@@ -55,7 +55,7 @@
         {% endif %}
         {% if config.showIndoorHumidity and indoor.humidity %}
             <div>
-                <span class="fa fa-tint"></span>
+                <span class="fas fa-tint"></span>
                 <span class="bright">
                     {{ indoor.humidity | roundValue | unit("humidity") | decimalSymbol }}
                 </span>

modules/default/weather/forecast.njk

@@ -2,27 +2,36 @@
     {% set numSteps = forecast | calcNumSteps %}
     {% set currentStep = 0 %}
     <table class="{{ config.tableClass }}">
+        {% if config.ignoreToday %}
+            {% set forecast = forecast.splice(1) %}
+        {% endif %}
         {% set forecast = forecast.slice(0, numSteps) %}
         {% for f in forecast %}
             <tr {% if config.colored %}class="colored"{% endif %} {% if config.fade %}style="opacity: {{ currentStep | opacity(numSteps) }};"{% endif %}>
-                {% if (currentStep == 0) %}
+                {% if (currentStep == 0) and config.ignoreToday == false and config.absoluteDates == false %}
                     <td class="day">{{ "TODAY" | translate }}</td>
-                {% elif (currentStep == 1) %}
+                {% elif (currentStep == 1) and config.ignoreToday == false and config.absoluteDates == false %}
                     <td class="day">{{ "TOMORROW" | translate }}</td>
                 {% else %}
                     <td class="day">{{ f.date.format('ddd') }}</td>
                 {% endif %}
                 <td class="bright weather-icon"><span class="wi weathericon wi-{{ f.weatherType }}"></span></td>
                 <td class="align-right bright max-temp">
-                    {{ f.maxTemperature | roundValue | unit("temperature") }}
+                    {{ f.maxTemperature | roundValue | unit("temperature") | decimalSymbol }}
                 </td>
                 <td class="align-right min-temp">
-                    {{ f.minTemperature | roundValue | unit("temperature") }}
+                    {{ f.minTemperature | roundValue | unit("temperature") | decimalSymbol }}
                 </td>
                 {% if config.showPrecipitationAmount %}
-                    <td class="align-right bright precipitation">
-                        {{ f.precipitation | unit("precip") }}
-                    </td>
+                    {% if f.precipitationUnits %}
+                        <td class="align-right bright precipitation">
+                            {{ f.precipitation }}{{ f.precipitationUnits }}
+                        </td>
+		                {% else %}
+                        <td class="align-right bright precipitation">
+                            {{ f.precipitation | unit("precip") }}
+                        </td>
+                    {% endif %}
                 {% endif %}
             </tr>
             {% set currentStep = currentStep + 1 %}

modules/default/weather/hourly.njk

@@ -11,9 +11,15 @@
                     {{ hour.temperature | roundValue | unit("temperature") }}
                 </td>
                 {% if config.showPrecipitationAmount %}
-                    <td class="align-right bright precipitation">
-                        {{ hour.precipitation | unit("precip") }}
-                    </td>
+                    {% if hour.precipitationUnits %}	
+                        <td class="align-right bright precipitation">
+                            {{ hour.precipitation }}{{ hour.precipitationUnits }}
+                        </td>			
+		                {% else %}
+                        <td class="align-right bright precipitation">
+                            {{ hour.precipitation | unit("precip") }}
+                        </td>
+                    {% endif %}
                 {% endif %}
             </tr>
             {% set currentStep = currentStep + 1 %}

modules/default/weather/providers/README.md

@@ -1,148 +1,3 @@
-# MagicMirror² Weather Module Weather Provider Development Documentation
+# Weather Module Weather Provider Development Documentation
 
-This document describes the way to develop your own MagicMirror² weather module weather provider.
-
-Table of Contents:
-
-- The weather provider file: yourprovider.js
-  - [Weather provider methods to implement](#weather-provider-methods-to-implement)
-  - [Weather Provider instance methods](#weather-provider-instance-methods)
-  - [WeatherObject](#weatherobject)
-
----
-
-## The weather provider file: yourprovider.js
-
-This is the script in which the weather provider will be defined. In its most simple form, the weather provider must implement the following:
-
-```javascript
-WeatherProvider.register("yourprovider", {
-  providerName: "YourProvider",
-
-  fetchCurrentWeather() {},
-
-  fetchWeatherForecast() {}
-});
-```
-
-### Weather provider methods to implement
-
-#### `fetchCurrentWeather()`
-
-This method is called when the weather module tries to fetch the current weather of your provider. The implementation of this method is required for current weather support.
-The implementation can make use of the already implemented function `this.fetchData(url, method, data);`, which is returning a promise.
-After the response is processed, the current weather information (as a [WeatherObject](#weatherobject)) needs to be set with `this.setCurrentWeather(currentWeather);`.
-It will then automatically refresh the module DOM with the new data.
-
-#### `fetchWeatherForecast()`
-
-This method is called when the weather module tries to fetch the weather of your provider. The implementation of this method is required for forecast support.
-The implementation can make use of the already implemented function `this.fetchData(url, method, data);`, which is returning a promise.
-After the response is processed, the weather forecast information (as an array of [WeatherObject](#weatherobject)s) needs to be set with `this.setWeatherForecast(forecast);`.
-It will then automatically refresh the module DOM with the new data.
-
-#### `fetchWeatherHourly()`
-
-This method is called when the weather module tries to fetch the weather of your provider. The implementation of this method is required for hourly support.
-The implementation can make use of the already implemented function `this.fetchData(url, method, data);`, which is returning a promise.
-After the response is processed, the hourly weather forecast information (as an array of [WeatherObject](#weatherobject)s) needs to be set with `this.setWeatherHourly(forecast);`.
-It will then automatically refresh the module DOM with the new data.
-
-### Weather Provider instance methods
-
-#### `init()`
-
-Called when a weather provider is initialized.
-
-#### `setConfig(config)`
-
-Called to set the config, this config is the same as the weather module's config.
-
-#### `start()`
-
-Called when the weather provider is about to start.
-
-#### `currentWeather()`
-
-This returns a WeatherDay object for the current weather.
-
-#### `weatherForecast()`
-
-This returns an array of WeatherDay objects for the weather forecast.
-
-#### `weatherHourly()`
-
-This returns an array of WeatherDay objects for the hourly weather forecast.
-
-#### `fetchedLocation()`
-
-This returns the name of the fetched location or an empty string.
-
-#### `setCurrentWeather(currentWeatherObject)`
-
-Set the currentWeather and notify the delegate that new information is available.
-
-#### `setWeatherForecast(weatherForecastArray)`
-
-Set the weatherForecastArray and notify the delegate that new information is available.
-
-#### `setWeatherHourly(weatherHourlyArray)`
-
-Set the weatherHourlyArray and notify the delegate that new information is available.
-
-#### `setFetchedLocation(name)`
-
-Set the fetched location name.
-
-#### `updateAvailable()`
-
-Notify the delegate that new weather is available.
-
-#### `fetchData(url, method, data)`
-
-A convenience function to make requests. It returns a promise.
-
-### WeatherObject
-
-| Property       | Type     | Value/Unit                                                                                                      |
-| -------------- | -------- | --------------------------------------------------------------------------------------------------------------- |
-| units          | `string` | Gets initialized with the constructor. <br> Possible values: `metric`, `imperial`                               |
-| tempUnits      | `string` | Gets initialized with the constructor. <br> Possible values: `metric`, `imperial`                               |
-| windUnits      | `string` | Gets initialized with the constructor. <br> Possible values: `metric`, `imperial`                               |
-| date           | `object` | [Moment.js](https://momentjs.com/) object of the time/date.                                                     |
-| windSpeed      | `number` | Metric: `meter/second` <br> Imperial: `miles/hour`                                                              |
-| windDirection  | `number` | Direction of the wind in degrees.                                                                               |
-| sunrise        | `object` | [Moment.js](https://momentjs.com/) object of sunrise.                                                           |
-| sunset         | `object` | [Moment.js](https://momentjs.com/) object of sunset.                                                            |
-| temperature    | `number` | Current temperature                                                                                             |
-| minTemperature | `number` | Lowest temperature of the day.                                                                                  |
-| maxTemperature | `number` | Highest temperature of the day.                                                                                 |
-| weatherType    | `string` | Icon name of the weather type. <br> Possible values: [WeatherIcons](https://www.npmjs.com/package/weathericons) |
-| humidity       | `number` | Percentage of humidity                                                                                          |
-| rain           | `number` | Metric: `millimeters` <br> Imperial: `inches`                                                                   |
-| snow           | `number` | Metric: `millimeters` <br> Imperial: `inches`                                                                   |
-| precipitation  | `number` | Metric: `millimeters` <br> Imperial: `inches` <br> UK Met Office provider: `percent`                            |
-
-#### Current weather
-
-For the current weather object the following properties are required:
-
-- humidity
-- sunrise
-- sunset
-- temperature
-- units
-- weatherType
-- windDirection
-- windSpeed
-
-#### Weather forecast
-
-For the forecast weather object the following properties are required:
-
-- date
-- maxTemperature
-- minTemperature
-- rain
-- units
-- weatherType
+For how to develop your own weather provider, please check the [MagicMirror² documentation](https://docs.magicmirror.builders/development/weather-provider.html).

modules/default/weather/providers/darksky.js

@@ -1,6 +1,6 @@
 /* global WeatherProvider, WeatherObject */
 
-/* Magic Mirror
+/* MagicMirror²
  * Module: Weather
  * Provider: Dark Sky
  *
@@ -8,7 +8,8 @@
  * MIT Licensed
  *
  * This class is a provider for Dark Sky.
- * Note that the Dark Sky API does not provide rainfall.  Instead it provides snowfall and precipitation probability
+ * Note that the Dark Sky API does not provide rainfall. Instead it provides
+ * snowfall and precipitation probability
  */
 WeatherProvider.register("darksky", {
 	// Set the name of the provider.
@@ -17,7 +18,8 @@ WeatherProvider.register("darksky", {
 
 	// Set the default config properties that is specific to this provider
 	defaults: {
-		apiBase: "https://cors-anywhere.herokuapp.com/https://api.darksky.net",
+		useCorsProxy: true,
+		apiBase: "https://api.darksky.net",
 		weatherEndpoint: "/forecast",
 		apiKey: "",
 		lat: 0,
@@ -98,7 +100,8 @@ WeatherProvider.register("darksky", {
 			weather.snow = 0;
 
 			// The API will return centimeters if units is 'si' and will return inches for 'us'
-			// Note that the Dark Sky API does not provide rainfall.  Instead it provides snowfall and precipitation probability
+			// Note that the Dark Sky API does not provide rainfall.
+			// Instead it provides snowfall and precipitation probability
 			if (forecast.hasOwnProperty("precipAccumulation")) {
 				if (this.config.units === "imperial" && !isNaN(forecast.precipAccumulation)) {
 					weather.snow = forecast.precipAccumulation;

modules/default/weather/providers/envcanada.js

@@ -0,0 +1,622 @@
+/* global WeatherProvider, WeatherObject */
+
+/* MagicMirror²
+ * Module: Weather
+ * Provider: Environment Canada (EC)
+ *
+ * This class is a provider for Environment Canada MSC Datamart
+ * Note that this is only for Canadian locations and does not require an API key (access is anonymous)
+ *
+ * EC Documentation at following links:
+ * 	https://dd.weather.gc.ca/citypage_weather/schema/
+ * 	https://eccc-msc.github.io/open-data/msc-datamart/readme_en/
+ *
+ * This module supports Canadian locations only and requires 2 additional config parms:
+ *
+ * siteCode - the city/town unique identifier for which weather is to be displayed. Format is 's0000000'.
+ *
+ * provCode - the 2-character province code for the selected city/town.
+ *
+ * Example: for Toronto, Ontario, the following parms would be used
+ *
+ * siteCode: 's0000458',
+ * provCode: 'ON'
+ *
+ * To determine the siteCode and provCode values for a Canadian city/town, look at the Environment Canada document
+ * at https://dd.weather.gc.ca/citypage_weather/docs/site_list_en.csv (or site_list_fr.csv). There you will find a table
+ * with locations you can search under column B (English Names), with the corresponding siteCode under
+ * column A (Codes) and provCode under column C (Province).
+ *
+ * Original by Kevin Godin
+ *
+ * License to use Environment Canada (EC) data is detailed here:
+ * 	https://eccc-msc.github.io/open-data/licence/readme_en/
+ *
+ */
+
+WeatherProvider.register("envcanada", {
+	// Set the name of the provider for debugging and alerting purposes (eg. provide eye-catcher)
+	providerName: "Environment Canada",
+
+	// Set the default config properties that is specific to this provider
+	defaults: {
+		useCorsProxy: true,
+		siteCode: "s1234567",
+		provCode: "ON"
+	},
+
+	//
+	// Set config values (equates to weather module config values). Also set values pertaining to caching of
+	// Today's temperature forecast (for use in the Forecast functions below)
+	//
+	setConfig: function (config) {
+		this.config = config;
+
+		this.todayTempCacheMin = 0;
+		this.todayTempCacheMax = 0;
+		this.todayCached = false;
+		this.cacheCurrentTemp = 999;
+	},
+
+	//
+	// Called when the weather provider is started
+	//
+	start: function () {
+		Log.info(`Weather provider: ${this.providerName} started.`);
+		this.setFetchedLocation(this.config.location);
+
+		// Ensure kmH are ignored since these are custom-handled by this Provider
+
+		this.config.useKmh = false;
+	},
+
+	//
+	// Override the fetchCurrentWeather method to query EC and construct a Current weather object
+	//
+	fetchCurrentWeather() {
+		this.fetchData(this.getUrl(), "GET", "xml")
+			.then((data) => {
+				if (!data) {
+					// Did not receive usable new data.
+					return;
+				}
+				const currentWeather = this.generateWeatherObjectFromCurrentWeather(data);
+
+				this.setCurrentWeather(currentWeather);
+			})
+			.catch(function (request) {
+				Log.error("Could not load EnvCanada site data ... ", request);
+			})
+			.finally(() => this.updateAvailable());
+	},
+
+	//
+	// Override the fetchWeatherForecast method to query EC and construct Forecast weather objects
+	//
+	fetchWeatherForecast() {
+		this.fetchData(this.getUrl(), "GET", "xml")
+			.then((data) => {
+				if (!data) {
+					// Did not receive usable new data.
+					return;
+				}
+				const forecastWeather = this.generateWeatherObjectsFromForecast(data);
+
+				this.setWeatherForecast(forecastWeather);
+			})
+			.catch(function (request) {
+				Log.error("Could not load EnvCanada forecast data ... ", request);
+			})
+			.finally(() => this.updateAvailable());
+	},
+
+	//
+	// Override the fetchWeatherHourly method to query EC and construct Forecast weather objects
+	//
+	fetchWeatherHourly() {
+		this.fetchData(this.getUrl(), "GET", "xml")
+			.then((data) => {
+				if (!data) {
+					// Did not receive usable new data.
+					return;
+				}
+				const hourlyWeather = this.generateWeatherObjectsFromHourly(data);
+
+				this.setWeatherHourly(hourlyWeather);
+			})
+			.catch(function (request) {
+				Log.error("Could not load EnvCanada hourly data ... ", request);
+			})
+			.finally(() => this.updateAvailable());
+	},
+
+	//////////////////////////////////////////////////////////////////////////////////
+	//
+	// Environment Canada methods - not part of the standard Provider methods
+	//
+	//////////////////////////////////////////////////////////////////////////////////
+
+	//
+	// Build the EC URL based on the Site Code and Province Code specified in the config parms. Note that the
+	// URL defaults to the Englsih version simply because there is no language dependancy in the data
+	// being accessed. This is only pertinent when using the EC data elements that contain a textual forecast.
+	//
+	getUrl() {
+		return "https://dd.weather.gc.ca/citypage_weather/xml/" + this.config.provCode + "/" + this.config.siteCode + "_e.xml";
+	},
+
+	//
+	// Generate a WeatherObject based on current EC weather conditions
+	//
+
+	generateWeatherObjectFromCurrentWeather(ECdoc) {
+		const currentWeather = new WeatherObject(this.config.units, this.config.tempUnits, this.config.windUnits);
+
+		// There are instances where EC will update weather data and current temperature will not be
+		// provided. While this is a defect in the EC systems, we need to accommodate to avoid a current temp
+		// of NaN being displayed. Therefore... whenever we get a valid current temp from EC, we will cache
+		// the value. Whenever EC data is missing current temp, we will provide the cached value
+		// instead. This is reasonable since the cached value will typically be accurate within the previous
+		// hour. The only time this does not work as expected is when MM is restarted and the first query to
+		// EC finds no current temp. In this scenario, MM will end up displaying a current temp of null;
+
+		if (ECdoc.querySelector("siteData currentConditions temperature").textContent) {
+			currentWeather.temperature = this.convertTemp(ECdoc.querySelector("siteData currentConditions temperature").textContent);
+			this.cacheCurrentTemp = currentWeather.temperature;
+		} else {
+			currentWeather.temperature = this.cacheCurrentTemp;
+		}
+
+		currentWeather.windSpeed = this.convertWind(ECdoc.querySelector("siteData currentConditions wind speed").textContent);
+
+		currentWeather.windDirection = ECdoc.querySelector("siteData currentConditions wind bearing").textContent;
+
+		currentWeather.humidity = ECdoc.querySelector("siteData currentConditions relativeHumidity").textContent;
+
+		// Ensure showPrecipitationAmount is forced to false. EC does not really provide POP for current day
+		// and this feature for the weather module (current only) is sort of broken in that it wants
+		// to say POP but will display precip as an accumulated amount vs. a percentage.
+
+		this.config.showPrecipitationAmount = false;
+
+		//
+		// If the module config wants to showFeelsLike... default to the current temperature.
+		// Check for EC wind chill and humidex values and overwrite the feelsLikeTemp value.
+		// This assumes that the EC current conditions will never contain both a wind chill
+		// and humidex temperature.
+		//
+
+		if (this.config.showFeelsLike) {
+			currentWeather.feelsLikeTemp = currentWeather.temperature;
+
+			if (ECdoc.querySelector("siteData currentConditions windChill")) {
+				currentWeather.feelsLikeTemp = this.convertTemp(ECdoc.querySelector("siteData currentConditions windChill").textContent);
+			}
+
+			if (ECdoc.querySelector("siteData currentConditions humidex")) {
+				currentWeather.feelsLikeTemp = this.convertTemp(ECdoc.querySelector("siteData currentConditions humidex").textContent);
+			}
+		}
+
+		//
+		// Need to map EC weather icon to MM weatherType values
+		//
+
+		currentWeather.weatherType = this.convertWeatherType(ECdoc.querySelector("siteData currentConditions iconCode").textContent);
+
+		//
+		// Capture the sunrise and sunset values from EC data
+		//
+
+		const sunList = ECdoc.querySelectorAll("siteData riseSet dateTime");
+
+		currentWeather.sunrise = moment(sunList[1].querySelector("timeStamp").textContent, "YYYYMMDDhhmmss");
+		currentWeather.sunset = moment(sunList[3].querySelector("timeStamp").textContent, "YYYYMMDDhhmmss");
+
+		return currentWeather;
+	},
+
+	//
+	// Generate an array of WeatherObjects based on EC weather forecast
+	//
+
+	generateWeatherObjectsFromForecast(ECdoc) {
+		// Declare an array to hold each day's forecast object
+
+		const days = [];
+
+		const weather = new WeatherObject(this.config.units, this.config.tempUnits, this.config.windUnits);
+
+		const foreBaseDates = ECdoc.querySelectorAll("siteData forecastGroup dateTime");
+		const baseDate = foreBaseDates[1].querySelector("timeStamp").textContent;
+
+		weather.date = moment(baseDate, "YYYYMMDDhhmmss");
+
+		const foreGroup = ECdoc.querySelectorAll("siteData forecastGroup forecast");
+
+		// For simplicity, we will only accumulate precipitation and will not try to break out
+		// rain vs snow accumulations
+
+		weather.rain = null;
+		weather.snow = null;
+		weather.precipitation = null;
+
+		//
+		// The EC forecast is held in a 12-element array - Elements 0 to 11 - with each day encompassing
+		// 2 elements. the first element for a day details the Today (daytime) forecast while the second
+		// element details the Tonight (nightime) forecast. Element 0 is always for the current day.
+		//
+		// However... the forecast is somewhat 'rolling'.
+		//
+		// If the EC forecast is queried in the morning, then Element 0 will contain Current
+		// Today and Element 1 will contain Current Tonight. From there, the next 5 days of forecast will be
+		// contained in Elements 2/3, 4/5, 6/7, 8/9, and 10/11. This module will create a 6-day forecast using
+		// all of these Elements.
+		//
+		// But, if the EC forecast is queried in late afternoon, the Current Today forecast will be rolled
+		// off and Element 0 will contain Current Tonight. From there, the next 5 days will be contained in
+		// Elements 1/2, 3/4, 5/6, 7/8, and 9/10. As well, Elelement 11 will contain a forecast for a 6th day,
+		// but only for the Today portion (not Tonight). This module will create a 6-day forecast using
+		// Elements 0 to 11, and will ignore the additional Todat forecast in Element 11.
+		//
+		// We need to determine if Element 0 is showing the forecast for Current Today or Current Tonight.
+		// This is required to understand how Min and Max temperature will be determined, and to understand
+		// where the next day's (aka Tomorrow's) forecast is located in the forecast array.
+		//
+
+		let nextDay = 0;
+		let lastDay = 0;
+		const currentTemp = ECdoc.querySelector("siteData currentConditions temperature").textContent;
+
+		//
+		// If the first Element is Current Today, look at Current Today and Current Tonight for the current day.
+		//
+
+		if (foreGroup[0].querySelector("period[textForecastName='Today']")) {
+			this.todaytempCacheMin = 0;
+			this.todaytempCacheMax = 0;
+			this.todayCached = true;
+
+			this.setMinMaxTemps(weather, foreGroup, 0, true, currentTemp);
+
+			this.setPrecipitation(weather, foreGroup, 0);
+
+			//
+			// Set the Element number that will reflect where the next day's forecast is located. Also set
+			// the Element number where the end of the forecast will be. This is important because of the
+			// rolling nature of the EC forecast. In the current scenario (Today and Tonight are present
+			// in elements 0 and 11, we know that we will have 6 full days of forecasts and we will use
+			// them. We will set lastDay such that we iterate through all 12 elements of the forecast.
+			//
+
+			nextDay = 2;
+			lastDay = 12;
+		}
+
+		//
+		// If the first Element is Current Tonight, look at Tonight only for the current day.
+		//
+		if (foreGroup[0].querySelector("period[textForecastName='Tonight']")) {
+			this.setMinMaxTemps(weather, foreGroup, 0, false, currentTemp);
+
+			this.setPrecipitation(weather, foreGroup, 0);
+
+			//
+			// Set the Element number that will reflect where the next day's forecast is located. Also set
+			// the Element number where the end of the forecast will be. This is important because of the
+			// rolling nature of the EC forecast. In the current scenario (only Current Tonight is present
+			// in Element 0, we know that we will have 6 full days of forecasts PLUS a half-day and
+			// forecast in the final element. Because we will only use full day forecasts, we set the
+			// lastDay number to ensure we ignore that final half-day (in forecast Element 11).
+			//
+
+			nextDay = 1;
+			lastDay = 11;
+		}
+
+		//
+		// Need to map EC weather icon to MM weatherType values. Always pick the first Element's icon to
+		// reflect either Today or Tonight depending on what the forecast is showing in Element 0.
+		//
+
+		weather.weatherType = this.convertWeatherType(foreGroup[0].querySelector("abbreviatedForecast iconCode").textContent);
+
+		// Push the weather object into the forecast array.
+
+		days.push(weather);
+
+		//
+		// Now do the the rest of the forecast starting at nextDay. We will process each day using 2 EC
+		// forecast Elements. This will address the fact that the EC forecast always includes Today and
+		// Tonight for each day. This is why we iterate through the forecast by a a count of 2, with each
+		// iteration looking at the current Element and the next Element.
+		//
+
+		let lastDate = moment(baseDate, "YYYYMMDDhhmmss");
+
+		for (let stepDay = nextDay; stepDay < lastDay; stepDay += 2) {
+			let weather = new WeatherObject(this.config.units, this.config.tempUnits, this.config.windUnits);
+
+			// Add 1 to the date to reflect the current forecast day we are building
+
+			lastDate = lastDate.add(1, "day");
+			weather.date = moment(lastDate, "X");
+
+			// Capture the temperatures for the current Element and the next Element in order to set
+			// the Min and Max temperatures for the forecast
+
+			this.setMinMaxTemps(weather, foreGroup, stepDay, true, currentTemp);
+
+			weather.rain = null;
+			weather.snow = null;
+			weather.precipitation = null;
+
+			this.setPrecipitation(weather, foreGroup, stepDay);
+
+			//
+			// Need to map EC weather icon to MM weatherType values. Always pick the first Element icon.
+			//
+
+			weather.weatherType = this.convertWeatherType(foreGroup[stepDay].querySelector("abbreviatedForecast iconCode").textContent);
+
+			// Push the weather object into the forecast array.
+
+			days.push(weather);
+		}
+
+		return days;
+	},
+
+	//
+	// Generate an array of WeatherObjects based on EC hourly weather forecast
+	//
+
+	generateWeatherObjectsFromHourly(ECdoc) {
+		// Declare an array to hold each hour's forecast object
+
+		const hours = [];
+
+		// Get local timezone UTC offset so that each hourly time can be calculated properly
+
+		const baseHours = ECdoc.querySelectorAll("siteData hourlyForecastGroup dateTime");
+		const hourOffset = baseHours[1].getAttribute("UTCOffset");
+
+		//
+		// The EC hourly forecast is held in a 24-element array - Elements 0 to 23 - with Element 0 holding
+		// the forecast for the next 'on the hour' timeslot. This means the array is a rolling 24 hours.
+		//
+
+		const hourGroup = ECdoc.querySelectorAll("siteData hourlyForecastGroup hourlyForecast");
+
+		for (let stepHour = 0; stepHour < 24; stepHour += 1) {
+			const weather = new WeatherObject(this.config.units, this.config.tempUnits, this.config.windUnits);
+
+			// Determine local time by applying UTC offset to the forecast timestamp
+
+			const foreTime = moment(hourGroup[stepHour].getAttribute("dateTimeUTC"), "YYYYMMDDhhmmss");
+			const currTime = foreTime.add(hourOffset, "hours");
+			weather.date = moment(currTime, "X");
+
+			// Capture the temperature
+
+			weather.temperature = this.convertTemp(hourGroup[stepHour].querySelector("temperature").textContent);
+
+			// Capture Likelihood of Precipitation (LOP) and unit-of-measure values
+
+			const precipLOP = hourGroup[stepHour].querySelector("lop").textContent * 1.0;
+
+			if (precipLOP > 0) {
+				weather.precipitation = precipLOP;
+				weather.precipitationUnits = hourGroup[stepHour].querySelector("lop").getAttribute("units");
+			}
+
+			//
+			// Need to map EC weather icon to MM weatherType values. Always pick the first Element icon.
+			//
+
+			weather.weatherType = this.convertWeatherType(hourGroup[stepHour].querySelector("iconCode").textContent);
+
+			// Push the weather object into the forecast array.
+
+			hours.push(weather);
+		}
+
+		return hours;
+	},
+	//
+	// Determine Min and Max temp based on a supplied Forecast Element index and a boolen that denotes if
+	// the next Forecast element should be considered - i.e. look at Today *and* Tonight vs.Tonight-only
+	//
+
+	setMinMaxTemps(weather, foreGroup, today, fullDay, currentTemp) {
+		const todayTemp = foreGroup[today].querySelector("temperatures temperature").textContent;
+
+		const todayClass = foreGroup[today].querySelector("temperatures temperature").getAttribute("class");
+
+		//
+		// The following logic is largely aimed at accommodating the Current day's forecast whereby we
+		// can have either Current Today+Current Tonight or only Current Tonight.
+		//
+		// If fullDay is false, then we only have Tonight for the current day's forecast - meaning we have
+		// lost a min or max temp value for the day. Therefore, we will see if we were able to cache the the
+		// Today forecast for the current day. If we have, we will use them. If we do not have the cached values,
+		// it means that MM or the Computer has been restarted since the time EC rolled off Today from the
+		// forecast. In this scenario, we will simply default to the Current Conditions temperature and then
+		// check the Tonight temperature.
+		//
+
+		if (fullDay === false) {
+			if (this.todayCached === true) {
+				weather.minTemperature = this.todayTempCacheMin;
+				weather.maxTemperature = this.todayTempCacheMax;
+			} else {
+				weather.minTemperature = this.convertTemp(currentTemp);
+				weather.maxTemperature = weather.minTemperature;
+			}
+		}
+
+		//
+		// We will check to see if the current Element's temperature is Low or High and set weather values
+		// accordingly. We will also check the condition where fullDay is true *and* we are looking at forecast
+		// element 0. This is a special case where we will cache temperature values so that we have them later
+		// in the current day when the Current Today element rolls off and we have Current Tonight only.
+		//
+
+		if (todayClass === "low") {
+			weather.minTemperature = this.convertTemp(todayTemp);
+			if (today === 0 && fullDay === true) {
+				this.todayTempCacheMin = weather.minTemperature;
+			}
+		}
+
+		if (todayClass === "high") {
+			weather.maxTemperature = this.convertTemp(todayTemp);
+			if (today === 0 && fullDay === true) {
+				this.todayTempCacheMax = weather.maxTemperature;
+			}
+		}
+
+		const nextTemp = foreGroup[today + 1].querySelector("temperatures temperature").textContent;
+
+		const nextClass = foreGroup[today + 1].querySelector("temperatures temperature").getAttribute("class");
+
+		if (fullDay === true) {
+			if (nextClass === "low") {
+				weather.minTemperature = this.convertTemp(nextTemp);
+			}
+
+			if (nextClass === "high") {
+				weather.maxTemperature = this.convertTemp(nextTemp);
+			}
+		}
+	},
+
+	//
+	// Check for a Precipitation forecast. EC can provide a forecast in 2 ways: either an accumulation figure
+	// or a POP percentage. If there is a POP, then that is what the module will show. If there is an accumulation,
+	// then it will be displayed ONLY if no POP is present.
+	//
+	// POP Logic: By default, we want to show the POP for 'daytime' since we are presuming that is what
+	// people are more interested in seeing. While EC provides a separate POP for daytime and nightime portions
+	// of each day, the weather module does not really allow for that view of a daily forecast. There we will
+	// ignore any nightime portion. There is an exception however! For the Current day, the EC data will only show
+	// the nightime forecast after a certain point in the afternoon. As such, we will be showing the nightime POP
+	// (if one exists) in that specific scenario.
+	//
+	// Accumulation Logic: Similar to POP, we want to show accumulation for 'daytime' since we presume that is what
+	// people are interested in seeing. While EC provides a separate accumulation for daytime and nightime portions
+	// of each day, the weather module does not really allow for that view of a daily forecast. There we will
+	// ignore any nightime portion. There is an exception however! For the Current day, the EC data will only show
+	// the nightime forecast after a certain point in that specific scenario.
+	//
+
+	setPrecipitation(weather, foreGroup, today) {
+		if (foreGroup[today].querySelector("precipitation accumulation")) {
+			weather.precipitation = foreGroup[today].querySelector("precipitation accumulation amount").textContent * 1.0;
+
+			weather.precipitationUnits = " " + foreGroup[today].querySelector("precipitation accumulation amount").getAttribute("units");
+
+			if (this.config.units === "imperial") {
+				if (weather.precipitationUnits === " cm") {
+					weather.precipitation = (weather.precipitation * 0.394).toFixed(2);
+					weather.precipitationUnits = " in";
+				}
+				if (weather.precipitationUnits === " mm") {
+					weather.precipitation = (weather.precipitation * 0.0394).toFixed(2);
+					weather.precipitationUnits = " in";
+				}
+			}
+		}
+
+		// Check Today element for POP
+
+		if (foreGroup[today].querySelector("abbreviatedForecast pop").textContent > 0) {
+			weather.precipitation = foreGroup[today].querySelector("abbreviatedForecast pop").textContent;
+			weather.precipitationUnits = foreGroup[today].querySelector("abbreviatedForecast pop").getAttribute("units");
+		}
+	},
+
+	//
+	// Unit conversions
+	//
+	//
+	// Convert C to F temps
+	//
+	convertTemp(temp) {
+		if (this.config.tempUnits === "imperial") {
+			return 1.8 * temp + 32;
+		} else {
+			return temp;
+		}
+	},
+
+	//
+	// Convert km/h to mph
+	//
+	convertWind(kilo) {
+		if (this.config.windUnits === "imperial") {
+			return kilo / 1.609344;
+		} else {
+			return kilo;
+		}
+	},
+
+	//
+	// Convert the icons to a more usable name.
+	//
+	convertWeatherType(weatherType) {
+		const weatherTypes = {
+			"00": "day-sunny",
+			"01": "day-sunny",
+			"02": "day-sunny-overcast",
+			"03": "day-cloudy",
+			"04": "day-cloudy",
+			"05": "day-cloudy",
+			"06": "day-sprinkle",
+			"07": "day-showers",
+			"08": "day-snow",
+			"09": "day-thunderstorm",
+			10: "cloud",
+			11: "showers",
+			12: "rain",
+			13: "rain",
+			14: "sleet",
+			15: "sleet",
+			16: "snow",
+			17: "snow",
+			18: "snow",
+			19: "thunderstorm",
+			20: "cloudy",
+			21: "cloudy",
+			22: "day-cloudy",
+			23: "day-haze",
+			24: "fog",
+			25: "snow-wind",
+			26: "sleet",
+			27: "sleet",
+			28: "rain",
+			29: "na",
+			30: "night-clear",
+			31: "night-clear",
+			32: "night-partly-cloudy",
+			33: "night-alt-cloudy",
+			34: "night-alt-cloudy",
+			35: "night-partly-cloudy",
+			36: "night-alt-showers",
+			37: "night-rain-mix",
+			38: "night-alt-snow",
+			39: "night-thunderstorm",
+			40: "snow-wind",
+			41: "tornado",
+			42: "tornado",
+			43: "windy",
+			44: "smoke",
+			45: "sandstorm",
+			46: "thunderstorm",
+			47: "thunderstorm",
+			48: "tornado"
+		};
+
+		return weatherTypes.hasOwnProperty(weatherType) ? weatherTypes[weatherType] : null;
+	}
+});

modules/default/weather/providers/openweathermap.js

@@ -1,6 +1,6 @@
 /* global WeatherProvider, WeatherObject */
 
-/* Magic Mirror
+/* MagicMirror²
  * Module: Weather
  *
  * By Michael Teeuw https://michaelteeuw.nl
@@ -18,10 +18,10 @@ WeatherProvider.register("openweathermap", {
 	defaults: {
 		apiVersion: "2.5",
 		apiBase: "https://api.openweathermap.org/data/",
-		weatherEndpoint: "",
+		weatherEndpoint: "", // can be "onecall", "forecast" or "weather" (for current)
 		locationID: false,
 		location: false,
-		lat: 0,
+		lat: 0, // the onecall endpoint needs lat / lon values, it doesn'T support the locationId
 		lon: 0,
 		apiKey: ""
 	},
@@ -30,16 +30,14 @@ WeatherProvider.register("openweathermap", {
 	fetchCurrentWeather() {
 		this.fetchData(this.getUrl())
 			.then((data) => {
-				if (!data || !data.main || typeof data.main.temp === "undefined") {
-					// Did not receive usable new data.
-					// Maybe this needs a better check?
-					return;
+				if (this.config.weatherEndpoint === "/onecall") {
+					const weatherData = this.generateWeatherObjectsFromOnecall(data);
+					this.setCurrentWeather(weatherData.current);
+					this.setFetchedLocation(`${data.timezone}`);
+				} else {
+					const currentWeather = this.generateWeatherObjectFromCurrentWeather(data);
+					this.setCurrentWeather(currentWeather);
 				}
-
-				this.setFetchedLocation(`${data.name}, ${data.sys.country}`);
-
-				const currentWeather = this.generateWeatherObjectFromCurrentWeather(data);
-				this.setCurrentWeather(currentWeather);
 			})
 			.catch(function (request) {
 				Log.error("Could not load data ... ", request);
@@ -51,16 +49,15 @@ WeatherProvider.register("openweathermap", {
 	fetchWeatherForecast() {
 		this.fetchData(this.getUrl())
 			.then((data) => {
-				if (!data || !data.list || !data.list.length) {
-					// Did not receive usable new data.
-					// Maybe this needs a better check?
-					return;
+				if (this.config.weatherEndpoint === "/onecall") {
+					const weatherData = this.generateWeatherObjectsFromOnecall(data);
+					this.setWeatherForecast(weatherData.days);
+					this.setFetchedLocation(`${data.timezone}`);
+				} else {
+					const forecast = this.generateWeatherObjectsFromForecast(data.list);
+					this.setWeatherForecast(forecast);
+					this.setFetchedLocation(`${data.city.name}, ${data.city.country}`);
 				}
-
-				this.setFetchedLocation(`${data.city.name}, ${data.city.country}`);
-
-				const forecast = this.generateWeatherObjectsFromForecast(data.list);
-				this.setWeatherForecast(forecast);
 			})
 			.catch(function (request) {
 				Log.error("Could not load data ... ", request);
@@ -92,7 +89,7 @@ WeatherProvider.register("openweathermap", {
 	/**
 	 * Overrides method for setting config to check if endpoint is correct for hourly
 	 *
-	 * @param config
+	 * @param {object} config The configuration object
 	 */
 	setConfig(config) {
 		this.config = config;
@@ -130,11 +127,8 @@ WeatherProvider.register("openweathermap", {
 
 		currentWeather.humidity = currentWeatherData.main.humidity;
 		currentWeather.temperature = currentWeatherData.main.temp;
-		if (this.config.windUnits === "metric") {
-			currentWeather.windSpeed = this.config.useKmh ? currentWeatherData.wind.speed * 3.6 : currentWeatherData.wind.speed;
-		} else {
-			currentWeather.windSpeed = currentWeatherData.wind.speed;
-		}
+		currentWeather.feelsLikeTemp = currentWeatherData.main.feels_like;
+		currentWeather.windSpeed = currentWeatherData.wind.speed;
 		currentWeather.windDirection = currentWeatherData.wind.deg;
 		currentWeather.weatherType = this.convertWeatherType(currentWeatherData.weather[0].icon);
 		currentWeather.sunrise = moment(currentWeatherData.sys.sunrise, "X");

modules/default/weather/providers/smhi.js

@@ -1,15 +1,14 @@
-/* global WeatherProvider, WeatherObject, SunCalc */
+/* global WeatherProvider, WeatherObject */
 
-/* Magic Mirror
+/* MagicMirror²
  * Module: Weather
  * Provider: SMHI
  *
  * By BuXXi https://github.com/buxxi
  * MIT Licensed
  *
- * This class is a provider for SMHI (Sweden only).
- * Note that SMHI doesn't provide sunrise and sundown, use SunCalc to calculate it.
- * Metric system is the only supported unit.
+ * This class is a provider for SMHI (Sweden only). Metric system is the only
+ * supported unit.
  */
 WeatherProvider.register("smhi", {
 	providerName: "SMHI",
@@ -56,11 +55,11 @@ WeatherProvider.register("smhi", {
 	/**
 	 * Overrides method for setting config with checks for the precipitationValue being unset or invalid
 	 *
-	 * @param config
+	 * @param {object} config The configuration object
 	 */
 	setConfig(config) {
 		this.config = config;
-		if (!config.precipitationValue || ["pmin", "pmean", "pmedian", "pmax"].indexOf(config.precipitationValue) == -1) {
+		if (!config.precipitationValue || ["pmin", "pmean", "pmedian", "pmax"].indexOf(config.precipitationValue) === -1) {
 			console.log("invalid or not set: " + config.precipitationValue);
 			config.precipitationValue = this.defaults.precipitationValue;
 		}
@@ -69,12 +68,13 @@ WeatherProvider.register("smhi", {
 	/**
 	 * Of all the times returned find out which one is closest to the current time, should be the first if the data isn't old.
 	 *
-	 * @param times
+	 * @param {object[]} times Array of time objects
+	 * @returns {object} The weatherdata closest to the current time
 	 */
 	getClosestToCurrentTime(times) {
 		let now = moment();
 		let minDiff = undefined;
-		for (time of times) {
+		for (const time of times) {
 			let diff = Math.abs(moment(time.validTime).diff(now));
 			if (!minDiff || diff < Math.abs(moment(minDiff.validTime).diff(now))) {
 				minDiff = time;
@@ -85,6 +85,8 @@ WeatherProvider.register("smhi", {
 
 	/**
 	 * Get the forecast url for the configured coordinates
+	 *
+	 * @returns {string} the url for the specified coordinates
 	 */
 	getURL() {
 		let lon = this.config.lon;
@@ -97,25 +99,25 @@ WeatherProvider.register("smhi", {
 	 * The returned units is always in metric system.
 	 * Requires coordinates to determine if its daytime or nighttime to know which icon to use and also to set sunrise and sunset.
 	 *
-	 * @param weatherData
-	 * @param coordinates
-	 * @param weatherData
-	 * @param coordinates
+	 * @param {object} weatherData Weatherdata to convert
+	 * @param {object} coordinates Coordinates of the locations of the weather
+	 * @returns {WeatherObject} The converted weatherdata at the specified location
 	 */
 	convertWeatherDataToObject(weatherData, coordinates) {
-		let currentWeather = new WeatherObject("metric", "metric", "metric"); //Weather data is only for Sweden and nobody in Sweden would use imperial
+		// Weather data is only for Sweden and nobody in Sweden would use imperial
+		let currentWeather = new WeatherObject("metric", "metric", "metric");
 
 		currentWeather.date = moment(weatherData.validTime);
-		let times = SunCalc.getTimes(currentWeather.date.toDate(), coordinates.lat, coordinates.lon);
-		currentWeather.sunrise = moment(times.sunrise, "X");
-		currentWeather.sunset = moment(times.sunset, "X");
+		currentWeather.updateSunTime(coordinates.lat, coordinates.lon);
 		currentWeather.humidity = this.paramValue(weatherData, "r");
 		currentWeather.temperature = this.paramValue(weatherData, "t");
 		currentWeather.windSpeed = this.paramValue(weatherData, "ws");
 		currentWeather.windDirection = this.paramValue(weatherData, "wd");
-		currentWeather.weatherType = this.convertWeatherType(this.paramValue(weatherData, "Wsymb2"), this.isDayTime(currentWeather));
+		currentWeather.weatherType = this.convertWeatherType(this.paramValue(weatherData, "Wsymb2"), currentWeather.isDayTime());
 
-		//Determine the precipitation amount and category and update the weatherObject with it, the valuetype to use can be configured or uses median as default.
+		// Determine the precipitation amount and category and update the
+		// weatherObject with it, the valuetype to use can be configured or uses
+		// median as default.
 		let precipitationValue = this.paramValue(weatherData, this.config.precipitationValue);
 		switch (this.paramValue(weatherData, "pcat")) {
 			// 0 = No precipitation
@@ -143,19 +145,18 @@ WeatherProvider.register("smhi", {
 	/**
 	 * Takes all of the data points and converts it to one WeatherObject per day.
 	 *
-	 * @param allWeatherData
-	 * @param coordinates
-	 * @param allWeatherData
-	 * @param coordinates
+	 * @param {object[]} allWeatherData Array of weatherdata
+	 * @param {object} coordinates Coordinates of the locations of the weather
+	 * @returns {WeatherObject[]} Array of weatherobjects
 	 */
 	convertWeatherDataGroupedByDay(allWeatherData, coordinates) {
-		var currentWeather;
+		let currentWeather;
 		let result = [];
 
 		let allWeatherObjects = this.fillInGaps(allWeatherData).map((weatherData) => this.convertWeatherDataToObject(weatherData, coordinates));
-		var dayWeatherTypes = [];
+		let dayWeatherTypes = [];
 
-		for (weatherObject of allWeatherObjects) {
+		for (const weatherObject of allWeatherObjects) {
 			//If its the first object or if a day change we need to reset the summary object
 			if (!currentWeather || !currentWeather.date.isSame(weatherObject.date, "day")) {
 				currentWeather = new WeatherObject(this.config.units, this.config.tempUnits, this.config.windUnits);
@@ -170,7 +171,7 @@ WeatherProvider.register("smhi", {
 			}
 
 			//Keep track of what icons has been used for each hour of daytime and use the middle one for the forecast
-			if (this.isDayTime(weatherObject)) {
+			if (weatherObject.isDayTime()) {
 				dayWeatherTypes.push(weatherObject.weatherType);
 			}
 			if (dayWeatherTypes.length > 0) {
@@ -191,37 +192,31 @@ WeatherProvider.register("smhi", {
 	},
 
 	/**
-	 * Resolve coordinates from the response data (probably preferably to use this if it's not matching the config values exactly)
+	 * Resolve coordinates from the response data (probably preferably to use
+	 * this if it's not matching the config values exactly)
 	 *
-	 * @param data
+	 * @param {object} data Response data from the weather service
+	 * @returns {{lon, lat}} the lat/long coordinates of the data
 	 */
 	resolveCoordinates(data) {
 		return { lat: data.geometry.coordinates[0][1], lon: data.geometry.coordinates[0][0] };
 	},
 
-	/**
-	 * Checks if the weatherObject is at dayTime.
-	 *
-	 * @param weatherObject
-	 */
-	isDayTime(weatherObject) {
-		return weatherObject.date.isBetween(weatherObject.sunrise, weatherObject.sunset, undefined, "[]");
-	},
-
 	/**
 	 * The distance between the data points is increasing in the data the more distant the prediction is.
 	 * Find these gaps and fill them with the previous hours data to make the data returned a complete set.
 	 *
-	 * @param data
+	 * @param {object[]} data Response data from the weather service
+	 * @returns {object[]} Given data with filled gaps
 	 */
 	fillInGaps(data) {
 		let result = [];
-		for (var i = 1; i < data.length; i++) {
+		for (let i = 1; i < data.length; i++) {
 			let to = moment(data[i].validTime);
 			let from = moment(data[i - 1].validTime);
 			let hours = moment.duration(to.diff(from)).asHours();
 			// For each hour add a datapoint but change the validTime
-			for (var j = 0; j < hours; j++) {
+			for (let j = 0; j < hours; j++) {
 				let current = Object.assign({}, data[i]);
 				current.validTime = from.clone().add(j, "hours").toISOString();
 				result.push(current);
@@ -231,84 +226,81 @@ WeatherProvider.register("smhi", {
 	},
 
 	/**
-	 * Helper method to fetch a property from the returned data set.
-	 * The returned values is an array with always one value in it.
+	 * Helper method to get a property from the returned data set.
 	 *
-	 * @param currentWeatherData
-	 * @param name
-	 * @param currentWeatherData
-	 * @param name
+	 * @param {object} currentWeatherData Weatherdata to get from
+	 * @param {string} name The name of the property
+	 * @returns {*} The value of the property in the weatherdata
 	 */
 	paramValue(currentWeatherData, name) {
-		return currentWeatherData.parameters.filter((p) => p.name == name).flatMap((p) => p.values)[0];
+		return currentWeatherData.parameters.filter((p) => p.name === name).flatMap((p) => p.values)[0];
 	},
 
 	/**
-	 * Map the icon value from SHMI to an icon that MagicMirror understands.
+	 * Map the icon value from SMHI to an icon that MagicMirror² understands.
 	 * Uses different icons depending if its daytime or nighttime.
-	 * SHMI's description of what the numeric value means is the comment after the case.
+	 * SMHI's description of what the numeric value means is the comment after the case.
 	 *
-	 * @param input
-	 * @param isDayTime
-	 * @param input
-	 * @param isDayTime
+	 * @param {number} input The SMHI icon value
+	 * @param {boolean} isDayTime True if the icon should be for daytime, false for nighttime
+	 * @returns {string} The icon name for the MagicMirror
 	 */
 	convertWeatherType(input, isDayTime) {
 		switch (input) {
 			case 1:
 				return isDayTime ? "day-sunny" : "night-clear"; // Clear sky
 			case 2:
-				return isDayTime ? "day-sunny-overcast" : "night-partly-cloudy"; //Nearly clear sky
+				return isDayTime ? "day-sunny-overcast" : "night-partly-cloudy"; // Nearly clear sky
 			case 3:
-				return isDayTime ? "day-cloudy" : "night-cloudy"; //Variable cloudiness
+				return isDayTime ? "day-cloudy" : "night-cloudy"; // Variable cloudiness
 			case 4:
-				return isDayTime ? "day-cloudy" : "night-cloudy"; //Halfclear sky
+				return isDayTime ? "day-cloudy" : "night-cloudy"; // Halfclear sky
 			case 5:
-				return "cloudy"; //Cloudy sky
+				return "cloudy"; // Cloudy sky
 			case 6:
-				return "cloudy"; //Overcast
+				return "cloudy"; // Overcast
 			case 7:
-				return "fog"; //Fog
+				return "fog"; // Fog
 			case 8:
-				return "showers"; //Light rain showers
+				return "showers"; // Light rain showers
 			case 9:
-				return "showers"; //Moderate rain showers
+				return "showers"; // Moderate rain showers
 			case 10:
-				return "showers"; //Heavy rain showers
+				return "showers"; // Heavy rain showers
 			case 11:
-				return "thunderstorm"; //Thunderstorm
+				return "thunderstorm"; // Thunderstorm
 			case 12:
-				return "sleet"; //Light sleet showers
+				return "sleet"; // Light sleet showers
 			case 13:
-				return "sleet"; //Moderate sleet showers
+				return "sleet"; // Moderate sleet showers
 			case 14:
-				return "sleet"; //Heavy sleet showers
+				return "sleet"; // Heavy sleet showers
 			case 15:
-				return "snow"; //Light snow showers
+				return "snow"; // Light snow showers
 			case 16:
-				return "snow"; //Moderate snow showers
+				return "snow"; // Moderate snow showers
 			case 17:
-				return "snow"; //Heavy snow showers
+				return "snow"; // Heavy snow showers
 			case 18:
-				return "rain"; //Light rain
+				return "rain"; // Light rain
 			case 19:
-				return "rain"; //Moderate rain
+				return "rain"; // Moderate rain
 			case 20:
-				return "rain"; //Heavy rain
+				return "rain"; // Heavy rain
 			case 21:
-				return "thunderstorm"; //Thunder
+				return "thunderstorm"; // Thunder
 			case 22:
 				return "sleet"; // Light sleet
 			case 23:
-				return "sleet"; //Moderate sleet
+				return "sleet"; // Moderate sleet
 			case 24:
 				return "sleet"; // Heavy sleet
 			case 25:
 				return "snow"; // Light snowfall
 			case 26:
-				return "snow"; //Moderate snowfall
+				return "snow"; // Moderate snowfall
 			case 27:
-				return "snow"; //Heavy snowfall
+				return "snow"; // Heavy snowfall
 			default:
 				return "";
 		}

modules/default/weather/providers/ukmetoffice.js

@@ -1,6 +1,6 @@
-/* global WeatherProvider, WeatherObject, SunCalc */
+/* global WeatherProvider, WeatherObject */
 
-/* Magic Mirror
+/* MagicMirror²
  * Module: Weather
  *
  * By Malcolm Oakes https://github.com/maloakes
@@ -81,6 +81,7 @@ WeatherProvider.register("ukmetoffice", {
 	 */
 	generateWeatherObjectFromCurrentWeather(currentWeatherData) {
 		const currentWeather = new WeatherObject(this.config.units, this.config.tempUnits, this.config.windUnits, this.config.useKmh);
+		const location = currentWeatherData.SiteRep.DV.Location;
 
 		// data times are always UTC
 		let nowUtc = moment.utc();
@@ -88,8 +89,8 @@ WeatherProvider.register("ukmetoffice", {
 		let timeInMins = nowUtc.diff(midnightUtc, "minutes");
 
 		// loop round each of the (5) periods, look for today (the first period may be yesterday)
-		for (var i in currentWeatherData.SiteRep.DV.Location.Period) {
-			let periodDate = moment.utc(currentWeatherData.SiteRep.DV.Location.Period[i].value.substr(0, 10), "YYYY-MM-DD");
+		for (const period of location.Period) {
+			const periodDate = moment.utc(period.value.substr(0, 10), "YYYY-MM-DD");
 
 			// ignore if period is before today
 			if (periodDate.isSameOrAfter(moment.utc().startOf("day"))) {
@@ -97,17 +98,17 @@ WeatherProvider.register("ukmetoffice", {
 				if (moment().diff(periodDate, "minutes") > 0) {
 					// loop round the reports looking for the one we are in
 					// $ value specifies the time in minutes-of-the-day: 0, 180, 360,...1260
-					for (var j in currentWeatherData.SiteRep.DV.Location.Period[i].Rep) {
-						let p = currentWeatherData.SiteRep.DV.Location.Period[i].Rep[j].$;
+					for (const rep of period.Rep) {
+						const p = rep.$;
 						if (timeInMins >= p && timeInMins - 180 < p) {
 							// finally got the one we want, so populate weather object
-							currentWeather.humidity = currentWeatherData.SiteRep.DV.Location.Period[i].Rep[j].H;
-							currentWeather.temperature = this.convertTemp(currentWeatherData.SiteRep.DV.Location.Period[i].Rep[j].T);
-							currentWeather.feelsLikeTemp = this.convertTemp(currentWeatherData.SiteRep.DV.Location.Period[i].Rep[j].F);
-							currentWeather.precipitation = parseInt(currentWeatherData.SiteRep.DV.Location.Period[i].Rep[j].Pp);
-							currentWeather.windSpeed = this.convertWindSpeed(currentWeatherData.SiteRep.DV.Location.Period[i].Rep[j].S);
-							currentWeather.windDirection = this.convertWindDirection(currentWeatherData.SiteRep.DV.Location.Period[i].Rep[j].D);
-							currentWeather.weatherType = this.convertWeatherType(currentWeatherData.SiteRep.DV.Location.Period[i].Rep[j].W);
+							currentWeather.humidity = rep.H;
+							currentWeather.temperature = this.convertTemp(rep.T);
+							currentWeather.feelsLikeTemp = this.convertTemp(rep.F);
+							currentWeather.precipitation = parseInt(rep.Pp);
+							currentWeather.windSpeed = this.convertWindSpeed(rep.S);
+							currentWeather.windDirection = this.convertWindDirection(rep.D);
+							currentWeather.weatherType = this.convertWeatherType(rep.W);
 						}
 					}
 				}
@@ -115,9 +116,7 @@ WeatherProvider.register("ukmetoffice", {
 		}
 
 		// determine the sunrise/sunset times - not supplied in UK Met Office data
-		let times = this.calcAstroData(currentWeatherData.SiteRep.DV.Location);
-		currentWeather.sunrise = times[0];
-		currentWeather.sunset = times[1];
+		currentWeather.updateSunTime(location.lat, location.lon);
 
 		return currentWeather;
 	},
@@ -130,21 +129,21 @@ WeatherProvider.register("ukmetoffice", {
 
 		// loop round the (5) periods getting the data
 		// for each period array, Day is [0], Night is [1]
-		for (var j in forecasts.SiteRep.DV.Location.Period) {
+		for (const period of forecasts.SiteRep.DV.Location.Period) {
 			const weather = new WeatherObject(this.config.units, this.config.tempUnits, this.config.windUnits, this.config.useKmh);
 
 			// data times are always UTC
-			const dateStr = forecasts.SiteRep.DV.Location.Period[j].value;
+			const dateStr = period.value;
 			let periodDate = moment.utc(dateStr.substr(0, 10), "YYYY-MM-DD");
 
 			// ignore if period is before today
 			if (periodDate.isSameOrAfter(moment.utc().startOf("day"))) {
 				// populate the weather object
 				weather.date = moment.utc(dateStr.substr(0, 10), "YYYY-MM-DD");
-				weather.minTemperature = this.convertTemp(forecasts.SiteRep.DV.Location.Period[j].Rep[1].Nm);
-				weather.maxTemperature = this.convertTemp(forecasts.SiteRep.DV.Location.Period[j].Rep[0].Dm);
-				weather.weatherType = this.convertWeatherType(forecasts.SiteRep.DV.Location.Period[j].Rep[0].W);
-				weather.precipitation = parseInt(forecasts.SiteRep.DV.Location.Period[j].Rep[0].PPd);
+				weather.minTemperature = this.convertTemp(period.Rep[1].Nm);
+				weather.maxTemperature = this.convertTemp(period.Rep[0].Dm);
+				weather.weatherType = this.convertWeatherType(period.Rep[0].W);
+				weather.precipitation = parseInt(period.Rep[0].PPd);
 
 				days.push(weather);
 			}
@@ -153,20 +152,6 @@ WeatherProvider.register("ukmetoffice", {
 		return days;
 	},
 
-	/*
-	 * calculate the astronomical data
-	 */
-	calcAstroData(location) {
-		const sunTimes = [];
-
-		// determine the sunrise/sunset times
-		let times = SunCalc.getTimes(new Date(), location.lat, location.lon);
-		sunTimes.push(moment(times.sunrise, "X"));
-		sunTimes.push(moment(times.sunset, "X"));
-
-		return sunTimes;
-	},
-
 	/*
 	 * Convert the Met Office icons to a more usable name.
 	 */
@@ -247,16 +232,16 @@ WeatherProvider.register("ukmetoffice", {
 		return windCardinals.hasOwnProperty(windDirection) ? windCardinals[windDirection] : null;
 	},
 
-	/*
+	/**
 	 * Generates an url with api parameters based on the config.
 	 *
-	 * return String - URL params.
+	 * @param {string} forecastType daily or 3hourly forecast
+	 * @returns {string} url
 	 */
 	getParams(forecastType) {
 		let params = "?";
 		params += "res=" + forecastType;
 		params += "&key=" + this.config.apiKey;
-
 		return params;
 	}
 });

modules/default/weather/providers/ukmetofficedatahub.js

@@ -1,4 +1,6 @@
-/* Magic Mirror
+/* global WeatherProvider, WeatherObject */
+
+/* MagicMirror²
  * Module: Weather
  *
  * By Malcolm Oakes https://github.com/maloakes
@@ -11,9 +13,8 @@
  * 		Hourly data for next 2 days ("hourly") - https://www.metoffice.gov.uk/binaries/content/assets/metofficegovuk/pdf/data/global-spot-data-hourly.pdf
  * 		3-hourly data for the next 7 days ("3hourly") - https://www.metoffice.gov.uk/binaries/content/assets/metofficegovuk/pdf/data/global-spot-data-3-hourly.pdf
  * 		Daily data for the next 7 days ("daily") - https://www.metoffice.gov.uk/binaries/content/assets/metofficegovuk/pdf/data/global-spot-data-daily.pdf
- */
-
-/* NOTES
+ *
+ * NOTES
  * This provider requires longitude/latitude coordinates, rather than a location ID (as with the previous Met Office provider)
  * Provide the following in your config.js file:
  * 		weatherProvider: "ukmetofficedatahub",
@@ -59,9 +60,7 @@ WeatherProvider.register("ukmetofficedatahub", {
 		let queryStrings = "?";
 		queryStrings += "latitude=" + this.config.lat;
 		queryStrings += "&longitude=" + this.config.lon;
-		if (this.config.appendLocationNameToHeader) {
-			queryStrings += "&includeLocationName=" + true;
-		}
+		queryStrings += "&includeLocationName=" + true;
 
 		// Return URL, making sure there is a trailing "/" in the base URL.
 		return this.config.apiBase + (this.config.apiBase.endsWith("/") ? "" : "/") + forecastType + queryStrings;
@@ -71,13 +70,11 @@ WeatherProvider.register("ukmetofficedatahub", {
 	// For DataHub requests, the API key/secret are sent in the headers rather than as query strings.
 	// Headers defined according to Data Hub API (https://metoffice.apiconnect.ibmcloud.com/metoffice/production/api)
 	getHeaders() {
-		let headers = {
+		return {
 			accept: "application/json",
 			"x-ibm-client-id": this.config.apiKey,
 			"x-ibm-client-secret": this.config.apiSecret
 		};
-
-		return headers;
 	},
 
 	// Fetch data using supplied URL and request headers
@@ -93,7 +90,7 @@ WeatherProvider.register("ukmetofficedatahub", {
 		this.fetchWeather(this.getUrl("hourly"), this.getHeaders())
 			.then((data) => {
 				// Check data is useable
-				if (!data || !data.features || !data.features[0].properties || !data.features[0].properties.timeSeries || data.features[0].properties.timeSeries.length == 0) {
+				if (!data || !data.features || !data.features[0].properties || !data.features[0].properties.timeSeries || data.features[0].properties.timeSeries.length === 0) {
 					// Did not receive usable new data.
 					// Maybe this needs a better check?
 					Log.error("Possibly bad current/hourly data?");
@@ -127,7 +124,7 @@ WeatherProvider.register("ukmetofficedatahub", {
 		let nowUtc = moment.utc();
 
 		// Find hour that contains the current time
-		for (hour in forecastDataHours) {
+		for (let hour in forecastDataHours) {
 			let forecastTime = moment.utc(forecastDataHours[hour].time);
 			if (nowUtc.isSameOrAfter(forecastTime) && nowUtc.isBefore(moment(forecastTime.add(1, "h")))) {
 				currentWeather.date = forecastTime;
@@ -150,11 +147,9 @@ WeatherProvider.register("ukmetofficedatahub", {
 		}
 
 		// Determine the sunrise/sunset times - (still) not supplied in UK Met Office data
-		// Passes {longitude, latitude, height} to calcAstroData
-		// Could just pass lat/long from this.config, but returned data from MO also contains elevation
-		let times = this.calcAstroData(currentWeatherData.features[0].geometry.coordinates);
-		currentWeather.sunrise = times[0];
-		currentWeather.sunset = times[1];
+		// Passes {longitude, latitude} to SunCalc, could pass height to, but
+		// SunCalc.getTimes doesnt take that into account
+		currentWeather.updateSunTime(this.config.lat, this.config.lon);
 
 		return currentWeather;
 	},
@@ -164,7 +159,7 @@ WeatherProvider.register("ukmetofficedatahub", {
 		this.fetchWeather(this.getUrl("daily"), this.getHeaders())
 			.then((data) => {
 				// Check data is useable
-				if (!data || !data.features || !data.features[0].properties || !data.features[0].properties.timeSeries || data.features[0].properties.timeSeries.length == 0) {
+				if (!data || !data.features || !data.features[0].properties || !data.features[0].properties.timeSeries || data.features[0].properties.timeSeries.length === 0) {
 					// Did not receive usable new data.
 					// Maybe this needs a better check?
 					Log.error("Possibly bad forecast data?");
@@ -198,7 +193,7 @@ WeatherProvider.register("ukmetofficedatahub", {
 		let today = moment.utc().startOf("date");
 
 		// Go through each day in the forecasts
-		for (day in forecastDataDays) {
+		for (let day in forecastDataDays) {
 			const forecastWeather = new WeatherObject(this.config.units, this.config.tempUnits, this.config.windUnits, this.config.useKmh);
 
 			// Get date of forecast
@@ -223,7 +218,6 @@ WeatherProvider.register("ukmetofficedatahub", {
 
 				// Pass on full details so they can be used in custom templates
 				// Note the units of the supplied data when using this (see top of file)
-
 				forecastWeather.rawData = forecastDataDays[day];
 
 				dailyForecasts.push(forecastWeather);
@@ -238,18 +232,6 @@ WeatherProvider.register("ukmetofficedatahub", {
 		this.fetchedLocationName = name;
 	},
 
-	// Calculate sunrise/sunset times
-	calcAstroData(location) {
-		const sunTimes = [];
-
-		// Careful to pass values to SunCalc in correct order (latitude, longitude, elevation)
-		let times = SunCalc.getTimes(new Date(), location[1], location[0], location[2]);
-		sunTimes.push(moment(times.sunrise, "X"));
-		sunTimes.push(moment(times.sunset, "X"));
-
-		return sunTimes;
-	},
-
 	// Convert temperatures to Fahrenheit (from degrees C), if required
 	convertTemp(tempInC) {
 		return this.config.tempUnits === "imperial" ? (tempInC * 9) / 5 + 32 : tempInC;
@@ -260,11 +242,11 @@ WeatherProvider.register("ukmetofficedatahub", {
 	// To use kilometres per hour, use "kph"
 	// Else assumed imperial and the value is returned in miles per hour (a Met Office user is likely to be UK-based)
 	convertWindSpeed(windInMpS) {
-		if (this.config.windUnits == "mps") {
+		if (this.config.windUnits === "mps") {
 			return windInMpS;
 		}
 
-		if (this.config.windUnits == "kph" || this.config.windUnits == "metric" || this.config.useKmh) {
+		if (this.config.windUnits === "kph" || this.config.windUnits === "metric" || this.config.useKmh) {
 			return windInMpS * 3.6;
 		}
 

modules/default/weather/providers/weatherbit.js

@@ -1,13 +1,14 @@
 /* global WeatherProvider, WeatherObject */
 
-/* Magic Mirror
+/* MagicMirror²
  * Module: Weather
  * Provider: Weatherbit
  *
  * By Andrew Pometti
  * MIT Licensed
  *
- * This class is a provider for Weatherbit, based on Nicholas Hubbard's class for Dark Sky & Vince Peri's class for Weather.gov.
+ * This class is a provider for Weatherbit, based on Nicholas Hubbard's class
+ * for Dark Sky & Vince Peri's class for Weather.gov.
  */
 WeatherProvider.register("weatherbit", {
 	// Set the name of the provider.
@@ -89,7 +90,6 @@ WeatherProvider.register("weatherbit", {
 		currentWeather.windSpeed = parseFloat(currentWeatherData.data[0].wind_spd);
 		currentWeather.windDirection = currentWeatherData.data[0].wind_dir;
 		currentWeather.weatherType = this.convertWeatherType(currentWeatherData.data[0].weather.icon);
-		Log.log("Wx Icon: " + currentWeatherData.data[0].weather.icon);
 		currentWeather.sunrise = moment(currentWeatherData.data[0].sunrise, "HH:mm").add(tzOffset, "m");
 		currentWeather.sunset = moment(currentWeatherData.data[0].sunset, "HH:mm").add(tzOffset, "m");