| Option | 73 |Description | 74 |
|---|---|
Alias |
79 | An Array of the Alias for the navigation entries. | 80 |
Action |
83 | An Array of Action of the Alias. There are two modes: 1. Execution of a single action, for Example {notification:'PAGE_INCREMENT',payload:''} to send page increment to MMM-Pages Module.84 | 2. Execution of an array of action, as there are some actions, which belong together (like PAGE_INCREMENT and PAGE_DECREMENT), Example Config: [{notification:'PAGE_INCREMENT',payload:''},{notification:'PAGE_DECREMENT',payload:''}]85 | Behavior: First press locks menu (can be identified by the red css frame), after this rotation CW/CCW executes actions from config, second press release lock mode so you can select another navigation entry. |
86 |
GPIOPins |
89 | Array for Definition of GPIO-Pins (BMC) to connect the rotary encoder for the following actions: Clockwise, Counterclockwise and Press | 90 |
SHELLCOMMAND |
93 | Executes code in a terminal of you pi, so you can do almost everything you want. Example you want to shutdown your pi; Config:
94 | {notification: 'SHELLCOMMAND', payload:'sudo shutdown -h now'}95 | |
96 |
SHELLCOMMAND.yourmmip:8080/MMM-Navigate/remote?action=NOTIFICATION¬ification=CCW emulates turning rotary counterclockwiseyourmmip:8080/MMM-Navigate/remote?action=NOTIFICATION¬ification=CW emulates turning rotary clockwiseyourmmip:8080/MMM-Navigate/remote?action=NOTIFICATION¬ification=PRESSED emulates pressing rotary encoderyourmmip:8080/MMM-Navigate/remote?notification=SHELLCOMMAND&action=sudo%20shutdown%20-h%20now send command to shutdown your pi
108 |
109 | ## Version
110 | 1.6 Changelog:
111 | - fix rebuild step process (thanks to sdetweil)
112 | 1.5 Changelog:
113 | - minor bugfixes
114 |
115 | 1.4 Changelog:
116 | - changed code for better recognition of the rotary encoder
117 | - changed code enables faster movement of the rotary
118 |
119 | 1.3 Changelog:
120 | - added some functions to no longer have a dependency to MMM-Remote-Control
121 | - SHELLCOMMAND
122 | - module is now listening to yourmmip:8080/MMM-Navigate/remote?
123 |
124 | 1.2 Changelog:
125 | - added lock icon next to navigation alias, if locked
126 | - code cleaned
127 |
128 | 1.1
129 | Changelog:
130 | - added ability to send notifications to MMM-Navigate by other modules
131 | - added locked mode, so you can put two(2) actions in one(1) navigation link which belong together (like PAGE_INCREMENT and PAGE_DECREMENT). More details see Configuration options (Action).
132 | - modified css, so locked mode is visual (red frame when locked) in MM
133 | - added second click confirmation notification for SHELLCOMMAND
134 |
135 | 1.0 initial release
136 |
--------------------------------------------------------------------------------
/node_helper.js:
--------------------------------------------------------------------------------
1 | /* Magic Mirror
2 | * Node Helper: {MMM-Navigate}
3 | *
4 | * By {AxLED}
5 | * {MIT} Licensed.
6 | */
7 |
8 | //Debugging
9 | //tail -f ~/.pm2/logs/mm-out-0.log
10 | //tail -f ~/.pm2/logs/mm-error-0.log
11 |
12 | const Gpio = require('onoff').Gpio;
13 | var NodeHelper = require("node_helper");
14 | const exec = require("child_process").exec;
15 | const url = require("url");
16 |
17 | //Variables
18 | var lastStateCLK = 0;
19 | var lastdir = '';
20 |
21 | module.exports = NodeHelper.create({
22 | // Subclass start method.
23 | start: function() {
24 | var self = this;
25 | this.loaded = false;
26 | this.createRoutes();
27 | },
28 |
29 | intializeRotary: function() {
30 |
31 | //Rotary Code..
32 | this.loaded = true;
33 | var self = this;
34 |
35 | console.log('MMM-Navigate, listen on GPIO PINs (BCM): '+self.config.GPIOPins[0]+','+self.config.GPIOPins[1]+','+self.config.GPIOPins[2]);
36 | const CLK = new Gpio(self.config.GPIOPins[1], 'in', 'both',{debounceTimeout : 0 }); //BCM Pin 20
37 | const DT = new Gpio(self.config.GPIOPins[0], 'in', 'both',{debounceTimeout : 0 }); //BCM Pin 26
38 | const SW = new Gpio(self.config.GPIOPins[2], 'in', 'both',{debounceTimeout : 20 }); //BCM Pin 19
39 |
40 | CLK.read(function (err, value) {
41 | if (err) {
42 | throw err;
43 | }
44 | this.lastStateCLK = value;
45 | this.a = value;
46 | });
47 |
48 | DT.read(function (err, value) {
49 | if (err) {
50 | throw err;
51 | }
52 | this.b = value;
53 | });
54 |
55 | CLK.watch(function (err, value) {
56 | if (err) {
57 | throw err;
58 | }
59 | this.a = value;
60 | });
61 |
62 | DT.watch(function (err, value) {
63 | if (err) {
64 | throw err;
65 | }
66 | this.b = value;
67 | tick();
68 | });
69 |
70 | SW.watch(function (err, value) {
71 | if (err) {
72 | throw err;
73 | }
74 | if(value == 0){
75 | self.sendSocketNotification('PRESSED',{inputtype: 'PRESSED'});
76 | }
77 | });
78 |
79 | function tick() {
80 | const { a, b } = this;
81 |
82 | if (a != lastStateCLK && a == 1){//only do action, if rotary was moved and only count one step
83 | if (b != a){
84 | self.sendSocketNotification('CW',{inputtype: 'CW'});
85 | lastdir = 'CW';
86 | } else {
87 | self.sendSocketNotification('CCW',{inputtype: 'CCW'});
88 | lastdir = 'CCW';
89 | }
90 | }
91 |
92 | //catch missing count when changing from CCW to CW
93 | if (a == lastStateCLK && b == 0 && lastdir == 'CCW') {
94 | self.sendSocketNotification('CW',{inputtype: 'CW'});
95 | lastdir = 'CW';
96 | }
97 |
98 | lastStateCLK = a;
99 | return this;
100 | }
101 |
102 | },
103 |
104 | // Override socketNotificationReceived method.
105 | socketNotificationReceived: function(notification, payload) {
106 | if (notification === 'BUTTON_CONFIG') {
107 | this.config = payload.config;
108 |
109 | if (this.loaded === false) {//AxLED 2020-04
110 | this.intializeRotary();
111 | }
112 |
113 | }
114 |
115 | if (notification === 'SHELLCOMMAND') {
116 | console.log("MMM-Navigate, received Shellcommand:", payload);
117 | exec(payload, null);
118 | }
119 | },
120 |
121 | createRoutes: function() {
122 | var self = this;
123 |
124 | this.expressApp.get("/MMM-Navigate/remote", function(req, res) {
125 | var query = url.parse(req.url, true).query;
126 | if(query.notification=='CW' || query.notification=='CCW' || query.notification=='PRESSED'){
127 | self.sendSocketNotification(query.notification,{inputtype: ""+query.notification+""});
128 | }
129 | res.send("MMM-Navigate, data received: "+ JSON.stringify(query));
130 | });
131 | },
132 | });
133 |
--------------------------------------------------------------------------------
/package.json:
--------------------------------------------------------------------------------
1 | {
2 | "name": "MagicMirror-Module-Navigate",
3 | "version": "1.6.0",
4 | "description": "A module to connect a rotary encoder for MM Navigation",
5 | "repository": {
6 | "type": "git",
7 | "url": "git+https://github.com/Ax-LED/MMM-Navigate"
8 | },
9 | "main": "MMM-Navigate.js",
10 | "author": "AxLED",
11 | "license": "MIT",
12 | "scripts": {
13 | "postinstall": "./postinstall"
14 | },
15 | "dependencies": {
16 | "onoff": "latest"
17 | }
18 | }
19 |
--------------------------------------------------------------------------------
/postinstall:
--------------------------------------------------------------------------------
1 | #!/bin/bash
2 |
3 | if [ ! -f ../../node_modules/.bin/electron-rebuild ]; then
4 | cd ../..
5 | npm install electron-rebuild >/dev/null 2>&1
6 | cd -
7 | fi
8 | ../../node_modules/.bin/electron-rebuild
--------------------------------------------------------------------------------