Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/rejas/MMM-MotionDetector
This is a motion detector module for MagicMirror
https://github.com/rejas/MMM-MotionDetector
javascript magic-mirror-modules magicmirror magicmirror2 motion-detection raspberry-pi
Last synced: 22 days ago
JSON representation
This is a motion detector module for MagicMirror
- Host: GitHub
- URL: https://github.com/rejas/MMM-MotionDetector
- Owner: rejas
- License: mit
- Created: 2017-05-21T10:56:36.000Z (over 7 years ago)
- Default Branch: main
- Last Pushed: 2023-07-19T05:31:36.000Z (over 1 year ago)
- Last Synced: 2024-11-19T07:06:29.003Z (23 days ago)
- Topics: javascript, magic-mirror-modules, magicmirror, magicmirror2, motion-detection, raspberry-pi
- Language: JavaScript
- Size: 158 KB
- Stars: 52
- Watchers: 8
- Forks: 11
- Open Issues: 10
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-mmm - **MMM-MotionDetector**
README
# MMM-MotionDetector
## Installation
Just clone the module into your MagicMirror modules folder.
Assuming you are in your MagicMirror directory execute these commands:
```
cd modules
git clone https://github.com/rejas/MMM-MotionDetector.git
```
## Requirements
Accessing your (web)cam requires to have the client run on localhost or a HTTPS host (due to new requirements in Chrome for getUserMedia).
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
```JavaScript
let config = {
address : '0.0.0.0',
...
```
### 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.
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:
```
sudo raspi-config
```
Then go to
```
3 Interface Options -> I1 Legacy Camera
```
and enable legacy camera support.
### Tested devices
So far I only used a [PlayStation3 Eye Webcam](https://en.wikipedia.org/wiki/PlayStation_Eye) for motion-detection at my MagicMirror.
If you have successfully used this module with any other webcam, I'd be happy to hear about it.
If you want to use the wired PI-camera follow these steps provided by [@rev138](https://github.com/rejas/MMM-MotionDetector/issues/8#issuecomment-483356950):
- Open /etc/modules-load.d/modules.conf
- Add bcm2835-v4l2 to the end of the file and save it.
- Reboot.
- Profit
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:
```javascript
modules: [
{
module: "MMM-MotionDetector",
position: "top_left", // Optional. This can be any of the regions. Displays debug informations.
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
**Default value:** `1000` |
| `scoreThreshold` | Threshold minimum for an image to be considered significant
**Default value:** `20` |
| `timeout` | Time in ms after which monitor is turned off when no motion is detected
Set to -1 to never turn off the monitor
**Default value:** `120000` |
| `deviceId` | (optional) specify which camera to use in case multiple exist in the system. |
#### How to get the deviceId
You need to retrieve the deviceId from the browser / electron instance you are running this module on.
- If you are running it in a browser, use this command in the web console `navigator.mediaDevices.enumerateDevices()` to get all devices.
- In the standard MM Electron, add 'export ELECTRON_ENABLE_LOGGING=true' to the mm.sh. Then cat the pm2 error logs and look for the DeviceID.
### Configuring MotionDetector with another module that requires MagicMirror address to be 0.0.0.0
You can do this by doing a simple workaround. You need to config the MagicMirror address to localhost (default)
and set up a reverse proxy for the other module.
As MagicMirror uses an express server, you can install http-proxy-middleware plugin for express.
Then you need to create 2 files:
routes.json
```JavaScript
{
"routes": [
{
"route": "/mirror", // any path you like
"address": "http://localhost:8080" // adrress of MagicMirror
}
]
}
```
proxyserver.js
```JavaScript
// Dependencies
const express = require('express');
const proxy = require('http-proxy-middleware');
// Config
const { routes } = require('./routes.json');
const app = express();
for (route of routes) {
app.use(route.route,
proxy({
target: route.address,
pathRewrite: (path, req) => {
return path.split('/').slice(2).join('/'); // Could use replace, but take care of the leading '/'
}
})
);
}
// Start server and listen on port 8081
app.listen(8081, () => {});
```
Now just start the proxyserver e.g. with PM2 like you may run your MagicMirror.
You can now call http://ipaddress:8081/mirror/modulename and it will be forwarded to http://localhost:8080/modulename.
As you are bypassing browser security with this workaround you may want to add some credentials and/or ip-ranges which can access your proxyserver.
## Notifications send
| Notification | Payload | Description |
| -------------------- | ------------- | ----------------------------------------------------------------------- |
| `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.