Skip to content
This module can monitor a PIR motion sensor and put your mirror to sleep.
Branch: master
Clone or download
Pull request Compare This branch is 15 commits ahead, 16 commits behind paviro:master.
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.gitignore
MMM-PIR-Sensor.js
README.md
node_helper.js
package.json

README.md

MMM-PIR-Sensor

This an extension for the MagicMirror. It can monitor a PIR motion sensor and put your mirror to sleep if nobody uses it by turning off HDMI output.

Installation

  1. Navigate into your MagicMirror's modules folder and execute git clone https://github.com/paviro/MMM-PIR-Sensor.git. A new folder will appear navigate into it.
  2. Execute npm install to install the node dependencies.
  3. Add your user (pi?) to the gpio group by executing sudo usermod -a -G gpio pi.

Using the module

To use this module, add it to the modules array in the config/config.js file:

modules: [
	{
		module: 'MMM-PIR-Sensor',
		config: {
			// See 'Configuration options' for more information.
		}
	}
]

Configuration options

The following properties can be configured:

Option Description
sensorPIN The pin your PIR-sensor is connected to.

Possible values: int
Default value: 22
Note: Please use BCM-numbering.
powerSavingDelay Additional software side delay (in seconds) before the monitor will be turned off.

Possible values: int
Default value: 0

Developer Notes

This module broadcasts a USER_PRESENCE notification with the payload beeing true or false you can use it to pause or disable your module.

The MIT License (MIT)

Copyright © 2016 Paul-Vincent Roll

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the “Software”), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

The software is provided “as is”, without warranty of any kind, express or implied, including but not limited to the warranties of merchantability, fitness for a particular purpose and noninfringement. In no event shall the authors or copyright holders be liable for any claim, damages or other liability, whether in an action of contract, tort or otherwise, arising from, out of or in connection with the software or the use or other dealings in the software.

You can’t perform that action at this time.