-
Notifications
You must be signed in to change notification settings - Fork 0
/
node_helper.js
504 lines (441 loc) · 20.3 KB
/
node_helper.js
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
/* global Module */
/* Magic Mirror
* Module: MMM-GPIO-HANDLER
*
* By Koen Harthoorn
* MIT Licensed.
*/
const NodeHelper = require('node_helper');
const pigpio = require('pigpio-client').pigpio({ host: 'localhost'});
module.exports = NodeHelper.create({
start: function () {
this.started = false;
this.configDefaults = {};
this.pins = { input: {}, output: {} };
this.hardwarePwmPins = [12, 13, 18, 19];
},
socketNotificationReceived: function (notification, payload) {
const me = this;
const { input, output, ...configDefaults } = payload;
if (notification === "CONFIG" && me.started === false) {
me.configDefaults = configDefaults;
for (const [pin, pinData] of Object.entries(input)) {
const pinStr = String(pin);
console.log(`${me.name}: Registering input pin: ${pinStr} for ${pinData.name}`);
me.pins.input[pinStr] = {
type: pinData.type,
name: pinData.name,
sysname: pinData.name.replace(/ /g, "_").toUpperCase(),
pull: pinData.pull,
gpio: pigpio.gpio(parseInt(pin, 10))
};
me.pins.input[pinStr].gpio.modeSet('input');
}
for (const [pin, pinData] of Object.entries(output)) {
const pinStr = String(pin);
console.log(`${me.name}: Registering output pin: ${pinStr} for ${pinData.name}`);
const isHardwarePwm = pinData.type === "hardwarePWM" && me.hardwarePwmPins.includes(parseInt(pin));
const isPwm = pinData.type === "PWM" || isHardwarePwm;
if (pinData.type === "hardwarePWM" && !me.hardwarePwmPins.includes(parseInt(pin))){
me.sendSocketNotification("SHOW_ALERT",`Pin ${pinStr} was configured as HardwarePWM, but ${pinStr} is not capable of HardwarePWM. Fallback to SoftwarePWM.`);
console.warn(`Pin ${pinStr} was configured as HardwarePWM, but ${pinStr} is not capable of HardwarePWM. Fallback to SoftwarePWM.`);
pinData.type = "PWM";
}
me.pins.output[pinStr] = {
type: pinData.type,
name: pinData.name,
gpio: pigpio.gpio(parseInt(pin, 10)),
default_PWM_effect: isPwm ? pinData.default_PWM_effect ?? me.configDefaults.default_PWM_effect : undefined,
default_PWM_speed: isPwm ? pinData.default_PWM_speed ?? me.configDefaults.default_PWM_speed : undefined,
default_PWM_steps: isPwm ? pinData.default_PWM_steps ?? me.configDefaults.default_PWM_steps : undefined,
default_PWM_upperLimitDCP: isPwm ? pinData.default_PWM_upperLimitDCP ?? me.configDefaults.default_PWM_upperLimitDCP : undefined,
default_PWM_lowerLimitDCP: isPwm ? pinData.default_PWM_lowerLimitDCP ?? me.configDefaults.default_PWM_lowerLimitDCP : undefined,
default_PWM_flashLength: isPwm ? pinData.default_PWM_flashLength ?? me.configDefaults.default_PWM_flashLength : undefined,
default_PWM_startOn: isPwm ? pinData.default_PWM_startOn ?? me.configDefaults.default_PWM_startOn : undefined,
default_PWM_cycles: isPwm ? pinData.default_PWM_cycles ?? me.configDefaults.default_PWM_cycles : undefined,
default_PWM_endOn: isPwm ? pinData.default_PWM_endOn ?? me.configDefaults.default_PWM_endOn : undefined,
default_PWM_endPrevOn: isPwm ? pinData.default_PWM_endPrevOn ?? me.configDefaults.default_PWM_endPrevOn : undefined,
default_PWM_state: isPwm ? pinData.default_PWM_state ?? me.configDefaults.default_PWM_state : undefined,
pwmEffect: isPwm ? { } : undefined,
default_state: !isPwm ? pinData.default_state ?? me.configDefaults.default_state : undefined,
default_hardwarePWM_frequency: isHardwarePwm ? pinData.default_hardwarePWM_frequency ?? me.configDefaults.default_hardwarePWM_frequency : undefined
};
me.pins.output[pinStr].gpio.modeSet('output');
}
console.log(`${me.name}: All pins in configuration are registered.`);
me.sendSocketNotification("SHOW_ALERT",`${me.name}: All pins in configuration are registered.`);
this.inputHandler();
this.initializeOutputs();
me.started = true;
} else if (notification === "HANDLE_PWM" && me.started === true) {
const pinStr = String(payload.pin);
me.pins.output[pinStr] ? me.PWMHandler(payload) : (console.error(`Pin ${pinStr} is not configured as an output pin.`), me.sendSocketNotification("SHOW_ALERT",`Pin ${pinStr} is not configured as an output pin.`));
} else if (notification === "HANDLE_ON/OFF" && me.started === true) {
const pinStr = String(payload.pin);
me.pins.output[pinStr] ? me.OnOffHandler(payload) : (console.error(`Pin ${pinStr} is not configured as an output pin.`), me.sendSocketNotification("SHOW_ALERT",`Pin ${pinStr} is not configured as an output pin.`));
} else if (notification !== "CONFIG" && me.started === false) {
me.sendSocketNotification("SHOW_ALERT",`Notification '${notification}' received, but MMM-GPIO-HANDLER is not (completely) initialized yet.`);
console.warn(`Notification '${notification}' received, but MMM-GPIO-HANDLER is not (completely) initialized yet.`);
} else {
me.sendSocketNotification("SHOW_ALERT",`Notification '${notification}' received, but MMM-GPIO-HANDLER does not recognize this notification.`);
console.error(`Notification '${notification}' received, but MMM-GPIO-HANDLER does not recognize this notification.`);
}
},
inputHandler: function () {
const me = this;
for (const [pin, pinData] of Object.entries(me.pins.input)) {
switch (pinData.pull) {
case "PUD_DOWN":
pinData.gpio.pullUpDown(1);
break;
case "PUD_UP":
pinData.gpio.pullUpDown(2);
break;
default:
pinData.gpio.pullUpDown(0);
}
switch (pinData.type) {
case "Button":
pinData.gpio.glitchSet(me.configDefaults.debounce * 1000);
let startTick, timeout;
pinData.gpio.notify((level, tick) => {
const pressed = (pinData.pull == "PUD_UP" && level == 0) || (pinData.pull != "PUD_UP" && level == 1);
if (pressed){
startTick = tick;
timeout = setTimeout(() => {
console.warn(`Button '${pinData.name}' is pressed longer than ${Math.round((me.configDefaults.longPressTimeOut / 1000) * 10) / 10} seconds. Is it stuck?`);
me.sendSocketNotification(`${pinData.sysname}_LONG_PRESSED`);
me.sendSocketNotification("SHOW_ALERT", `Button '${pinData.name}' is pressed longer than ${Math.round((me.configDefaults.longPressTimeOut / 1000) * 10) / 10} seconds. A long press is sent, but is it stuck?`);
}, me.configDefaults.longPressTimeOut);
console.log(`Button '${pinData.name}' is pressed.`);
} else {
clearTimeout(timeout);
const diff = (tick >> 0) - (startTick >> 0);
console.log(`Button '${pinData.name}' is released.`);
if (diff < (me.configDefaults.longPressTime * 1000)) {
me.sendSocketNotification(`${pinData.sysname}_SHORT_PRESSED`);
console.log(`Button '${pinData.name}' was pressed only short.`);
} else if (diff > (me.configDefaults.longPressTime * 1000) && diff < (me.configDefaults.longPressTimeOut * 1000)) {
me.sendSocketNotification(`${pinData.sysname}_LONG_PRESSED`);
console.log(`Button '${pinData.name}' was pressed long.`);
}
}
});
break;
case "PIR":
pinData.gpio.notify((level) => {
const detected = (pinData.pull == "PUD_UP" && level == 0) || (pinData.pull != "PUD_UP" && level == 1);
if(detected){
me.sendSocketNotification(`${pinData.sysname}_DETECTION`);
console.log(`${pinData.name} detected presence`);
} else {
me.sendSocketNotification(`${pinData.sysname}_NO_DETECTION`);
console.log(`${pinData.name} did not detect presence`);
}
});
break;
case "Other":
pinData.gpio.notify((level) => {
if (level == 1) {
me.sendSocketNotification(`${pinData.sysname}_HIGH`);
console.log(`${pinData.name} is high.`);
} else if (level == 0){
me.sendSocketNotification(`${pinData.sysname}_LOW`);
console.log(`${pinData.name} is low.`);
} else {
me.sendSocketNotification(`${pinData.sysname}_FLOATING`);
console.log(`${pinData.name} is floating.`);
}
});
break;
default:
console.log(`Input type ${pinData.type} of input pin ${pin} not recognized. Could not be initialized.`);
me.sendSocketNotification("SHOW_ALERT", `Input type ${pinData.type} of input pin ${pin} not recognized. Could not be initialized.`);
}
}
},
initializeOutputs: function () {
const me = this;
for (const [pin, pinData] of Object.entries(me.pins.output)) {
switch (pinData.type) {
case "PWM":
case "hardwarePWM":
this.PWMHandler({"pin": pin});
break;
case "On/Off":
this.OnOffHandler({"pin": pin, "action": "set"});
break;
default:
console.error(`Output type ${pinData.type} of output pin ${pin} not recognized. Could not be initialized.`);
me.sendSocketNotification("SHOW_ALERT", `Output type ${pinData.type} of output pin ${pin} not recognized. Could not be initialized.`);
}
}
},
PWMHandler: function (payload) {
const me = this;
try {
const pinData = me.pins.output[String(payload.pin)];
const effect = payload.pwmEffect ?? pinData.default_PWM_effect;
const speed = payload.pwmSpeed ?? pinData.default_PWM_speed;
const steps = payload.pwmSteps ?? pinData.default_PWM_steps;
const upperLimitDCP = payload.pwmUpperLimitDCP ?? pinData.default_PWM_upperLimitDCP ?? 100;
const lowerLimitDCP = payload.pwmLowerLimitDCP ?? pinData.default_PWM_lowerLimitDCP ?? 0;
const flashLength = payload.pwmFlashLength ?? pinData.default_PWM_flashLength;
const startOn = payload.pwmStart ?? pinData.default_PWM_startOn ?? "low";
const cycles = payload.pwmCycles?? pinData.default_PWM_cycles;
const endOn = payload.pwmEnd ?? pinData.default_PWM_endOn;
const endPrevOn = payload.pwmEndPrevOn ?? pinData.default_PWM_endPrevOn;
const isHardwarePWM = pinData.type === "hardwarePWM";
const state = Math.round((payload.pwmState ?? pinData.default_PWM_state) / (isHardwarePWM ? 1 : 3922));
const frequency = pinData.default_hardwarePWM_frequency;
const maxDutyCycle = isHardwarePWM ? 1000000 : 255;
const minDutyCycle = 0;
if (!pinData.gpio) throw new Error("Pin not initialized for GPIO.");
if (pinData.type !== "PWM" && pinData.type !== "hardwarePWM") throw new Error("Pin not configured for PWM.");
if ("number" != typeof upperLimitDCP || upperLimitDCP < 0 || upperLimitDCP > 100 || "number" != typeof lowerLimitDCP || lowerLimitDCP < 0 || lowerLimitDCP > 100 || upperLimitDCP <= lowerLimitDCP) throw new Error("Invalid values. upperLimitDCP and lowerLimitDCP should be numbers between 0 and 100 (percentage), and upperLimitDCP should be greater than lowerLimitDCP.");
function setDutyCycle(dutyCycle) {
if (isHardwarePWM) {
pinData.gpio.hardwarePWM(frequency, dutyCycle);
} else {
pinData.gpio.analogWrite(dutyCycle);
}
}
function newEffect() {
clearInterval(pinData.pwmEffect.interval);
clearTimeout(pinData.pwmEffect.timeout);
for (var obj in pinData.pwmEffect) delete pinData.pwmEffect[obj];
const upperLimitDC = Math.round(upperLimitDCP * maxDutyCycle / 100);
const lowerLimitDC = Math.round(lowerLimitDCP * maxDutyCycle / 100);
const DCBandwitdh = upperLimitDC - lowerLimitDC;
let dutyCycle = startOn === "high" ? upperLimitDC : lowerLimitDC;
const endDutyCycle = endOn === "high" ? upperLimitDC : lowerLimitDC;
let dir = startOn === "high" ? -1 : 1;
let cycleCount = 0;
if (effect === "Breath"){
if (typeof speed !== "number" || typeof steps !== "number" || speed < 4 || steps < 1 || steps > DCBandwitdh) throw new Error("Invalid speed or step value for PWM Breath.");
pinData.pwmEffect.type = effect;
pinData.pwmEffect.steps = steps;
pinData.pwmEffect.speed = speed;
const step = Math.round(DCBandwitdh / steps);
let isMax = false;
let isMin = false;
pinData.pwmEffect.interval = setInterval(() => {
setDutyCycle(dutyCycle);
dutyCycle += step * dir;
if (dutyCycle >= upperLimitDC) {
dutyCycle = upperLimitDC;
dir = -1;
isMax = true;
} else if (dutyCycle <= lowerLimitDC) {
dutyCycle = lowerLimitDC;
dir = 1;
isMin = true
}
pinData.pwmEffect.extreme = dutyCycle === upperLimitDC ? "high" : (dutyCycle === lowerLimitDC ? "low" : "no");
if (isMax && isMin) {
cycleCount++;
isMax = false;
isMin = false;
}
if (cycles !== -1 && cycleCount >= cycles && Math.abs(dutyCycle - endDutyCycle) === 0) {
clearInterval(pinData.pwmEffect.interval);
for (var obj in pinData.pwmEffect) delete pinData.pwmEffect[obj];
}
}, speed);
} else if (effect === "Pulse"){
if (typeof speed !== "number" || typeof steps !== "number" || speed < 4 || steps < 1 || steps > DCBandwitdh) throw new Error("Invalid speed or steps value for PWM Pulse.");
pinData.pwmEffect.type = effect;
pinData.pwmEffect.speed = speed;
pinData.pwmEffect.steps = steps;
let cyclePosition = startOn === "high" ? Math.PI : 0;
const startPosition = cyclePosition;
const tolerance = Math.round(Math.min((DCBandwitdh / steps), DCBandwitdh / 100));
let prevDutyCycle = dutyCycle;
pinData.pwmEffect.interval = setInterval(() => {
setDutyCycle(dutyCycle);
cyclePosition += Math.PI / steps;
if (cyclePosition > 2 * Math.PI) {
cyclePosition -= 2 * Math.PI;
}
prevDutyCycle = dutyCycle;
dutyCycle = Math.round(lowerLimitDC + (Math.sin(cyclePosition) + 1) / 2 * DCBandwitdh);
if (dutyCycle >= upperLimitDC - tolerance && dutyCycle <= upperLimitDC + tolerance){
pinData.pwmEffect.extreme = "high";
} else if (dutyCycle >= lowerLimitDC - tolerance && dutyCycle <= lowerLimitDC + tolerance) {
pinData.pwmEffect.extreme = "low";
} else {
pinData.pwmEffect.extreme = "no";
}
if (cyclePosition === startPosition) {
cycleCount++;
}
if (cycles !== -1 && cycleCount >= cycles && Math.abs(dutyCycle - endDutyCycle) <= tolerance) {
clearInterval(pinData.pwmEffect.interval);
for (var obj in pinData.pwmEffect) delete pinData.pwmEffect[obj];
setDutyCycle(dutyCycle);
}
}, speed);
} else if (effect === "Flash"){
if (typeof speed !== "number" || typeof flashLength !== "number" || speed < 4 || flashLength < 4 || flashLength >= speed) throw new Error("Invalid speed or flashLength value for PWM Flash, and speed should be greater than flashLength.");
pinData.pwmEffect.type = effect;
pinData.pwmEffect.speed = speed;
const flashLow = speed - flashLength;
const timer = startOn === "high" ? flashLength : flashLow;
const updateExtreme = () => {
pinData.pwmEffect.extreme = dutyCycle === upperLimitDC ? "high" : "low";
};
pinData.pwmEffect.interval = setInterval(() => {
dutyCycle = startOn === "high" ? upperLimitDC : lowerLimitDC;
setDutyCycle(dutyCycle);
updateExtreme();
pinData.pwmEffect.timeout = setTimeout(() => {
dutyCycle = startOn === "high" ? lowerLimitDC : upperLimitDC ;
setDutyCycle(dutyCycle);
updateExtreme();
cycleCount++;
if (cycles !== -1 && cycleCount >= cycles) {
clearInterval(pinData.pwmEffect.interval);
clearTimeout(pinData.pwmEffect.timeout);
if (dutyCycle != endDutyCycle){
pinData.pwmEffect.timeout = setTimeout(() => {
setDutyCycle(endDutyCycle);
updateExtreme();
clearTimeout(pinData.pwmEffect.timeout);
}, startOn === "high" ? flashLow : flashLength );
}
for (var obj in pinData.pwmEffect) delete pinData.pwmEffect[obj];
}
}, timer);
}, speed);
} else if (effect === "Fade-in" || effect === "Fade-out"){
if (typeof speed !== "number" || typeof steps !== "number" || speed < 4 || steps < 1 || steps > DCBandwitdh) throw new Error(`Invalid speed value for PWM ${effect}.`);
pinData.pwmEffect.type = effect;
pinData.pwmEffect.speed = speed;
pinData.pwmEffect.steps = steps;
const step = Math.round(DCBandwitdh / steps);
const startDC = effect === "Fade-in" ? lowerLimitDC : upperLimitDC;
const endDC = effect === "Fade-in" ? upperLimitDC : lowerLimitDC;
const dir = effect === "Fade-in" ? 1 : -1;
dutyCycle = startDC;
pinData.pwmEffect.interval = setInterval(() => {
setDutyCycle(dutyCycle);
dutyCycle += step * dir;
if ((dir === 1 && dutyCycle > endDC) || (dir === -1 && dutyCycle < endDC)) {
dutyCycle = endDC;
setDutyCycle(dutyCycle);
clearInterval(pinData.pwmEffect.interval);
for (var obj in pinData.pwmEffect) delete pinData.pwmEffect[obj];
}
}, speed);
} else if (effect === "Fixed"){
if (typeof state !== "number" || state < minDutyCycle || state > maxDutyCycle) throw new Error("Invalid state value for PWM fixed.");
setDutyCycle(state);
} else {
throw new Error("Invalid PWM type specified.");
}
}
if (pinData.pwmEffect.interval && endPrevOn !== undefined) {
let endTime, promise;
const targetExtreme = endPrevOn === "high" ? "high" : "low";
switch (pinData.pwmEffect.type ) {
case "Breath":
case "Pulse":
endTime = new Date().getTime() + ((3 * pinData.pwmEffect.steps) * pinData.pwmEffect.speed );
promise = new Promise((resolve) => {
let promiseInterval = setInterval(() => {
if (pinData.pwmEffect.extreme === targetExtreme || new Date().getTime() < endTime) {
clearInterval(promiseInterval);
resolve();
}
},Math.round(pinData.pwmEffect.speed / 2));
});
promise.then(newEffect);
break;
case "Flash":
endTime = new Date().getTime() + (2 * pinData.pwmEffect.speed );
promise = new Promise((resolve) => {
let promiseInterval = setInterval(() => {
if (pinData.pwmEffect.extreme === targetExtreme || new Date().getTime() < endTime) {
clearInterval(promiseInterval);
resolve();
}
},Math.round(pinData.pwmEffect.speed / 2));
});
promise.then(newEffect);
break;
case "Fade-in":
case "Fade-out":
endTime = new Date().getTime() + ((2 * pinData.pwmEffect.steps) * pinData.pwmEffect.speed );
promise = new Promise((resolve) => {
let promiseInterval = setInterval(() => {
if (pinData.pwmEffect.interval || new Date().getTime() < endTime) {
clearInterval(promiseInterval);
resolve();
}
},Math.round(pinData.pwmEffect.speed / 2));
});
promise.then(newEffect);
break;
default:
newEffect();
}
} else {
newEffect();
}
} catch (error){
console.error("PWM handling error:", error.message);
me.sendSocketNotification("SHOW_ALERT", error.message);
}
},
OnOffHandler: function (payload) {
const me = this;
try{
const pinData = me.pins.output[String(payload.pin)];
const action = payload.action;
if (!pinData.gpio) {
throw new Error("Pin not initialized for GPIO.");
}
if (action === undefined) {
throw new Error("No action specified. It is not possible to change outputs.");
}
switch (action){
case "set":
const state = payload.state ?? pinData.default_state ?? me.configDefaults.default_state;
if (state !== 0 && state !== 1) {
throw new Error("Invalid state value. State must be 0 or 1.");
}
pinData.gpio.write(state);
break;
case "toggle":
pinData.gpio.read((err, value) => {
if (err) {
console.error("Error reading pin:", err.message);
me.sendSocketNotification("SHOW_ALERT", err.message);
return;
}
pinData.gpio.write(value ^ 1);
});
break;
case "trigger":
const length = payload.length;
const level = payload.level;
if (typeof length !== "number" || length <= 0) {
throw new Error("Invalid length value. Length must be a positive number.");
}
if (level !== 0 && level !== 1) {
throw new Error("Invalid level value. Level must be 0 or 1.");
}
pinData.gpio.trigger(length, level);
break;
default:
throw new Error(`Invalid action: ${action}. Valid actions are "set", "toggle", and "trigger".`);
}
} catch (error){
console.error("On/Off handling error:", error.message);
me.sendSocketNotification("SHOW_ALERT", error.message);
}
},
stop: function() {
console.log("Shutting down module: " + this.name);
}
});