Release 2.31.0 (#3758)

Thanks to: @Developer-Incoming, @eltociear, @geraki, @khassel,
@KristjanESPERANTO, @MagMar94, @mixasgr, @n8many, @OWL4C, @rejas,
@savvadam, @sdetweil.

> ⚠️ This release needs nodejs version `v22.14.0 or higher`

### Added

- Add CSS support to the digital clock hour/minute/second through the
use of the classes `clock-hour-digital`, `clock-minute-digital`, and
`clock-second-digital`.
- Add Arabic (#3719) and Esperanto translation.
- Mark option `secondsColor` as deprecated in clock module.
- Add Greek translation to Alerts module.
- [newsfeed] Add specific ignoreOlderThan value (override) per feed
(#3360)
- [weather] Added option Humidity to hourly View
- [weather] Added option to hide hourly entries that are Zero, hiding
the entire column if empty.
- [updatenotification] Added option to iterate over modules directory
instead using modules defined in `config.js` (#3739)

### Changed

- [core] starting clientonly now checks for needed env var
`WAYLAND_DISPLAY` or `DISPLAY` and starts electron with needed
parameters (if both are set wayland is used) (#3677)
- [core] Optimize systeminformation calls and output (#3689)
- [core] Add issue templates for feature requests and bug reports
(#3695)
- [core] Adapt `start:x11:dev` script
- [weather/yr] The Yr weather provider now enforces a minimum
`updateInterval` of 600 000 ms (10 minutes) to comply with the terms of
service. If a lower value is set, it will be automatically increased to
this minimum.
- [weather/weatherflow] Fixed icons and added hourly support as well as
UV, precipitation, and location name support.
- [workflow] Run `sudo apt-get update` before installing packages to
avoid install errors
- [workflow] Exclude issues with label `ready (coming with next
release)` from stale job

### Removed

### Updated

- [core] Update requirements and dependencies including electron to v35
and formatting (#3593, #3693, #3717)
- [core] Update prettier, ESLint and simplify config
- Update Greek translation

### Fixed

- [calendar] Fix clipping events being broadcast (#3678)
- [tests] Fix Electron tests by running them under new github image
ubuntu-24.04, replace xserver with labwc, running under xserver and
labwc depending on env variable WAYLAND_DISPLAY is set (#3676)
- [calendar] Fix arrayed symbols, #3267, again, add testcase, add
testcase for #3678
- [weather] Fix wrong weatherCondition name in openmeteo provider which
lead to n/a icon (#3691)
- [core] Fix wrong port in log message when starting server only (#3696)
- [calendar] Fix NewYork event processed on system in Central timezone
shows wrong time #3701
- [weather/yr] The Yr weather provider is now able to recover from bad
API responses instead of freezing (#3296)
- [compliments] Fix evening events being shown during the day (#3727)
- [weather] Fixed minor spacing issues when using UV Index in Hourly
- [workflow] Fix command to run spellcheck

---------

Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: Michael Teeuw <michael@xonaymedia.nl>
Co-authored-by: Kristjan ESPERANTO <35647502+KristjanESPERANTO@users.noreply.github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
Co-authored-by: Karsten Hassel <hassel@gmx.de>
Co-authored-by: Ross Younger <crazyscot@gmail.com>
Co-authored-by: Bugsounet - Cédric <github@bugsounet.fr>
Co-authored-by: jkriegshauser <joshuakr@nvidia.com>
Co-authored-by: illimarkangur <116028111+illimarkangur@users.noreply.github.com>
Co-authored-by: sam detweiler <sdetweil@gmail.com>
Co-authored-by: vppencilsharpener <tim.pray@gmail.com>
Co-authored-by: Paranoid93 <6515818+Paranoid93@users.noreply.github.com>
Co-authored-by: Brian O'Connor <btoconnor@users.noreply.github.com>
Co-authored-by: WallysWellies <59727507+WallysWellies@users.noreply.github.com>
Co-authored-by: Jason Stieber <jrstieber@gmail.com>
Co-authored-by: jargordon <50050429+jargordon@users.noreply.github.com>
Co-authored-by: Daniel <32464403+dkallen78@users.noreply.github.com>
Co-authored-by: Ryan Williams <65094007+ryan-d-williams@users.noreply.github.com>
Co-authored-by: Panagiotis Skias <panagiotis.skias@gmail.com>
Co-authored-by: Marc Landis <dirk.rettschlag@gmail.com>
Co-authored-by: HeikoGr <20295490+HeikoGr@users.noreply.github.com>
Co-authored-by: Pedro Lamas <pedrolamas@gmail.com>
Co-authored-by: veeck <gitkraken@veeck.de>
Co-authored-by: Magnus <34011212+MagMar94@users.noreply.github.com>
Co-authored-by: Ikko Eltociear Ashimine <eltociear@gmail.com>
Co-authored-by: DevIncomin <56730075+Developer-Incoming@users.noreply.github.com>
Co-authored-by: Nathan <n8nyoung@gmail.com>
Co-authored-by: mixasgr <mixasgr@users.noreply.github.com>
Co-authored-by: Savvas Adamtziloglou <savvas-gr@greeklug.gr>
Co-authored-by: Konstantinos <geraki@gmail.com>
Co-authored-by: OWL4C <124401812+OWL4C@users.noreply.github.com>

.eslintignore

@@ -1,2 +0,0 @@
-modules/*
-!modules/default/

.eslintrc.json

@@ -1,93 +0,0 @@
-{
-	"extends": ["eslint:recommended", "plugin:@stylistic/all-extends", "plugin:import/recommended", "plugin:jest/recommended", "plugin:jsdoc/recommended"],
-	"plugins": ["unicorn"],
-	"env": {
-		"browser": true,
-		"es2024": true,
-		"jest/globals": true,
-		"node": true
-	},
-	"globals": {
-		"config": true,
-		"Log": true,
-		"MM": true,
-		"Module": true,
-		"moment": true
-	},
-	"parserOptions": {
-		"sourceType": "module",
-		"ecmaVersion": "latest",
-		"ecmaFeatures": {
-			"globalReturn": true
-		}
-	},
-	"rules": {
-		"eqeqeq": "error",
-		"import/order": "error",
-		"import/extensions": "error",
-		"import/newline-after-import": "error",
-		"jest/consistent-test-it": "warn",
-		"jest/expect-expect": "warn",
-		"jest/no-done-callback": "warn",
-		"jest/prefer-expect-resolves": "warn",
-		"jest/prefer-mock-promise-shorthand": "warn",
-		"jest/prefer-to-be": "warn",
-		"jest/prefer-to-have-length": "warn",
-		"no-param-reassign": "error",
-		"no-prototype-builtins": "off",
-		"no-throw-literal": "error",
-		"no-unused-vars": "off",
-		"no-useless-return": "error",
-		"object-shorthand": ["error", "methods"],
-		"prefer-template": "error",
-		"@stylistic/array-element-newline": ["error", "consistent"],
-		"@stylistic/arrow-parens": ["error", "always"],
-		"@stylistic/brace-style": "off",
-		"@stylistic/comma-dangle": ["error", "never"],
-		"@stylistic/dot-location": ["error", "property"],
-		"@stylistic/function-call-argument-newline": ["error", "consistent"],
-		"@stylistic/function-paren-newline": ["error", "consistent"],
-		"@stylistic/implicit-arrow-linebreak": ["error", "beside"],
-		"@stylistic/max-statements-per-line": ["error", { "max": 2 }],
-		"@stylistic/multiline-ternary": ["error", "always-multiline"],
-		"@stylistic/newline-per-chained-call": ["error", { "ignoreChainWithDepth": 4 }],
-		"@stylistic/no-extra-parens": "off",
-		"@stylistic/no-tabs": "off",
-		"@stylistic/object-curly-spacing": ["error", "always"],
-		"@stylistic/object-property-newline": ["error", { "allowAllPropertiesOnSameLine": true }],
-		"@stylistic/operator-linebreak": ["error", "before"],
-		"@stylistic/padded-blocks": "off",
-		"@stylistic/quote-props": ["error", "as-needed"],
-		"@stylistic/quotes": ["error", "double"],
-		"@stylistic/indent": ["error", "tab"],
-		"@stylistic/semi": ["error", "always"],
-		"@stylistic/space-before-function-paren": ["error", "always"],
-		"@stylistic/spaced-comment": "off",
-		"unicorn/prefer-node-protocol": "error"
-	},
-	"overrides": [
-		{
-			"files": ["config/config.js*"],
-			"rules": {
-				"@stylistic/comma-dangle": "off",
-				"@stylistic/indent": "off",
-				"@stylistic/no-multi-spaces": "off"
-			}
-		},
-		{
-			"files": ["tests/configs/modules/weather/*.js"],
-			"rules": {
-				"@stylistic/quotes": "off"
-			}
-		},
-		{
-			"extends": ["plugin:package-json/recommended"],
-			"files": ["package.json"],
-			"parser": "jsonc-eslint-parser",
-			"plugins": ["package-json"],
-			"rules": {
-				"package-json/sort-collections": ["error", ["devDependencies", "dependencies", "peerDependencies", "config"]]
-			}
-		}
-	]
-}

.github/CONTRIBUTING.md

@@ -6,22 +6,28 @@ We hold our code to standard, and these standards are documented below.
 
 ## Linters
 
-We use prettier for automatic linting of all our files: `npm run lint:prettier`.
+We use [prettier](https://prettier.io/) for automatic formatting a lot all our files. The configuration is in our `prettier.config.mjs` file.
+
+To run prettier, use `npm run lint:prettier`.
 
 ### JavaScript: Run ESLint
 
-We use [ESLint](https://eslint.org) on our JavaScript files.
-
-Our ESLint configuration is in our `.eslintrc.json` and `.eslintignore` files.
+We use [ESLint](https://eslint.org) to lint our JavaScript files. The configuration is in our `eslint.config.mjs` file.
 
 To run ESLint, use `npm run lint:js`.
 
 ### CSS: Run StyleLint
 
-We use [StyleLint](https://stylelint.io) to lint our CSS. Our configuration is in our `.stylelintrc` file.
+We use [StyleLint](https://stylelint.io) to lint our CSS. The configuration is in our `.stylelintrc.json` file.
 
 To run StyleLint, use `npm run lint:css`.
 
+### Markdown: Run markdownlint
+
+We use [markdownlint-cli2](https://github.com/DavidAnson/markdownlint-cli2) to lint our markdown files. The configuration is in our `.markdownlint.json` file.
+
+To run markdownlint, use `npm run markdownlint:css`.
+
 ## Testing
 
 We use [Jest](https://jestjs.io) for JavaScript testing.
@@ -30,31 +36,3 @@ 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.
-
-If you're not sure if it's a real bug or if it's just you, please open a topic on the forum: [https://forum.magicmirror.builders/category/15/bug-hunt](https://forum.magicmirror.builders/category/15/bug-hunt)
-
-Problems installing or configuring your MagicMirror? Check out: [https://forum.magicmirror.builders/category/10/troubleshooting](https://forum.magicmirror.builders/category/10/troubleshooting)
-
-When submitting a new issue, please supply the following information:
-
-**Platform**: 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 18 or later (recommended is 20).
-
-**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.
-
-**Steps to Reproduce**: List the step by step process to reproduce the issue.
-
-**Expected Results**: Describe what you expected to see.
-
-**Actual Results**: Describe what you actually saw.
-
-**Configuration**: What does the used config.js file look like? Don't forget to remove any sensitive information!
-
-**Additional Notes**: Provide any other relevant notes not previously mentioned. This is optional.

.github/ISSUE_TEMPLATE.md

@@ -1,52 +0,0 @@
-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)
-
-## I'm having troubles installing or configuring MagicMirror
-
-Problems installing or configuring your MagicMirror? Check out: [https://forum.magicmirror.builders/category/10/troubleshooting](https://forum.magicmirror.builders/category/10/troubleshooting)
-
-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
-
-If you are facing an issue or found a bug while trying to install MagicMirror² via the installer please report it in the respective GitHub repository:
-[https://github.com/sdetweil/MagicMirror_scripts](https://github.com/sdetweil/MagicMirror_scripts)
-
-## I found a bug in the MagicMirror² Docker image
-
-If you are facing an issue or found a bug while running MagicMirror² inside a Docker container please create an issue in the corresponding repository:
-[https://gitlab.com/khassel/magicmirror](https://gitlab.com/khassel/magicmirror)
-
-## I'm having troubles installing or configuring foreign modules
-
-Please open an issue in the module repository or ask for help in the [forum](https://forum.magicmirror.builders/)
-
----
-
-## I found a bug in MagicMirror
-
-Please make sure to only submit reproducible issues. You can safely remove everything above the dividing line.
-When submitting a new issue, please supply the following information:
-
-**Platform**: Place your platform here... give us your web browser/Electron version _and_ your hardware (Raspberry Pi 2/3/4, Windows, Mac, Linux, System V UNIX).
-
-**Node Version**: Make sure it's version 18 or later (recommended is 20).
-
-**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.
-
-**Steps to Reproduce**: List the step by step process to reproduce the issue.
-
-**Expected Results**: Describe what you expected to see.
-
-**Actual Results**: Describe what you actually saw.
-
-**Configuration**: What does the used config.js file look like? Don't forget to remove any sensitive information!
-
-**Additional Notes**: Provide any other relevant notes not previously mentioned. This is optional.

.github/ISSUE_TEMPLATE/bug_report.yml

@@ -0,0 +1,154 @@
+name: 🐛 Report a problem
+description: Report an issue with MagicMirror² 🚨
+title: "[Bug] {{ brief description }}"
+labels:
+  - bug
+body:
+  - type: markdown
+    attributes:
+      value: |
+        Thanks for reporting a bug! Please fill in the following template to help us reproduce the issue.
+        Please only submit reproducible issues. If you're not sure if it's a real bug or if it's just you, please open a topic on the forum.
+  - type: textarea
+    id: environment
+    attributes:
+      label: Environment
+      description: |
+        Please tell us about how your MagicMirror² is set up.
+
+        Optimal would be the systeminformation from the logs, which looks like this:
+        ```bash
+        [2025-01-14 20:05:03.529] [INFO]  System information:
+        ### SYSTEM:    manufacturer: Raspberry Pi Foundation; model: Raspberry Pi 4 Model B Rev 1.5; virtual: false
+        ### OS:        platform: linux; distro: Debian GNU/Linux; release: 12; arch: arm64; kernel: 6.1.21-v8+
+        ### VERSIONS:  electron: 31.2.1; used node: 20.15.0; installed node: 22.4.1; npm: 10.8.1; pm2:
+        ### OTHER:     timeZone: Europe/Berlin; ELECTRON_ENABLE_GPU: undefined
+        ```
+
+        If you can't provide this information, please provide the following:
+        - MagicMirror² version: Can be found in the `package.json` file. Please use the latest version before reporting a bug.
+        - Node version: Run `node -v` to find out. Make sure it's version 20 or later (recommended is 22).
+        - npm version: Run `npm -v` to find out.
+        - Platform: Are you using a Raspberry Pi (2/3/4/5), Windows, Mac, Linux, Docker, or something else?
+      value: |
+        MagicMirror² version: 
+        Node version: 
+        npm version: 
+        Platform:
+    validations:
+      required: true
+  - type: dropdown
+    id: start-option
+    attributes:
+      label: Which start option are you using?
+      description: |
+        Please keep in mind that some problems are specific to certain start options.
+      options:
+        - "npm run start"
+        - "npm run start:wayland"
+        - "npm run start:windows"
+        - "npm run start:x11"
+        - "npm run server"
+        - "node clientonly --address ... --port ..."
+    validations:
+      required: true
+  - type: dropdown
+    id: pm2
+    attributes:
+      label: Are you using PM2?
+      options:
+        - "No"
+        - "Yes"
+        - "I don't know"
+    validations:
+      required: true
+  - type: dropdown
+    id: module
+    attributes:
+      label: Module
+      description: |
+        If the issue is related to a specific module, please provide the name of the module.
+        Note: Please don't report issues with 3rd party modules here. Report them on the module's repository.
+      options:
+        - "alert"
+        - "calendar"
+        - "clock"
+        - "compliments"
+        - "helloworld"
+        - "newsfeed"
+        - "updatenotification"
+        - "weather"
+  - type: checkboxes
+    id: module-disabled
+    attributes:
+      label: Have you tried disabling other modules?
+      options:
+        - label: "Yes"
+        - label: "No"
+  - type: checkboxes
+    id: search
+    attributes:
+      label: Have you searched if someone else has already reported the issue on the forum or in the issues?
+      options:
+        - label: "Yes"
+          required: true
+  - type: textarea
+    id: description
+    attributes:
+      label: What did you do?
+      description: |
+        Please include a *minimal* reproduction case. List the step by step process to reproduce the issue.
+        You can use Markdown in this field.
+      value: |
+        <details>
+        <summary>Configuration</summary>
+
+        ```
+        <!-- Paste your configuration here. Don't forget to remove any sensitive information! -->
+        ```
+        </details>
+
+        ```js
+        <!-- Paste relevant code here -->
+        ```
+
+        Steps to reproduce the issue:
+    validations:
+      required: true
+  - type: textarea
+    id: expectation
+    attributes:
+      label: What did you expect to happen?
+      description: |
+        You can use Markdown in this field.
+    validations:
+      required: true
+  - type: textarea
+    id: lint-output
+    attributes:
+      label: What actually happened?
+      description: |
+        Please copy-paste relevant log output or error messages.
+        You can use Markdown in this field.
+    validations:
+      required: true
+
+  - type: textarea
+    id: comments
+    attributes:
+      label: Additional comments
+      description: |
+        Is there anything else that's important for the team to know?
+        Fill out all fields and provide as much information as possible.
+        Adding screenshots might help us understand your problem better.
+
+  - type: checkboxes
+    attributes:
+      label: Participation
+      options:
+        - label: "I am willing to submit a pull request for this change."
+          required: false
+
+  - type: markdown
+    attributes:
+      value: Please **do not** open a pull request until this issue has been accepted by the team.

.github/ISSUE_TEMPLATE/change_request.yml

@@ -0,0 +1,41 @@
+name: 🔀 Request a change
+description: Request a change that is not a bug fix, a feature request or a support request.
+title: "[Change Request] {{ brief description }}"
+labels:
+  - enhancement
+  - core
+body:
+  - type: markdown
+    attributes:
+      value: Thanks for requesting a change! Please fill in the following template to help us understand your request.
+  - type: textarea
+    attributes:
+      label: What problem do you want to solve with this change?
+      description: |
+        Please explain your use case in as much detail as possible.
+      placeholder: |
+        Currently...
+    validations:
+      required: true
+  - type: textarea
+    attributes:
+      label: What do you think is the correct solution?
+      description: |
+        Please explain how you'd like to change MagicMirror² to address the problem.
+      placeholder: |
+        I'd like MagicMirror² to...
+    validations:
+      required: true
+  - type: checkboxes
+    attributes:
+      label: Participation
+      options:
+        - label: I am willing to submit a pull request for this change.
+          required: false
+  - type: markdown
+    attributes:
+      value: Please **do not** open a pull request until this issue has been accepted by the team.
+  - type: textarea
+    attributes:
+      label: Additional comments
+      description: Is there anything else that's important for the team to know?

.github/ISSUE_TEMPLATE/config.yml

@@ -0,0 +1,14 @@
+blank_issues_enabled: false
+contact_links:
+  - name: 📚 Documentation
+    url: https://github.com/MagicMirrorOrg/MagicMirror-Documentation/issues
+    about: This issue tracker is not for documentation issues. Please file documentation issues on the docs repo.
+  - name: 🤔 Support Question
+    url: https://forum.magicmirror.builders/
+    about: Problems installing or configuring your MagicMirror? Please post your question on the MagicMirror² Forum.
+  - name: 💬 Exchange of ideas
+    url: https://discord.gg/AmGBBwPph5
+    about: This issue tracker is not for general discussion. Please use the Discord channel.
+  - name: 📦 Issues with a 3rd-party module
+    url: https://kristjanesperanto.github.io/MagicMirror-3rd-Party-Modules/
+    about: This issue tracker is not for 3rd-party module issues. Please file 3rd-party module issues on the module's repo.

.github/ISSUE_TEMPLATE/feature_request.yml

@@ -0,0 +1,67 @@
+name: 🚀 Feature Request
+description: Suggest a new feature for MagicMirror² 💡
+title: "[Feature Request] {{ brief description }}"
+body:
+  - type: checkboxes
+    id: prerequisites
+    attributes:
+      label: Prerequisites
+      description: Please ensure you have completed all of the following.
+      options:
+        - label: I am running the latest version of MagicMirror², and know that this feature is not available now.
+          required: true
+        - label: I know my issue is not related to a third-party module.
+          required: true
+        - label: I have searched for [existing issues](https://github.com/MagicMirrorOrg/MagicMirror/issues) that already include this feature request, without success.
+          required: true
+
+  - type: textarea
+    id: description
+    attributes:
+      label: Describe the Feature Request
+      description: A clear and concise description of what the feature does.
+    validations:
+      required: true
+
+  - type: textarea
+    id: use-case
+    attributes:
+      label: Describe the Use Case
+      description: A clear and concise use case for what problem this feature would solve.
+    validations:
+      required: true
+
+  - type: textarea
+    id: proposed-solution
+    attributes:
+      label: Describe Preferred Solution
+      description: A clear and concise description of how you want this feature to be added to MagicMirror².
+
+  - type: textarea
+    id: alternatives-considered
+    attributes:
+      label: Describe Alternatives
+      description: A clear and concise description of any alternative solutions or features you have considered.
+
+  - type: textarea
+    id: related-code
+    attributes:
+      label: Related Code
+      description: If you are able to illustrate the feature request with an example, please provide a sample here.
+
+  - type: textarea
+    id: additional-information
+    attributes:
+      label: Additional Information
+      description: List any other information that is relevant to your issue. Related issues, suggestions on how to implement, Stack Overflow links, forum links, etc.
+
+  - type: checkboxes
+    attributes:
+      label: Participation
+      options:
+        - label: I am willing to submit a pull request for this change.
+          required: false
+
+  - type: markdown
+    attributes:
+      value: Please **do not** open a pull request until this issue has been accepted by the team.

.github/PULL_REQUEST_TEMPLATE.md

@@ -1,4 +1,4 @@
-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:**
 

.github/stale.yaml

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

.github/workflows/automated-tests.yaml

@@ -13,13 +13,37 @@ permissions:
   contents: read
 
 jobs:
-  test:
+  code-style-check:
     runs-on: ubuntu-latest
+    timeout-minutes: 15
+    steps:
+      - name: "Checkout code"
+        uses: actions/checkout@v4
+      - name: "Use Node.js"
+        uses: actions/setup-node@v4
+        with:
+          node-version: 23
+          cache: "npm"
+      - name: "Install dependencies"
+        run: |
+          npm run install-mm:dev
+      - name: "Run linter tests"
+        run: |
+          npm run test:prettier
+          npm run test:js
+          npm run test:css
+          npm run test:markdown
+  test:
+    runs-on: ubuntu-24.04
     timeout-minutes: 30
     strategy:
       matrix:
-        node-version: [20.x, 22.x]
+        node-version: [22.14.0, 22.x, 23.x]
     steps:
+      - name: Install electron dependencies and labwc
+        run: |
+          sudo apt-get update
+          sudo apt-get install -y libnss3 libasound2t64 labwc
       - name: "Checkout code"
         uses: actions/checkout@v4
       - name: "Use Node.js ${{ matrix.node-version }}"
@@ -28,15 +52,16 @@ jobs:
           node-version: ${{ matrix.node-version }}
           check-latest: true
           cache: "npm"
-      - name: "Install dependencies"
+      - name: "Install MagicMirror²"
         run: |
           npm run install-mm:dev
       - name: "Run tests"
         run: |
-          Xvfb :99 -screen 0 1024x768x16 &
-          export DISPLAY=:99
+          # Fix chrome-sandbox permissions:
+          sudo chown root:root ./node_modules/electron/dist/chrome-sandbox
+          sudo chmod 4755 ./node_modules/electron/dist/chrome-sandbox
+          # Start labwc
+          WLR_BACKENDS=headless WLR_LIBINPUT_NO_DEVICES=1 WLR_RENDERER=pixman labwc &
+          export WAYLAND_DISPLAY=wayland-0
           touch css/custom.css
-          npm run test:prettier
-          npm run test:js
-          npm run test:css
           npm run test

.github/workflows/electron-rebuild.yaml

@@ -8,7 +8,7 @@ jobs:
     runs-on: ubuntu-latest
     strategy:
       matrix:
-        node-version: [20.x, 22.x]
+        node-version: [22.14.0, 22.x, 23.x]
     steps:
       - name: Checkout code
         uses: actions/checkout@v4
@@ -21,8 +21,12 @@ jobs:
         run: npm run install-mm
       - name: Install @electron/rebuild
         run: npm install @electron/rebuild
-      - name: Install some test library to be rebuilded
-        run: npm install onoff node-pty drivelist
+      - name: Install node-libgpiod deps
+        run: |
+          sudo apt-get update
+          sudo apt-get install gpiod libgpiod2 libgpiod-dev
+      - name: Install test library (node-libgpiod) to be rebuilded
+        run: npm install node-libgpiod
       - name: Run electron-rebuild
         run: npx electron-rebuild
         continue-on-error: false

.github/workflows/enforce-pullrequest-rules.yaml

@@ -5,7 +5,7 @@
 name: "Enforce Pull-Request Rules"
 
 on:
-  pull_request:
+  pull_request_target:
     types: [opened, synchronize, reopened, ready_for_review, labeled, unlabeled]
 
 jobs:
@@ -25,4 +25,4 @@ jobs:
           echo "Please don't do this. Switch the branch to 'develop'."
           exit 1
         env:
-          BASE_BRANCH: ${{ github.base_ref }}
+          BASE_BRANCH: ${{ github.event.pull_request.base.ref }}

.github/workflows/spellcheck.yaml

@@ -0,0 +1,31 @@
+# This workflow will run a spellcheck on the codebase.
+# It runs a few days before each release. At 00:00 on day-of-month 27 in March, June, September, and December.
+
+name: Run Spellcheck
+
+on:
+  schedule:
+    - cron: "0 0 27 3,6,9,12 *"
+
+permissions:
+  contents: read
+
+jobs:
+  spellcheck:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v4
+        with:
+          ref: develop
+      - name: Set up Node.js
+        uses: actions/setup-node@v4
+        with:
+          node-version: "22"
+          check-latest: true
+          cache: "npm"
+      - name: Install dependencies
+        run: |
+          npm run install-mm:dev
+      - name: Run Spellcheck
+        run: npm run test:spelling

.github/workflows/stale.yaml

@@ -0,0 +1,22 @@
+name: "Close stale issues and PRs"
+
+on:
+  workflow_dispatch: # needed for manually running this workflow
+  schedule:
+    - cron: "30 1 * * 6" # every Saturday at 1:30
+
+permissions:
+  issues: write
+
+jobs:
+  stale:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/stale@v9
+        with:
+          stale-issue-message: "This issue has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs. Thank you for your contributions."
+          days-before-issue-stale: 60
+          days-before-issue-close: 7
+          operations-per-run: 100
+          stale-issue-label: "wontfix"
+          exempt-issue-labels: "pinned,security,under investigation,pr welcome,ready (coming with next release)"

.gitignore

@@ -81,3 +81,6 @@ Temporary Items
 *.orig
 *.rej
 *.bak
+
+# Ignore positions file (#3518)
+js/positions.js

.husky/pre-commit

@@ -1,5 +1,5 @@
 #!/bin/sh
 
-if command -v npm &> /dev/null; then
-  npm run lint:staged
+if command -v npx &> /dev/null; then
+  npx lint-staged
 fi

.markdownlint.json

@@ -0,0 +1,6 @@
+{
+	"line_length": false,
+	"no-duplicate-heading": false,
+	"no-inline-html": false,
+	"no-trailing-punctuation": false
+}

.prettierignore

@@ -1,5 +1,5 @@
 *.js
-.eslintignore
+*.mjs
 .husky/pre-commit
 .prettierignore
 /config

.prettierrc.json

@@ -1,3 +0,0 @@
-{
-	"trailingComma": "none"
-}

CHANGELOG.md

@@ -1,15 +1,175 @@
-# MagicMirror² Change Log
+# Changelog
 
 All notable changes to this project will be documented in this file.
-This project adheres to [Semantic Versioning](https://semver.org/).
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
 ❤️ **Donate:** Enjoying MagicMirror²? [Please consider a donation!](https://magicmirror.builders/#donate) With your help we can continue to improve the MagicMirror².
 
+## [2.31.0] - 2025-04-01
+
+Thanks to: @Developer-Incoming, @eltociear, @geraki, @khassel, @KristjanESPERANTO, @MagMar94, @mixasgr, @n8many, @OWL4C, @rejas, @savvadam, @sdetweil.
+
+> ⚠️ This release needs nodejs version `v22.14.0 or higher`
+
+### Added
+
+- Add CSS support to the digital clock hour/minute/second through the use of the classes `clock-hour-digital`, `clock-minute-digital`, and `clock-second-digital`.
+- Add Arabic (#3719) and Esperanto translation.
+- Mark option `secondsColor` as deprecated in clock module.
+- Add Greek translation to Alerts module.
+- [newsfeed] Add specific ignoreOlderThan value (override) per feed (#3360)
+- [weather] Added option Humidity to hourly View
+- [weather] Added option to hide hourly entries that are Zero, hiding the entire column if empty.
+- [updatenotification] Added option to iterate over modules directory instead using modules defined in `config.js` (#3739)
+
+### Changed
+
+- [core] starting clientonly now checks for needed env var `WAYLAND_DISPLAY` or `DISPLAY` and starts electron with needed parameters (if both are set wayland is used) (#3677)
+- [core] Optimize systeminformation calls and output (#3689)
+- [core] Add issue templates for feature requests and bug reports (#3695)
+- [core] Adapt `start:x11:dev` script
+- [weather/yr] The Yr weather provider now enforces a minimum `updateInterval` of 600 000 ms (10 minutes) to comply with the terms of service. If a lower value is set, it will be automatically increased to this minimum.
+- [weather/weatherflow] Fixed icons and added hourly support as well as UV, precipitation, and location name support.
+- [workflow] Run `sudo apt-get update` before installing packages to avoid install errors
+- [workflow] Exclude issues with label `ready (coming with next release)` from stale job
+
+### Removed
+
+### Updated
+
+- [core] Update requirements and dependencies including electron to v35 and formatting (#3593, #3693, #3717)
+- [core] Update prettier, ESLint and simplify config
+- Update Greek translation
+
+### Fixed
+
+- [calendar] Fix clipping events being broadcast (#3678)
+- [tests] Fix Electron tests by running them under new github image ubuntu-24.04, replace xserver with labwc, running under xserver and labwc depending on env variable WAYLAND_DISPLAY is set (#3676)
+- [calendar] Fix arrayed symbols, #3267, again, add testcase, add testcase for #3678
+- [weather] Fix wrong weatherCondition name in openmeteo provider which lead to n/a icon (#3691)
+- [core] Fix wrong port in log message when starting server only (#3696)
+- [calendar] Fix NewYork event processed on system in Central timezone shows wrong time #3701
+- [weather/yr] The Yr weather provider is now able to recover from bad API responses instead of freezing (#3296)
+- [compliments] Fix evening events being shown during the day (#3727)
+- [weather] Fixed minor spacing issues when using UV Index in Hourly
+- [workflow] Fix command to run spellcheck
+
+## [2.30.0] - 2025-01-01
+
+Thanks to: @xsorifc28, @HeikoGr, @bugsounet, @khassel, @KristjanESPERANTO, @rejas, @sdetweil.
+
+> ⚠️ This release needs nodejs version `v20` or `v22 or higher`, minimum version is `v20.18.1`
+
+### Added
+
+- [core] Add wayland and windows start options to `package.json` (#3594)
+- [docs] Add step for npm publishing in release process (#3595)
+- [core] Add GitHub workflow to run spellcheck a few days before each release (#3623)
+- [core] Add test flag to `index.html` to pass to module js for test mode detection (needed by #3630)
+- [core] Add export on animation names (#3644)
+- [compliments] Add support for refreshing remote compliments file, and test cases (#3630)
+- [linter] Re-add `eslint-plugin-import`now that it supports ESLint v9 (#3586)
+- [linter] Re-activate `eslint-plugin-package-json` to lint `package.json` (#3643)
+- [linter] Add linting for markdown files (#3646)
+- [linter] Add some handy ESLint rules (#3665)
+- [calendar] Add ability to display end date for full date events, where end is not same day (showEnd=true) (#3650)
+- [core] Add text to the config.js.sample file about the locale variable (#3654, #3655)
+- [core] Add fetch timeout for all node_helpers (thru undici, forces node 20.18.1 minimum) to help on slower systems. (#3660) (3661)
+
+### Changed
+
+- [core] Run code style checks in workflow only once (#3648)
+- [core] Fix animations export #3644 only on server side (#3649)
+- [core] Use project URL in fallback config (#3656)
+- [core] Fix Access Denied crash writing js/positions.js (on synology nas) #3651. new message, MM starts, but no modules showing (#3652)
+- [linter] Switch to 'npx' for lint-staged in pre-commit hook (#3658)
+
+### Removed
+
+- [tests] Remove `node-pty` and `drivelist` from rebuilded test (#3575)
+- [deps] Remove `@eslint/js` dependency. Already installed with `eslint` in deep (#3636)
+
+### Updated
+
+- [repo] Reactivate `stale.yaml` as GitHub action to mark issues as stale after 60 days and close them 7 days later (if no activity) (#3577, #3580, #3581)
+- [core] Update electron dependency to v32 (test electron rebuild) and all other dependencies too (#3657)
+- [tests] All test configs have been updated to allow full external access, allowing for easier debugging (especially when running as a container)
+- [core] Run and test with node 23 (#3588)
+- [workflow] delete exception `allow-ghsas: GHSA-8hc4-vh64-cxmj` in `dep-review.yaml` (#3659)
+
+### Fixed
+
+- [updatenotification] Fix pm2 using detection when pm2 script is inside or outside MagicMirror root folder (#3576) (#3605) (#3626) (#3628)
+- [core] Fix loading node_helper of modules: avoid black screen, display errors and continue loading with next module (#3578)
+- [weather] Change default value for weatherEndpoint of provider openweathermap to "/onecall" (#3574)
+- [tests] Fix electron tests with mock dates, the mock on server side was missing (#3597)
+- [tests] Fix testcases with hard coded Date.now (#3597)
+- [core] Fix missing `basePath` where `location.host` is used (#3613)
+- [compliments] croner library changed filenames used in latest version (#3624)
+- [linter] Fix ESLint ignore pattern which caused that default modules not to be linted (#3632)
+- [core] Fix module path in case of sub/sub folder is used and use path.resolve for resolve `moduleFolder` and `defaultModuleFolder` in app.js (#3653)
+- [calendar] Update to resolve issues #3098 #3144 #3351 #3422 #3443 #3467 #3537 related to timezone changes
+- [calendar] Fix #3267 (styles array), also fixes event with both exdate AND recurrence(and testcase)
+- [calendar] Fix showEndsOnlyWithDuration not working, #3598, applies ONLY to full day events
+- [calendar] Fix showEnd for Full Day events (#3602)
+- [tests] Suppress "module is not defined" in e2e tests (#3647)
+- [calendar] Fix #3267 (styles array, really this time!)
+- [core] Fix #3662 js/positions.js created incorrectly
+
+## [2.29.0] - 2024-10-01
+
+Thanks to: @bugsounet, @dkallen78, @jargordon, @khassel, @KristjanESPERANTO, @MarcLandis, @rejas, @ryan-d-williams, @sdetweil, @skpanagiotis.
+
+> ⚠️ This release needs nodejs version `v20` or `v22`, minimum version is `v20.9.0`
+
+### Added
+
+- [compliments] Added support for cron type date/time format entries mm hh DD MM dow (minutes/hours/days/months and day of week) see <https://crontab.cronhub.io> for construction (#3481)
+- [core] Check config at every start of MagicMirror² (#3450)
+- [core] Add spelling check (cspell): `npm run test:spelling` and handle spelling issues (#3544)
+- [core] removed `config.paths.vendor` (could not work because `vendor` is hardcoded in `index.html`), renamed `config.paths.modules` to `config.foreignModulesDir`, added variable `MM_CUSTOMCSS_FILE` which - if set - overrides `config.customCss`, added variable `MM_MODULES_DIR` which - if set - overrides `config.foreignModulesDir`, added test for `MM_MODULES_DIR` (#3530)
+- [core] elements are now removed from `index.html` when loading script or stylesheet files fails
+- [core] Added `MODULE_DOM_UPDATED` notification each time the DOM is re-rendered via `updateDom` (#3534)
+- [tests] added minimal needed node version to tests (currently v20.9.0) to avoid releases with wrong node version info
+- [tests] Added `node-libgpiod` library to electron-rebuild tests (#3563)
+
+### Removed
+
+- [core] removed installer only files (#3492)
+- [core] removed raspberry object from systeminformation (#3505)
+- [linter] removed `eslint-plugin-import`, because it doesn't support ESLint v9. We will reenter it later when it does.
+- [tests] removed `onoff` library from electron-rebuild tests (#3563)
+
+### Updated
+
+- [weather] Updated `apiVersion` default from 2.5 to 3.0 (#3424)
+- [core] Updated dependencies including stylistic-eslint
+- [core] nail down `node-ical` version to `0.18.0` with exception `allow-ghsas: GHSA-8hc4-vh64-cxmj` in `dep-review.yaml` (which should removed after next `node-ical` update)
+- [core] Updated SocketIO catch all to new API
+- [core] Allow custom modules positions by scanning index.html for the defined regions, instead of hard coded (PR #3518 fixes issue #3504)
+- [core] Detail optimizations in `config_check.js`
+- [core] Updated minimal needed node version in `package.json` (currently v20.9.0) (#3559) and except for v21 (no security updates) (#3561)
+- [linter] Switch to ESLint v9 and flat config and replace `eslint-plugin-unicorn` by `@eslint/js`
+- [core] Fix discovering module positions twice after #3450
+
+### Fixed
+
+- [docs] Fixed `checks` badge in README.md
+- [weather] Fixed issue with the UK Met Office provider following a change in their API paths and header info.
+- [core] Add check for node_helper loading for multiple instances of same module (#3502)
+- [weather] Fixed issue for respecting unit config on broadcasted notifications
+- [tests] Fixes calendar test by moving it from e2e to electron with fixed date (#3532)
+- [calendar] fixed sliceMultiDayEvents getting wrong count and displaying incorrect entries, Europe/Berlin (#3542)
+- [tests] ignore `js/positions.js` when linting (this file is created at runtime)
+- [calendar] fixed sliceMultiDayEvents showing previous day without config enabled
+
 ## [2.28.0] - 2024-07-01
 
 Thanks to: @btoconnor, @bugsounet, @JasonStieber, @khassel, @kleinmantara and @WallysWellies.
 
-> ⚠️ This release needs nodejs version >= v20
+> ⚠️ This release needs nodejs version >= v20.9.0
 
 ### Added
 
@@ -31,7 +191,7 @@ Thanks to: @btoconnor, @bugsounet, @JasonStieber, @khassel, @kleinmantara and @W
 
 ### Fixed
 
-- [core] Fixed crash possibility if `module: <name>` is not defined and on `postion: <positon>` mistake (#3445)
+- [core] Fixed crash possibility if `module: <name>` is not defined and on `position: <position>` mistake (#3445)
 - [weather] Fixed precipitationProbability in forecast for provider openmeteo (#3446)
 - [weather] Fixed type=daily for provider openmeteo having no data when running after 23:00 (#3449)
 - [weather] Fixed type=daily for provider openmeteo showing nightly icons in forecast when current time is "nightly" (#3458)
@@ -56,7 +216,7 @@ For more info, please read the following post: [A New Chapter for MagicMirror: T
 
 ### Updated
 
-- Update updatenotification (update_helper.js): Recode with pm2 library (#3332)
+- [updatenotification] Recode update_helper.js with pm2 library (#3332)
 - Removing lodash dependency by replacing merge by spread operator (#3339)
 - Use node prefix for build-in modules (#3340)
 - Rework logging colors (#3350)
@@ -70,7 +230,7 @@ For more info, please read the following post: [A New Chapter for MagicMirror: T
 
 ### Fixed
 
-- Correct apibase of weathergov weatherprovider to match documentation (#2926)
+- [weather] Correct apiBase of weathergov weatherProvider to match documentation (#2926)
 - Worked around several issues in the RRULE library that were causing deleted calender events to still show, some
   initial and recurring events to not show, and some event times to be off an hour. (#3291)
 - Skip changelog requirement when running tests for dependency updates (#3320)
@@ -136,8 +296,8 @@ This release also marks the latest release by Michael Teeuw. For more info, plea
 - Fix issue template (#3167)
 - Fix #3256 filter out bad results from rrule.between
 - Fix calendar events sometimes not respecting deleted events (#3250)
-- Fix electron loadurl locally on Windows when address "0.0.0.0" (#2550)
-- Fix updatanotification (update_helper.js): catch error if response is not an JSON format (check PM2)
+- Fix electron loadURL locally on Windows when address "0.0.0.0" (#2550)
+- Fix updatenotification (update_helper.js): catch error if response is not an JSON format (check PM2)
 - Fix missing typeof in calendar module
 - Fix style issues after prettier update
 - Fix calendar test (#3291) by moving "Exdate check" from e2e to electron to run on a Thursday
@@ -222,7 +382,7 @@ Special thanks to @khassel, @rejas and @sdetweil for taking over most (if not al
 
 ### Updated
 
-- Added support for precipitation probability with openmeteo weather-provider
+- [weather] Added support for precipitation probability with openmeteo weather-provider
 - Update electron to v25.2 and other dependencies
 - Use node v20 in github workflow (replacing v14)
 - Refactor formatTime into common util function for default modules
@@ -395,7 +555,7 @@ Special thanks to the following contributors: @eouia, @khassel, @kolbyjack, @Kri
 
 ### Added
 
-- Added a new config option `httpHeaders` used by helmet (see https://helmetjs.github.io/). You can now set own httpHeaders which will override the defaults in `js/defauls.js` which is useful e.g. if you want to embed MagicMirror into annother website (solves #2847).
+- Added a new config option `httpHeaders` used by helmet (see <https://helmetjs.github.io/>). You can now set own httpHeaders which will override the defaults in `js/defaults.js` which is useful e.g. if you want to embed MagicMirror into another website (solves #2847).
 - Show endDate for calendar events when dateHeader is enabled and showEnd is set to true (#2192).
 - Added the notification emitting from the weather module on information updated.
 - Use recommended file extension for YAML files (#2864).
@@ -444,7 +604,7 @@ Special thanks to the following contributors: @10bias, @CFenner, @JHWelch, @k1rd
 - 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)
+- Fix conflicting parameter turning off showEnd for full day events. (#2629)
 - Fix regression, calendar.maximumEntries not used to filter calendar level entries (#2868)
 
 ## [2.18.0] - 2022-01-01
@@ -476,7 +636,7 @@ Special thanks to the following contributors: @AmpioRosso, @eouia, @fewieden, @j
 ### 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 `feels_like` data from openweathermap's 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.
@@ -513,7 +673,7 @@ Special thanks to the following contributors: @apiontek, @eouia, @jupadin, @khas
 - Updated github templates.
 - Actually test all js and css files when lint script is run.
 - Updated jsdocs and print warnings during testing too.
-- Updated weathergov provider to try fetching not just current, but also foreacst, when API URLs available.
+- Updated weathergov provider to try fetching not just current, but also forecast, when API URLs available.
 - Refactored clock layout.
 - Refactored methods from weather-providers into weatherobject (isDaytime, updateSunTime).
 - Use of `logger.js` in jest tests.
@@ -863,7 +1023,7 @@ Special thanks to @sdetweil for all his great contributions!
 ### Updated
 
 - Updated lower bound of `lodash` and `helmet` dependencies for security patches.
-- Updated compliments.js to handle newline in text, as textfields to not interpolate contents.
+- Updated compliments.js to handle newline in text, as text fields to not interpolate contents.
 - Updated raspberry.sh installer script to handle new platform issues, split node/npm, pm2, and screen saver changes.
 - Improve handling for armv6l devices, where electron support has gone away, add optional serveronly config option.
 - Improved run-start.sh to handle for serveronly mode, by choice, or when electron not available.
@@ -1084,7 +1244,7 @@ A huge, huge, huge thanks to user @fewieden for all his hard work on the new `we
 - Fixed close dates to be absolute, if no configured in the config.js - module Calendar
 - Fixed the updatenotification module message about new commits in the repository, so they can be correctly localized in singular and plural form.
 - Fix for weatherforecast rainfall rounding [#1374](https://github.com/MagicMirrorOrg/MagicMirror/issues/1374)
-- Fix calendar parsing issue for Midori on RasperryPi Zero w, related to issue #694.
+- Fix calendar parsing issue for Midori on Raspberry Pi Zero w, related to issue #694.
 - Fix weather city ID link in sample config
 - Fixed issue with clientonly not updating with IP address and port provided on command line.
 
@@ -1139,7 +1299,7 @@ A huge, huge, huge thanks to user @fewieden for all his hard work on the new `we
 - Fixed weatherforecast to use dt_txt field instead of dt to handle timezones better
 - Newsfeed now remembers to show the description when `"ARTICLE_LESS_DETAILS"` is called if the user wants to always show the description. [#1282](https://github.com/MagicMirrorOrg/MagicMirror/issues/1282)
 - `clientonly/*.js` is now linted, and one linting error is fixed
-- Fix issue #1196 by changing underscore to hyphen in locale id, in align with momentjs.
+- Fix issue #1196 by changing underscore to hyphen in locale id, in align with moment.js.
 - Fixed issue where heat index and wind chill were reporting incorrect values in Kelvin. [#1263](https://github.com/MagicMirrorOrg/MagicMirror/issues/1263)
 
 ### Updated
@@ -1164,7 +1324,7 @@ A huge, huge, huge thanks to user @fewieden for all his hard work on the new `we
 - Implement Danger.js to notify contributors when CHANGELOG.md is missing in PR.
 - Allow scrolling in full page article view of default newsfeed module with gesture events from [MMM-Gestures](https://github.com/thobach/MMM-Gestures)
 - Changed 'compliments.js' - Updated DOM if remote compliments are loaded instead of waiting one updateInterval to show custom compliments
-- Automated unit tests utils, deprecated, translator, cloneObject(lockstrings)
+- Automated unit tests utils, deprecated, translator, cloneObject(lockStrings)
 - Automated integration tests translations
 - Add advanced filtering to the excludedEvents configuration of the default calendar module
 - New currentweather module config option: `showFeelsLike`: Shows how it actually feels like. (wind chill or heat index)
@@ -1268,7 +1428,7 @@ A huge, huge, huge thanks to user @fewieden for all his hard work on the new `we
 ### Fixed
 
 - Fixed issue with incorrect alignment of analog clock when displayed in the center column of the MM.
-- Fixed ipWhitelist behaviour to make empty whitelist ([]) allow any and all hosts access to the MM.
+- Fixed ipWhitelist behavior to make empty whitelist ([]) allow any and all hosts access to the MM.
 - Fixed issue with calendar module where 'excludedEvents' count towards 'maximumEntries'.
 - Fixed issue with calendar module where global configuration of maximumEntries was not overridden by calendar specific config (see module doc).
 - Fixed issue where `this.file(filename)` returns a path with two hashes.
@@ -1373,7 +1533,7 @@ A huge, huge, huge thanks to user @fewieden for all his hard work on the new `we
 - Added multiple calendar icon support.
 - Added tests for Translations, dev argument, version, dev console.
 - Added test anytime feature compliments module.
-- Added test ipwhitelist configuration directive.
+- Added test ipWhitelist configuration directive.
 - Added test for calendar module: default, basic-auth, backward compatibility, fail-basic-auth.
 - Added meta tags to support fullscreen mode on iOS (for server mode)
 - Added `ignoreOldItems` and `ignoreOlderThan` options to the News Feed module
@@ -1559,3 +1719,51 @@ It includes (but is not limited to) the following features:
 ### 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)
+
+[2.31.0]: https://github.com/MagicMirrorOrg/MagicMirror/compare/v2.30.0...v2.31.0
+[2.30.0]: https://github.com/MagicMirrorOrg/MagicMirror/compare/v2.29.0...v2.30.0
+[2.29.0]: https://github.com/MagicMirrorOrg/MagicMirror/compare/v2.28.0...v2.29.0
+[2.28.0]: https://github.com/MagicMirrorOrg/MagicMirror/compare/v2.27.0...v2.28.0
+[2.27.0]: https://github.com/MagicMirrorOrg/MagicMirror/compare/v2.26.0...v2.27.0
+[2.26.0]: https://github.com/MagicMirrorOrg/MagicMirror/compare/v2.25.0...v2.26.0
+[2.25.0]: https://github.com/MagicMirrorOrg/MagicMirror/compare/v2.24.0...v2.25.0
+[2.24.0]: https://github.com/MagicMirrorOrg/MagicMirror/compare/v2.23.0...v2.24.0
+[2.23.0]: https://github.com/MagicMirrorOrg/MagicMirror/compare/v2.22.0...v2.23.0
+[2.22.0]: https://github.com/MagicMirrorOrg/MagicMirror/compare/v2.21.0...v2.22.0
+[2.21.0]: https://github.com/MagicMirrorOrg/MagicMirror/compare/v2.20.0...v2.21.0
+[2.20.0]: https://github.com/MagicMirrorOrg/MagicMirror/compare/v2.19.0...v2.20.0
+[2.19.0]: https://github.com/MagicMirrorOrg/MagicMirror/compare/v2.18.0...v2.19.0
+[2.18.0]: https://github.com/MagicMirrorOrg/MagicMirror/compare/v2.17.1...v2.18.0
+[2.17.1]: https://github.com/MagicMirrorOrg/MagicMirror/compare/v2.17.0...v2.17.1
+[2.17.0]: https://github.com/MagicMirrorOrg/MagicMirror/compare/v2.16.0...v2.17.0
+[2.16.0]: https://github.com/MagicMirrorOrg/MagicMirror/compare/v2.15.0...v2.16.0
+[2.15.0]: https://github.com/MagicMirrorOrg/MagicMirror/compare/v2.14.0...v2.15.0
+[2.14.0]: https://github.com/MagicMirrorOrg/MagicMirror/compare/v2.13.0...v2.14.0
+[2.13.0]: https://github.com/MagicMirrorOrg/MagicMirror/compare/v2.12.0...v2.13.0
+[2.12.0]: https://github.com/MagicMirrorOrg/MagicMirror/compare/v2.11.0...v2.12.0
+[2.11.0]: https://github.com/MagicMirrorOrg/MagicMirror/compare/v2.10.1...v2.11.0
+[2.10.1]: https://github.com/MagicMirrorOrg/MagicMirror/compare/v2.10.0...v2.10.1
+[2.10.0]: https://github.com/MagicMirrorOrg/MagicMirror/compare/v2.9.0...v2.10.0
+[2.9.0]: https://github.com/MagicMirrorOrg/MagicMirror/compare/v2.8.0...v2.9.0
+[2.8.0]: https://github.com/MagicMirrorOrg/MagicMirror/compare/v2.7.1...v2.8.0
+[2.7.1]: https://github.com/MagicMirrorOrg/MagicMirror/compare/v2.7.0...v2.7.1
+[2.7.0]: https://github.com/MagicMirrorOrg/MagicMirror/compare/v2.6.0...v2.7.0
+[2.6.0]: https://github.com/MagicMirrorOrg/MagicMirror/compare/v2.5.0...v2.6.0
+[2.5.0]: https://github.com/MagicMirrorOrg/MagicMirror/compare/v2.4.1...v2.5.0
+[2.4.1]: https://github.com/MagicMirrorOrg/MagicMirror/compare/v2.4.0...v2.4.1
+[2.4.0]: https://github.com/MagicMirrorOrg/MagicMirror/compare/v2.3.1...v2.4.0
+[2.3.1]: https://github.com/MagicMirrorOrg/MagicMirror/compare/v2.3.0...v2.3.1
+[2.3.0]: https://github.com/MagicMirrorOrg/MagicMirror/compare/v2.2.2...v2.3.0
+[2.2.2]: https://github.com/MagicMirrorOrg/MagicMirror/compare/v2.2.1...v2.2.2
+[2.2.1]: https://github.com/MagicMirrorOrg/MagicMirror/compare/v2.2.0...v2.2.1
+[2.2.0]: https://github.com/MagicMirrorOrg/MagicMirror/compare/v2.1.3...v2.2.0
+[2.1.3]: https://github.com/MagicMirrorOrg/MagicMirror/compare/v2.1.2...v2.1.3
+[2.1.2]: https://github.com/MagicMirrorOrg/MagicMirror/compare/v2.1.1...v2.1.2
+[2.1.1]: https://github.com/MagicMirrorOrg/MagicMirror/compare/v2.1.0...v2.1.1
+[2.1.0]: https://github.com/MagicMirrorOrg/MagicMirror/compare/v2.0.5...v2.1.0
+[2.0.5]: https://github.com/MagicMirrorOrg/MagicMirror/compare/v2.0.4...v2.0.5
+[2.0.4]: https://github.com/MagicMirrorOrg/MagicMirror/compare/v2.0.3...v2.0.4
+[2.0.3]: https://github.com/MagicMirrorOrg/MagicMirror/compare/v2.0.2...v2.0.3
+[2.0.2]: https://github.com/MagicMirrorOrg/MagicMirror/compare/v2.0.1...v2.0.2
+[2.0.1]: https://github.com/MagicMirrorOrg/MagicMirror/compare/v2.0.0...v2.0.1
+[2.0.0]: https://github.com/MagicMirrorOrg/MagicMirror/releases/tag/v2.0.0

Collaboration.md

@@ -1,3 +1,5 @@
+# Collaboration
+
 This document describes how collaborators of this repository should work together.
 
 ## Pull Requests
@@ -15,24 +17,51 @@ This document describes how collaborators of this repository should work togethe
 
 ## Releases
 
-Are done by @rejas or @khassel.
+Are done by
+
+- [ ] @rejas
+- [ ] @sdetweil
+- [ ] @khassel
+
+### Pre-Deployment steps
+
+- [ ] update dependencies (a few days before)
 
 ### Deployment steps
 
-- pull latest `develop` branch
-- update `package.json` to reflect correct version number
-- run `npm install` to generate new `package-lock.json`
-- test `develop` branch
-- update `CHANGELOG.md` (don't forget to add all contributor names)
-- commit and push all changes
-- after successful test run via github actions: create pull request to `master` branch
-- after PR tests run without issues, merge PR
-- create new release with corresponding version tag
-- publish release notes with link to github release on forum in new locked topic
+- [ ] pull latest `develop` branch
+- [ ] create `prep-release` branch from `develop`
+  - [ ] update `package.json` and `package-lock.json` to reflect correct version number `2.xx.0`
+  - [ ] test `prep-release` branch
+  - [ ] update `CHANGELOG.md`
+    - [ ] add all contributor names: `...`
+    - [ ] add min. node version: > ⚠️ This release needs nodejs version `v22.14.0` or higher
+    - [ ] check release link at the bottom of the file
+  - [ ] commit and push all changes
+  - [ ] create pull request from `prep-release` to `develop` branch with title `Prepare Release 2.xx.0`
+  - [ ] after successful test run via github actions: merge pull request to `develop`
+- [ ] after successful test run via github actions: create pull request from `develop` to `master` branch
+  - [ ] add label `mastermerge`
+  - [ ] title of the PR is `Release 2.xx.0`
+  - [ ] description of the PR is the section of the `CHANGELOG.md`
+- [ ] after PR tests run without issues, merge PR
+- [ ] create new release with
+  - [ ] corresponding version tag `v2.xx.0`
+  - [ ] a release name: `...`
+  - [ ] description of the release is the section of the `CHANGELOG.md`
 
 ### Draft new development release
 
-- checkout `develop` branch
-- update `package.json` to reflect correct version number `2.xx.0-develop`
-- draft new section in `CHANGELOG.md`
-- commit and publish `develop` branch
+- [ ] checkout `develop` branch
+- [ ] update `package.json` and `package-lock.json` to reflect correct version number `2.xx.0-develop`
+- [ ] draft new section in `CHANGELOG.md`
+  - [ ] create new release link at the bottom of the file
+- [ ] commit and publish `develop` branch
+- [ ] if new release will be in January, update the year in LICENSE.md
+
+### After release
+
+- [ ] publish release notes with link to github release on forum in new locked topic
+- [ ] close all issues with label `ready (coming with next release)`
+- [ ] release new documentation by merging `develop` on `master` in documentation repository
+- [ ] publish new version on [npm](https://www.npmjs.com/package/magicmirror)

LICENSE.md

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

README.md

@@ -1,14 +1,14 @@
-![MagicMirror²: The open source modular smart mirror platform. ](.github/header.png)
+# ![MagicMirror²: The open source modular smart mirror platform.](.github/header.png)
 
 <p style="text-align: center">
   <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/actions/workflow/status/magicmirrororg/magicmirror/automated-tests.yaml" alt="GitHub Actions">
-	<img src="https://img.shields.io/github/checks-status/magicmirrororg/magicmirror/master" alt="Build Status">
-	<a href="https://github.com/MagicMirrorOrg/MagicMirror">
-		<img src="https://img.shields.io/github/stars/magicmirrororg/magicmirror?style=social">
-	</a>
+  <img src="https://img.shields.io/badge/license-MIT-blue.svg" alt="License">
+ </a>
+ <img src="https://img.shields.io/github/actions/workflow/status/magicmirrororg/magicmirror/automated-tests.yaml" alt="GitHub Actions">
+ <img src="https://img.shields.io/github/check-runs/magicmirrororg/magicmirror/master" alt="Build Status">
+ <a href="https://github.com/MagicMirrorOrg/MagicMirror">
+  <img src="https://img.shields.io/github/stars/magicmirrororg/magicmirror?style=social" alt="GitHub Stars">
+ </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/MagicMirrorOrg/MagicMirror/graphs/contributors).
@@ -24,7 +24,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
+  - 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)
@@ -41,7 +41,7 @@ For the full contribution guidelines, check out: [https://docs.magicmirror.build
 
 ## Enjoying MagicMirror? Consider a donation!
 
-MagicMirror² is opensource and free. That doesn't mean we don't need any money.
+MagicMirror² is Open Source and free. That doesn't mean we don't need any money.
 
 Please consider a donation to help us cover the ongoing costs like webservers and email services.
 If we receive enough donations we might even be able to free up some working hours and spend some extra time improving the MagicMirror² core.
@@ -49,5 +49,5 @@ If we receive enough donations we might even be able to free up some working hou
 To donate, please follow [this](https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick&hosted_button_id=G5D8E9MR5DTD2&source=url) link.
 
 <p style="text-align: center">
-	<a href="https://forum.magicmirror.builders/topic/728/magicmirror-is-voted-number-1-in-the-magpi-top-50"><img src="https://magicmirror.builders/img/magpi-best-watermark-custom.png" width="150" alt="MagPi Top 50"></a>
+  <a href="https://forum.magicmirror.builders/topic/728/magicmirror-is-voted-number-1-in-the-magpi-top-50"><img src="https://magicmirror.builders/img/magpi-best-watermark-custom.png" width="150" alt="MagPi Top 50"></a>
 </p>

clientonly/index.js

@@ -28,7 +28,7 @@
 		});
 
 		// determine if "--use-tls"-flag was provided
-		config["tls"] = process.argv.indexOf("--use-tls") > 0;
+		config.tls = process.argv.indexOf("--use-tls") > 0;
 	}
 
 	/**
@@ -83,6 +83,17 @@
 	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) {
+				// check environment for DISPLAY or WAYLAND_DISPLAY
+				const elecParams = ["js/electron.js"];
+				if (process.env.WAYLAND_DISPLAY) {
+					console.log(`Client: Using WAYLAND_DISPLAY=${process.env.WAYLAND_DISPLAY}`);
+					elecParams.push("--enable-features=UseOzonePlatform");
+					elecParams.push("--ozone-platform=wayland");
+				} else if (process.env.DISPLAY) {
+					console.log(`Client: Using DISPLAY=${process.env.DISPLAY}`);
+				} else {
+					fail("Error: Requires environment variable WAYLAND_DISPLAY or DISPLAY, none is provided.");
+				}
 				// Pass along the server config via an environment variable
 				const env = Object.create(process.env);
 				env.clientonly = true; // set to pass to electron.js
@@ -94,7 +105,7 @@
 
 				// Spawn electron application
 				const electron = require("electron");
-				const child = require("node:child_process").spawn(electron, ["js/electron.js"], options);
+				const child = require("node:child_process").spawn(electron, elecParams, options);
 
 				// Pipe all child process output to current stdout
 				child.stdout.on("data", function (buf) {

config/config.js.sample

@@ -28,7 +28,11 @@ let config = {
 	httpsCertificate: "",	// HTTPS Certificate path, only require when useHttps is true
 
 	language: "en",
-	locale: "en-US",
+	locale: "en-US",   // this variable is provided as a consistent location
+			   // it is currently only used by 3rd party modules. no MagicMirror code uses this value
+			   // as we have no usage, we  have no constraints on what this field holds
+			   // see https://en.wikipedia.org/wiki/Locale_(computer_software) for the possibilities
+
 	logLevel: ["INFO", "LOG", "WARN", "ERROR"], // Add "DEBUG" for even more logging
 	timeFormat: 24,
 	units: "metric",

cspell.config.json

@@ -0,0 +1,245 @@
+{
+	"version": "0.2",
+	"language": "en",
+	"words": [
+		"aarch",
+		"Alvinger",
+		"Ampio",
+		"andrezibaia",
+		"angeldeejay",
+		"apiontek",
+		"armv",
+		"ashishtank",
+		"autoplay",
+		"beada",
+		"Binney",
+		"bluemanos",
+		"bnitkin",
+		"bokmål",
+		"Brasileiro",
+		"Brento",
+		"browserwindow",
+		"bryanzzhu",
+		"btoconnor",
+		"bugsounet",
+		"buxxi",
+		"byday",
+		"calendarfetcherutils",
+		"calendarutils",
+		"chamakura",
+		"cjbrunner",
+		"clientonly",
+		"clockfaces",
+		"cmdline",
+		"codac",
+		"Crazylegstoo",
+		"crazyscot",
+		"Creepin",
+		"currentweather",
+		"CUSTOMCSS",
+		"customregions",
+		"cxmj",
+		"Cymraeg",
+		"dariom",
+		"darksky",
+		"dateheader",
+		"dateheaders",
+		"davide",
+		"DAYAFTERTOMORROW",
+		"DAYBEFOREYESTERDAY",
+		"defaultmodules",
+		"dgoth",
+		"dkallen",
+		"drivelist",
+		"DTEND",
+		"Duffman",
+		"earlman",
+		"easyas",
+		"eddiehung",
+		"Edgardos",
+		"Ekristoffe",
+		"elec",
+		"envcanada",
+		"envsub",
+		"envsubst",
+		"eouia",
+		"exdate",
+		"expectedheaders",
+		"ezeholz",
+		"Faizan",
+		"feedme",
+		"feelslike",
+		"Fenner",
+		"fewieden",
+		"fixuppm",
+		"flopp",
+		"fontawesome",
+		"fontface",
+		"forecastweather",
+		"fortawesome",
+		"frameguard",
+		"Frysk",
+		"fulldate",
+		"fullday",
+		"fullscreen",
+		"Gevoelstemperatuur",
+		"GHSA",
+		"ghsas",
+		"grenagit",
+		"Heiko",
+		"Hirschberger",
+		"hourlyweather",
+		"Hwind",
+		"ical",
+		"illimarkangur",
+		"Ingan",
+		"ipfilter",
+		"ismarslomic",
+		"jakemulley",
+		"jakobsarwary",
+		"jalibu",
+		"jargordon",
+		"jetson",
+		"jkriegshauser",
+		"jsdocs",
+		"jsonlint",
+		"jupadin",
+		"kaennchenstruggle",
+		"kenzal",
+		"Keyport",
+		"khassel",
+		"Kingdon",
+		"kioskmode",
+		"klaernie",
+		"kleinmantara",
+		"Kmph",
+		"Knapoc",
+		"Koepke",
+		"kolbyjack",
+		"krekos",
+		"Kristjan",
+		"krukle",
+		"labwc",
+		"Landis",
+		"larryare",
+		"letsencrypt",
+		"libgpiod",
+		"Lightspeed",
+		"locationforecast",
+		"lockstring",
+		"lstrip",
+		"Luciella",
+		"luxon",
+		"lxsession",
+		"magicmirror",
+		"martingron",
+		"marvai",
+		"mastermerge",
+		"matchtype",
+		"maxentries",
+		"Meteo",
+		"michaelteeuw",
+		"michmich",
+		"Midori",
+		"mirontoli",
+		"MISSINGLANG",
+		"MMPM",
+		"modernizr",
+		"modulename",
+		"multiday",
+		"Mystara",
+		"Ñandú",
+		"nathannaveen",
+		"naveensrinivasan",
+		"ndom",
+		"Nerfzooka",
+		"NEWSFEED",
+		"newsitems",
+		"nfogal",
+		"njwilliams",
+		"nonrepeating",
+		"Norsk",
+		"nunjuck",
+		"odroid",
+		"oemel",
+		"onecall",
+		"onevent",
+		"openmeteo",
+		"openweathermap",
+		"oraclesean",
+		"oscarb",
+		"philnagel",
+		"Português",
+		"PRECIP",
+		"Problema",
+		"psieg",
+		"radokristof",
+		"rajniszp",
+		"rebuilded",
+		"Reis",
+		"rejas",
+		"Resig",
+		"roboto",
+		"rohitdharavath",
+		"Rosso",
+		"rrule",
+		"sdetweil",
+		"sendheaders",
+		"serveronly",
+		"skpanagiotis",
+		"SMHI",
+		"Snille",
+		"socketclient",
+		"socketio",
+		"spectron",
+		"Starinvest",
+		"sthuber",
+		"Stieber",
+		"stylelintrc",
+		"subclassing",
+		"sunaction",
+		"suncalc",
+		"suntimes",
+		"symboltest",
+		"systeminformation",
+		"tada",
+		"taglist",
+		"Teeuw",
+		"TESTMODE",
+		"thomasrockhu",
+		"tomzt",
+		"ukmetoffice",
+		"ukmetofficedatahub",
+		"unitless",
+		"unparseable",
+		"updatenotification",
+		"Vaice",
+		"veeck",
+		"VEVENT",
+		"vgtu",
+		"Voelt",
+		"vppencilsharpener",
+		"Wallys",
+		"Weatherbit",
+		"WEATHERDATA",
+		"Weatherflow",
+		"weatherforecast",
+		"weathergov",
+		"weathericons",
+		"weatherobject",
+		"weatherutils",
+		"windspeed",
+		"Woolridge",
+		"worktree",
+		"xlarge",
+		"xrandr",
+		"xsmall",
+		"xsorifc",
+		"xwindows",
+		"xxxe",
+		"Ybbet",
+		"yearmatchgroup"
+	],
+	"ignorePaths": ["node_modules/**", "modules/**", "vendor/node_modules/**", "translations/**", "tests/mocks/**", "tests/e2e/modules/clock_es_spec.js", "fonts/roboto.css"],
+	"dictionaries": ["node"]
+}

eslint.config.mjs

@@ -0,0 +1,124 @@
+import eslintPluginImport from "eslint-plugin-import";
+import eslintPluginJest from "eslint-plugin-jest";
+import eslintPluginJs from "@eslint/js";
+import eslintPluginPackageJson from "eslint-plugin-package-json";
+import eslintPluginStylistic from "@stylistic/eslint-plugin";
+import globals from "globals";
+
+const config = [
+	eslintPluginImport.flatConfigs.recommended,
+	eslintPluginJest.configs["flat/recommended"],
+	eslintPluginJs.configs.recommended,
+	eslintPluginPackageJson.configs.recommended,
+	eslintPluginStylistic.configs.all,
+	{
+		files: ["**/*.js"],
+		languageOptions: {
+			ecmaVersion: "latest",
+			globals: {
+				...globals.browser,
+				...globals.node,
+				...globals.jest,
+				Log: "readonly",
+				MM: "readonly",
+				Module: "readonly",
+				config: "readonly",
+				moment: "readonly"
+			}
+		},
+		rules: {
+			"@stylistic/array-element-newline": ["error", "consistent"],
+			"@stylistic/arrow-parens": ["error", "always"],
+			"@stylistic/brace-style": "off",
+			"@stylistic/comma-dangle": ["error", "never"],
+			"@stylistic/dot-location": ["error", "property"],
+			"@stylistic/function-call-argument-newline": ["error", "consistent"],
+			"@stylistic/function-paren-newline": ["error", "consistent"],
+			"@stylistic/implicit-arrow-linebreak": ["error", "beside"],
+			"@stylistic/indent": ["error", "tab"],
+			"@stylistic/max-statements-per-line": ["error", {max: 2}],
+			"@stylistic/multiline-comment-style": "off",
+			"@stylistic/multiline-ternary": ["error", "always-multiline"],
+			"@stylistic/newline-per-chained-call": ["error", {ignoreChainWithDepth: 4}],
+			"@stylistic/no-extra-parens": "off",
+			"@stylistic/no-tabs": "off",
+			"@stylistic/object-curly-spacing": ["error", "always"],
+			"@stylistic/object-property-newline": ["error", {allowAllPropertiesOnSameLine: true}],
+			"@stylistic/operator-linebreak": ["error", "before"],
+			"@stylistic/padded-blocks": "off",
+			"@stylistic/quote-props": ["error", "as-needed"],
+			"@stylistic/quotes": ["error", "double"],
+			"@stylistic/semi": ["error", "always"],
+			"@stylistic/space-before-function-paren": ["error", "always"],
+			"@stylistic/spaced-comment": "off",
+			"dot-notation": "error",
+			eqeqeq: "error",
+			"id-length": "off",
+			"import/extensions": "error",
+			"import/newline-after-import": "error",
+			"import/order": "error",
+			"init-declarations": "off",
+			"jest/consistent-test-it": "warn",
+			"jest/no-done-callback": "warn",
+			"jest/prefer-expect-resolves": "warn",
+			"jest/prefer-mock-promise-shorthand": "warn",
+			"jest/prefer-to-be": "warn",
+			"jest/prefer-to-have-length": "warn",
+			"max-lines-per-function": ["warn", 400],
+			"max-statements": "off",
+			"no-global-assign": "off",
+			"no-inline-comments": "off",
+			"no-magic-numbers": "off",
+			"no-param-reassign": "error",
+			"no-plusplus": "off",
+			"no-prototype-builtins": "off",
+			"no-ternary": "off",
+			"no-throw-literal": "error",
+			"no-undefined": "off",
+			"no-unneeded-ternary": "error",
+			"no-unused-vars": "off",
+			"no-useless-return": "error",
+			"no-warning-comments": "off",
+			"object-shorthand": ["error", "methods"],
+			"one-var": "off",
+			"prefer-destructuring": "off",
+			"prefer-template": "error",
+			"sort-keys": "off"
+		}
+	},
+	{
+		files: ["**/*.mjs"],
+		languageOptions: {
+			ecmaVersion: "latest",
+			globals: {
+				...globals.node
+			},
+			sourceType: "module"
+		},
+		rules: {
+			"@stylistic/array-element-newline": "off",
+			"@stylistic/indent": ["error", "tab"],
+			"@stylistic/padded-blocks": ["error", "never"],
+			"@stylistic/quote-props": ["error", "as-needed"],
+			"func-style": "off",
+			"import/namespace": "off",
+			"import/no-unresolved": "off",
+			"max-lines-per-function": ["error", 100],
+			"no-magic-numbers": "off",
+			"one-var": "off",
+			"prefer-destructuring": "off",
+			"sort-keys": "error"
+		}
+	},
+	{
+		files: ["tests/configs/modules/weather/*.js"],
+		rules: {
+			"@stylistic/quotes": "off"
+		}
+	},
+	{
+		ignores: ["config/**", "modules/**/*", "!modules/default/**", "js/positions.js"]
+	}
+];
+
+export default config;

fonts/package-lock.json

@@ -9,19 +9,27 @@
 			"version": "1.0.0",
 			"license": "MIT",
 			"dependencies": {
-				"@fontsource/roboto": "^5.0.13",
-				"@fontsource/roboto-condensed": "^5.0.16"
+				"@fontsource/roboto": "^5.2.5",
+				"@fontsource/roboto-condensed": "^5.2.5"
 			}
 		},
 		"node_modules/@fontsource/roboto": {
-			"version": "5.0.13",
-			"resolved": "https://registry.npmjs.org/@fontsource/roboto/-/roboto-5.0.13.tgz",
-			"integrity": "sha512-j61DHjsdUCKMXSdNLTOxcG701FWnF0jcqNNQi2iPCDxU8seN/sMxeh62dC++UiagCWq9ghTypX+Pcy7kX+QOeQ=="
+			"version": "5.2.5",
+			"resolved": "https://registry.npmjs.org/@fontsource/roboto/-/roboto-5.2.5.tgz",
+			"integrity": "sha512-70r2UZ0raqLn5W+sPeKhqlf8wGvUXFWlofaDlcbt/S3d06+17gXKr3VNqDODB0I1ASme3dGT5OJj9NABt7OTZQ==",
+			"license": "OFL-1.1",
+			"funding": {
+				"url": "https://github.com/sponsors/ayuhito"
+			}
 		},
 		"node_modules/@fontsource/roboto-condensed": {
-			"version": "5.0.16",
-			"resolved": "https://registry.npmjs.org/@fontsource/roboto-condensed/-/roboto-condensed-5.0.16.tgz",
-			"integrity": "sha512-pjO80g5x/hkqzWCIafvkS3JrkBDxSiTjEy4LdqQKJYrmoGx8x2AlhSUMgzIzG/ge4kT98bA7+gmm7yquzrrZ/w=="
+			"version": "5.2.5",
+			"resolved": "https://registry.npmjs.org/@fontsource/roboto-condensed/-/roboto-condensed-5.2.5.tgz",
+			"integrity": "sha512-FVubmVJpZ2js2+nCBEA3IOHhAgWmZ2/YKvTae0X25jlxbd85umOOvUIY6FL6OMpUvIgvwOImS9l0GJjzEPk+mg==",
+			"license": "OFL-1.1",
+			"funding": {
+				"url": "https://github.com/sponsors/ayuhito"
+			}
 		}
 	}
 }

fonts/package.json

@@ -11,7 +11,7 @@
 	},
 	"license": "MIT",
 	"dependencies": {
-		"@fontsource/roboto": "^5.0.13",
-		"@fontsource/roboto-condensed": "^5.0.16"
+		"@fontsource/roboto": "^5.2.5",
+		"@fontsource/roboto-condensed": "^5.2.5"
 	}
 }

index.html

@@ -18,6 +18,7 @@
 
     <script type="text/javascript">
       window.mmVersion = "#VERSION#";
+      window.mmTestMode = "#TESTMODE#";
     </script>
   </head>
   <body>
@@ -55,6 +56,7 @@
     <script type="text/javascript" src="js/loader.js"></script>
     <script type="text/javascript" src="js/socketclient.js"></script>
     <script type="text/javascript" src="js/animateCSS.js"></script>
+    <script type="text/javascript" src="js/positions.js"></script>
     <script type="text/javascript" src="js/main.js"></script>
   </body>
 </html>

installers/mm.sh

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

js/animateCSS.js

@@ -155,3 +155,4 @@ function removeAnimateCSS (element, animation) {
 	node.classList.remove("animate__animated", animationName);
 	node.style.removeProperty("--animate-duration");
 }
+if (typeof window === "undefined") module.exports = { AnimateCSSIn, AnimateCSSOut };

js/app.js

@@ -9,9 +9,16 @@ const Log = require("logger");
 const Server = require(`${__dirname}/server`);
 const Utils = require(`${__dirname}/utils`);
 const defaultModules = require(`${__dirname}/../modules/default/defaultmodules`);
+const { getEnvVarsAsObj } = require(`${__dirname}/server_functions`);
+
+// used to control fetch timeout for node_helpers
+const { setGlobalDispatcher, Agent } = require("undici");
+// common timeout value, provide environment override in case
+const fetch_timeout = process.env.mmFetchTimeout !== undefined ? process.env.mmFetchTimeout : 30000;
 
 // Get version number.
 global.version = require(`${__dirname}/../package.json`).version;
+global.mmTestMode = process.env.mmTestMode === "true";
 Log.log(`Starting MagicMirror: v${global.version}`);
 
 // Log system information.
@@ -116,6 +123,8 @@ function App () {
 			}
 		}
 
+		require(`${global.root_path}/js/check_config.js`);
+
 		try {
 			fs.accessSync(configFilename, fs.F_OK);
 			const c = require(configFilename);
@@ -144,11 +153,23 @@ function App () {
 	 */
 	function checkDeprecatedOptions (userConfig) {
 		const deprecated = require(`${global.root_path}/js/deprecated`);
-		const deprecatedOptions = deprecated.configs;
 
+		// check for deprecated core options
+		const deprecatedOptions = deprecated.configs;
 		const usedDeprecated = deprecatedOptions.filter((option) => userConfig.hasOwnProperty(option));
 		if (usedDeprecated.length > 0) {
-			Log.warn(`WARNING! Your config is using deprecated options: ${usedDeprecated.join(", ")}. Check README and CHANGELOG for more up-to-date ways of getting the same functionality.`);
+			Log.warn(`WARNING! Your config is using deprecated option(s): ${usedDeprecated.join(", ")}. Check README and CHANGELOG for more up-to-date ways of getting the same functionality.`);
+		}
+
+		// check for deprecated module options
+		for (const element of userConfig.modules) {
+			if (deprecated[element.module] !== undefined && element.config !== undefined) {
+				const deprecatedModuleOptions = deprecated[element.module];
+				const usedDeprecatedModuleOptions = deprecatedModuleOptions.filter((option) => element.config.hasOwnProperty(option));
+				if (usedDeprecatedModuleOptions.length > 0) {
+					Log.warn(`WARNING! Your config for module ${element.module} is using deprecated option(s): ${usedDeprecatedModuleOptions.join(", ")}. Check README and CHANGELOG for more up-to-date ways of getting the same functionality.`);
+				}
+			}
 		}
 	}
 
@@ -159,13 +180,22 @@ function App () {
 	function loadModule (module) {
 		const elements = module.split("/");
 		const moduleName = elements[elements.length - 1];
-		let moduleFolder = `${__dirname}/../modules/${module}`;
+		const env = getEnvVarsAsObj();
+		let moduleFolder = path.resolve(`${__dirname}/../${env.modulesDir}`, module);
 
 		if (defaultModules.includes(moduleName)) {
-			moduleFolder = `${__dirname}/../modules/default/${module}`;
+			const defaultModuleFolder = path.resolve(`${__dirname}/../modules/default/`, module);
+			if (process.env.JEST_WORKER_ID === undefined) {
+				moduleFolder = defaultModuleFolder;
+			} else {
+				// running in Jest, allow defaultModules placed under moduleDir for testing
+				if (env.modulesDir === "modules" || env.modulesDir === "tests/mocks") {
+					moduleFolder = defaultModuleFolder;
+				}
+			}
 		}
 
-		const moduleFile = `${moduleFolder}/${module}.js`;
+		const moduleFile = `${moduleFolder}/${moduleName}.js`;
 
 		try {
 			fs.accessSync(moduleFile, fs.R_OK);
@@ -183,8 +213,15 @@ function App () {
 			Log.log(`No helper found for module: ${moduleName}.`);
 		}
 
+		// if the helper was found
 		if (loadHelper) {
-			const Module = require(helperPath);
+			let Module;
+			try {
+				Module = require(helperPath);
+			} catch (e) {
+				Log.error(`Error when loading ${moduleName}:`, e.message);
+				return;
+			}
 			let m = new Module();
 
 			if (m.requiresVersion) {
@@ -255,20 +292,28 @@ function App () {
 
 		Log.setLogLevel(config.logLevel);
 
+		// get the used module positions
+		Utils.getModulePositions();
+
 		let modules = [];
 		for (const module of config.modules) {
 			if (module.disabled) continue;
 			if (module.module) {
 				if (Utils.moduleHasValidPosition(module.position) || typeof (module.position) === "undefined") {
-					modules.push(module.module);
+					// Only add this module to be loaded if it is not a duplicate (repeated instance of the same module)
+					if (!modules.includes(module.module)) {
+						modules.push(module.module);
+					}
 				} else {
-					Log.warn("Invalid module position found for this configuration:", module);
+					Log.warn("Invalid module position found for this configuration:" + `\n${JSON.stringify(module, null, 2)}`);
 				}
 			} else {
-				Log.warn("No module name found for this configuration:", module);
+				Log.warn("No module name found for this configuration:" + `\n${JSON.stringify(module, null, 2)}`);
 			}
 		}
 
+		setGlobalDispatcher(new Agent({ connect: { timeout: fetch_timeout } }));
+
 		await loadModules(modules);
 
 		httpServer = new Server(config);

js/check_config.js

@@ -1,16 +1,16 @@
 const path = require("node:path");
 const fs = require("node:fs");
-const colors = require("ansis");
-const { Linter } = require("eslint");
-
-const linter = new Linter();
-
 const Ajv = require("ajv");
-
-const ajv = new Ajv();
+const colors = require("ansis");
+const globals = require("globals");
+const { Linter } = require("eslint");
 
 const rootPath = path.resolve(`${__dirname}/../`);
 const Log = require(`${rootPath}/js/logger.js`);
+const Utils = require(`${rootPath}/js/utils.js`);
+
+const linter = new Linter({ configType: "flat" });
+const ajv = new Ajv();
 
 /**
  * Returns a string with path of configuration file.
@@ -30,46 +30,55 @@ function checkConfigFile () {
 
 	// Check if file is present
 	if (fs.existsSync(configFileName) === false) {
-		Log.error(`File not found: ${configFileName}`);
-		throw new Error("No config file present!");
+		throw new Error(`File not found: ${configFileName}\nNo config file present!`);
 	}
 
 	// Check permission
 	try {
 		fs.accessSync(configFileName, fs.F_OK);
-	} catch (e) {
-		Log.error(e);
-		throw new Error("No permission to access config file!");
+	} catch (error) {
+		throw new Error(`${error}\nNo permission to access config file!`);
 	}
 
 	// Validate syntax of the configuration file.
-	Log.info("Checking file... ", configFileName);
+	Log.info(`Checking config file ${configFileName} ...`);
 
 	// I'm not sure if all ever is utf-8
 	const configFile = fs.readFileSync(configFileName, "utf-8");
 
-	// Explicitly tell linter that he might encounter es6 syntax ("let config = {...}")
-	const errors = linter.verify(configFile, {
-		env: {
-			es6: true
-		}
-	});
+	const errors = linter.verify(
+		configFile,
+		{
+			languageOptions: {
+				ecmaVersion: "latest",
+				globals: {
+					...globals.node
+				}
+			}
+		},
+		configFileName
+	);
 
 	if (errors.length === 0) {
 		Log.info(colors.green("Your configuration file doesn't contain syntax errors :)"));
+		validateModulePositions(configFileName);
 	} else {
-		Log.error(colors.red("Your configuration file contains syntax errors :("));
+		let errorMessage = "Your configuration file contains syntax errors :(";
 
 		for (const error of errors) {
-			Log.error(`Line ${error.line} column ${error.column}: ${error.message}`);
+			errorMessage += `\nLine ${error.line} column ${error.column}: ${error.message}`;
 		}
-		return;
+		throw new Error(errorMessage);
 	}
+}
 
-	Log.info("Checking modules structure configuration... ");
+function validateModulePositions (configFileName) {
+	Log.info("Checking modules structure configuration ...");
 
-	// Make Ajv schema confguration of modules config
-	// only scan "module" and "position"
+	const positionList = Utils.getModulePositions();
+
+	// Make Ajv schema configuration of modules config
+	// Only scan "module" and "position"
 	const schema = {
 		type: "object",
 		properties: {
@@ -83,21 +92,7 @@ function checkConfigFile () {
 						},
 						position: {
 							type: "string",
-							enum: [
-								"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"
-							]
+							enum: positionList
 						}
 					},
 					required: ["module"]
@@ -106,26 +101,31 @@ function checkConfigFile () {
 		}
 	};
 
-	// scan all modules
+	// Scan all modules
 	const validate = ajv.compile(schema);
 	const data = require(configFileName);
 
 	const valid = validate(data);
-	if (!valid) {
-		let module = validate.errors[0].instancePath.split("/")[2];
-		let position = validate.errors[0].instancePath.split("/")[3];
-
-		Log.error(colors.red("This module configuration contains errors:"));
-		Log.error(data.modules[module]);
-		if (position) {
-			Log.error(colors.red(`${position}: ${validate.errors[0].message}`));
-			Log.error(validate.errors[0].params.allowedValues);
-		} else {
-			Log.error(colors.red(validate.errors[0].message));
-		}
-	} else {
+	if (valid) {
 		Log.info(colors.green("Your modules structure configuration doesn't contain errors :)"));
+	} else {
+		const module = validate.errors[0].instancePath.split("/")[2];
+		const position = validate.errors[0].instancePath.split("/")[3];
+		let errorMessage = "This module configuration contains errors:";
+		errorMessage += `\n${JSON.stringify(data.modules[module], null, 2)}`;
+		if (position) {
+			errorMessage += `\n${position}: ${validate.errors[0].message}`;
+			errorMessage += `\n${JSON.stringify(validate.errors[0].params.allowedValues, null, 2).slice(1, -1)}`;
+		} else {
+			errorMessage += validate.errors[0].message;
+		}
+		Log.error(errorMessage);
 	}
 }
 
-checkConfigFile();
+try {
+	checkConfigFile();
+} catch (error) {
+	Log.error(error.message);
+	process.exit(1);
+}

js/class.js

@@ -1,6 +1,7 @@
 /* global Class, xyz */
 
-/* Simple JavaScript Inheritance
+/*
+ * Simple JavaScript Inheritance
  * By John Resig https://johnresig.com/
  *
  * Inspired by base2 and Prototype
@@ -22,8 +23,10 @@
 	Class.extend = function (prop) {
 		let _super = this.prototype;
 
-		// Instantiate a base class (but only create the instance,
-		// don't run the init constructor)
+		/*
+		 * Instantiate a base class (but only create the instance,
+		 * don't run the init constructor)
+		 */
 		initializing = true;
 		const prototype = new this();
 		initializing = false;
@@ -42,12 +45,16 @@
 						return function () {
 							const tmp = this._super;
 
-							// Add a new ._super() method that is the same method
-							// but on the super-class
+							/*
+							 * Add a new ._super() method that is the same method
+							 * but on the super-class
+							 */
 							this._super = _super[name];
 
-							// The method only need to be bound temporarily, so we
-							// remove it when we're done executing
+							/*
+							 * The method only need to be bound temporarily, so we
+							 * remove it when we're done executing
+							 */
 							const ret = fn.apply(this, arguments);
 							this._super = tmp;
 

js/defaults.js

@@ -19,6 +19,7 @@ const defaults = {
 	units: "metric",
 	zoom: 1,
 	customCss: "css/custom.css",
+	foreignModulesDir: "modules",
 	// httpHeaders used by helmet, see https://helmetjs.github.io/. You can add other/more object values by overriding this in config.js,
 	// e.g. you need to add `frameguard: false` for embedding MagicMirror in another website, see https://github.com/MagicMirrorOrg/MagicMirror/issues/2847
 	httpHeaders: { contentSecurityPolicy: false, crossOriginOpenerPolicy: false, crossOriginEmbedderPolicy: false, crossOriginResourcePolicy: false, originAgentCluster: false },
@@ -69,15 +70,10 @@ const defaults = {
 			position: "bottom_bar",
 			classes: "xsmall dimmed",
 			config: {
-				text: "www.michaelteeuw.nl"
+				text: "https://magicmirror.builders/"
 			}
 		}
-	],
-
-	paths: {
-		modules: "modules",
-		vendor: "vendor"
-	}
+	]
 };
 
 /*************** DO NOT EDIT THE LINE BELOW ***************/

js/deprecated.js

@@ -1,3 +1,4 @@
 module.exports = {
-	configs: ["kioskmode"]
+	configs: ["kioskmode"],
+	clock: ["secondsColor"]
 };

js/electron.js

@@ -8,9 +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;
-// Per default electron is started with --disable-gpu flag, if you want the gpu enabled,
-// you must set the env var ELECTRON_ENABLE_GPU=1 on startup.
-// See https://www.electronjs.org/docs/latest/tutorial/offscreen-rendering for more info.
+
+/*
+ * Per default electron is started with --disable-gpu flag, if you want the gpu enabled,
+ * you must set the env var ELECTRON_ENABLE_GPU=1 on startup.
+ * See https://www.electronjs.org/docs/latest/tutorial/offscreen-rendering for more info.
+ */
 if (process.env.ELECTRON_ENABLE_GPU !== "1") {
 	app.disableHardwareAcceleration();
 }
@@ -18,16 +21,21 @@ if (process.env.ELECTRON_ENABLE_GPU !== "1") {
 // Module to create native browser window.
 const BrowserWindow = electron.BrowserWindow;
 
-// Keep a global reference of the window object, if you don't, the window will
-// be closed automatically when the JavaScript object is garbage collected.
+/*
+ * Keep a global reference of the window object, if you don't, the window will
+ * be closed automatically when the JavaScript object is garbage collected.
+ */
 let mainWindow;
 
 /**
  *
  */
 function createWindow () {
-	// see https://www.electronjs.org/docs/latest/api/screen
-	// Create a window that fills the screen's available work area.
+
+	/*
+	 * see https://www.electronjs.org/docs/latest/api/screen
+	 * Create a window that fills the screen's available work area.
+	 */
 	let electronSize = (800, 600);
 	try {
 		electronSize = electron.screen.getPrimaryDisplay().workAreaSize;
@@ -52,8 +60,10 @@ function createWindow () {
 		backgroundColor: "#000000"
 	};
 
-	// DEPRECATED: "kioskmode" backwards compatibility, to be removed
-	// settings these options directly instead provides cleaner interface
+	/*
+	 * DEPRECATED: "kioskmode" backwards compatibility, to be removed
+	 * settings these options directly instead provides cleaner interface
+	 */
 	if (config.kioskmode) {
 		electronOptionsDefaults.kiosk = true;
 	} else {
@@ -66,14 +76,33 @@ function createWindow () {
 
 	const electronOptions = Object.assign({}, electronOptionsDefaults, config.electronOptions);
 
+	if (process.env.JEST_WORKER_ID !== undefined && process.env.MOCK_DATE !== undefined) {
+		// if we are running with jest and we want to mock the current date
+		const fakeNow = new Date(process.env.MOCK_DATE).valueOf();
+		Date = class extends Date {
+			constructor (...args) {
+				if (args.length === 0) {
+					super(fakeNow);
+				} else {
+					super(...args);
+				}
+			}
+		};
+		const __DateNowOffset = fakeNow - Date.now();
+		const __DateNow = Date.now;
+		Date.now = () => __DateNow() + __DateNowOffset;
+	}
+
 	// Create the browser window.
 	mainWindow = new BrowserWindow(electronOptions);
 
-	// and load the index.html of the app.
-	// If config.address is not defined or is an empty string (listening on all interfaces), connect to localhost
+	/*
+	 * and load the index.html of the app.
+	 * 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"]) || config.useHttps) {
+	if ((config.tls !== null && config.tls) || config.useHttps) {
 		prefix = "https://";
 	} else {
 		prefix = "http://";
@@ -122,11 +151,11 @@ function createWindow () {
 	//remove response headers that prevent sites of being embedded into iframes if configured
 	mainWindow.webContents.session.webRequest.onHeadersReceived((details, callback) => {
 		let curHeaders = details.responseHeaders;
-		if (config["ignoreXOriginHeader"] || false) {
+		if (config.ignoreXOriginHeader || false) {
 			curHeaders = Object.fromEntries(Object.entries(curHeaders).filter((header) => !(/x-frame-options/i).test(header[0])));
 		}
 
-		if (config["ignoreContentSecurityPolicy"] || false) {
+		if (config.ignoreContentSecurityPolicy || false) {
 			curHeaders = Object.fromEntries(Object.entries(curHeaders).filter((header) => !(/content-security-policy/i).test(header[0])));
 		}
 
@@ -149,14 +178,18 @@ app.on("window-all-closed", function () {
 });
 
 app.on("activate", function () {
-	// On OS X it's common to re-create a window in the app when the
-	// dock icon is clicked and there are no other windows open.
+
+	/*
+	 * On OS X it's common to re-create a window in the app when the
+	 * dock icon is clicked and there are no other windows open.
+	 */
 	if (mainWindow === null) {
 		createWindow();
 	}
 });
 
-/* This method will be called when SIGINT is received and will call
+/*
+ * This method will be called when SIGINT is received and will call
  * each node_helper's stop function if it exists. Added to fix #1056
  *
  * Note: this is only used if running Electron. Otherwise
@@ -187,8 +220,10 @@ if (process.env.clientonly) {
 	});
 }
 
-// Start the core application if server is run on localhost
-// This starts all node helpers and starts the webserver.
+/*
+ * 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)) {
 	core.start().then((c) => {
 		config = c;

js/loader.js

@@ -10,6 +10,15 @@ const Loader = (function () {
 
 	/* Private Methods */
 
+	/**
+	 * Retrieve object of env variables.
+	 * @returns {object} with key: values as assembled in js/server_functions.js
+	 */
+	const getEnvVars = async function () {
+		const res = await fetch(`${location.protocol}//${location.host}${config.basePath}env`);
+		return JSON.parse(await res.text());
+	};
+
 	/**
 	 * Loops through all modules and requests start for every module.
 	 */
@@ -58,19 +67,28 @@ const Loader = (function () {
 	 * Generate array with module information including module paths.
 	 * @returns {object[]} Module information.
 	 */
-	const getModuleData = function () {
+	const getModuleData = async function () {
 		const modules = getAllModules();
 		const moduleFiles = [];
+		const envVars = await getEnvVars();
 
 		modules.forEach(function (moduleData, index) {
 			const module = moduleData.module;
 
 			const elements = module.split("/");
 			const moduleName = elements[elements.length - 1];
-			let moduleFolder = `${config.paths.modules}/${module}`;
+			let moduleFolder = `${envVars.modulesDir}/${module}`;
 
 			if (defaultModules.indexOf(moduleName) !== -1) {
-				moduleFolder = `${config.paths.modules}/default/${module}`;
+				const defaultModuleFolder = `modules/default/${module}`;
+				if (window.name !== "jsdom") {
+					moduleFolder = defaultModuleFolder;
+				} else {
+					// running in Jest, allow defaultModules placed under moduleDir for testing
+					if (envVars.modulesDir === "modules") {
+						moduleFolder = defaultModuleFolder;
+					}
+				}
 			}
 
 			if (moduleData.disabled === true) {
@@ -166,6 +184,7 @@ const Loader = (function () {
 					};
 					script.onerror = function () {
 						Log.error("Error on loading script:", fileName);
+						script.remove();
 						resolve();
 					};
 					document.getElementsByTagName("body")[0].appendChild(script);
@@ -183,6 +202,7 @@ const Loader = (function () {
 					};
 					stylesheet.onerror = function () {
 						Log.error("Error on loading stylesheet:", fileName);
+						stylesheet.remove();
 						resolve();
 					};
 					document.getElementsByTagName("head")[0].appendChild(stylesheet);
@@ -197,7 +217,9 @@ const Loader = (function () {
 		 * Load all modules as defined in the config.
 		 */
 		async loadModules () {
-			let moduleData = getModuleData();
+			let moduleData = await getModuleData();
+			const envVars = await getEnvVars();
+			const customCss = envVars.customCss;
 
 			/**
 			 * @returns {Promise<void>} when all modules are loaded
@@ -212,7 +234,7 @@ const Loader = (function () {
 					// All modules loaded. Load custom.css
 					// This is done after all the modules so we can
 					// overwrite all the defined styles.
-					await loadFile(config.customCss);
+					await loadFile(customCss);
 					// custom.css loaded. Start all modules.
 					await startModules();
 				}
@@ -244,7 +266,7 @@ const Loader = (function () {
 				// This file is available in the vendor folder.
 				// Load it from this vendor folder.
 				loadedFiles.push(fileName.toLowerCase());
-				return loadFile(`${config.paths.vendor}/${vendor[fileName]}`);
+				return loadFile(`vendor/${vendor[fileName]}`);
 			}
 
 			// File not loaded yet.

js/main.js

@@ -1,4 +1,4 @@
-/* global Loader, defaults, Translator, addAnimateCSS, removeAnimateCSS, AnimateCSSIn, AnimateCSSOut */
+/* global Loader, defaults, Translator, addAnimateCSS, removeAnimateCSS, AnimateCSSIn, AnimateCSSOut, modulePositions */
 
 const MM = (function () {
 	let modules = [];
@@ -286,9 +286,9 @@ const MM = (function () {
 				Log.debug(`${module.identifier} Force remove animateIn (in hide): ${module.hasAnimateIn}`);
 				module.hasAnimateIn = false;
 			}
-			// haveAnimateName for verify if we are using AninateCSS library
+			// haveAnimateName for verify if we are using AnimateCSS library
 			// we check AnimateCSSOut Array for validate it
-			// and finaly return the animate name or `null` (for default MM² animation)
+			// and finally return the animate name or `null` (for default MM² animation)
 			let haveAnimateName = null;
 			// check if have valid animateOut in module definition (module.data.animateOut)
 			if (module.data.animateOut && AnimateCSSOut.indexOf(module.data.animateOut) !== -1) haveAnimateName = module.data.animateOut;
@@ -357,7 +357,7 @@ const MM = (function () {
 			}
 		}
 
-		// Check if there are no more lockstrings set, or the force option is set.
+		// Check if there are no more lockStrings set, or the force option is set.
 		// Otherwise cancel show action.
 		if (module.lockStrings.length !== 0 && options.force !== true) {
 			Log.log(`Will not show ${module.name}. LockStrings active: ${module.lockStrings.join(",")}`);
@@ -380,7 +380,7 @@ const MM = (function () {
 
 		module.hidden = false;
 
-		// If forced show, clean current lockstrings.
+		// If forced show, clean current lockStrings.
 		if (module.lockStrings.length !== 0 && options.force === true) {
 			Log.log(`Force show of module: ${module.name}`);
 			module.lockStrings = [];
@@ -390,9 +390,9 @@ const MM = (function () {
 		if (moduleWrapper !== null) {
 			clearTimeout(module.showHideTimer);
 
-			// haveAnimateName for verify if we are using AninateCSS library
+			// haveAnimateName for verify if we are using AnimateCSS library
 			// we check AnimateCSSIn Array for validate it
-			// and finaly return the animate name or `null` (for default MM² animation)
+			// and finally return the animate name or `null` (for default MM² animation)
 			let haveAnimateName = null;
 			// check if have valid animateOut in module definition (module.data.animateIn)
 			if (module.data.animateIn && AnimateCSSIn.indexOf(module.data.animateIn) !== -1) haveAnimateName = module.data.animateIn;
@@ -450,7 +450,6 @@ const MM = (function () {
 	 * an ugly top margin. By using this function, the top bar will be hidden if the
 	 * update notification is not visible.
 	 */
-	const modulePositions = ["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 () {
 		modulePositions.forEach(function (position) {
@@ -609,7 +608,7 @@ const MM = (function () {
 					// if server startup time has changed (which means server was restarted)
 					// the client reloads the mm page
 					try {
-						const res = await fetch(`${location.protocol}//${location.host}/startup`);
+						const res = await fetch(`${location.protocol}//${location.host}${config.basePath}startup`);
 						const curr = await res.text();
 						if (startUp === "") startUp = curr;
 						if (startUp !== curr) {
@@ -667,7 +666,10 @@ const MM = (function () {
 			}
 
 			// Further implementation is done in the private method.
-			updateDom(module, updateOptions);
+			updateDom(module, updateOptions).then(function () {
+				// Once the update is complete and rendered, send a notification to the module that the DOM has been updated
+				sendNotification("MODULE_DOM_UPDATED", null, null, module);
+			});
 		},
 
 		/**
@@ -703,7 +705,7 @@ const MM = (function () {
 			showModule(module, speed, callback, options);
 		},
 
-		// return all available module postions.
+		// Return all available module positions.
 		getAvailableModulePositions: modulePositions
 	};
 }());

js/module.js

@@ -1,13 +1,16 @@
 /* global Class, cloneObject, Loader, MMSocket, nunjucks, Translator */
 
-/* Module Blueprint.
+/*
+ * Module Blueprint.
  * @typedef {Object} Module
  */
 const Module = Class.extend({
 
-	/*********************************************************
+	/**
+	 ********************************************************
 	 * All methods (and properties) below can be subclassed. *
-	 *********************************************************/
+	 ********************************************************
+	 */
 
 	// Set the minimum MagicMirror² module version for this module.
 	requiresVersion: "2.0.0",
@@ -18,13 +21,17 @@ const Module = Class.extend({
 	// Timer reference used for showHide animation callbacks.
 	showHideTimer: null,
 
-	// Array to store lockStrings. These strings are used to lock
-	// visibility when hiding and showing module.
+	/*
+	 * Array to store lockStrings. These strings are used to lock
+	 * visibility when hiding and showing module.
+	 */
 	lockStrings: [],
 
-	// Storage of the nunjucks Environment,
-	// This should not be referenced directly.
-	// Use the nunjucksEnvironment() to get it.
+	/*
+	 * Storage of the nunjucks Environment,
+	 * This should not be referenced directly.
+	 * Use the nunjucksEnvironment() to get it.
+	 */
 	_nunjucksEnvironment: null,
 
 	/**
@@ -189,9 +196,11 @@ const Module = Class.extend({
 		Log.log(`${this.name} is resumed.`);
 	},
 
-	/*********************************************
+	/**
+	 ********************************************
 	 * The methods below don't need subclassing. *
-	 *********************************************/
+	 ********************************************
+	 */
 
 	/**
 	 * Set the module data.

js/node_helper.js

@@ -49,7 +49,8 @@ const NodeHelper = Class.extend({
 		this.path = path;
 	},
 
-	/* sendSocketNotification(notification, payload)
+	/*
+	 * sendSocketNotification(notification, payload)
 	 * Send a socket notification to the node helper.
 	 *
 	 * argument notification string - The identifier of the notification.
@@ -59,7 +60,8 @@ const NodeHelper = Class.extend({
 		this.io.of(this.name).emit(notification, payload);
 	},
 
-	/* setExpressApp(app)
+	/*
+	 * setExpressApp(app)
 	 * Sets the express app object for this module.
 	 * This allows you to host files from the created webserver.
 	 *
@@ -71,7 +73,8 @@ const NodeHelper = Class.extend({
 		app.use(`/${this.name}`, express.static(`${this.path}/public`));
 	},
 
-	/* setSocketIO(io)
+	/*
+	 * setSocketIO(io)
 	 * Sets the socket io object for this module.
 	 * Binds message receiver.
 	 *
@@ -83,20 +86,9 @@ const NodeHelper = Class.extend({
 		Log.log(`Connecting socket for: ${this.name}`);
 
 		io.of(this.name).on("connection", (socket) => {
-			// add a catch all event.
-			const onevent = socket.onevent;
-			socket.onevent = function (packet) {
-				const args = packet.data || [];
-				onevent.call(this, packet); // original call
-				packet.data = ["*"].concat(args);
-				onevent.call(this, packet); // additional call to catch-all
-			};
-
 			// register catch all.
-			socket.on("*", (notification, payload) => {
-				if (notification !== "*") {
-					this.socketNotificationReceived(notification, payload);
-				}
+			socket.onAny((notification, payload) => {
+				this.socketNotificationReceived(notification, payload);
 			});
 		});
 	}

js/server.js

@@ -8,8 +8,7 @@ const helmet = require("helmet");
 const socketio = require("socket.io");
 
 const Log = require("logger");
-const Utils = require("./utils");
-const { cors, getConfig, getHtml, getVersion, getStartup } = require("./server_functions");
+const { cors, getConfig, getHtml, getVersion, getStartup, getEnvVars } = require("./server_functions");
 
 /**
  * Server
@@ -73,8 +72,7 @@ function Server (config) {
 			app.use(helmet(config.httpHeaders));
 			app.use("/js", express.static(__dirname));
 
-			// TODO add tests directory only when running tests?
-			const directories = ["/config", "/css", "/fonts", "/modules", "/vendor", "/translations", "/tests/configs", "/tests/mocks"];
+			let directories = ["/config", "/css", "/fonts", "/modules", "/vendor", "/translations", "/tests/configs", "/tests/mocks"];
 			for (const directory of directories) {
 				app.use(directory, express.static(path.resolve(global.root_path + directory)));
 			}
@@ -87,6 +85,8 @@ function Server (config) {
 
 			app.get("/startup", (req, res) => getStartup(req, res));
 
+			app.get("/env", (req, res) => getEnvVars(req, res));
+
 			app.get("/", (req, res) => getHtml(req, res));
 
 			server.on("listening", () => {

js/server_functions.js

@@ -45,12 +45,12 @@ async function cors (req, res) {
 			url = match[1];
 
 			const headersToSend = getHeadersToSend(req.url);
-			const expectedRecievedHeaders = geExpectedRecievedHeaders(req.url);
+			const expectedReceivedHeaders = geExpectedReceivedHeaders(req.url);
 
 			Log.log(`cors url: ${url}`);
 			const response = await fetch(url, { headers: headersToSend });
 
-			for (const header of expectedRecievedHeaders) {
+			for (const header of expectedReceivedHeaders) {
 				const headerValue = response.headers.get(header);
 				if (header) res.set(header, headerValue);
 			}
@@ -89,16 +89,16 @@ function getHeadersToSend (url) {
  * @param {string} url - The url containing the expected headers from the response.
  * @returns {string[]} headers - The name of the expected headers.
  */
-function geExpectedRecievedHeaders (url) {
-	const expectedRecievedHeaders = ["Content-Type"];
-	const expectedRecievedHeadersMatch = new RegExp("expectedheaders=(.+?)(&|$)", "g").exec(url);
-	if (expectedRecievedHeadersMatch) {
-		const headers = expectedRecievedHeadersMatch[1].split(",");
+function geExpectedReceivedHeaders (url) {
+	const expectedReceivedHeaders = ["Content-Type"];
+	const expectedReceivedHeadersMatch = new RegExp("expectedheaders=(.+?)(&|$)", "g").exec(url);
+	if (expectedReceivedHeadersMatch) {
+		const headers = expectedReceivedHeadersMatch[1].split(",");
 		for (const header of headers) {
-			expectedRecievedHeaders.push(header);
+			expectedReceivedHeaders.push(header);
 		}
 	}
-	return expectedRecievedHeaders;
+	return expectedReceivedHeaders;
 }
 
 /**
@@ -109,6 +109,7 @@ function geExpectedRecievedHeaders (url) {
 function getHtml (req, res) {
 	let html = fs.readFileSync(path.resolve(`${global.root_path}/index.html`), { encoding: "utf8" });
 	html = html.replace("#VERSION#", global.version);
+	html = html.replace("#TESTMODE#", global.mmTestMode);
 
 	let configFile = "config/config.js";
 	if (typeof global.configuration_file !== "undefined") {
@@ -128,4 +129,30 @@ function getVersion (req, res) {
 	res.send(global.version);
 }
 
-module.exports = { cors, getConfig, getHtml, getVersion, getStartup };
+/**
+ * Gets environment variables needed in the browser.
+ * @returns {object} environment variables key: values
+ */
+function getEnvVarsAsObj () {
+	const obj = { modulesDir: `${config.foreignModulesDir}`, customCss: `${config.customCss}` };
+	if (process.env.MM_MODULES_DIR) {
+		obj.modulesDir = process.env.MM_MODULES_DIR.replace(`${global.root_path}/`, "");
+	}
+	if (process.env.MM_CUSTOMCSS_FILE) {
+		obj.customCss = process.env.MM_CUSTOMCSS_FILE.replace(`${global.root_path}/`, "");
+	}
+
+	return obj;
+}
+
+/**
+ * Gets environment variables needed in the browser.
+ * @param {Request} req - the request
+ * @param {Response} res - the result
+ */
+function getEnvVars (req, res) {
+	const obj = getEnvVarsAsObj();
+	res.send(obj);
+}
+
+module.exports = { cors, getConfig, getHtml, getVersion, getStartup, getEnvVars, getEnvVarsAsObj };

js/translator.js

@@ -15,14 +15,14 @@ const Translator = (function () {
 			xhr.onreadystatechange = function () {
 				if (xhr.readyState === 4 && xhr.status === 200) {
 					// needs error handler try/catch at least
-					let fileinfo = null;
+					let fileInfo = null;
 					try {
-						fileinfo = JSON.parse(xhr.responseText);
+						fileInfo = JSON.parse(xhr.responseText);
 					} catch (exception) {
 						// nothing here, but don't die
 						Log.error(` loading json file =${file} failed`);
 					}
-					resolve(fileinfo);
+					resolve(fileInfo);
 				}
 			};
 			xhr.send(null);

js/utils.js

@@ -1,7 +1,17 @@
 const execSync = require("node:child_process").execSync;
-const Log = require("logger");
+const path = require("node:path");
+
+const rootPath = path.resolve(`${__dirname}/../`);
+const Log = require(`${rootPath}/js/logger.js`);
+const os = require("node:os");
+const fs = require("node:fs");
 const si = require("systeminformation");
 
+const modulePositions = []; // will get list from index.html
+const regionRegEx = /"region ([^"]*)/i;
+const indexFileName = "index.html";
+const discoveredPositionsJSFilename = "js/positions.js";
+
 module.exports = {
 
 	async logSystemInformation  () {
@@ -9,15 +19,16 @@ module.exports = {
 			let installedNodeVersion = execSync("node -v", { encoding: "utf-8" }).replace("v", "").replace(/(?:\r\n|\r|\n)/g, "");
 
 			const staticData = await si.get({
-				system: "manufacturer, model, raspberry, virtual",
+				system: "manufacturer, model, virtual",
 				osInfo: "platform, distro, release, arch",
 				versions: "kernel, node, npm, pm2"
 			});
-			let systemDataString = "System information:";
-			systemDataString += `\n### SYSTEM:   manufacturer: ${staticData["system"]["manufacturer"]}; model: ${staticData["system"]["model"]}; raspberry: ${staticData["system"]["raspberry"]}; virtual: ${staticData["system"]["virtual"]}`;
-			systemDataString += `\n### OS:       platform: ${staticData["osInfo"]["platform"]}; distro: ${staticData["osInfo"]["distro"]}; release: ${staticData["osInfo"]["release"]}; arch: ${staticData["osInfo"]["arch"]}; kernel: ${staticData["versions"]["kernel"]}`;
-			systemDataString += `\n### VERSIONS: electron: ${process.versions.electron}; used node: ${staticData["versions"]["node"]}; installed node: ${installedNodeVersion}; npm: ${staticData["versions"]["npm"]}; pm2: ${staticData["versions"]["pm2"]}`;
-			systemDataString += `\n### OTHER:    timeZone: ${Intl.DateTimeFormat().resolvedOptions().timeZone}; ELECTRON_ENABLE_GPU: ${process.env.ELECTRON_ENABLE_GPU}`;
+			let systemDataString = `System information:
+					### SYSTEM:   manufacturer: ${staticData.system.manufacturer}; model: ${staticData.system.model}; virtual: ${staticData.system.virtual}
+					### OS:       platform: ${staticData.osInfo.platform}; distro: ${staticData.osInfo.distro}; release: ${staticData.osInfo.release}; arch: ${staticData.osInfo.arch}; kernel: ${staticData.versions.kernel}
+					### VERSIONS: electron: ${process.versions.electron}; used node: ${staticData.versions.node}; installed node: ${installedNodeVersion}; npm: ${staticData.versions.npm}; pm2: ${staticData.versions.pm2}
+					### OTHER:    timeZone: ${Intl.DateTimeFormat().resolvedOptions().timeZone}; ELECTRON_ENABLE_GPU: ${process.env.ELECTRON_ENABLE_GPU}`
+				.replace(/\t/g, "");
 			Log.info(systemDataString);
 
 			// Return is currently only for jest
@@ -29,12 +40,40 @@ module.exports = {
 
 	// return all available module positions
 	getAvailableModulePositions () {
-		return ["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"];
+		return modulePositions;
 	},
 
-	// return if postion is on modulePositions Array (true/false)
+	// return if position is on modulePositions Array (true/false)
 	moduleHasValidPosition (position) {
 		if (this.getAvailableModulePositions().indexOf(position) === -1) return false;
 		return true;
+	},
+
+	getModulePositions () {
+		// if not already discovered
+		if (modulePositions.length === 0) {
+			// get the lines of the index.html
+			const lines = fs.readFileSync(indexFileName).toString().split("\n");
+			// loop thru the lines
+			lines.forEach((line) => {
+				// run the regex on each line
+				const results = regionRegEx.exec(line);
+				// if the regex returned something
+				if (results && results.length > 0) {
+					// get the position parts and replace space with underscore
+					const positionName = results[1].replace(" ", "_");
+					// add it to the list
+					modulePositions.push(positionName);
+				}
+			});
+			try {
+				fs.writeFileSync(discoveredPositionsJSFilename, `const modulePositions=${JSON.stringify(modulePositions)}`);
+			}
+			catch (error) {
+				console.error("unable to write js/positions.js with the discovered module positions\nmake the MagicMirror/js folder writeable by the user starting MagicMirror");
+			}
+		}
+		// return the list to the caller
+		return modulePositions;
 	}
 };

modules/default/alert/alert.js

@@ -25,6 +25,7 @@ Module.register("alert", {
 			da: "translations/da.json",
 			de: "translations/de.json",
 			en: "translations/en.json",
+			eo: "translations/eo.json",
 			es: "translations/es.json",
 			fr: "translations/fr.json",
 			hu: "translations/hu.json",

modules/default/alert/translations/el.json

@@ -0,0 +1,4 @@
+{
+	"sysTitle": "MagicMirror² Ειδοποίηση",
+	"welcome": "Καλώς ήρθατε, η εκκίνηση ήταν επιτυχής!"
+}

modules/default/alert/translations/eo.json

@@ -0,0 +1,4 @@
+{
+	"sysTitle": "MagicMirror²-sciigo",
+	"welcome": "Bonvenon, lanĉo sukcesis!"
+}

modules/default/calendar/calendar.js

@@ -82,9 +82,12 @@ Module.register("calendar", {
 
 	// Define required translations.
 	getTranslations () {
-		// The translations for the default modules are defined in the core translation files.
-		// Therefore 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.
+
+		/*
+		 * The translations for the default modules are defined in the core translation files.
+		 * Therefore 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;
 	},
 
@@ -148,8 +151,10 @@ Module.register("calendar", {
 				};
 			}
 
-			// tell helper to start a fetcher for this calendar
-			// fetcher till cycle
+			/*
+			 * tell helper to start a fetcher for this calendar
+			 * fetcher till cycle
+			 */
 			this.addCalendar(calendar.url, calendar.auth, calendarConfig);
 		});
 
@@ -163,12 +168,17 @@ Module.register("calendar", {
 
 		this.selfUpdate();
 	},
+	notificationReceived (notification, payload, sender) {
+
+		if (notification === "FETCH_CALENDAR") {
+			if (this.hasCalendarURL(payload.url)) {
+				this.sendSocketNotification(notification, { url: payload.url, id: this.identifier });
+			}
+		}
+	},
 
 	// Override socket notification handler.
 	socketNotificationReceived (notification, payload) {
-		if (notification === "FETCH_CALENDAR") {
-			this.sendSocketNotification(notification, { url: payload.url, id: this.identifier });
-		}
 
 		if (this.identifier !== payload.id) {
 			return;
@@ -412,18 +422,26 @@ Module.register("calendar", {
 					timeWrapper.innerHTML = CalendarUtils.capFirst(moment(event.startDate, "x").format(this.config.dateFormat));
 					// Add end time if showEnd
 					if (this.config.showEnd) {
-						if (this.config.showEndsOnlyWithDuration && event.startDate === event.endDate) {
-							// no duration here, don't display end
-						} else {
+						// and has a duation
+						if (event.startDate !== event.endDate) {
 							timeWrapper.innerHTML += "-";
 							timeWrapper.innerHTML += CalendarUtils.capFirst(moment(event.endDate, "x").format(this.config.dateEndFormat));
 						}
 					}
+
 					// For full day events we use the fullDayEventDateFormat
 					if (event.fullDayEvent) {
 						//subtract one second so that fullDayEvents end at 23:59:59, and not at 0:00:00 one the next day
 						event.endDate -= ONE_SECOND;
 						timeWrapper.innerHTML = CalendarUtils.capFirst(moment(event.startDate, "x").format(this.config.fullDayEventDateFormat));
+						// only show end if requested and allowed and the dates are different
+						if (this.config.showEnd && !this.config.showEndsOnlyWithDuration && moment(event.startDate, "x").format("YYYYMMDD") !== moment(event.endDate, "x").format("YYYYMMDD")) {
+							timeWrapper.innerHTML += "-";
+							timeWrapper.innerHTML += CalendarUtils.capFirst(moment(event.endDate, "x").format(this.config.fullDayEventDateFormat));
+						} else
+							if ((moment(event.startDate, "x").format("YYYYMMDD") !== moment(event.endDate, "x").format("YYYYMMDD")) && (moment(event.startDate, "x") < moment(now, "x"))) {
+								timeWrapper.innerHTML = CalendarUtils.capFirst(moment(now, "x").format(this.config.fullDayEventDateFormat));
+							}
 					} else if (this.config.getRelative > 0 && event.startDate < now) {
 						// Ongoing and getRelative is set
 						timeWrapper.innerHTML = CalendarUtils.capFirst(
@@ -455,16 +473,18 @@ Module.register("calendar", {
 					if (event.startDate >= now || (event.fullDayEvent && this.eventEndingWithinNextFullTimeUnit(event, ONE_DAY))) {
 						// Use relative time
 						if (!this.config.hideTime && !event.fullDayEvent) {
-							timeWrapper.innerHTML = CalendarUtils.capFirst(moment(event.startDate, "x").calendar(null, { sameElse: this.config.dateFormat }));
+							Log.debug("event not hidden and not fullday");
+							timeWrapper.innerHTML = `${CalendarUtils.capFirst(moment(event.startDate, "x").calendar(null, { sameElse: this.config.dateFormat }))}`;
 						} else {
-							timeWrapper.innerHTML = CalendarUtils.capFirst(
+							Log.debug("event full day or hidden");
+							timeWrapper.innerHTML = `${CalendarUtils.capFirst(
 								moment(event.startDate, "x").calendar(null, {
 									sameDay: this.config.showTimeToday ? "LT" : `[${this.translate("TODAY")}]`,
 									nextDay: `[${this.translate("TOMORROW")}]`,
 									nextWeek: "dddd",
 									sameElse: event.fullDayEvent ? this.config.fullDayEventDateFormat : this.config.dateFormat
 								})
-							);
+							)}`;
 						}
 						if (event.fullDayEvent) {
 							// Full days events within the next two days
@@ -483,9 +503,11 @@ Module.register("calendar", {
 									timeWrapper.innerHTML = CalendarUtils.capFirst(this.translate("DAYAFTERTOMORROW"));
 								}
 							}
+							Log.info("event fullday");
 						} else if (event.startDate - now < this.config.getRelative * ONE_HOUR) {
+							Log.info("not full day but within getrelative size");
 							// If event is within getRelative hours, display 'in xxx' time format or moment.fromNow()
-							timeWrapper.innerHTML = CalendarUtils.capFirst(moment(event.startDate, "x").fromNow());
+							timeWrapper.innerHTML = `${CalendarUtils.capFirst(moment(event.startDate, "x").fromNow())}`;
 						}
 					} else {
 						// Ongoing event
@@ -598,6 +620,7 @@ Module.register("calendar", {
 			const calendar = this.calendarData[calendarUrl];
 			let remainingEntries = this.maximumEntriesForUrl(calendarUrl);
 			let maxPastDaysCompare = now - this.maximumPastDaysForUrl(calendarUrl) * ONE_DAY;
+			let by_url_calevents = [];
 			for (const e in calendar) {
 				const event = JSON.parse(JSON.stringify(calendar[e])); // clone object
 
@@ -615,9 +638,6 @@ Module.register("calendar", {
 					if (this.config.hideDuplicates && this.listContainsEvent(events, event)) {
 						continue;
 					}
-					if (--remainingEntries < 0) {
-						break;
-					}
 				}
 
 				event.url = calendarUrl;
@@ -627,10 +647,11 @@ Module.register("calendar", {
 				event.tomorrow = !event.today && event.startDate >= today + ONE_DAY && event.startDate < today + 2 * ONE_DAY;
 				event.dayAfterTomorrow = !event.tomorrow && event.startDate >= today + ONE_DAY * 2 && event.startDate < today + 3 * ONE_DAY;
 
-				/* if sliceMultiDayEvents is set to true, multiday events (events exceeding at least one midnight) are sliced into days,
+				/*
+				 * if sliceMultiDayEvents is set to true, multiday events (events exceeding at least one midnight) are sliced into days,
 				 * otherwise, esp. in dateheaders mode it is not clear how long these events are.
 				 */
-				const maxCount = Math.ceil((event.endDate - 1 - moment(event.startDate, "x").endOf("day").format("x")) / ONE_DAY) + 1;
+				const maxCount = Math.round((event.endDate - 1 - moment(event.startDate, "x").endOf("day").format("x")) / ONE_DAY) + 1;
 				if (this.config.sliceMultiDayEvents && maxCount > 1) {
 					const splitEvents = [];
 					let midnight
@@ -638,19 +659,20 @@ Module.register("calendar", {
 							.clone()
 							.startOf("day")
 							.add(1, "day")
+							.endOf("day")
 							.format("x");
 					let count = 1;
 					while (event.endDate > midnight) {
 						const thisEvent = JSON.parse(JSON.stringify(event)); // clone object
 						thisEvent.today = thisEvent.startDate >= today && thisEvent.startDate < today + ONE_DAY;
 						thisEvent.tomorrow = !thisEvent.today && thisEvent.startDate >= today + ONE_DAY && thisEvent.startDate < today + 2 * ONE_DAY;
-						thisEvent.endDate = midnight;
+						thisEvent.endDate = moment(midnight, "x").clone().subtract(1, "day").format("x");
 						thisEvent.title += ` (${count}/${maxCount})`;
 						splitEvents.push(thisEvent);
 
 						event.startDate = midnight;
 						count += 1;
-						midnight = moment(midnight, "x").add(1, "day").format("x"); // next day
+						midnight = moment(midnight, "x").add(1, "day").endOf("day").format("x"); // next day
 					}
 					// Last day
 					event.title += ` (${count}/${maxCount})`;
@@ -660,15 +682,26 @@ Module.register("calendar", {
 
 					for (let splitEvent of splitEvents) {
 						if (splitEvent.endDate > now && splitEvent.endDate <= future) {
-							events.push(splitEvent);
+							by_url_calevents.push(splitEvent);
 						}
 					}
 				} else {
-					events.push(event);
+					by_url_calevents.push(event);
 				}
 			}
+			if (limitNumberOfEntries) {
+				// sort entries before clipping
+				by_url_calevents.sort(function (a, b) {
+					return a.startDate - b.startDate;
+				});
+				Log.debug(`pushing ${by_url_calevents.length} events to total with room for ${remainingEntries}`);
+				events = events.concat(by_url_calevents.slice(0, remainingEntries));
+				Log.debug(`events for calendar=${events.length}`);
+			} else {
+				events = events.concat(by_url_calevents);
+			}
 		}
-
+		Log.info(`sorting events count=${events.length}`);
 		events.sort(function (a, b) {
 			return a.startDate - b.startDate;
 		});
@@ -677,16 +710,21 @@ Module.register("calendar", {
 			return events;
 		}
 
-		// Limit the number of days displayed
-		// If limitDays is set > 0, limit display to that number of days
+		/*
+		 * Limit the number of days displayed
+		 * If limitDays is set > 0, limit display to that number of days
+		 */
 		if (this.config.limitDays > 0) {
 			let newEvents = [];
 			let lastDate = today.clone().subtract(1, "days").format("YYYYMMDD");
 			let days = 0;
 			for (const ev of events) {
 				let eventDate = moment(ev.startDate, "x").format("YYYYMMDD");
-				// if date of event is later than lastdate
-				// check if we already are showing max unique days
+
+				/*
+				 * if date of event is later than lastdate
+				 * check if we already are showing max unique days
+				 */
 				if (eventDate > lastDate) {
 					// if the only entry in the first day is a full day event that day is not counted as unique
 					if (!this.config.limitDaysNeverSkip && newEvents.length === 1 && days === 1 && newEvents[0].fullDayEvent) {
@@ -703,7 +741,7 @@ Module.register("calendar", {
 			}
 			events = newEvents;
 		}
-
+		Log.info(`slicing events total maxcount=${this.config.maximumEntries}`);
 		return events.slice(0, this.config.maximumEntries);
 	},
 
@@ -874,9 +912,13 @@ Module.register("calendar", {
 		let p = this.getCalendarProperty(url, property, defaultValue);
 		if (property === "symbol" || property === "recurringSymbol" || property === "fullDaySymbol") {
 			const className = this.getCalendarProperty(url, "symbolClassName", this.config.defaultSymbolClassName);
-			p = className + p;
+			if (p instanceof Array) {
+				let t = [];
+				p.forEach((n) => { t.push(className + n); });
+				p = t;
+			}
+			else p = className + p;
 		}
-
 		if (!(p instanceof Array)) p = [p];
 		return p;
 	},

modules/default/calendar/calendarfetcher.js

@@ -56,7 +56,7 @@ const CalendarFetcher = function (url, reloadInterval, excludedEvents, maximumEn
 
 				try {
 					data = ical.parseICS(responseData);
-					Log.debug(`parsed data=${JSON.stringify(data)}`);
+					Log.debug(`parsed data=${JSON.stringify(data, null, 2)}`);
 					events = CalendarFetcherUtils.filterEvents(data, {
 						excludedEvents,
 						includePastEvents,

modules/default/calendar/calendarfetcherutils.js

@@ -160,7 +160,7 @@ const CalendarFetcherUtils = {
 			}
 
 			if (event.type === "VEVENT") {
-				Log.debug(`Event:\n${JSON.stringify(event)}`);
+				Log.debug(`Event:\n${JSON.stringify(event, null, 2)}`);
 				let startMoment = eventDate(event, "start");
 				let endMoment;
 
@@ -246,6 +246,8 @@ const CalendarFetcherUtils = {
 				const location = event.location || false;
 				const geo = event.geo || false;
 				const description = event.description || false;
+				let d1;
+				let d2;
 
 				if (event.rrule && typeof event.rrule !== "undefined" && !isFacebookBirthday) {
 					const rule = event.rrule;
@@ -261,9 +263,10 @@ const CalendarFetcherUtils = {
 
 					// For recurring events, get the set of start dates that fall within the range
 					// of dates we're looking for.
-					// kblankenship1989 - to fix issue #1798, converting all dates to locale time first, then converting back to UTC time
+
 					let pastLocal;
 					let futureLocal;
+
 					if (CalendarFetcherUtils.isFullDayEvent(event)) {
 						Log.debug("fullday");
 						// if full day event, only use the date part of the ranges
@@ -283,52 +286,52 @@ const CalendarFetcherUtils = {
 						}
 						futureLocal = futureMoment.toDate(); // future
 					}
-					Log.debug(`Search for recurring events between: ${pastLocal} and ${futureLocal}`);
-					const hasByWeekdayRule = rule.options.byweekday !== undefined && rule.options.byweekday !== null;
 					const oneDayInMs = 24 * 60 * 60 * 1000;
+					d1 = new Date(new Date(pastLocal.valueOf() - oneDayInMs).getTime());
+					d2 = new Date(new Date(futureLocal.valueOf() + oneDayInMs).getTime());
+					Log.debug(`Search for recurring events between: ${d1} and ${d2}`);
+
+					event.start = rule.options.dtstart;
+
+					Log.debug("fix rrule start=", rule.options.dtstart);
+					Log.debug("event before rrule.between=", JSON.stringify(event, null, 2), "exdates=", event.exdate);
+					// fixup the exdate and recurrence date to local time too for post between() handling
+					CalendarFetcherUtils.fixEventtoLocal(event);
+
 					Log.debug(`RRule: ${rule.toString()}`);
 					rule.options.tzid = null; // RRule gets *very* confused with timezones
-					let dates = rule.between(new Date(pastLocal.valueOf() - oneDayInMs), new Date(futureLocal.valueOf() + oneDayInMs), true, () => { return true; });
-					Log.debug(`Title: ${event.summary}, with dates: ${JSON.stringify(dates)}`);
+
+					let dates = rule.between(d1, d2, true, () => { return true; });
+
+					Log.debug(`Title: ${event.summary}, with dates: \n\n${JSON.stringify(dates)}\n`);
+
+					// shouldn't need this  anymore, as RRULE not passed junk
 					dates = dates.filter((d) => {
 						if (JSON.stringify(d) === "null") return false;
 						else return true;
 					});
 
-					// RRule can generate dates with an incorrect recurrence date. Process the array here and apply date correction.
-					if (hasByWeekdayRule) {
-						Log.debug("Rule has byweekday, checking for correction");
-						dates.forEach((date, index, arr) => {
-							// NOTE: getTimezoneOffset() is negative of the expected value. For America/Los_Angeles under DST (GMT-7),
-							// this value is +420. For Australia/Sydney under DST (GMT+11), this value is -660.
-							const tzOffset = date.getTimezoneOffset() / 60;
-							const hour = date.getHours();
-							if ((tzOffset < 0) && (hour < -tzOffset)) { // east of GMT
-								Log.debug(`East of GMT (tzOffset: ${tzOffset}) and hour=${hour} < ${-tzOffset}, Subtracting 1 day from ${date}`);
-								arr[index] = new Date(date.valueOf() - oneDayInMs);
-							} else if ((tzOffset > 0) && (hour >= (24 - tzOffset))) { // west of GMT
-								Log.debug(`West of GMT (tzOffset: ${tzOffset}) and hour=${hour} >= 24-${tzOffset}, Adding 1 day to ${date}`);
-								arr[index] = new Date(date.valueOf() + oneDayInMs);
-							}
-						});
-						// Adjusting the dates could push it beyond the 'until' date, so filter those out here.
-						if (rule.options.until !== null) {
-							dates = dates.filter((date) => {
-								return date.valueOf() <= rule.options.until.valueOf();
-							});
-						}
-					}
-
-					// The dates array from rrule can be confused by DST. If the event was created during DST and we
-					// are querying a date range during non-DST, rrule can have the incorrect time for the date range.
-					// Reprocess the array here computing and applying the time offset.
-					dates.forEach((date, index, arr) => {
-						let adjustHours = CalendarFetcherUtils.calculateTimezoneAdjustment(event, date);
-						if (adjustHours !== 0) {
-							Log.debug(`Applying timezone adjustment hours=${adjustHours} to ${date}`);
-							arr[index] = new Date(date.valueOf() + (adjustHours * 60 * 60 * 1000));
-						}
+					// go thru all the rrule.between() dates and put back the tz offset removed so rrule.between would work
+					let datesLocal = [];
+					let offset = d1.getTimezoneOffset();
+					Log.debug("offset =", offset);
+					dates.forEach((d) => {
+						let dtext = d.toISOString().slice(0, -5);
+						Log.debug(" date text form without tz=", dtext);
+						let dLocal = new Date(d.valueOf() + (offset * 60000));
+						let offset2 = dLocal.getTimezoneOffset();
+						Log.debug("date after offset applied=", dLocal);
+						if (offset !== offset2) {
+							// woops, dst/std switch
+							let delta = offset - offset2;
+							Log.debug("offset delta=", delta);
+							dLocal = new Date(d.valueOf() + ((offset - delta) * 60000));
+							Log.debug("corrected normalized date=", dLocal);
+						} else Log.debug(" neutralized date=", dLocal);
+						datesLocal.push(dLocal);
 					});
+					dates = datesLocal;
+
 
 					// 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
@@ -337,29 +340,22 @@ const CalendarFetcherUtils = {
 					// 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}`);
+					//
+					// i don't think we will ever see this anymore (oct 2024) due to code fixes for rrule.between()
+					//
+					Log.debug("event.recurrences:", event.recurrences);
 					if (event.recurrences !== undefined) {
 						for (let dateKey in event.recurrences) {
 							// Only add dates that weren't already in the range we added from the rrule so that
 							// we don't double-add those events.
 							let d = new Date(dateKey);
-							if (!moment(d).isBetween(pastMoment, futureMoment)) {
+							if (!moment(d).isBetween(d1, d2)) {
+								Log.debug("adding recurring event not found in between list =", d, " should not happen now using local dates oct 17,24");
 								dates.push(d);
 							}
 						}
 					}
 
-					// Lastly, sometimes rrule doesn't include the event.start even if it is in the requested range. Ensure
-					// inclusion here. Unfortunately dates.includes() doesn't find it so we have to do forEach().
-					{
-						let found = false;
-						dates.forEach((d) => { if (d.valueOf() === event.start.valueOf()) found = true; });
-						if (!found) {
-							Log.debug(`event.start=${event.start} was not included in results from rrule; adding`);
-							dates.splice(0, 0, event.start);
-						}
-					}
-
 					// 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];
@@ -367,30 +363,42 @@ const CalendarFetcherUtils = {
 						let curDurationMs = durationMs;
 						let showRecurrence = true;
 
-						startMoment = moment(date);
+						let startMoment = moment(date);
 
-						// 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/).
-						// This must be done after `date` is adjusted
-						const dateKey = date.toISOString().substring(0, 10);
+						let dateKey = CalendarFetcherUtils.getDateKeyFromDate(date);
 
+						Log.debug("event date dateKey=", dateKey);
 						// For each date that we're checking, it's possible that there is a recurrence override for that one day.
-						if (curEvent.recurrences !== undefined && curEvent.recurrences[dateKey] !== undefined) {
-							// We found an override, so for this recurrence, use a potentially different title, start date, and duration.
-							curEvent = curEvent.recurrences[dateKey];
-							startMoment = moment(curEvent.start);
-							curDurationMs = curEvent.end.valueOf() - startMoment.valueOf();
+						if (curEvent.recurrences !== undefined) {
+							Log.debug("have recurrences=", curEvent.recurrences);
+							if (curEvent.recurrences[dateKey] !== undefined) {
+								Log.debug("have a recurrence match for dateKey=", dateKey);
+								// We found an override, so for this recurrence, use a potentially different title, start date, and duration.
+								curEvent = curEvent.recurrences[dateKey];
+								curEvent.start = new Date(new Date(curEvent.start.valueOf()).getTime());
+								curEvent.end = new Date(new Date(curEvent.end.valueOf()).getTime());
+								startMoment = CalendarFetcherUtils.getAdjustedStartMoment(curEvent.start, event);
+								endMoment = CalendarFetcherUtils.getAdjustedStartMoment(curEvent.end, event);
+								date = curEvent.start;
+								curDurationMs = new Date(endMoment).valueOf() - startMoment.valueOf();
+							} else {
+								Log.debug("recurrence key ", dateKey, " doesn't match");
+							}
 						}
 						// If there's no recurrence override, check for an exception date.  Exception dates represent exceptions to the rule.
-						else if (curEvent.exdate !== undefined && curEvent.exdate[dateKey] !== undefined) {
-							// This date is an exception date, which means we should skip it in the recurrence pattern.
-							showRecurrence = false;
+						if (curEvent.exdate !== undefined) {
+							Log.debug("have datekey=", dateKey, " exdates=", curEvent.exdate);
+							if (curEvent.exdate[dateKey] !== undefined) {
+								// This date is an exception date, which means we should skip it in the recurrence pattern.
+								showRecurrence = false;
+							}
 						}
 						Log.debug(`duration: ${curDurationMs}`);
 
+						startMoment = CalendarFetcherUtils.getAdjustedStartMoment(date, event);
+
 						endMoment = moment(startMoment.valueOf() + curDurationMs);
+
 						if (startMoment.valueOf() === endMoment.valueOf()) {
 							endMoment = endMoment.endOf("day");
 						}
@@ -408,7 +416,7 @@ const CalendarFetcherUtils = {
 						}
 
 						if (showRecurrence === true) {
-							Log.debug(`saving event: ${description}`);
+							Log.debug(`saving event: ${recurrenceTitle}`);
 							newEvents.push({
 								title: recurrenceTitle,
 								startDate: startMoment.format("x"),
@@ -421,7 +429,10 @@ const CalendarFetcherUtils = {
 								geo: geo,
 								description: description
 							});
+						} else {
+							Log.debug("not saving event ", recurrenceTitle, new Date(startMoment));
 						}
+						Log.debug(" ");
 					}
 					// End recurring event parsing.
 				} else {
@@ -472,7 +483,9 @@ const CalendarFetcherUtils = {
 						startDate: startMoment.add(adjustHours, "hours").format("x"),
 						endDate: endMoment.add(adjustHours, "hours").format("x"),
 						fullDayEvent: fullDayEvent,
+						recurringEvent: false,
 						class: event.class,
+						firstYear: event.start.getFullYear(),
 						location: location,
 						geo: geo,
 						description: description
@@ -488,6 +501,202 @@ const CalendarFetcherUtils = {
 		return newEvents;
 	},
 
+	/**
+	 * fixup thew event fields that have dates to use local time
+	 * BEFORE calling rrule.between
+	 * @param the event being processed
+	 * @returns nothing
+	 */
+	fixEventtoLocal (event) {
+		// if there are excluded dates, their date is incorrect and possibly key as well.
+		if (event.exdate !== undefined) {
+			Object.keys(event.exdate).forEach((dateKey) => {
+				// get the date
+				let exdate = event.exdate[dateKey];
+				Log.debug("exdate w key=", exdate);
+				//exdate=CalendarFetcherUtils.convertDateToLocalTime(exdate, event.end.tz)
+				exdate = new Date(new Date(exdate.valueOf() - ((120 * 60 * 1000))).getTime());
+				Log.debug("new exDate item=", exdate, " with old key=", dateKey);
+				let newkey = exdate.toISOString().slice(0, 10);
+				if (newkey !== dateKey) {
+					Log.debug("new exDate item=", exdate, ` key=${newkey}`);
+					event.exdate[newkey] = exdate;
+					//delete event.exdate[dateKey]
+				}
+			});
+			Log.debug("updated exdate list=", event.exdate);
+		}
+		if (event.recurrences) {
+			Object.keys(event.recurrences).forEach((dateKey) => {
+				let exdate = event.recurrences[dateKey];
+				//exdate=new Date(new Date(exdate.valueOf()-(60*60*1000)).getTime())
+				Log.debug("new recurrence item=", exdate, " with old key=", dateKey);
+				exdate.start = CalendarFetcherUtils.convertDateToLocalTime(exdate.start, exdate.start.tz);
+				exdate.end = CalendarFetcherUtils.convertDateToLocalTime(exdate.end, exdate.end.tz);
+				Log.debug("adjusted recurringEvent start=", exdate.start, " end=", exdate.end);
+			});
+		}
+		Log.debug("modified recurrences before rrule.between", event.recurrences);
+	},
+
+	/**
+	 * convert a UTC date to local time
+	 * BEFORE calling rrule.between
+	 * @param date ti conert
+	 * 				tz event is currently in
+	 * @returns updated date object
+	 */
+	convertDateToLocalTime (date, tz) {
+		let delta_tz_offset = 0;
+		let now_offset = CalendarFetcherUtils.getTimezoneOffsetFromTimezone(moment.tz.guess());
+		let event_offset = CalendarFetcherUtils.getTimezoneOffsetFromTimezone(tz);
+		Log.debug("date to convert=", date);
+		if (Math.sign(now_offset) !== Math.sign(event_offset)) {
+			delta_tz_offset = Math.abs(now_offset) + Math.abs(event_offset);
+		} else {
+			// signs are the same
+			// if negative
+			if (Math.sign(now_offset) === -1) {
+				// la looking at chicago
+				if (now_offset < event_offset) { // 5 -7
+					delta_tz_offset = now_offset - event_offset;
+				}
+				else { //7 -5 , chicago looking at LA
+					delta_tz_offset = event_offset - now_offset;
+				}
+			}
+			else {
+				// berlin looking at sydney
+				if (now_offset < event_offset) { // 5 -7
+					delta_tz_offset = event_offset - now_offset;
+					Log.debug("less delta=", delta_tz_offset);
+				}
+				else { // 11 - 2, sydney looking at berlin
+					delta_tz_offset = -(now_offset - event_offset);
+					Log.debug("more delta=", delta_tz_offset);
+				}
+			}
+		}
+		const newdate = new Date(new Date(date.valueOf() + (delta_tz_offset * 60 * 1000)).getTime());
+		Log.debug("modified date =", newdate);
+		return newdate;
+	},
+
+	/**
+	 * get the exdate/recurrence hash key from the date object
+	 * BEFORE calling rrule.between
+	 * @param the date of the event
+	 * @returns string date key YYYY-MM-DD
+	 */
+	getDateKeyFromDate (date) {
+		// get our runtime timezone offset
+		const nowDiff = CalendarFetcherUtils.getTimezoneOffsetFromTimezone(moment.tz.guess());
+		let startday = date.getDate();
+		let adjustment = 0;
+		Log.debug(" day of month=", (`0${startday}`).slice(-2), " nowDiff=", nowDiff, ` start time=${date.toString().split(" ")[4].slice(0, 2)}`);
+		Log.debug("date string=    ", date.toString());
+		Log.debug("date iso string ", date.toISOString());
+		// if the dates are different
+		if (date.toString().slice(8, 10) < date.toISOString().slice(8, 10)) {
+			startday = date.toString().slice(8, 10);
+			Log.debug("< ", startday);
+		} else { // tostring is more
+			if (date.toString().slice(8, 10) > date.toISOString().slice(8, 10)) {
+				startday = date.toISOString().slice(8, 10);
+				Log.debug("> ", startday);
+			}
+		}
+		return date.toISOString().substring(0, 8) + (`0${startday}`).slice(-2);
+	},
+
+	/**
+	 * get the timezone offset from the timezone string
+	 *
+	 * @param the timezone string
+	 * @returns the numerical offset
+	 */
+	getTimezoneOffsetFromTimezone (timeZone) {
+		const str = new Date().toLocaleString("en", { timeZone, timeZoneName: "longOffset" });
+		Log.debug("tz offset=", str);
+		const [_, h, m] = str.match(/([+-]\d+):(\d+)$/) || ["", "+00", "00"];
+		return h * 60 + (h > 0 ? +m : -m);
+	},
+
+	/**
+	 * fixup the date start moment after rrule.between returns date array
+	 *
+	 * @param date object from rrule.between results
+	 *  			the event object it came from
+	 * @returns moment object
+	 */
+	getAdjustedStartMoment (date, event) {
+
+		let startMoment = moment(date);
+
+		Log.debug("startMoment pre=", startMoment);
+		// get our runtime timezone offset
+		const nowDiff = CalendarFetcherUtils.getTimezoneOffsetFromTimezone(moment.tz.guess()); //  10/18 16:49, 300
+		let eventDiff = CalendarFetcherUtils.getTimezoneOffsetFromTimezone(event.end.tz); // watch out, start tz is cleared to handle rrule 120 23:49
+
+		Log.debug("tz diff event=", eventDiff, " local=", nowDiff, " end event timezone=", event.end.tz);
+
+		// if the diffs are different (not same tz for processing as event)
+		if (nowDiff !== eventDiff) {
+			// if signs are different
+			if (Math.sign(nowDiff) !== Math.sign(eventDiff)) {
+				// its the accumulated total
+				Log.debug("diff signs, accumulate");
+				eventDiff = Math.abs(eventDiff) + Math.abs(nowDiff);
+				// sign of diff depends on where you are looking at which event.
+				// australia looking at US, add to get same time
+				Log.debug("new different event diff=", eventDiff);
+				if (Math.sign(nowDiff) === -1) {
+					eventDiff *= -1;
+					// US looking at australia event have to subtract
+					Log.debug("new diff, same sign, total event diff=", eventDiff);
+				}
+			}
+			else {
+				// signs are the same, all east of UTC or all west of UTC
+				// if the signs are negative (west of UTC)
+				Log.debug("signs are the same");
+				if (Math.sign(eventDiff) === -1) {
+					//if west, looking at more west
+					//  -350 <-300
+					if (nowDiff < eventDiff) {
+						//-600        -420
+						//300           -300         -360      +300
+						eventDiff = nowDiff - eventDiff; //-180
+						Log.debug("now looking back east delta diff=", eventDiff);
+					}
+					else {
+						Log.debug("now looking more west");
+						eventDiff = Math.abs(eventDiff - nowDiff);
+					}
+				} else {
+					Log.debug("signs are both positive");
+					// signs are positive (east of UTC)
+					// berlin < sydney
+					if (nowDiff < eventDiff) {
+						// germany vs australia
+						eventDiff = -(eventDiff - nowDiff);
+					}
+					else {
+						// australia vs germany
+						//eventDiff = eventDiff; //- nowDiff
+					}
+				}
+			}
+			startMoment = moment.tz(new Date(date.valueOf() + (eventDiff * (60 * 1000))), event.end.tz);
+		} else {
+			Log.debug("same tz event and display");
+			eventDiff = 0;
+			startMoment = moment.tz(new Date(date.valueOf() - (eventDiff * (60 * 1000))), event.end.tz);
+		}
+		Log.debug("startMoment post=", startMoment);
+		return startMoment;
+	},
+
 	/**
 	 * Lookup iana tz from windows
 	 * @param {string} msTZName the timezone name to lookup

modules/default/calendar/debug.js

@@ -1,4 +1,5 @@
-/* CalendarFetcher Tester
+/*
+ * 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.
  */

modules/default/clock/clock.js

@@ -23,7 +23,7 @@ Module.register("clock", {
 		analogFace: "simple", // options: 'none', 'simple', 'face-###' (where ### is 001 to 012 inclusive)
 		analogPlacement: "bottom", // options: 'top', 'bottom', 'left', 'right'
 		analogShowDate: "top", // OBSOLETE, can be replaced with analogPlacement and showTime, options: false, 'top', or 'bottom'
-		secondsColor: "#888888",
+		secondsColor: "#888888", // DEPRECATED, use CSS instead. Class "clock-second-digital" for digital clock, "clock-second" for analog clock.
 
 		showSunTimes: false,
 		showMoonTimes: false, // options: false, 'times' (rise/set), 'percent' (lit percent), 'phase' (current phase), or 'both' (percent & phase)
@@ -105,6 +105,8 @@ Module.register("clock", {
 		 */
 		const dateWrapper = document.createElement("div");
 		const timeWrapper = document.createElement("div");
+		const hoursWrapper = document.createElement("span");
+		const minutesWrapper = document.createElement("span");
 		const secondsWrapper = document.createElement("sup");
 		const periodWrapper = document.createElement("span");
 		const sunWrapper = document.createElement("div");
@@ -114,39 +116,40 @@ Module.register("clock", {
 		// Style Wrappers
 		dateWrapper.className = "date normal medium";
 		timeWrapper.className = "time bright large light";
-		secondsWrapper.className = "seconds dimmed";
+		hoursWrapper.className = "clock-hour-digital";
+		minutesWrapper.className = "clock-minute-digital";
+		secondsWrapper.className = "clock-second-digital dimmed";
 		sunWrapper.className = "sun dimmed small";
 		moonWrapper.className = "moon dimmed small";
 		weekWrapper.className = "week dimmed medium";
 
 		// Set content of wrappers.
-		// The moment().format("h") method has a bug on the Raspberry Pi.
-		// So we need to generate the timestring manually.
-		// See issue: https://github.com/MagicMirrorOrg/MagicMirror/issues/181
-		let timeString;
 		const now = moment();
 		if (this.config.timezone) {
 			now.tz(this.config.timezone);
 		}
 
-		let hourSymbol = "HH";
-		if (this.config.timeFormat !== 24) {
-			hourSymbol = "h";
-		}
-
-		if (this.config.clockBold) {
-			timeString = now.format(`${hourSymbol}[<span class="bold">]mm[</span>]`);
-		} else {
-			timeString = now.format(`${hourSymbol}:mm`);
-		}
-
 		if (this.config.showDate) {
 			dateWrapper.innerHTML = now.format(this.config.dateFormat);
 			digitalWrapper.appendChild(dateWrapper);
 		}
 
 		if (this.config.displayType !== "analog" && this.config.showTime) {
-			timeWrapper.innerHTML = timeString;
+			let hourSymbol = "HH";
+			if (this.config.timeFormat !== 24) {
+				hourSymbol = "h";
+			}
+
+			hoursWrapper.innerHTML = now.format(hourSymbol);
+			minutesWrapper.innerHTML = now.format("mm");
+
+			timeWrapper.appendChild(hoursWrapper);
+			if (this.config.clockBold) {
+				minutesWrapper.classList.add("bold");
+			} else {
+				timeWrapper.innerHTML += ":";
+			}
+			timeWrapper.appendChild(minutesWrapper);
 			secondsWrapper.innerHTML = now.format("ss");
 			if (this.config.showPeriodUpper) {
 				periodWrapper.innerHTML = now.format("A");
@@ -181,8 +184,8 @@ Module.register("clock", {
 			const untilNextEventString = `${untilNextEvent.hours()}h ${untilNextEvent.minutes()}m`;
 			sunWrapper.innerHTML
 				= `<span class="${isVisible ? "bright" : ""}"><i class="fas fa-sun" aria-hidden="true"></i> ${untilNextEventString}</span>`
-				+ `<span><i class="fas fa-arrow-up" aria-hidden="true"></i> ${formatTime(this.config, sunTimes.sunrise)}</span>`
-				+ `<span><i class="fas fa-arrow-down" aria-hidden="true"></i> ${formatTime(this.config, sunTimes.sunset)}</span>`;
+				  + `<span><i class="fas fa-arrow-up" aria-hidden="true"></i> ${formatTime(this.config, sunTimes.sunrise)}</span>`
+				  + `<span><i class="fas fa-arrow-down" aria-hidden="true"></i> ${formatTime(this.config, sunTimes.sunset)}</span>`;
 			digitalWrapper.appendChild(sunWrapper);
 		}
 
@@ -208,8 +211,8 @@ Module.register("clock", {
 
 			moonWrapper.innerHTML
 				= `<span class="${isVisible ? "bright" : ""}">${image} ${showFraction ? illuminatedFractionString : ""}</span>`
-				+ `<span><i class="fas fa-arrow-up" aria-hidden="true"></i> ${moonRise ? formatTime(this.config, moonRise) : "..."}</span>`
-				+ `<span><i class="fas fa-arrow-down" aria-hidden="true"></i> ${moonSet ? formatTime(this.config, moonSet) : "..."}</span>`;
+				  + `<span><i class="fas fa-arrow-up" aria-hidden="true"></i> ${moonRise ? formatTime(this.config, moonRise) : "..."}</span>`
+				  + `<span><i class="fas fa-arrow-down" aria-hidden="true"></i> ${moonSet ? formatTime(this.config, moonSet) : "..."}</span>`;
 			digitalWrapper.appendChild(moonWrapper);
 		}
 
@@ -267,7 +270,7 @@ Module.register("clock", {
 				clockSecond.id = "clock-second";
 				clockSecond.style.transform = `rotate(${second}deg)`;
 				clockSecond.className = "clock-second";
-				clockSecond.style.backgroundColor = this.config.secondsColor;
+				clockSecond.style.backgroundColor = this.config.secondsColor; /* DEPRECATED, to be removed in a future version , use CSS instead */
 				clockFace.appendChild(clockSecond);
 			}
 			analogWrapper.appendChild(clockFace);

modules/default/clock/clock_styles.css

@@ -78,7 +78,12 @@
   left: 50%;
   margin: -38% -1px 0 0; /* numbers must match negative length & thickness */
   padding: 38% 1px 0 0; /* indicator length & thickness */
-  background: var(--color-text);
+
+  /* background: #888888 !important; */
+
+  /* use this instead of secondsColor */
+
+  /* have to use !important, because the code explicitly sets the color currently */
   transform-origin: 50% 100%;
 }
 
@@ -91,3 +96,15 @@
 .module.clock .moon > * {
   flex: 1;
 }
+
+.module.clock .clock-hour-digital {
+  color: var(--color-text-bright);
+}
+
+.module.clock .clock-minute-digital {
+  color: var(--color-text-bright);
+}
+
+.module.clock .clock-second-digital {
+  color: var(--color-text-dimmed);
+}

modules/default/compliments/compliments.js

@@ -1,3 +1,5 @@
+/* global Cron */
+
 Module.register("compliments", {
 	// Module config defaults.
 	defaults: {
@@ -10,6 +12,7 @@ Module.register("compliments", {
 		},
 		updateInterval: 30000,
 		remoteFile: null,
+		remoteFileRefreshInterval: 0,
 		fadeSpeed: 4000,
 		morningStartTime: 3,
 		morningEndTime: 12,
@@ -18,13 +21,18 @@ Module.register("compliments", {
 		random: true,
 		specialDayUnique: false
 	},
+	urlSuffix: "",
+	compliments_new: null,
+	refreshMinimumDelay: 15 * 60 * 60 * 1000, // 15 minutes
 	lastIndexUsed: -1,
 	// Set currentweather from module
 	currentWeatherType: "",
-
+	cron_regex: /^(((\d+,)+\d+|((\d+|[*])[/]\d+|((JAN|FEB|APR|MA[RY]|JU[LN]|AUG|SEP|OCT|NOV|DEC)(-(JAN|FEB|APR|MA[RY]|JU[LN]|AUG|SEP|OCT|NOV|DEC))?))|(\d+-\d+)|\d+(-\d+)?[/]\d+(-\d+)?|\d+|[*]|(MON|TUE|WED|THU|FRI|SAT|SUN)(-(MON|TUE|WED|THU|FRI|SAT|SUN))?) ?){5}$/i,
+	date_regex: "[1-9.][0-9.][0-9.]{2}-([0][1-9]|[1][0-2])-([1-2][0-9]|[0][1-9]|[3][0-1])",
+	pre_defined_types: ["anytime", "morning", "afternoon", "evening"],
 	// Define required scripts.
 	getScripts () {
-		return ["moment.js"];
+		return ["croner.js", "moment.js"];
 	},
 
 	// Define start sequence.
@@ -37,12 +45,62 @@ Module.register("compliments", {
 			const response = await this.loadComplimentFile();
 			this.config.compliments = JSON.parse(response);
 			this.updateDom();
+			if (this.config.remoteFileRefreshInterval !== 0) {
+				if ((this.config.remoteFileRefreshInterval >= this.refreshMinimumDelay) || window.mmTestMode === "true") {
+					setInterval(async () => {
+						const response = await this.loadComplimentFile();
+						if (response) {
+							this.compliments_new = JSON.parse(response);
+						}
+						else {
+							Log.error(`${this.name} remoteFile refresh failed`);
+						}
+					},
+					this.config.remoteFileRefreshInterval);
+				} else {
+					Log.error(`${this.name} remoteFileRefreshInterval less than minimum`);
+				}
+			}
 		}
+		let minute_sync_delay = 1;
+		// loop thru all the configured when events
+		for (let m of Object.keys(this.config.compliments)) {
+			// if it is a cron entry
+			if (this.isCronEntry(m)) {
+				// we need to synch our interval cycle to the minute
+				minute_sync_delay = (60 - (moment().second())) * 1000;
+				break;
+			}
+		}
+		// Schedule update timer. sync to the minute start (if needed), so minute based events happen on the minute start
+		setTimeout(() => {
+			setInterval(() => {
+				this.updateDom(this.config.fadeSpeed);
+			}, this.config.updateInterval);
+		},
+		minute_sync_delay);
+	},
 
-		// Schedule update timer.
-		setInterval(() => {
-			this.updateDom(this.config.fadeSpeed);
-		}, this.config.updateInterval);
+	// check to see if this entry could be a cron entry wich contains spaces
+	isCronEntry (entry) {
+		return entry.includes(" ");
+	},
+
+	/**
+	 * @param {string} cronExpression The cron expression. See https://croner.56k.guru/usage/pattern/
+	 * @param {Date} [timestamp] The timestamp to check. Defaults to the current time.
+	 * @returns {number} The number of seconds until the next cron run.
+	 */
+	getSecondsUntilNextCronRun (cronExpression, timestamp = new Date()) {
+		// Required for seconds precision
+		const adjustedTimestamp = new Date(timestamp.getTime() - 1000);
+
+		// https://www.npmjs.com/package/croner
+		const cronJob = new Cron(cronExpression);
+		const nextRunTime = cronJob.nextRun(adjustedTimestamp);
+
+		const secondsDelta = (nextRunTime - adjustedTimestamp) / 1000;
+		return secondsDelta;
 	},
 
 	/**
@@ -75,38 +133,73 @@ Module.register("compliments", {
 	 * @returns {string[]} array with compliments for the time of the day.
 	 */
 	complimentArray () {
-		const hour = moment().hour();
-		const date = moment().format("YYYY-MM-DD");
+		const now = moment();
+		const hour = now.hour();
+		const date = now.format("YYYY-MM-DD");
 		let compliments = [];
 
 		// Add time of day compliments
-		if (hour >= this.config.morningStartTime && hour < this.config.morningEndTime && this.config.compliments.hasOwnProperty("morning")) {
-			compliments = [...this.config.compliments.morning];
-		} else if (hour >= this.config.afternoonStartTime && hour < this.config.afternoonEndTime && this.config.compliments.hasOwnProperty("afternoon")) {
-			compliments = [...this.config.compliments.afternoon];
-		} else if (this.config.compliments.hasOwnProperty("evening")) {
-			compliments = [...this.config.compliments.evening];
+		let timeOfDay;
+		if (hour >= this.config.morningStartTime && hour < this.config.morningEndTime) {
+			timeOfDay = "morning";
+		} else if (hour >= this.config.afternoonStartTime && hour < this.config.afternoonEndTime) {
+			timeOfDay = "afternoon";
+		} else {
+			timeOfDay = "evening";
+		}
+
+		if (timeOfDay && this.config.compliments.hasOwnProperty(timeOfDay)) {
+			compliments = [...this.config.compliments[timeOfDay]];
 		}
 
 		// Add compliments based on weather
 		if (this.currentWeatherType in this.config.compliments) {
 			Array.prototype.push.apply(compliments, this.config.compliments[this.currentWeatherType]);
+			// if the predefine list doesn't include it (yet)
+			if (!this.pre_defined_types.includes(this.currentWeatherType)) {
+				// add it
+				this.pre_defined_types.push(this.currentWeatherType);
+			}
 		}
 
 		// Add compliments for anytime
 		Array.prototype.push.apply(compliments, this.config.compliments.anytime);
 
-		// Add compliments for special days
-		for (let entry in this.config.compliments) {
-			if (new RegExp(entry).test(date)) {
-				// Only display compliments configured for the day if specialDayUnique is set to true
-				if (this.config.specialDayUnique) {
-					compliments.length = 0;
-				}
-				Array.prototype.push.apply(compliments, this.config.compliments[entry]);
+		// get the list of just date entry keys
+		let temp_list = Object.keys(this.config.compliments).filter((k) => {
+			if (this.pre_defined_types.includes(k)) return false;
+			else return true;
+		});
+
+		let date_compliments = [];
+		// Add compliments for special day/times
+		for (let entry of temp_list) {
+			// check if this could be a cron type entry
+			if (this.isCronEntry(entry)) {
+				// make sure the regex is valid
+				if (new RegExp(this.cron_regex).test(entry)) {
+					// check if we are in the time range for the cron entry
+					if (this.getSecondsUntilNextCronRun(entry, now.set("seconds", 0).toDate()) <= 1) {
+						// if so, use its notice entries
+						Array.prototype.push.apply(date_compliments, this.config.compliments[entry]);
+					}
+				} else Log.error(`compliments cron syntax invalid=${JSON.stringify(entry)}`);
+			} else if (new RegExp(entry).test(date)) {
+				Array.prototype.push.apply(date_compliments, this.config.compliments[entry]);
 			}
 		}
 
+		// if we found any date compliments
+		if (date_compliments.length) {
+			// and the special flag is true
+			if (this.config.specialDayUnique) {
+				// clear the non-date compliments if any
+				compliments.length = 0;
+			}
+			// put the date based compliments on the list
+			Array.prototype.push.apply(compliments, date_compliments);
+		}
+
 		return compliments;
 	},
 
@@ -117,8 +210,18 @@ Module.register("compliments", {
 	async loadComplimentFile () {
 		const isRemote = this.config.remoteFile.indexOf("http://") === 0 || this.config.remoteFile.indexOf("https://") === 0,
 			url = isRemote ? this.config.remoteFile : this.file(this.config.remoteFile);
-		const response = await fetch(url);
-		return await response.text();
+		// because we may be fetching the same url,
+		// we need to force the server to not give us the cached result
+		// create an extra property (ignored by the server handler) just so the url string is different
+		// that will never be the same, using the ms value of date
+		if (isRemote && this.config.remoteFileRefreshInterval !== 0) this.urlSuffix = `?dummy=${Date.now()}`;
+		//
+		try {
+			const response = await fetch(url + this.urlSuffix);
+			return await response.text();
+		} catch (error) {
+			Log.info(`${this.name} fetch failed error=`, error);
+		}
 	},
 
 	/**
@@ -168,6 +271,27 @@ Module.register("compliments", {
 			compliment.lastElementChild.remove();
 			wrapper.appendChild(compliment);
 		}
+		// if a new set of compliments was loaded from the refresh task
+		// we do this here to make sure no other function is using the compliments list
+		if (this.compliments_new) {
+			// use them
+			if (JSON.stringify(this.config.compliments) !== JSON.stringify(this.compliments_new)) {
+				// only reset if the contents changes
+				this.config.compliments = this.compliments_new;
+				// reset the index
+				this.lastIndexUsed = -1;
+			}
+			// clear new file list so we don't waste cycles comparing between refreshes
+			this.compliments_new = null;
+		}
+		// only in test mode
+		if (window.mmTestMode === "true") {
+			// check for (undocumented) remoteFile2 to test new file load
+			if (this.config.remoteFile2 !== null && this.config.remoteFileRefreshInterval !== 0) {
+				// switch the file so that next time it will be loaded from a changed file
+				this.config.remoteFile = this.config.remoteFile2;
+			}
+		}
 		return wrapper;
 	},
 

modules/default/defaultmodules.js

@@ -1,4 +1,5 @@
-/* Default Modules List
+/*
+ * Default Modules List
  * Modules listed below can be loaded without the 'default/' prefix. Omitting the default folder name.
  */
 const defaultModules = ["alert", "calendar", "clock", "compliments", "helloworld", "newsfeed", "updatenotification", "weather"];

modules/default/newsfeed/newsfeed.js

@@ -38,7 +38,7 @@ Module.register("newsfeed", {
 
 	getUrlPrefix (item) {
 		if (item.useCorsProxy) {
-			return `${location.protocol}//${location.host}/cors?url=`;
+			return `${location.protocol}//${location.host}${config.basePath}cors?url=`;
 		} else {
 			return "";
 		}
@@ -57,7 +57,7 @@ Module.register("newsfeed", {
 	// Define required translations.
 	getTranslations () {
 		// 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.
+		// Therefore 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;
 	},
@@ -177,6 +177,18 @@ Module.register("newsfeed", {
 		}
 	},
 
+	/**
+	 * Gets a feed property by name
+	 * @param {object} feed A feed object.
+	 * @param {string} property The name of the property.
+	 */
+	getFeedProperty (feed, property) {
+		let res = this.config[property];
+		const f = this.config.feeds.find((feedItem) => feedItem.url === feed);
+		if (f && f[property]) res = f[property];
+		return res;
+	},
+
 	/**
 	 * Generate an ordered list of items for this configured module.
 	 * @param {object} feeds An object with feeds returned by the node helper.
@@ -188,7 +200,7 @@ Module.register("newsfeed", {
 			if (this.subscribedToFeed(feed)) {
 				for (let item of feedItems) {
 					item.sourceTitle = this.titleForFeed(feed);
-					if (!(this.config.ignoreOldItems && Date.now() - new Date(item.pubdate) > this.config.ignoreOlderThan)) {
+					if (!(this.getFeedProperty(feed, "ignoreOldItems") && Date.now() - new Date(item.pubdate) > this.getFeedProperty(feed, "ignoreOlderThan"))) {
 						newsItems.push(item);
 					}
 				}

modules/default/updatenotification/node_helper.js

@@ -1,3 +1,5 @@
+const fs = require("node:fs");
+const path = require("node:path");
 const NodeHelper = require("node_helper");
 const defaultModules = require("../defaultmodules");
 const GitHelper = require("./git_helper");
@@ -14,8 +16,23 @@ module.exports = NodeHelper.create({
 	gitHelper: new GitHelper(),
 	updateHelper: null,
 
+	getModules (modules) {
+		if (this.config.useModulesFromConfig) {
+			return modules;
+		} else {
+			// get modules from modules-directory
+			const moduleDir = path.normalize(`${__dirname}/../../`);
+			const getDirectories = (source) => {
+				return fs.readdirSync(source, { withFileTypes: true })
+					.filter((dirent) => dirent.isDirectory() && dirent.name !== "default")
+					.map((dirent) => dirent.name);
+			};
+			return getDirectories(moduleDir);
+		}
+	},
+
 	async configureModules (modules) {
-		for (const moduleName of modules) {
+		for (const moduleName of this.getModules(modules)) {
 			if (!this.ignoreUpdateChecking(moduleName)) {
 				await this.gitHelper.add(moduleName);
 			}

modules/default/updatenotification/update_helper.js

@@ -4,7 +4,8 @@ const fs = require("node:fs");
 
 const Log = require("logger");
 
-/* class Updater
+/*
+ * class Updater
  * Allow to self updating 3rd party modules from command defined in config
  *
  * [constructor] read value in config:
@@ -46,8 +47,8 @@ class Updater {
 		this.autoRestart = config.updateAutorestart;
 		this.moduleList = {};
 		this.updating = false;
-		this.usePM2 = false;
-		this.PM2 = null;
+		this.usePM2 = false; // don't use pm2 by default
+		this.PM2Id = null; // pm2 process number
 		this.version = global.version;
 		this.root_path = global.root_path;
 		Log.info("updatenotification: Updater Class Loaded!");
@@ -84,13 +85,15 @@ class Updater {
 		return updater;
 	}
 
-	// module updater with his proper command
-	// return object as result
-	//{
-	//	error: <boolean>, // if error detected
-	//	updated: <boolean>, // if updated successfully
-	//	needRestart: <boolean> // if magicmirror restart required
-	//};
+	/*
+	 *  module updater with his proper command
+	 *  return object as result
+	 * {
+	 * 	error: <boolean>, // if error detected
+	 * 	updated: <boolean>, // if updated successfully
+	 * 	needRestart: <boolean> // if magicmirror restart required
+	 * };
+	 */
 	updateProcess (module) {
 		let Result = {
 			error: false,
@@ -136,11 +139,11 @@ class Updater {
 		else this.npmRestart();
 	}
 
-	// restart MagicMiror with "pm2"
+	// restart MagicMiror with "pm2": use PM2Id for restart it
 	pm2Restart () {
 		Log.info("updatenotification: PM2 will restarting MagicMirror...");
 		const pm2 = require("pm2");
-		pm2.restart(this.PM2, (err, proc) => {
+		pm2.restart(this.PM2Id, (err, proc) => {
 			if (err) {
 				Log.error("updatenotification:[PM2] restart Error", err);
 			}
@@ -153,7 +156,7 @@ class Updater {
 		const out = process.stdout;
 		const err = process.stderr;
 		const subprocess = Spawn("npm start", { cwd: this.root_path, shell: true, detached: true, stdio: ["ignore", out, err] });
-		subprocess.unref();
+		subprocess.unref(); // detach the newly launched process from the master process
 		process.exit();
 	}
 
@@ -163,38 +166,45 @@ class Updater {
 		return new Promise((resolve) => {
 			if (fs.existsSync("/.dockerenv")) {
 				Log.info("updatenotification: Running in docker container, not using PM2 ...");
-				this.usePM2 = false;
 				resolve(false);
 				return;
 			}
 
+			if (process.env.unique_id === undefined) {
+				Log.info("updatenotification: [PM2] You are not using pm2");
+				resolve(false);
+				return;
+			}
+
+			Log.debug(`updatenotification: [PM2] Search for pm2 id: ${process.env.pm_id} -- name: ${process.env.name} -- unique_id: ${process.env.unique_id}`);
+
 			const pm2 = require("pm2");
 			pm2.connect((err) => {
 				if (err) {
 					Log.error("updatenotification: [PM2]", err);
-					this.usePM2 = false;
 					resolve(false);
 					return;
 				}
 				pm2.list((err, list) => {
 					if (err) {
 						Log.error("updatenotification: [PM2] Can't get process List!");
-						this.usePM2 = false;
 						resolve(false);
 						return;
 					}
 					list.forEach((pm) => {
-						if (pm.pm2_env.version === this.version && pm.pm2_env.status === "online" && pm.pm2_env.pm_cwd.includes(`${this.root_path}/`)) {
-							this.PM2 = pm.name;
+						Log.debug(`updatenotification: [PM2] found pm2 process id: ${pm.pm_id} -- name: ${pm.name} -- unique_id: ${pm.pm2_env.unique_id}`);
+						if (pm.pm2_env.status === "online" && process.env.name === pm.name && +process.env.pm_id === +pm.pm_id && process.env.unique_id === pm.pm2_env.unique_id) {
+							this.PM2Id = pm.pm_id;
 							this.usePM2 = true;
-							Log.info("updatenotification: [PM2] You are using pm2 with", this.PM2);
+							Log.info(`updatenotification: [PM2] You are using pm2 with id: ${this.PM2Id} (${pm.name})`);
 							resolve(true);
+						} else {
+							Log.debug(`updatenotification: [PM2] pm2 process id: ${pm.pm_id} don't match...`);
 						}
 					});
 					pm2.disconnect();
-					if (!this.PM2) {
+					if (!this.usePM2) {
 						Log.info("updatenotification: [PM2] You are not using pm2");
-						this.usePM2 = false;
 						resolve(false);
 					}
 				});

modules/default/updatenotification/updatenotification.js

@@ -6,7 +6,8 @@ Module.register("updatenotification", {
 		sendUpdatesNotifications: false,
 		updates: [],
 		updateTimeout: 2 * 60 * 1000, // max update duration
-		updateAutorestart: false // autoRestart MM when update done ?
+		updateAutorestart: false, // autoRestart MM when update done ?
+		useModulesFromConfig: true // if `false` iterate over modules directory
 	},
 
 	suspended: false,

modules/default/utils.js

@@ -5,13 +5,14 @@
  * @param {boolean} useCorsProxy A flag to indicate
  * @param {Array.<{name: string, value:string}>} requestHeaders the HTTP headers to send
  * @param {Array.<string>} expectedResponseHeaders the expected HTTP headers to receive
+ * @param {string} basePath, default /
  * @returns {Promise} resolved when the fetch is done. The response headers is placed in a headers-property (provided the response does not already contain a headers-property).
  */
-async function performWebRequest (url, type = "json", useCorsProxy = false, requestHeaders = undefined, expectedResponseHeaders = undefined) {
+async function performWebRequest (url, type = "json", useCorsProxy = false, requestHeaders = undefined, expectedResponseHeaders = undefined, basePath = "/") {
 	const request = {};
 	let requestUrl;
 	if (useCorsProxy) {
-		requestUrl = getCorsUrl(url, requestHeaders, expectedResponseHeaders);
+		requestUrl = getCorsUrl(url, requestHeaders, expectedResponseHeaders, basePath);
 	} else {
 		requestUrl = url;
 		request.headers = getHeadersToSend(requestHeaders);
@@ -37,13 +38,14 @@ async function performWebRequest (url, type = "json", useCorsProxy = false, requ
  * @param {string} url the url to fetch from
  * @param {Array.<{name: string, value:string}>} requestHeaders the HTTP headers to send
  * @param {Array.<string>} expectedResponseHeaders the expected HTTP headers to receive
+ * @param {string} basePath, default /
  * @returns {string} to be used as URL when calling CORS-method on server.
  */
-const getCorsUrl = function (url, requestHeaders, expectedResponseHeaders) {
+const getCorsUrl = function (url, requestHeaders, expectedResponseHeaders, basePath = "/") {
 	if (!url || url.length < 1) {
 		throw new Error(`Invalid URL: ${url}`);
 	} else {
-		let corsUrl = `${location.protocol}//${location.host}/cors?`;
+		let corsUrl = `${location.protocol}//${location.host}${basePath}cors?`;
 
 		const requestHeaderString = getRequestHeaderString(requestHeaders);
 		if (requestHeaderString) corsUrl = `${corsUrl}sendheaders=${requestHeaderString}`;

modules/default/weather/hourly.njk

@@ -21,15 +21,25 @@
                         {% endif %}
                     </td>
                 {% endif %}
+                {% if config.showHumidity != "none" %}
+                  <td class="align-left bright humidity-hourly">
+                          {{ hour.humidity }}
+                          <span class="wi wi-humidity humidity-icon"></span>
+                  </td>
+                {% endif %}
                 {% if config.showPrecipitationAmount %}
-                    <td class="align-right bright precipitation-amount">
-                        {{ hour.precipitationAmount | unit("precip", hour.precipitationUnits) }}
-                    </td>
+                  {% if (not config.hideZeroes or hour.precipitationAmount>0) %}
+                      <td class="align-right bright precipitation-amount">
+                          {{ hour.precipitationAmount | unit("precip", hour.precipitationUnits) }}
+                      </td>
+                  {% endif %}
                 {% endif %}
                 {% if config.showPrecipitationProbability %}
+                  {% if (not config.hideZeroes or hour.precipitationAmount>0) %}
                     <td class="align-right bright precipitation-prob">
-                        {{ hour.precipitationProbability | unit('precip', '%') }}
+                      {{ hour.precipitationProbability | unit('precip', '%') }}
                     </td>
+                  {% endif %}
                 {% endif %}
             </tr>
             {% set currentStep = currentStep + 1 %}

modules/default/weather/providers/envcanada.js

@@ -1,6 +1,7 @@
 /* global WeatherProvider, WeatherObject, WeatherUtils */
 
-/* This class is a provider for Environment Canada MSC Datamart
+/*
+ * 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:
@@ -25,9 +26,7 @@
  *
  * 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",
@@ -39,10 +38,10 @@ WeatherProvider.register("envcanada", {
 		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)
-	//
+	/*
+	 * 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 (config) {
 		this.config = config;
 
@@ -52,17 +51,17 @@ WeatherProvider.register("envcanada", {
 		this.cacheCurrentTemp = 999;
 	},
 
-	//
-	// Called when the weather provider is started
-	//
+	/*
+	 * Called when the weather provider is started
+	 */
 	start () {
 		Log.info(`Weather provider: ${this.providerName} started.`);
 		this.setFetchedLocation(this.config.location);
 	},
 
-	//
-	// Override the fetchCurrentWeather method to query EC and construct a Current weather object
-	//
+	/*
+	 * Override the fetchCurrentWeather method to query EC and construct a Current weather object
+	 */
 	fetchCurrentWeather () {
 		this.fetchData(this.getUrl(), "xml")
 			.then((data) => {
@@ -80,9 +79,9 @@ WeatherProvider.register("envcanada", {
 			.finally(() => this.updateAvailable());
 	},
 
-	//
-	// Override the fetchWeatherForecast method to query EC and construct Forecast weather objects
-	//
+	/*
+	 * Override the fetchWeatherForecast method to query EC and construct Forecast weather objects
+	 */
 	fetchWeatherForecast () {
 		this.fetchData(this.getUrl(), "xml")
 			.then((data) => {
@@ -100,9 +99,9 @@ WeatherProvider.register("envcanada", {
 			.finally(() => this.updateAvailable());
 	},
 
-	//
-	// Override the fetchWeatherHourly method to query EC and construct Forecast weather objects
-	//
+	/*
+	 * Override the fetchWeatherHourly method to query EC and construct Forecast weather objects
+	 */
 	fetchWeatherHourly () {
 		this.fetchData(this.getUrl(), "xml")
 			.then((data) => {
@@ -120,36 +119,30 @@ WeatherProvider.register("envcanada", {
 			.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 params. Note that the
-	// URL defaults to the English version simply because there is no language dependency in the data
-	// being accessed. This is only pertinent when using the EC data elements that contain a textual forecast.
-	//
+	/*
+	 * Build the EC URL based on the Site Code and Province Code specified in the config params. Note that the
+	 * URL defaults to the English version simply because there is no language dependency 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
-	//
-
+	/*
+	 * Generate a WeatherObject based on current EC weather conditions
+	 */
 	generateWeatherObjectFromCurrentWeather (ECdoc) {
 		const currentWeather = new WeatherObject();
 
-		// 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;
-
+		/*
+		 * 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 = ECdoc.querySelector("siteData currentConditions temperature").textContent;
 			this.cacheCurrentTemp = currentWeather.temperature;
@@ -163,19 +156,19 @@ WeatherProvider.register("envcanada", {
 
 		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.
-
+		/*
+		 * 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 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;
 
@@ -188,16 +181,10 @@ WeatherProvider.register("envcanada", {
 			}
 		}
 
-		//
 		// 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");
@@ -206,13 +193,11 @@ WeatherProvider.register("envcanada", {
 		return currentWeather;
 	},
 
-	//
-	// Generate an array of WeatherObjects based on EC weather forecast
-	//
-
+	/*
+	 * 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();
@@ -226,37 +211,33 @@ WeatherProvider.register("envcanada", {
 
 		weather.precipitationAmount = 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.
-		//
-
+		/*
+		 * 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;
@@ -266,167 +247,144 @@ WeatherProvider.register("envcanada", {
 
 			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.
-			//
-
+			/*
+			 * 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).
-			//
-
+			/*
+			 * 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.
-		//
-
+		/*
+		 * 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 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.
-		//
-
+		/*
+		 * Now do 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();
 
 			// Add 1 to the date to reflect the current forecast day we are building
-
 			lastDate = lastDate.add(1, "day");
 			weather.date = moment(lastDate);
 
-			// Capture the temperatures for the current Element and the next Element in order to set
-			// the Min and Max temperatures for the forecast
-
+			/*
+			 * 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.precipitationAmount = 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
-	//
-
+	/*
+	 * 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.
-		//
-
+		/*
+		 * 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();
 
 			// 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);
 
 			// Capture the temperature
-
 			weather.temperature = 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.precipitationProbability = precipLOP;
 			}
 
-			//
 			// 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
-	//
 
+	/*
+	 * 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.
-		//
-
+		/*
+		 * 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.x
+		 */
 		if (fullDay === false) {
 			if (this.todayCached === true) {
 				weather.minTemperature = this.todayTempCacheMin;
@@ -437,13 +395,12 @@ WeatherProvider.register("envcanada", {
 			}
 		}
 
-		//
-		// 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.
-		//
-
+		/*
+		 * 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 = todayTemp;
 			if (today === 0 && fullDay === true) {
@@ -473,25 +430,24 @@ WeatherProvider.register("envcanada", {
 		}
 	},
 
-	//
-	// 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.
-	//
-
+	/*
+	 * 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.precipitationAmount = foreGroup[today].querySelector("precipitation accumulation amount").textContent * 1.0;
@@ -505,9 +461,9 @@ WeatherProvider.register("envcanada", {
 		}
 	},
 
-	//
-	// Convert the icons to a more usable name.
-	//
+	/*
+	 * Convert the icons to a more usable name.
+	 */
 	convertWeatherType (weatherType) {
 		const weatherTypes = {
 			"00": "day-sunny",

modules/default/weather/providers/openmeteo.js

@@ -1,6 +1,7 @@
 /* global WeatherProvider, WeatherObject */
 
-/* This class is a provider for Open-Meteo,
+/*
+ * This class is a provider for Open-Meteo,
  * see https://open-meteo.com/
  */
 
@@ -9,8 +10,11 @@ const GEOCODE_BASE = "https://api.bigdatacloud.net/data/reverse-geocode-client";
 const OPEN_METEO_BASE = "https://api.open-meteo.com/v1";
 
 WeatherProvider.register("openmeteo", {
-	// Set the name of the provider.
-	// Not strictly required, but helps for debugging.
+
+	/*
+	 * Set the name of the provider.
+	 * Not strictly required, but helps for debugging.
+	 */
 	providerName: "Open-Meteo",
 
 	// Set the default config properties that is specific to this provider
@@ -240,17 +244,17 @@ WeatherProvider.register("openmeteo", {
 			.add(Math.max(0, Math.min(7, this.config.maxNumberOfDays)), "days")
 			.endOf("day");
 
-		params["start_date"] = startDate.format("YYYY-MM-DD");
+		params.start_date = startDate.format("YYYY-MM-DD");
 
 		switch (this.config.type) {
 			case "hourly":
 			case "daily":
 			case "forecast":
-				params["end_date"] = endDate.format("YYYY-MM-DD");
+				params.end_date = endDate.format("YYYY-MM-DD");
 				break;
 			case "current":
-				params["current_weather"] = true;
-				params["end_date"] = params["start_date"];
+				params.current_weather = true;
+				params.end_date = params.start_date;
 				break;
 			default:
 				// Failsafe
@@ -258,7 +262,7 @@ WeatherProvider.register("openmeteo", {
 		}
 
 		return Object.keys(params)
-			.filter((key) => (params[key] ? true : false))
+			.filter((key) => (!!params[key]))
 			.map((key) => {
 				switch (key) {
 					case "hourly":
@@ -466,7 +470,7 @@ WeatherProvider.register("openmeteo", {
 			61: "rain-slight-intensity",
 			63: "rain-moderate-intensity",
 			65: "rain-heavy-intensity",
-			66: "freezing-rain-light-heavy-intensity",
+			66: "freezing-rain-light-intensity",
 			67: "freezing-rain-heavy-intensity",
 			71: "snow-fall-slight-intensity",
 			73: "snow-fall-moderate-intensity",

modules/default/weather/providers/openweathermap.js

@@ -1,22 +1,29 @@
 /* global WeatherProvider, WeatherObject */
 
-/* This class is a provider for Openweathermap,
+/*
+ * This class is a provider for Openweathermap,
  * see https://openweathermap.org/
  */
 WeatherProvider.register("openweathermap", {
-	// Set the name of the provider.
-	// This isn't strictly necessary, since it will fallback to the provider identifier
-	// But for debugging (and future alerts) it would be nice to have the real name.
+
+	/*
+	 * Set the name of the provider.
+	 * This isn't strictly necessary, since it will fallback to the provider identifier
+	 * But for debugging (and future alerts) it would be nice to have the real name.
+	 */
 	providerName: "OpenWeatherMap",
 
 	// Set the default config properties that is specific to this provider
 	defaults: {
-		apiVersion: "2.5",
+		apiVersion: "3.0",
 		apiBase: "https://api.openweathermap.org/data/",
-		weatherEndpoint: "", // can be "onecall", "forecast" or "weather" (for current)
+		// weatherEndpoint is "/onecall" since API 3.0
+		// "/onecall", "/forecast" or "/weather" only for pro customers
+		weatherEndpoint: "/onecall",
 		locationID: false,
 		location: false,
-		lat: 0, // the onecall endpoint needs lat / lon values, it doesn't support the locationId
+		// the /onecall endpoint needs lat / lon values, it doesn't support the locationId
+		lat: 0,
 		lon: 0,
 		apiKey: ""
 	},
@@ -67,8 +74,11 @@ WeatherProvider.register("openweathermap", {
 		this.fetchData(this.getUrl())
 			.then((data) => {
 				if (!data) {
-					// Did not receive usable new data.
-					// Maybe this needs a better check?
+
+					/*
+					 * Did not receive usable new data.
+					 * Maybe this needs a better check?
+					 */
 					return;
 				}
 
@@ -83,30 +93,6 @@ WeatherProvider.register("openweathermap", {
 			.finally(() => this.updateAvailable());
 	},
 
-	/**
-	 * Overrides method for setting config to check if endpoint is correct for hourly
-	 * @param {object} config The configuration object
-	 */
-	setConfig (config) {
-		this.config = config;
-		if (!this.config.weatherEndpoint) {
-			switch (this.config.type) {
-				case "hourly":
-					this.config.weatherEndpoint = "/onecall";
-					break;
-				case "daily":
-				case "forecast":
-					this.config.weatherEndpoint = "/forecast";
-					break;
-				case "current":
-					this.config.weatherEndpoint = "/weather";
-					break;
-				default:
-					Log.error("weatherEndpoint not configured and could not resolve it based on type");
-			}
-		}
-	},
-
 	/** OpenWeatherMap Specific Methods - These are not part of the default provider methods */
 	/*
 	 * Gets the complete url for the request
@@ -206,8 +192,10 @@ WeatherProvider.register("openweathermap", {
 				weather.weatherType = this.convertWeatherType(forecast.weather[0].icon);
 			}
 
-			// the same day as before
-			// add values from forecast to corresponding variables
+			/*
+			 * the same day as before
+			 * add values from forecast to corresponding variables
+			 */
 			minTemp.push(forecast.main.temp_min);
 			maxTemp.push(forecast.main.temp_max);
 
@@ -220,8 +208,10 @@ WeatherProvider.register("openweathermap", {
 			}
 		}
 
-		// last day
-		// calculate minimum/maximum temperature, specify rain amount
+		/*
+		 * last day
+		 * calculate minimum/maximum temperature, specify rain amount
+		 */
 		weather.minTemperature = Math.min.apply(null, minTemp);
 		weather.maxTemperature = Math.max.apply(null, maxTemp);
 		weather.rain = rain;
@@ -250,14 +240,18 @@ WeatherProvider.register("openweathermap", {
 			weather.rain = 0;
 			weather.snow = 0;
 
-			// forecast.rain not available if amount is zero
-			// The API always returns in millimeters
+			/*
+			 * forecast.rain not available if amount is zero
+			 * The API always returns in millimeters
+			 */
 			if (forecast.hasOwnProperty("rain") && !isNaN(forecast.rain)) {
 				weather.rain = forecast.rain;
 			}
 
-			// forecast.snow not available if amount is zero
-			// The API always returns in millimeters
+			/*
+			 * forecast.snow not available if amount is zero
+			 * The API always returns in millimeters
+			 */
 			if (forecast.hasOwnProperty("snow") && !isNaN(forecast.snow)) {
 				weather.snow = forecast.snow;
 			}
@@ -291,12 +285,12 @@ WeatherProvider.register("openweathermap", {
 			current.weatherType = this.convertWeatherType(data.current.weather[0].icon);
 			current.humidity = data.current.humidity;
 			current.uv_index = data.current.uvi;
-			if (data.current.hasOwnProperty("rain") && !isNaN(data.current["rain"]["1h"])) {
-				current.rain = data.current["rain"]["1h"];
+			if (data.current.hasOwnProperty("rain") && !isNaN(data.current.rain["1h"])) {
+				current.rain = data.current.rain["1h"];
 				precip = true;
 			}
-			if (data.current.hasOwnProperty("snow") && !isNaN(data.current["snow"]["1h"])) {
-				current.snow = data.current["snow"]["1h"];
+			if (data.current.hasOwnProperty("snow") && !isNaN(data.current.snow["1h"])) {
+				current.snow = data.current.snow["1h"];
 				precip = true;
 			}
 			if (precip) {
@@ -402,7 +396,8 @@ WeatherProvider.register("openweathermap", {
 		return weatherTypes.hasOwnProperty(weatherType) ? weatherTypes[weatherType] : null;
 	},
 
-	/* getParams(compliments)
+	/*
+	 * getParams(compliments)
 	 * Generates an url with api parameters based on the config.
 	 *
 	 * return String - URL params.

modules/default/weather/providers/pirateweather.js

@@ -1,11 +1,15 @@
 /* global WeatherProvider, WeatherObject */
 
-/* This class is a provider for Pirate Weather, it is a replacement for Dark Sky (same api),
+/*
+ * This class is a provider for Pirate Weather, it is a replacement for Dark Sky (same api),
  * see http://pirateweather.net/en/latest/
  */
 WeatherProvider.register("pirateweather", {
-	// Set the name of the provider.
-	// Not strictly required, but helps for debugging.
+
+	/*
+	 * Set the name of the provider.
+	 * Not strictly required, but helps for debugging.
+	 */
 	providerName: "pirateweather",
 
 	// Set the default config properties that is specific to this provider

modules/default/weather/providers/smhi.js

@@ -1,6 +1,7 @@
 /* global WeatherProvider, WeatherObject */
 
-/* This class is a provider for SMHI (Sweden only).
+/*
+ * This class is a provider for SMHI (Sweden only).
  * Metric system is the only supported unit,
  * see https://www.smhi.se/
  */
@@ -138,9 +139,11 @@ WeatherProvider.register("smhi", {
 		currentWeather.weatherType = this.convertWeatherType(this.paramValue(weatherData, "Wsymb2"), currentWeather.isDayTime());
 		currentWeather.feelsLikeTemp = this.calculateApparentTemperature(weatherData);
 
-		// 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

modules/default/weather/providers/ukmetoffice.js

@@ -1,12 +1,16 @@
 /* global WeatherProvider, WeatherObject, WeatherUtils */
 
-/* This class is a provider for UK Met Office Datapoint,
+/*
+ * This class is a provider for UK Met Office Datapoint,
  * see https://www.metoffice.gov.uk/
  */
 WeatherProvider.register("ukmetoffice", {
-	// Set the name of the provider.
-	// This isn't strictly necessary, since it will fallback to the provider identifier
-	// But for debugging (and future alerts) it would be nice to have the real name.
+
+	/*
+	 * Set the name of the provider.
+	 * This isn't strictly necessary, since it will fallback to the provider identifier
+	 * But for debugging (and future alerts) it would be nice to have the real name.
+	 */
 	providerName: "UK Met Office",
 
 	// Set the default config properties that is specific to this provider
@@ -21,8 +25,11 @@ WeatherProvider.register("ukmetoffice", {
 		this.fetchData(this.getUrl("3hourly"))
 			.then((data) => {
 				if (!data || !data.SiteRep || !data.SiteRep.DV || !data.SiteRep.DV.Location || !data.SiteRep.DV.Location.Period || data.SiteRep.DV.Location.Period.length === 0) {
-					// Did not receive usable new data.
-					// Maybe this needs a better check?
+
+					/*
+					 * Did not receive usable new data.
+					 * Maybe this needs a better check?
+					 */
 					return;
 				}
 
@@ -42,8 +49,11 @@ WeatherProvider.register("ukmetoffice", {
 		this.fetchData(this.getUrl("daily"))
 			.then((data) => {
 				if (!data || !data.SiteRep || !data.SiteRep.DV || !data.SiteRep.DV.Location || !data.SiteRep.DV.Location.Period || data.SiteRep.DV.Location.Period.length === 0) {
-					// Did not receive usable new data.
-					// Maybe this needs a better check?
+
+					/*
+					 * Did not receive usable new data.
+					 * Maybe this needs a better check?
+					 */
 					return;
 				}
 
@@ -86,8 +96,11 @@ WeatherProvider.register("ukmetoffice", {
 			if (periodDate.isSameOrAfter(moment.utc().startOf("day"))) {
 				// check this is the period we want, after today the diff will be -ve
 				if (moment().diff(periodDate, "minutes") > 0) {
-					// loop round the reports looking for the one we are in
-					// $ value specifies the time in minutes-of-the-day: 0, 180, 360,...1260
+
+					/*
+					 * 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 (const rep of period.Rep) {
 						const p = rep.$;
 						if (timeInMins >= p && timeInMins - 180 < p) {
@@ -117,8 +130,10 @@ WeatherProvider.register("ukmetoffice", {
 	generateWeatherObjectsFromForecast (forecasts) {
 		const days = [];
 
-		// loop round the (5) periods getting the data
-		// for each period array, Day is [0], Night is [1]
+		/*
+		 * loop round the (5) periods getting the data
+		 * for each period array, Day is [0], Night is [1]
+		 */
 		for (const period of forecasts.SiteRep.DV.Location.Period) {
 			const weather = new WeatherObject();
 

modules/default/weather/providers/ukmetofficedatahub.js

@@ -1,6 +1,7 @@
 /* global WeatherProvider, WeatherObject */
 
-/* This class is a provider for UK Met Office Data Hub (the replacement for their Data Point services).
+/*
+ * This class is a provider for UK Met Office Data Hub (the replacement for their Data Point services).
  * For more information on Data Hub, see https://www.metoffice.gov.uk/services/data/datapoint/notifications/weather-datahub
  * Data available:
  * 		Hourly data for next 2 days ("hourly") - https://www.metoffice.gov.uk/binaries/content/assets/metofficegovuk/pdf/data/global-spot-data-hourly.pdf
@@ -11,9 +12,8 @@
  * 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",
- * 		apiBase: "https://api-metoffice.apiconnect.ibmcloud.com/metoffice/production/v0/forecasts/point/",
+ * 		apiBase: "https://data.hub.api.metoffice.gov.uk/sitespecific/v0/point/",
  * 		apiKey: "[YOUR API KEY]",
- * 		apiSecret: "[YOUR API SECRET]",
  * 		lat: [LATITUDE (DECIMAL)],
  * 		lon: [LONGITUDE (DECIMAL)]
  *
@@ -38,14 +38,13 @@ WeatherProvider.register("ukmetofficedatahub", {
 
 	// Set the default config properties that is specific to this provider
 	defaults: {
-		apiBase: "https://api-metoffice.apiconnect.ibmcloud.com/metoffice/production/v0/forecasts/point/",
+		apiBase: "https://data.hub.api.metoffice.gov.uk/sitespecific/v0/point/",
 		apiKey: "",
-		apiSecret: "",
 		lat: 0,
 		lon: 0
 	},
 
-	// Build URL with query strings according to DataHub API (https://metoffice.apiconnect.ibmcloud.com/metoffice/production/api)
+	// Build URL with query strings according to DataHub API (https://datahub.metoffice.gov.uk/docs/f/category/site-specific/type/site-specific/api-documentation#get-/point/hourly)
 	getUrl (forecastType) {
 		let queryStrings = "?";
 		queryStrings += `latitude=${this.config.lat}`;
@@ -56,14 +55,15 @@ WeatherProvider.register("ukmetofficedatahub", {
 		return this.config.apiBase + (this.config.apiBase.endsWith("/") ? "" : "/") + forecastType + queryStrings;
 	},
 
-	// Build the list of headers for the request
-	// 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)
+	/*
+	 * Build the list of headers for the request
+	 * 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://datahub.metoffice.gov.uk/docs/f/category/site-specific/type/site-specific/api-documentation#get-/point/hourly)
+	 */
 	getHeaders () {
 		return {
 			accept: "application/json",
-			"x-ibm-client-id": this.config.apiKey,
-			"x-ibm-client-secret": this.config.apiSecret
+			apikey: this.config.apiKey
 		};
 	},
 
@@ -81,8 +81,11 @@ WeatherProvider.register("ukmetofficedatahub", {
 			.then((data) => {
 				// Check data is usable
 				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?
+
+					/*
+					 * Did not receive usable new data.
+					 * Maybe this needs a better check?
+					 */
 					Log.error("Possibly bad current/hourly data?");
 					Log.error(data);
 					return;
@@ -130,15 +133,19 @@ WeatherProvider.register("ukmetofficedatahub", {
 				currentWeather.precipitationProbability = forecastDataHours[hour].probOfPrecipitation;
 				currentWeather.feelsLikeTemp = forecastDataHours[hour].feelsLikeTemperature;
 
-				// 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)
+				/*
+				 * 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)
+				 */
 				currentWeather.rawData = forecastDataHours[hour];
 			}
 		}
 
-		// Determine the sunrise/sunset times - (still) not supplied in UK Met Office data
-		// Passes {longitude, latitude} to SunCalc, could pass height to, but
-		// SunCalc.getTimes doesn't take that into account
+		/*
+		 * Determine the sunrise/sunset times - (still) not supplied in UK Met Office data
+		 * Passes {longitude, latitude} to SunCalc, could pass height to, but
+		 * SunCalc.getTimes doesn't take that into account
+		 */
 		currentWeather.updateSunTime(this.config.lat, this.config.lon);
 
 		return currentWeather;
@@ -150,8 +157,11 @@ WeatherProvider.register("ukmetofficedatahub", {
 			.then((data) => {
 				// Check data is usable
 				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?
+
+					/*
+					 * Did not receive usable new data.
+					 * Maybe this needs a better check?
+					 */
 					Log.error("Possibly bad forecast data?");
 					Log.error(data);
 					return;
@@ -206,8 +216,10 @@ WeatherProvider.register("ukmetofficedatahub", {
 				forecastWeather.snow = forecastDataDays[day].dayProbabilityOfSnow;
 				forecastWeather.feelsLikeTemp = forecastDataDays[day].dayMaxFeelsLikeTemp;
 
-				// 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)
+				/*
+				 * 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);
@@ -222,9 +234,11 @@ WeatherProvider.register("ukmetofficedatahub", {
 		this.fetchedLocationName = name;
 	},
 
-	// Match the Met Office "significant weather code" to a weathericons.css icon
-	// Use: https://metoffice.apiconnect.ibmcloud.com/metoffice/production/node/264
-	// and: https://erikflowers.github.io/weather-icons/
+	/*
+	 * Match the Met Office "significant weather code" to a weathericons.css icon
+	 * Use: https://metoffice.apiconnect.ibmcloud.com/metoffice/production/node/264
+	 * and: https://erikflowers.github.io/weather-icons/
+	 */
 	convertWeatherType (weatherType) {
 		const weatherTypes = {
 			0: "night-clear",

modules/default/weather/providers/weatherbit.js

@@ -1,11 +1,15 @@
 /* global WeatherProvider, WeatherObject */
 
-/* This class is a provider for Weatherbit,
+/*
+ * This class is a provider for Weatherbit,
  * see https://www.weatherbit.io/
  */
 WeatherProvider.register("weatherbit", {
-	// Set the name of the provider.
-	// Not strictly required, but helps for debugging.
+
+	/*
+	 * Set the name of the provider.
+	 * Not strictly required, but helps for debugging.
+	 */
 	providerName: "Weatherbit",
 
 	// Set the default config properties that is specific to this provider

modules/default/weather/providers/weatherflow.js

@@ -1,11 +1,15 @@
 /* global WeatherProvider, WeatherObject, WeatherUtils */
 
-/* This class is a provider for Weatherflow.
+/*
+ * This class is a provider for Weatherflow.
  * Note that the Weatherflow API does not provide snowfall.
  */
 WeatherProvider.register("weatherflow", {
-	// Set the name of the provider.
-	// Not strictly required, but helps for debugging
+
+	/*
+	 * Set the name of the provider.
+	 * Not strictly required, but helps for debugging
+	 */
 	providerName: "WeatherFlow",
 
 	// Set the default config properties that is specific to this provider
@@ -21,14 +25,20 @@ WeatherProvider.register("weatherflow", {
 				const currentWeather = new WeatherObject();
 				currentWeather.date = moment();
 
+				// Other available values: air_density, brightness, delta_t, dew_point,
+				// pressure_trend (i.e. rising/falling), sea_level_pressure, wind gust, and more.
+
 				currentWeather.humidity = data.current_conditions.relative_humidity;
 				currentWeather.temperature = data.current_conditions.air_temperature;
+				currentWeather.feelsLikeTemp = data.current_conditions.feels_like;
 				currentWeather.windSpeed = WeatherUtils.convertWindToMs(data.current_conditions.wind_avg);
 				currentWeather.windFromDirection = data.current_conditions.wind_direction;
-				currentWeather.weatherType = data.forecast.daily[0].icon;
+				currentWeather.weatherType = this.convertWeatherType(data.current_conditions.icon);
+				currentWeather.uv_index = data.current_conditions.uv;
 				currentWeather.sunrise = moment.unix(data.forecast.daily[0].sunrise);
 				currentWeather.sunset = moment.unix(data.forecast.daily[0].sunset);
 				this.setCurrentWeather(currentWeather);
+				this.fetchedLocationName = data.location_name;
 			})
 			.catch(function (request) {
 				Log.error("Could not load data ... ", request);
@@ -48,13 +58,27 @@ WeatherProvider.register("weatherflow", {
 					weather.minTemperature = forecast.air_temp_low;
 					weather.maxTemperature = forecast.air_temp_high;
 					weather.precipitationProbability = forecast.precip_probability;
-					weather.weatherType = forecast.icon;
-					weather.snow = 0;
+					weather.weatherType = this.convertWeatherType(forecast.icon);
 
+					// Must manually build UV and Precipitation from hourly
+					weather.precipitationAmount = 0.0; // This will sum up rain and snow
+					weather.precipitationUnits = "mm";
+					weather.uv_index = 0;
+
+					for (const hour of data.forecast.hourly) {
+						const hour_time = moment.unix(hour.time);
+						if (hour_time.day() === weather.date.day()) { // Iterate though until day is reached
+							// Get data from today
+							weather.uv_index = Math.max(weather.uv_index, hour.uv);
+							weather.precipitationAmount += (hour.precip ?? 0);
+						} else if (hour_time.diff(weather.date) >= 86400) {
+							break; // No more data to be found
+						}
+					}
 					days.push(weather);
 				}
-
 				this.setWeatherForecast(days);
+				this.fetchedLocationName = data.location_name;
 			})
 			.catch(function (request) {
 				Log.error("Could not load data ... ", request);
@@ -62,6 +86,63 @@ WeatherProvider.register("weatherflow", {
 			.finally(() => this.updateAvailable());
 	},
 
+	fetchWeatherHourly () {
+		this.fetchData(this.getUrl())
+			.then((data) => {
+				const hours = [];
+				for (const hour of data.forecast.hourly) {
+					const weather = new WeatherObject();
+
+					weather.date = moment.unix(hour.time);
+					weather.temperature = hour.air_temperature;
+					weather.feelsLikeTemp = hour.feels_like;
+					weather.humidity = hour.relative_humidity;
+					weather.windSpeed = hour.wind_avg;
+					weather.windFromDirection = hour.wind_direction;
+					weather.weatherType = this.convertWeatherType(hour.icon);
+					weather.precipitationProbability = hour.precip_probability;
+					weather.precipitationAmount = hour.precip; // NOTE: precipitation type is available
+					weather.precipitationUnits = "mm"; // Hardcoded via request, TODO: Add conversion
+					weather.uv_index = hour.uv;
+
+					hours.push(weather);
+					if (hours.length >= 48) break; // 10 days of hours are available, best to trim down.
+				}
+				this.setWeatherHourly(hours);
+				this.fetchedLocationName = data.location_name;
+			})
+			.catch(function (request) {
+				Log.error("Could not load data ... ", request);
+			})
+			.finally(() => this.updateAvailable());
+	},
+
+	convertWeatherType (weatherType) {
+		const weatherTypes = {
+			"clear-day": "day-sunny",
+			"clear-night": "night-clear",
+			cloudy: "cloudy",
+			foggy: "fog",
+			"partly-cloudy-day": "day-cloudy",
+			"partly-cloudy-night": "night-alt-cloudy",
+			"possibly-rainy-day": "day-rain",
+			"possibly-rainy-night": "night-alt-rain",
+			"possibly-sleet-day": "day-sleet",
+			"possibly-sleet-night": "night-alt-sleet",
+			"possibly-snow-day": "day-snow",
+			"possibly-snow-night": "night-alt-snow",
+			"possibly-thunderstorm-day": "day-thunderstorm",
+			"possibly-thunderstorm-night": "night-alt-thunderstorm",
+			rainy: "rain",
+			sleet: "sleet",
+			snow: "snow",
+			thunderstorm: "thunderstorm",
+			windy: "strong-wind"
+		};
+
+		return weatherTypes.hasOwnProperty(weatherType) ? weatherTypes[weatherType] : null;
+	},
+
 	// Create a URL from the config and base URL.
 	getUrl () {
 		return `${this.config.apiBase}better_forecast?station_id=${this.config.stationid}&units_temp=c&units_wind=kph&units_pressure=mb&units_precip=mm&units_distance=km&token=${this.config.token}`;

modules/default/weather/providers/weathergov.js

@@ -1,6 +1,7 @@
 /* global WeatherProvider, WeatherObject, WeatherUtils */
 
-/* Provider: weather.gov
+/*
+ * Provider: weather.gov
  * https://weather-gov.github.io/api/general-faqs
  *
  * This class is a provider for weather.gov.
@@ -9,9 +10,12 @@
  */
 
 WeatherProvider.register("weathergov", {
-	// Set the name of the provider.
-	// This isn't strictly necessary, since it will fallback to the provider identifier
-	// But for debugging (and future alerts) it would be nice to have the real name.
+
+	/*
+	 * Set the name of the provider.
+	 * This isn't strictly necessary, since it will fallback to the provider identifier
+	 * But for debugging (and future alerts) it would be nice to have the real name.
+	 */
 	providerName: "Weather.gov",
 
 	// Set the default config properties that is specific to this provider
@@ -98,8 +102,11 @@ WeatherProvider.register("weathergov", {
 		this.fetchData(this.forecastHourlyURL)
 			.then((data) => {
 				if (!data) {
-					// Did not receive usable new data.
-					// Maybe this needs a better check?
+
+					/*
+					 * Did not receive usable new data.
+					 * Maybe this needs a better check?
+					 */
 					return;
 				}
 				const hourly = this.generateWeatherObjectsFromHourly(data.properties.periods);
@@ -282,14 +289,18 @@ WeatherProvider.register("weathergov", {
 				weather.weatherType = this.convertWeatherType(forecast.shortForecast, forecast.isDaytime);
 			}
 
-			// the same day as before
-			// add values from forecast to corresponding variables
+			/*
+			 * the same day as before
+			 * add values from forecast to corresponding variables
+			 */
 			minTemp.push(forecast.temperature);
 			maxTemp.push(forecast.temperature);
 		}
 
-		// last day
-		// calculate minimum/maximum temperature
+		/*
+		 * last day
+		 * calculate minimum/maximum temperature
+		 */
 		weather.minTemperature = Math.min.apply(null, minTemp);
 		weather.maxTemperature = Math.max.apply(null, maxTemp);
 
@@ -302,8 +313,11 @@ WeatherProvider.register("weathergov", {
 	 * Convert the icons to a more usable name.
 	 */
 	convertWeatherType (weatherType, isDaytime) {
-		//https://w1.weather.gov/xml/current_obs/weather.php
-		// There are way too many types to create, so lets just look for certain strings
+
+		/*
+		 * https://w1.weather.gov/xml/current_obs/weather.php
+		 *  There are way too many types to create, so lets just look for certain strings
+		 */
 
 		if (weatherType.includes("Cloudy") || weatherType.includes("Partly")) {
 			if (isDaytime) {

modules/default/weather/providers/yr.js

@@ -1,6 +1,7 @@
 /* global WeatherProvider, WeatherObject */
 
-/* This class is a provider for Yr.no, a norwegian weather service.
+/*
+ * This class is a provider for Yr.no, a norwegian weather service.
  * Terms of service: https://developer.yr.no/doc/TermsOfService/
  */
 WeatherProvider.register("yr", {
@@ -22,6 +23,10 @@ WeatherProvider.register("yr", {
 			Log.error("The Yr weather provider requires local storage.");
 			throw new Error("Local storage not available");
 		}
+		if (this.config.updateInterval < 600000) {
+			Log.warn("The Yr weather provider requires a minimum update interval of 10 minutes (600 000 ms). The configuration has been adjusted to meet this requirement.");
+			this.delegate.config.updateInterval = 600000;
+		}
 		Log.info(`Weather provider: ${this.providerName} started.`);
 	},
 
@@ -33,7 +38,7 @@ WeatherProvider.register("yr", {
 			})
 			.catch((error) => {
 				Log.error(error);
-				throw new Error(error);
+				this.updateAvailable();
 			});
 	},
 
@@ -67,8 +72,11 @@ WeatherProvider.register("yr", {
 
 	getWeatherData () {
 		return new Promise((resolve, reject) => {
-			// If a user has several Yr-modules, for instance one current and one forecast, the API calls must be synchronized across classes.
-			// This is to avoid multiple similar calls to the API.
+
+			/*
+			 * If a user has several Yr-modules, for instance one current and one forecast, the API calls must be synchronized across classes.
+			 * This is to avoid multiple similar calls to the API.
+			 */
 			let shouldWait = localStorage.getItem("yrIsFetchingWeatherData");
 			if (shouldWait) {
 				const checkForGo = setInterval(function () {
@@ -115,7 +123,12 @@ WeatherProvider.register("yr", {
 				})
 				.catch((err) => {
 					Log.error(err);
-					reject("Unable to get weather data from Yr.");
+					if (weatherData) {
+						Log.warn("Using outdated cached weather data.");
+						resolve(weatherData);
+					} else {
+						reject("Unable to get weather data from Yr.");
+					}
 				})
 				.finally(() => {
 					localStorage.removeItem("yrIsFetchingWeatherData");
@@ -201,8 +214,11 @@ WeatherProvider.register("yr", {
 	},
 
 	getStellarData () {
-		// If a user has several Yr-modules, for instance one current and one forecast, the API calls must be synchronized across classes.
-		// This is to avoid multiple similar calls to the API.
+
+		/*
+		 * If a user has several Yr-modules, for instance one current and one forecast, the API calls must be synchronized across classes.
+		 * This is to avoid multiple similar calls to the API.
+		 */
 		return new Promise((resolve, reject) => {
 			let shouldWait = localStorage.getItem("yrIsFetchingStellarData");
 			if (shouldWait) {
@@ -490,7 +506,7 @@ WeatherProvider.register("yr", {
 			})
 			.catch((error) => {
 				Log.error(error);
-				throw new Error(error);
+				this.updateAvailable();
 			});
 	},
 
@@ -523,7 +539,15 @@ WeatherProvider.register("yr", {
 	getHourlyForecastFrom (weatherData) {
 		const series = [];
 
+		const now = moment({
+			year: moment().year(),
+			month: moment().month(),
+			day: moment().date(),
+			hour: moment().hour()
+		});
 		for (const forecast of weatherData.properties.timeseries) {
+			if (now.isAfter(moment(forecast.time))) continue;
+
 			forecast.symbol = forecast.data.next_1_hours?.summary?.symbol_code;
 			forecast.precipitationAmount = forecast.data.next_1_hours?.details?.precipitation_amount;
 			forecast.precipitationProbability = forecast.data.next_1_hours?.details?.probability_of_precipitation;
@@ -593,7 +617,7 @@ WeatherProvider.register("yr", {
 			})
 			.catch((error) => {
 				Log.error(error);
-				throw new Error(error);
+				this.updateAvailable();
 			});
 	}
 });

modules/default/weather/weather.css

@@ -31,6 +31,7 @@
 
 .weather .precipitation-amount,
 .weather .precipitation-prob,
+.weather .humidity-hourly,
 .weather .uv-index {
   padding-left: 20px;
   padding-right: 0;

modules/default/weather/weather.js

@@ -14,7 +14,8 @@ Module.register("weather", {
 		updateInterval: 10 * 60 * 1000, // every 10 minutes
 		animationSpeed: 1000,
 		showFeelsLike: true,
-		showHumidity: "none", // this is now a string; see current.njk
+		showHumidity: "none", // possible options for "current" weather are "none", "wind", "temp", "feelslike" or "below", for "hourly" weather "none" or "true"
+		hideZeroes: false, // hide zeroes (and empty columns) in hourly, currently only for precipitation
 		showIndoorHumidity: false,
 		showIndoorTemperature: false,
 		allowOverrideNotification: false,
@@ -170,12 +171,19 @@ Module.register("weather", {
 		}
 
 		const notificationPayload = {
-			currentWeather: this.weatherProvider?.currentWeatherObject?.simpleClone() ?? null,
-			forecastArray: this.weatherProvider?.weatherForecastArray?.map((ar) => ar.simpleClone()) ?? [],
-			hourlyArray: this.weatherProvider?.weatherHourlyArray?.map((ar) => ar.simpleClone()) ?? [],
+			currentWeather: this.config.units === "imperial"
+				? WeatherUtils.convertWeatherObjectToImperial(this.weatherProvider?.currentWeatherObject?.simpleClone()) ?? null
+				: this.weatherProvider?.currentWeatherObject?.simpleClone() ?? null,
+			forecastArray: this.config.units === "imperial"
+				? this.weatherProvider?.weatherForecastArray?.map((ar) => WeatherUtils.convertWeatherObjectToImperial(ar.simpleClone())) ?? []
+				: this.weatherProvider?.weatherForecastArray?.map((ar) => ar.simpleClone()) ?? [],
+			hourlyArray: this.config.units === "imperial"
+				? this.weatherProvider?.weatherHourlyArray?.map((ar) => WeatherUtils.convertWeatherObjectToImperial(ar.simpleClone())) ?? []
+				: this.weatherProvider?.weatherHourlyArray?.map((ar) => ar.simpleClone()) ?? [],
 			locationName: this.weatherProvider?.fetchedLocationName,
 			providerName: this.weatherProvider.providerName
 		};
+
 		this.sendNotification("WEATHER_UPDATED", notificationPayload);
 	},
 

modules/default/weather/weatherprovider.js

@@ -119,7 +119,7 @@ const WeatherProvider = Class.extend({
 			return JSON.parse(data);
 		}
 		const useCorsProxy = typeof this.config.useCorsProxy !== "undefined" && this.config.useCorsProxy;
-		return performWebRequest(url, type, useCorsProxy, requestHeaders, expectedResponseHeaders);
+		return performWebRequest(url, type, useCorsProxy, requestHeaders, expectedResponseHeaders, config.basePath);
 	}
 });
 

modules/default/weather/weatherutils.js

@@ -30,8 +30,7 @@ const WeatherUtils = {
 		let convertedValue = value;
 		let conversionUnit = valueUnit;
 		if (outputUnit === "imperial") {
-			if (valueUnit && valueUnit.toLowerCase() === "cm") convertedValue = convertedValue * 0.3937007874;
-			else convertedValue = convertedValue * 0.03937007874;
+			convertedValue = this.convertPrecipitationToInch(value, valueUnit);
 			conversionUnit = "in";
 		} else {
 			conversionUnit = valueUnit ? valueUnit : "mm";
@@ -40,6 +39,17 @@ const WeatherUtils = {
 		return `${convertedValue.toFixed(2)} ${conversionUnit}`;
 	},
 
+	/**
+	 * Convert precipitation value into inch
+	 * @param {number} value the precipitation value for convert
+	 * @param {string} valueUnit can be 'mm' or 'cm'
+	 * @returns {number} the converted precipitation value
+	 */
+	convertPrecipitationToInch (value, valueUnit) {
+		if (valueUnit && valueUnit.toLowerCase() === "cm") return value * 0.3937007874;
+		else return value * 0.03937007874;
+	},
+
 	/**
 	 * Convert temp (from degrees C) into imperial or metric unit depending on
 	 * your config
@@ -118,17 +128,39 @@ const WeatherUtils = {
 		} else if (tempInF > 80 && humidity > 40) {
 			feelsLike
 				= -42.379
-				+ 2.04901523 * tempInF
-				+ 10.14333127 * humidity
-				- 0.22475541 * tempInF * humidity
-				- 6.83783 * Math.pow(10, -3) * tempInF * tempInF
-				- 5.481717 * Math.pow(10, -2) * humidity * humidity
-				+ 1.22874 * Math.pow(10, -3) * tempInF * tempInF * humidity
-				+ 8.5282 * Math.pow(10, -4) * tempInF * humidity * humidity
-				- 1.99 * Math.pow(10, -6) * tempInF * tempInF * humidity * humidity;
+				  + 2.04901523 * tempInF
+				  + 10.14333127 * humidity
+				  - 0.22475541 * tempInF * humidity
+				  - 6.83783 * Math.pow(10, -3) * tempInF * tempInF
+				  - 5.481717 * Math.pow(10, -2) * humidity * humidity
+				  + 1.22874 * Math.pow(10, -3) * tempInF * tempInF * humidity
+				  + 8.5282 * Math.pow(10, -4) * tempInF * humidity * humidity
+				  - 1.99 * Math.pow(10, -6) * tempInF * tempInF * humidity * humidity;
 		}
 
 		return ((feelsLike - 32) * 5) / 9;
+	},
+
+	/**
+	 * Converts the Weather Object's values into imperial unit
+	 * @param {object} weatherObject the weather object
+	 * @returns {object} the weather object with converted values to imperial
+	 */
+	convertWeatherObjectToImperial (weatherObject) {
+		if (!weatherObject || Object.keys(weatherObject).length === 0) return null;
+
+		let imperialWeatherObject = { ...weatherObject };
+
+		if (imperialWeatherObject) {
+			if (imperialWeatherObject.feelsLikeTemp) imperialWeatherObject.feelsLikeTemp = this.convertTemp(imperialWeatherObject.feelsLikeTemp, "imperial");
+			if (imperialWeatherObject.maxTemperature) imperialWeatherObject.maxTemperature = this.convertTemp(imperialWeatherObject.maxTemperature, "imperial");
+			if (imperialWeatherObject.minTemperature) imperialWeatherObject.minTemperature = this.convertTemp(imperialWeatherObject.minTemperature, "imperial");
+			if (imperialWeatherObject.precipitationAmount) imperialWeatherObject.precipitationAmount = this.convertPrecipitationToInch(imperialWeatherObject.precipitationAmount, imperialWeatherObject.precipitationUnits);
+			if (imperialWeatherObject.temperature) imperialWeatherObject.temperature = this.convertTemp(imperialWeatherObject.temperature, "imperial");
+			if (imperialWeatherObject.windSpeed) imperialWeatherObject.windSpeed = this.convertWind(imperialWeatherObject.windSpeed, "imperial");
+		}
+
+		return imperialWeatherObject;
 	}
 };
 

package.json

@@ -1,6 +1,6 @@
 {
 	"name": "magicmirror",
-	"version": "2.28.0",
+	"version": "2.31.0",
 	"description": "The open source modular smart mirror platform.",
 	"keywords": [
 		"magic mirror",
@@ -24,29 +24,37 @@
 	],
 	"main": "js/electron.js",
 	"scripts": {
-		"start": "DISPLAY=\"${DISPLAY:=:0}\" ./node_modules/.bin/electron js/electron.js",
-		"start:dev": "DISPLAY=\"${DISPLAY:=:0}\" ./node_modules/.bin/electron js/electron.js dev",
-		"server": "node ./serveronly",
+		"config:check": "node js/check_config.js",
+		"install-fonts": "echo \"Installing fonts ...\n\" && cd fonts && npm install --loglevel=error --no-audit --no-fund --no-update-notifier",
 		"install-mm": "npm install --no-audit --no-fund --no-update-notifier --only=prod --omit=dev",
 		"install-mm:dev": "npm install --no-audit --no-fund --no-update-notifier",
 		"install-vendor": "echo \"Installing vendor files ...\n\" && cd vendor && npm install --loglevel=error --no-audit --no-fund --no-update-notifier",
-		"install-fonts": "echo \"Installing fonts ...\n\" && cd fonts && npm install --loglevel=error --no-audit --no-fund --no-update-notifier",
-		"postinstall": "npm run install-vendor && npm run install-fonts && echo \"MagicMirror² installation finished successfully! \n\"",
-		"test": "NODE_ENV=test jest -i --forceExit",
-		"test:coverage": "NODE_ENV=test jest --coverage -i --verbose false --forceExit",
-		"test:electron": "NODE_ENV=test jest --selectProjects electron -i --forceExit",
-		"test:e2e": "NODE_ENV=test jest --selectProjects e2e -i --forceExit",
-		"test:unit": "NODE_ENV=test jest --selectProjects unit",
-		"test:prettier": "prettier . --check",
-		"test:js": "eslint .",
-		"test:css": "stylelint 'css/main.css' 'fonts/*.css' 'modules/default/**/*.css' 'vendor/*.css' --config .stylelintrc.json",
-		"test:calendar": "node ./modules/default/calendar/debug.js",
-		"config:check": "node js/check_config.js",
-		"lint:prettier": "prettier . --write",
-		"lint:js": "eslint . --fix",
 		"lint:css": "stylelint 'css/main.css' 'fonts/*.css' 'modules/default/**/*.css' 'vendor/*.css' --config .stylelintrc.json --fix",
-		"lint:staged": "lint-staged",
-		"prepare": "[ -f node_modules/.bin/husky ] && husky || echo no husky installed."
+		"lint:js": "eslint --fix",
+		"lint:markdown": "markdownlint-cli2 . --fix",
+		"lint:prettier": "prettier . --write",
+		"postinstall": "npm run install-vendor && npm run install-fonts && echo \"MagicMirror² installation finished successfully! \n\"",
+		"prepare": "[ -f node_modules/.bin/husky ] && husky || echo no husky installed.",
+		"server": "node ./serveronly",
+		"start": "npm run start:x11",
+		"start:dev": "npm run start -- dev",
+		"start:wayland": "WAYLAND_DISPLAY=\"${WAYLAND_DISPLAY:=wayland-1}\" ./node_modules/.bin/electron js/electron.js --enable-features=UseOzonePlatform --ozone-platform=wayland",
+		"start:wayland:dev": "npm run start:wayland -- dev",
+		"start:windows": ".\\node_modules\\.bin\\electron js\\electron.js",
+		"start:windows:dev": "npm run start:windows -- dev",
+		"start:x11": "DISPLAY=\"${DISPLAY:=:0}\" ./node_modules/.bin/electron js/electron.js",
+		"start:x11:dev": "npm run start:x11 -- dev",
+		"test": "NODE_ENV=test jest -i --forceExit",
+		"test:calendar": "node ./modules/default/calendar/debug.js",
+		"test:coverage": "NODE_ENV=test jest --coverage -i --verbose false --forceExit",
+		"test:css": "stylelint 'css/main.css' 'fonts/*.css' 'modules/default/**/*.css' 'vendor/*.css' --config .stylelintrc.json",
+		"test:e2e": "NODE_ENV=test jest --selectProjects e2e -i --forceExit",
+		"test:electron": "NODE_ENV=test jest --selectProjects electron -i --forceExit",
+		"test:js": "eslint",
+		"test:markdown": "markdownlint-cli2 .",
+		"test:prettier": "prettier . --check",
+		"test:spelling": "cspell . --gitignore",
+		"test:unit": "NODE_ENV=test jest --selectProjects unit"
 	},
 	"lint-staged": {
 		"*": "prettier --write",
@@ -54,49 +62,51 @@
 		"*.css": "stylelint --fix"
 	},
 	"dependencies": {
-		"ajv": "^8.16.0",
-		"ansis": "^3.2.0",
+		"ajv": "^8.17.1",
+		"ansis": "^3.17.0",
 		"console-stamp": "^3.1.2",
 		"envsub": "^4.1.0",
-		"eslint": "^8.57.0",
-		"express": "^4.19.2",
+		"eslint": "^9.23.0",
+		"express": "^4.21.2",
 		"express-ipfilter": "^1.3.2",
 		"feedme": "^2.0.2",
-		"helmet": "^7.1.0",
+		"helmet": "^8.1.0",
 		"html-to-text": "^9.0.5",
 		"iconv-lite": "^0.6.3",
 		"module-alias": "^2.2.3",
 		"moment": "^2.30.1",
-		"node-ical": "^0.18.0",
-		"pm2": "^5.4.1",
-		"socket.io": "^4.7.5",
+		"node-ical": "^0.20.1",
+		"pm2": "^5.4.3",
+		"socket.io": "^4.8.1",
 		"suncalc": "^1.9.0",
-		"systeminformation": "^5.22.11"
+		"systeminformation": "^5.25.11",
+		"undici": "^7.6.0"
 	},
 	"devDependencies": {
-		"@stylistic/eslint-plugin": "^1.8.1",
-		"eslint-plugin-import": "^2.29.1",
-		"eslint-plugin-jest": "^28.6.0",
-		"eslint-plugin-jsdoc": "^48.5.0",
-		"eslint-plugin-package-json": "^0.15.0",
-		"eslint-plugin-unicorn": "^54.0.0",
+		"@stylistic/eslint-plugin": "^4.2.0",
+		"cspell": "^8.18.1",
+		"eslint-plugin-import": "^2.31.0",
+		"eslint-plugin-jest": "^28.11.0",
+		"eslint-plugin-jsdoc": "^50.6.9",
+		"eslint-plugin-package-json": "^0.29.0",
 		"express-basic-auth": "^1.2.1",
-		"husky": "^9.0.11",
+		"husky": "^9.1.7",
 		"jest": "^29.7.0",
-		"jsdom": "^24.1.0",
-		"lint-staged": "^15.2.7",
-		"playwright": "^1.45.0",
-		"prettier": "^3.3.2",
-		"sinon": "^18.0.0",
-		"stylelint": "^16.6.1",
-		"stylelint-config-standard": "^36.0.1",
-		"stylelint-prettier": "^5.0.0"
+		"jsdom": "^26.0.0",
+		"lint-staged": "^15.5.0",
+		"markdownlint-cli2": "^0.17.2",
+		"playwright": "^1.51.1",
+		"prettier": "^3.5.3",
+		"sinon": "^20.0.0",
+		"stylelint": "^16.17.0",
+		"stylelint-config-standard": "^37.0.0",
+		"stylelint-prettier": "^5.0.3"
 	},
 	"optionalDependencies": {
-		"electron": "^31.1.0"
+		"electron": "^35.1.2"
 	},
 	"engines": {
-		"node": ">=20"
+		"node": ">=22.14.0"
 	},
 	"_moduleAliases": {
 		"node_helper": "js/node_helper.js",

prettier.config.mjs

@@ -0,0 +1,13 @@
+const config = {
+	overrides: [
+		{
+			files: "*.md",
+			options: {
+				parser: "markdown"
+			}
+		}
+	],
+	trailingComma: "none"
+};
+
+export default config;

serveronly/index.js

@@ -4,5 +4,5 @@ const Log = require("../js/logger");
 app.start().then((config) => {
 	const bindAddress = config.address ? config.address : "localhost";
 	const httpType = config.useHttps ? "https" : "http";
-	Log.info(`\n>>>   Ready to go! Please point your browser to: ${httpType}://${bindAddress}:${config.port}   <<<`);
+	Log.info(`\n>>>   Ready to go! Please point your browser to: ${httpType}://${bindAddress}:${global.mmPort || config.port}   <<<`);
 });

splashscreen/MagicMirror.plymouth

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

splashscreen/MagicMirror.script

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

tests/configs/customregions.js

@@ -0,0 +1,25 @@
+let config = {
+	address: "0.0.0.0",
+	ipWhitelist: [],
+	modules:
+		// Using exotic content. This is why don't accept go to JSON configuration file
+		(() => {
+			let positions = ["row3_left", "top3_left1"];
+			let modules = Array();
+			for (let idx in positions) {
+				modules.push({
+					module: "helloworld",
+					position: positions[idx],
+					config: {
+						text: `Text in ${positions[idx]}`
+					}
+				});
+			}
+			return modules;
+		})()
+};
+
+/*************** DO NOT EDIT THE LINE BELOW ***************/
+if (typeof module !== "undefined") {
+	module.exports = config;
+}

tests/configs/modules/alert/default.js

@@ -1,4 +1,6 @@
 let config = {
+	address: "0.0.0.0",
+	ipWhitelist: [],
 	modules: [
 		{
 			module: "alert",

tests/configs/modules/calendar/3_move_first_allday_repeating_event.js

@@ -0,0 +1,35 @@
+let config = {
+	address: "0.0.0.0",
+	ipWhitelist: [],
+
+	timeFormat: 24,
+	units: "metric",
+	modules: [
+		{
+			module: "calendar",
+			position: "bottom_bar",
+			config: {
+				fade: false,
+				hideDuplicates: false,
+				maximumEntries: 100,
+				urgency: 0,
+				dateFormat: "Do.MMM, HH:mm",
+				fullDayEventDateFormat: "Do.MMM",
+				timeFormat: "absolute",
+				getRelative: 0,
+				maximumNumberOfDays: 28,
+				calendars: [
+					{
+						maximumEntries: 100,
+						url: "http://localhost:8080/tests/mocks/3_move_first_allday_repeating_event.ics"
+					}
+				]
+			}
+		}
+	]
+};
+
+/*************** DO NOT EDIT THE LINE BELOW ***************/
+if (typeof module !== "undefined") {
+	module.exports = config;
+}

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

@@ -1,4 +1,6 @@
 let config = {
+	address: "0.0.0.0",
+	ipWhitelist: [],
 	timeFormat: 12,
 
 	modules: [

tests/configs/modules/calendar/bad_rrule.js

@@ -1,4 +1,6 @@
 let config = {
+	address: "0.0.0.0",
+	ipWhitelist: [],
 	timeFormat: 12,
 	logLevel: ["INFO", "LOG", "WARN", "ERROR", "DEBUG"],
 	modules: [

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

@@ -1,4 +1,6 @@
 let config = {
+	address: "0.0.0.0",
+	ipWhitelist: [],
 	timeFormat: 12,
 
 	modules: [

tests/configs/modules/calendar/berlin_end_of_day_repeating.js

@@ -0,0 +1,33 @@
+let config = {
+	address: "0.0.0.0",
+	ipWhitelist: [],
+
+	timeFormat: 24,
+	modules: [
+		{
+			module: "calendar",
+			position: "bottom_bar",
+			config: {
+				fade: false,
+				urgency: 0,
+				dateFormat: "Do.MMM, HH:mm",
+				fullDayEventDateFormat: "Do.MMM",
+				timeFormat: "absolute",
+				getRelative: 0,
+				maximumNumberOfDays: 28,
+				showEnd: true,
+				calendars: [
+					{
+						maximumEntries: 100,
+						url: "http://localhost:8080/tests/mocks/end_of_day_berlin_moved.ics"
+					}
+				]
+			}
+		}
+	]
+};
+
+/*************** DO NOT EDIT THE LINE BELOW ***************/
+if (typeof module !== "undefined") {
+	module.exports = config;
+}

tests/configs/modules/calendar/berlin_multi.js

@@ -0,0 +1,33 @@
+let config = {
+	address: "0.0.0.0",
+	ipWhitelist: [],
+
+	timeFormat: 24,
+	modules: [
+		{
+			module: "calendar",
+			position: "bottom_bar",
+			config: {
+				fade: false,
+				urgency: 0,
+				dateFormat: "Do.MMM, HH:mm",
+				fullDayEventDateFormat: "Do.MMM",
+				timeFormat: "absolute",
+				getRelative: 0,
+				maximumNumberOfDays: 28,
+				showEnd: true,
+				calendars: [
+					{
+						maximumEntries: 100,
+						url: "http://localhost:8080/tests/mocks/RepeatingEvent.Oct21.ics"
+					}
+				]
+			}
+		}
+	]
+};
+
+/*************** DO NOT EDIT THE LINE BELOW ***************/
+if (typeof module !== "undefined") {
+	module.exports = config;
+}

tests/configs/modules/calendar/berlin_whole_day_event_moved_over_dst_change.js

@@ -0,0 +1,33 @@
+let config = {
+	address: "0.0.0.0",
+	ipWhitelist: [],
+
+	timeFormat: 24,
+	modules: [
+		{
+			module: "calendar",
+			position: "bottom_bar",
+			config: {
+				fade: false,
+				urgency: 0,
+				dateFormat: "Do.MMM, HH:mm",
+				fullDayEventDateFormat: "Do.MMM",
+				timeFormat: "absolute",
+				getRelative: 0,
+				maximumNumberOfDays: 28,
+				showEnd: true,
+				calendars: [
+					{
+						maximumEntries: 100,
+						url: "http://localhost:8080/tests/mocks/whole_day_moved_over_dst_change_berlin.ics"
+					}
+				]
+			}
+		}
+	]
+};
+
+/*************** DO NOT EDIT THE LINE BELOW ***************/
+if (typeof module !== "undefined") {
+	module.exports = config;
+}

tests/configs/modules/calendar/changed-port.js

@@ -1,4 +1,6 @@
 let config = {
+	address: "0.0.0.0",
+	ipWhitelist: [],
 	timeFormat: 12,
 
 	modules: [

tests/configs/modules/calendar/chicago-looking-at-ny-recurring.js

@@ -0,0 +1,33 @@
+let config = {
+	address: "0.0.0.0",
+	ipWhitelist: [],
+
+	timeFormat: 24,
+	modules: [
+		{
+			module: "calendar",
+			position: "bottom_bar",
+			config: {
+				fade: false,
+				urgency: 0,
+				dateFormat: "Do.MMM, HH:mm",
+				fullDayEventDateFormat: "Do.MMM",
+				timeFormat: "absolute",
+				getRelative: 0,
+				maximumNumberOfDays: 28,
+				showEnd: true,
+				calendars: [
+					{
+						maximumEntries: 100,
+						url: "http://localhost:8080/tests/mocks/chicago-nyedge.ics"
+					}
+				]
+			}
+		}
+	]
+};
+
+/*************** DO NOT EDIT THE LINE BELOW ***************/
+if (typeof module !== "undefined") {
+	module.exports = config;
+}

tests/configs/modules/calendar/chicago_late_in_timezone.js

@@ -0,0 +1,33 @@
+let config = {
+	address: "0.0.0.0",
+	ipWhitelist: [],
+
+	timeFormat: 24,
+	modules: [
+		{
+			module: "calendar",
+			position: "bottom_bar",
+			config: {
+				fade: false,
+				urgency: 0,
+				dateFormat: "Do.MMM, HH:mm",
+				fullDayEventDateFormat: "Do.MMM",
+				timeFormat: "absolute",
+				getRelative: 0,
+				maximumNumberOfDays: 20,
+				calendars: [
+					{
+						maximumEntries: 100,
+						//url: "http://localhost:8080/tests/mocks/chicago_late_in_timezone.ics"
+						url: "http://localhost:8080/tests/mocks/chicago_late_in_timezone.ics"
+					}
+				]
+			}
+		}
+	]
+};
+
+/*************** DO NOT EDIT THE LINE BELOW ***************/
+if (typeof module !== "undefined") {
+	module.exports = config;
+}