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 or by turning off the mirror via a relay.

Installation

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.
Execute npm install to install the node dependencies.
Add your user (pi?) to the gpio group by executing sudo usermod -a -G gpio pi.
Execute sudo chmod u+s /opt/vc/bin/tvservice && sudo chmod u+s /bin/chvt to allow turning on/off the hdmi output.
Reboot your 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.
`sensorState`	Invert the GPIO-state that triggers user presence. For example, a `0` value would tell the mirror to trigger user presence when the GPIO pin receives `0` value. Possible values: `int (0 or 1)` Default value: `1`
`powerSaving`	Should the monitor be turned off if no user is present? (via HDMI or relay) Possible values: `boolean` Default value: `true`
`powerSavingDelay`	Additional software side delay (in seconds) before the monitor will be turned off. Possible values: `int` Default value: `0`
`relayPin`	If you want to use a relay to turn of the mirror provide the pin here. If no pin is provided HDMI is turned off instead. Possible values: `int` Default value: `false` Note: Please use BCM-numbering.
`relayState`	GPIO-state your relay is turned on. Possible values: `int (0 or 1)` Default value: `1`
`alwaysOnPin`	If you would like to use a GPIO pin to trigger power-saving mode. Ideal for users who want to have a physical switch that controls whether or not to use the motion sensor. Possible values: `int` Default value: `false` Note: Please use BCM-numbering.
`alwaysOnState`	GPIO-state to trigger always-on. Possible values: `int (0 or 1)` Default value: `1`
`alwaysOffPin`	If you would like to use a GPIO pin to trigger sleep mode. Ideal for users who want to have a physical switch to shut off the screen (perhaps the mirror is too bright at night). Possible values: `int` Default value: `false` Note: Please use BCM-numbering.
`alwaysOffState`	GPIO-state to trigger always-off. Possible values: `int (0 or 1)` Default value: `1`
`powerSavingNotification`	To display a notification before to switch screen off Possible values: `boolean` Default value: `false` Note: Need the default module "alert" to be declared on config.js file.
`powerSavingMessage`	Message notification to display before to switch screen off Default value: `"Monitor will be turn Off by PIR module"`
`preventHDMITimeout`	When `powerSaving` is On: time, in minutes, after which- while HDMI is off- the screen will be briefly turned on and off again, periodically. This is to avoid older HDMI screens from automatically turning Off due to "No Signal". Possible values: `0-10` Default value: `0` Note:0 value means that this feature is turned off.
`supportCEC`	When `powerSaving` is On: support CEC to turn monitor ON or OFF as well, not just the HDMI circuit in the RPI. Possible values: `boolean` Default value: `false`
`presenceIndicator`	When module `position` is defined, thus it is visible, display an indicator when `USER_PRESENCE` is detected. Possible values: `Font Awesome icons` [See here](https://fontawesome.com/icons?d=gallery) Default value: `fa-bullseye` Note: Not displayed if set to `null`
`presenceIndicatorColor`	The color of `presenceIndicator`, if defined. Possible values: `color value` Default value: `red` Note: `presenceIndicator` is not displayed if this parameter is set to `null`
`presenceOffIndicator`	When module `position` is defined, thus it is visible, display an indicator when `USER_PRESENCE` is not detected. Possible values: `Font Awesome icons` [See here](https://fontawesome.com/icons?d=gallery) Default value: `null` Note: Not displayed if set to `null`
`presenceOffIndicatorColor`	The color of `presenceOffIndicator`, if defined. Possible values: `color value` Default value: `dimgray` Note: `presenceOffIndicator` is not displayed if this parameter is set to `null`
`runSimulator`	Turn on a simulator that will send `USER_PRESENCE ON` every 20 seconds, and `USER_PRESENCE OFF` one second after that. This is handy when you want to work on the configuration of the mirror without having to stand up in front of it in order to test. Possible values: `boolean` Default value: `false` Note: Don't forget to turn this one off when using the actual IR sensor!

Example

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

modules: [
	{
		module: 'MMM-PIR-Sensor', 
		position: "top_center", // Remove this line to avoid having an visible indicator
		config: {
			sensorPin: 23,
			powerSavingDelay: 60, // Turn HDMI OFF after 60 seconds of no motion, until motion is detected again
			preventHDMITimeout: 4, // Turn HDMI ON and OFF again every 4 minutes when power saving, to avoid LCD/TV timeout
			supportCEC: true, 
			presenceIndicator: "fa-eye", // Customizing the indicator
			presenceOffIndicator: "fa-eye", // Customizing the indicator
			presenceIndicatorColor: "#f51d16", // Customizing the indicator
			presenceOffIndicatorColor: "#2b271c" // Customizing the indicator
		}
	}
]

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.

Dependencies

wiring-pi (installed via npm install)

The MIT License (MIT)

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.

paviro/MMM-PIR-Sensor