MMM-NearCompliments

This is an extension for the MagicMirror. It uses the USER_PRESENCE notification of MMM-PIR-Sensor to activate distance measurement of a HC-SR04 sensor to display the compliments module for a specified time when a measured distance is fallen below a specified distance. Inspired by https://github.com/thobach/MMM-Gestures and https://github.com/mochman/MMM-Swipe.

Installation

Navigate into your MagicMirror's modules folder and execute git clone https://github.com/semox/MMM-NearCompliments.git. A new folder will appear navigate into it.
Execute npm install to install the node dependencies.
Configure config/config.js with documentation below.
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-NearCompliments',
		// position: 'bottom_left',
		config: {
			// See 'Configuration options' for more information.
		}
	}
]

Configuration Options

The following properties can be configured:

Option	Description
`echoPin`	The echo pin your HC-SR04 is connected to.
`triggerPin`	The trigger pin your HC-SR04 is connected to.
`distance`	Specified distance in cm which measured distance has to be smaller to display compliments module. Possible values: `int` Default value: `70`
`sensorTimeout`	Sensor timeout to ignore bad measurements. Possible values: `int` Default value: `5000`
`animationSpeed`	Animation speed in ms to display compliments module. Possible values: `int` Default value: `200`
`measuringInterval`	Measuring interval of two measured distances. Defined in ms. Possible values: `int` Default value: `500`
`delay`	Delay defined in seconds to show compliments module. Possible values: `int` Default value: `30`
`autoStart`	Auto start the distance measurment. Use only if MMM-PIR-Sensor is _not_ available. Possible values: `boolean` Default value: `true`
`usePIR`	Should we use PIR sensor to activate only distance measurment when USER_PRESENCE notification is sent by MMM-PIR-Sensor? Possible values: `boolean` Default value: `false`
`powerSavingDelay`	Power saving delay in seconds defined in MMM-PIR-Sensor. It gets overwritten by MMM-PIR-Sensore module and is only defined for backup purpose. Possible values: `int` Default value: `30`
`verbose`	Verbose mode to give more information in log. Possible values: `boolean` Default value: `false`
`calibrate`	Calibration mode to display measured distance on magic mirror. Note: You have to define `position: 'bottom_left'` in config.js. Possible values: `boolean` Default value: `false`

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.

lefevred / mmm-nearcompliments Goto Github PK