https://github.com/PtrBld/MMM-Button

Use a button to hide or show different modules via a broadcast message
https://github.com/PtrBld/MMM-Button

Last synced: 7 months ago
JSON representation

Use a button to hide or show different modules via a broadcast message

• Host: GitHub
• URL: https://github.com/PtrBld/MMM-Button
• Owner: PtrBld
• Created: 2016-05-15T09:47:19.000Z (about 10 years ago)
• Default Branch: master
• Last Pushed: 2019-02-25T08:40:47.000Z (over 7 years ago)
• Last Synced: 2024-06-29T10:33:24.184Z (almost 2 years ago)
• Language: JavaScript
• Size: 14.6 KB
• Stars: 17
• Watchers: 8
• Forks: 9
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

• awesome-mmm - **MMM-Button**

README

          
# MMM-Button

This is an extension for the [MagicMirror](https://github.com/MichMich/MagicMirror). It can monitor a button click and change for example the visibility of some of your modules (at the moment just works with my [MMM-Podcast](https://github.com/ptrbld/MMM-Podcast) module).

Special thanks goes to [Paviro](https://github.com/paviro) as this module is heavily based on his [PIR-Sensor](https://github.com/paviro/MMM-PIR-Sensor) module.

## Installation

1. Navigate into your MagicMirror's `modules` folder and execute `git clone https://github.com/ptrbld/MMM-Button.git`. A new folder will appear navigate into it.

2. Execute `npm install` to install the node dependencies.

## Using the module

First of all connect a button to your Raspberry PI: [How to connect a button.](http://razzpisampler.oreilly.com/ch07.html)

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

````javascript

modules: [

	{

		module: 'MMM-Button',

		config: {

			// See 'Configuration options' for more information.

		}

	}

]

````

## Configuration options

The following properties can be configured:

	

	

		

			Option

			Description

		

	

	

		

			buttonPIN

			The pin your button is connected to.


				
Possible values: int

				
Default value: 5

			

		

		

			clickDelay

			The time in miliseconds before another button click is recognized


				
Possible values: int

				
Default value: 500

			

		

		

			notificationMessage

			The message broadcasted to other modules


				
Possible values: string

				
Default value: BUTTON_PRESSED

			

		

	

## Developer Notes

This module broadcasts a `BUTTON_PRESSED` (as default; specified in the module config) notification with the payload beeing `true` you can use it to show/hide your module (e.g. [MMM-Podcast](https://github.com/ptrbld/MMM-Podcast)).

## Dependencies

- [onoff](https://www.npmjs.com/package/onoff) (installed via `npm install`)

The MIT License (MIT)

=====================

Copyright © 2016 PtrBld

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.**