1.7.0

Author: rejas

.github/dependabot.yaml

@@ -0,0 +1,11 @@
+version: 2
+updates:
+  - package-ecosystem: github-actions
+    directory: /
+    schedule:
+      interval: monthly
+
+  - package-ecosystem: npm
+    directory: /
+    schedule:
+      interval: monthly

.github/workflows/automated-tests.yaml

@@ -0,0 +1,36 @@
+name: Automated Tests
+on:
+  push:
+    branches: [main, develop]
+  pull_request:
+    branches: [main, develop]
+
+permissions:
+  contents: read
+
+jobs:
+  run-lint:
+    runs-on: ubuntu-latest
+    timeout-minutes: 30
+    steps:
+      - run: echo "🎉 The job was automatically triggered by a ${{ github.event_name }} event."
+      - run: echo "🐧 This job is now running on a ${{ runner.os }} server hosted by GitHub!"
+      - run: echo "🔎 The name of your branch is ${{ github.ref }} and your repository is ${{ github.repository }}."
+      - name: Check out repository code
+        uses: actions/checkout@v5
+      - run: echo "💡 The ${{ github.repository }} repository has been cloned to the runner."
+      - run: echo "🖥️ The workflow is now ready to test your code on the runner."
+      - name: Use Node.js
+        uses: actions/setup-node@v5
+        with:
+          node-version: lts/*
+          cache: npm
+      - name: Install dependencies
+        run: npm ci
+      - name: Check spelling
+        run: node --run test:spelling
+      - name: Check linting
+        run: node --run lint
+      - name: Report status
+        if: always()
+        run: echo "🍏 This job's status is ${{ job.status }}."

.husky/pre-commit

@@ -0,0 +1 @@
+npx lint-staged

.prettierignore

@@ -0,0 +1,2 @@
+*.js
+*.mjs

.prettierrc.json

@@ -0,0 +1,60 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+This project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [develop](https://github.com/rejas/MMM-MotionDetector/compare/v1.7.0...develop) - unreleased
+
+## [1.7.0](https://github.com/rejas/MMM-MotionDetector/compare/v1.6.0...v1.7.0) - 2025-11-15
+
+- Update linting (#61)
+- Update logging (#62)
+- Added github actions for testing (#63)
+- Added platform config option incl mac (#64, #65)
+- Use async calls everywhere in module (#66)
+- Update dependencies
+
+## [1.6.0](https://github.com/rejas/MMM-MotionDetector/compare/v1.5.0...v1.6.0) - 2020-07-05
+
+- Allow disabling the monitor-functionality and just get the motion detection
+- Use Logger from MM² core
+- Update dependencies
+
+## [1.5.0](https://github.com/rejas/MMM-MotionDetector/compare/v1.4.0...v1.5.0) - 2019-07-14
+
+- Show error on UI element when something goes wrong during initialization
+- Cleaned up code
+- Update dependencies
+
+## [1.4.0](https://github.com/rejas/MMM-MotionDetector/compare/v1.3.0...v1.4.0) - 2019-03-08
+
+- Updated code to getUserMedia from browser
+- Cleaned up DOM template
+
+## [1.3.0](https://github.com/rejas/MMM-MotionDetector/compare/v1.2.2...v1.3.0) - 2019-03-06
+
+- Added time/percentage powered-off to DOM
+- Switched to DOM templating
+
+## [1.2.2](https://github.com/rejas/MMM-MotionDetector/compare/v1.2.1...v1.2.2) - 2019-03-06
+
+- Switched to MM² codestyle
+- Cleaned up code
+
+## [1.2.1](https://github.com/rejas/MMM-MotionDetector/compare/v1.2.0...v1.2.1) - 2019-03-02
+
+- Added eslint code styles
+
+## [1.2.0](https://github.com/rejas/MMM-MotionDetector/compare/v1.1.0...v1.2.0) - 2019-03-01
+
+- Added DOM for displaying basic debug information on the MagicMirror when a position is specified
+- Updated documentation
+
+## [1.1.0](https://github.com/rejas/MMM-MotionDetector/compare/v1.0.0...v1.1.0) - 2018-11-01
+
+- Switched from tvservice to vcgencmd. Module can now be used with vc4-kms-v3d and vc4-fkms-v3d drivers.
+
+## [1.0.0](https://github.com/rejas/MMM-MotionDetector/releases/tag/v1.0.0) - 2018-07-20
+
+- Initial release

CHANGELOG.md

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2021 rejas
+Copyright (c) 2025 rejas
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

LICENSE

@@ -1,7 +1,8 @@
-/* global DiffCamEngine */
+/* global DiffCamEngine, Log, Module, moment */
 Module.register("MMM-MotionDetector", {
   defaults: {
     captureIntervalTime: 1000, // 1 second
+    platform: "x11",
     scoreThreshold: 20,
     timeout: 120000, // 2 minutes,
     deviceId: null,
@@ -47,16 +48,15 @@ Module.register("MMM-MotionDetector", {
   },
 
   start: function () {
-    Log.info("MMM-MotionDetector: starting up");
+    Log.info("starting up for platform " + this.config.platform + ".");
 
     this.data.header = "MMM-MotionDetector";
     this.lastScoreDetected = 0;
     this.lastTimeMotionDetected = new Date();
     this.lastTimePoweredOff = new Date();
     this.timeStarted = new Date().getTime();
 
-    // make sure that the monitor is on when starting
-    this.sendSocketNotification("ACTIVATE_MONITOR");
+    this.sendSocketNotification("INIT_MONITOR", this.config.platform);
 
     const canvas = document.createElement("canvas");
     const video = document.createElement("video");
@@ -72,11 +72,11 @@ Module.register("MMM-MotionDetector", {
       motionCanvas: canvas,
       scoreThreshold: this.config.scoreThreshold,
       initSuccessCallback: () => {
-        Log.info("MMM-MotionDetector: DiffCamEngine init successful.");
+        Log.info("DiffCamEngine init successful.");
         DiffCamEngine.start();
       },
       initErrorCallback: (error) => {
-        Log.error("MMM-MotionDetector: DiffCamEngine init failed: " + error);
+        Log.error(`DiffCamEngine init failed: ${error}`);
         this.error = error;
         this.updateDom();
       },
@@ -86,10 +86,11 @@ Module.register("MMM-MotionDetector", {
           2
         );
         if (hasMotion) {
-          Log.info("MMM-MotionDetector: Motion detected, score " + score);
+          Log.info(`Motion detected, score: ${score}`);
           this.sendSocketNotification("MOTION_DETECTED", { score: score });
           this.sendNotification("MOTION_DETECTED", { score: score });
           if (this.poweredOff) {
+            Log.info(`Percentage of uptime powered off:  ${this.percentagePoweredOff}`);
             this.sendSocketNotification("ACTIVATE_MONITOR");
             this.poweredOffTime = this.poweredOffTime + (currentDate.getTime() - this.lastTimePoweredOff.getTime());
             this.poweredOff = false;

MMM-MotionDetector.js

@@ -6,7 +6,7 @@ Just clone the module into your MagicMirror modules folder.
 
 Assuming you are in your MagicMirror directory execute these commands:
 
-```
+```shell
 cd modules
 git clone https://github.com/rejas/MMM-MotionDetector.git
 ```
@@ -17,7 +17,7 @@ Accessing your (web)cam requires to have the client run on localhost or a HTTPS
 The default value in your MagicMirror config.js is already `localhost` so most users shouldn't be affected.
 
 Just in case you still have problems (like [here](https://github.com/rejas/MMM-MotionDetector/issues/6)) check your config
-and see if you can solve it by outcommenting the ip-address under
+and see if you can solve it by uncommenting the ip-address under
 
 ```JavaScript
 let config = {
@@ -27,19 +27,19 @@ let config = {
 
 ### Raspberry Pi OS
 
-Due to some changes on chromium and raspiOS (see https://github.com/rejas/MMM-MotionDetector/issues/56) the [legacy raspios](https://www.raspberrypi.com/news/new-old-functionality-with-raspberry-pi-os-legacy/) is needed.
+Due to some changes on chromium and raspiOS (see https://github.com/rejas/MMM-MotionDetector/issues/56) the [legacy raspiOS](https://www.raspberrypi.com/news/new-old-functionality-with-raspberry-pi-os-legacy/) is needed.
 
 Any help getting this module run on the default raspiOS is greatly appreciated!
 
 Some people had success with enabling the legacy camera mode in the default raspiOS, but this is not a 100% confirmed:
 
-```
+```shell
 sudo raspi-config
 ```
 
 Then go to
 
-```
+```shell
 3 Interface Options -> I1 Legacy Camera
 ```
 
@@ -59,13 +59,6 @@ If you want to use the wired PI-camera follow these steps provided by [@rev138](
 
 Another tutorial on how to enable the PI-camera in the browser can be found [in this blog post](https://reprage.com/post/pi-camera-module-in-the-browser).
 
-### Mac support
-
-Thanks to [3vidar](https://github.com/3vidar) you can also use this module on a Mac.
-For now the code only resides in the branch called "mac" in this git repo.
-
-I hope to find the time to generalize it and have it in the mainline too.
-
 ## Configuration
 
 To use this module, add it to the modules array in the `config/config.js` file:
@@ -74,25 +67,26 @@ To use this module, add it to the modules array in the `config/config.js` file:
 modules: [
   {
     module: "MMM-MotionDetector",
-    position: "top_left", // Optional. This can be any of the regions. Displays debug informations.
+    position: "top_left", // Optional. This can be any of the regions. Displays debug information.
     config: {
       // The config property is optional.
       // See 'Configuration options' for more information.
-    },
-  },
+    }
+  }
 ];
 ```
 
 ### Configuration options
 
 The following properties can be configured:
 
-| Option                | Description                                                                                                                                               |
-| --------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------- |
-| `captureIntervalTime` | Time in ms between capturing images for detection<br><br>**Default value:** `1000`                                                                        |
-| `scoreThreshold`      | Threshold minimum for an image to be considered significant<br><br>**Default value:** `20`                                                                |
-| `timeout`             | Time in ms after which monitor is turned off when no motion is detected<br><br>Set to -1 to never turn off the monitor<br><br>**Default value:** `120000` |
-| `deviceId`            | (optional) specify which camera to use in case multiple exist in the system.                                                                              |
+| Option                | Description                                                                                                            | Default value |
+| --------------------- | ---------------------------------------------------------------------------------------------------------------------- | ------------- |
+| `captureIntervalTime` | Time in ms between capturing images for detection                                                                      | `1000`        |
+| `deviceId`            | (optional) specify which camera to use in case multiple exist in the system.                                           |               |
+| `platform`            | On what platforms this runs. <br><br>**Possible values:** `cec` (untested), `labwc`,`mac-intel`, `mac-intel`, `x11`    | `x11`         |
+| `scoreThreshold`      | Threshold minimum for an image to be considered significant                                                            | `20`          |
+| `timeout`             | Time in ms after which monitor is turned off when no motion is detected<br><br>Set to -1 to never turn off the monitor | `120000`      |
 
 #### How to get the deviceId
 
@@ -116,7 +110,7 @@ routes.json
   "routes": [
     {
       "route": "/mirror", // any path you like
-      "address": "http://localhost:8080" // adrress of MagicMirror
+      "address": "http://localhost:8080" // address of MagicMirror
     }
   ]
 }
@@ -162,55 +156,9 @@ As you are bypassing browser security with this workaround you may want to add s
 | `MOTION_DETECTED`    | score         | score calculated by the diff-cam-engine, 0 or greater                   |
 | `DEACTIVATE_MONITOR` | percentageOff | percentage of time the monitor was deactivated since the module started |
 
-## Changelog
-
-### [1.6.0] - 2020-07-05
-
-- Allow disabling the monitor-functionality and just get the motion detection
-- Use Logger from MM² core
-- Update dependencies
-
-### [1.5.0] - 2019-07-14
-
-- Show error on UI element when something goes wrong during initialization
-- Cleaned up code
-- Update dependencies
-
-### [1.4.0] - 2019-03-08
-
-- Updated code to getUserMedia from browser
-- Cleaned up DOM template
-
-### [1.3.0] - 2019-03-06
-
-- Added time/percentage powered-off to DOM
-- Switched to DOM templating
-
-### [1.2.2] - 2019-03-06
-
-- Switched to MM² codestyle
-- Cleaned up code
-
-### [1.2.1] - 2019-03-02
-
-- Added eslint codestyles
-
-### [1.2.0] - 2019-03-01
-
-- Added DOM for displaying basic debug information on the MagicMirror when a position is specified
-- Updated documentation
-
-### [1.1.0] - 2018-11-01
-
-- Switched from tvservice to vgcencmd. Module can now be used with vc4-kms-v3d and vc4-fkms-v3d drivers.
-
-### [1.0.0] - 2018-07-20
-
-- Initial release
-
 ## Acknowledgements
 
 Many thanks to
 
 - [alexyak](https://github.com/alexyak/motiondetector) for the original module code
-- [lonekorean](https://github.com/lonekorean/diff-cam-engine/) for the diffcam engine code.
+- [lonekorean](https://github.com/lonekorean/diff-cam-engine/) for the diff-cam-engine code.

README.md

@@ -0,0 +1,25 @@
+{
+  "version": "0.2",
+  "language": "en",
+  "words": [
+    "alexyak",
+    "caffeinate",
+    "displaysleepnow",
+    "fkms",
+    "initialising",
+    "ioreg",
+    "labwc",
+    "lonekorean",
+    "motiondetector",
+    "pmset",
+    "proxyserver",
+    "randr",
+    "raspi",
+    "raspiOS",
+    "rejas",
+    "tvservice",
+    "vcgencmd"
+  ],
+  "ignorePaths": ["node_modules/**"],
+  "dictionaries": ["node"]
+}