MMM-keybindings.js

/* global document, Module, window, Mousetrap, console */
/* Magic Mirror
 * Module: MMM-KeyBindings
 *
 * By shbatm
 * MIT Licensed.
 */
/* jshint esversion:6 */
var global = this;

Module.register("MMM-KeyBindings", {
    defaults: {/*
                enabledKeyStates: ["KEY_PRESSED"],
                evdev: { enabled: false },
                handleKeys: [ 'r', 'l' ],
                enableMousetrap: true,
                enableKeyboard: false,*/
			},

    // Allow for control on muliple instances
    instance: (global.location && ["localhost", "127.0.0.1", "::1", "::ffff:127.0.0.1", undefined, "0.0.0.0"].indexOf(global.location.hostname) > -1) ? "SERVER" : "LOCAL",

    requiresVersion: "2.3.0", // Required version of MagicMirror

    start: function() {
        console.log(this.name + " has started...");

        // Allow Legacy Config Settings:
        if (this.config.evdevKeyMap) {
            this.config.keyMap = this.config.evdevKeyMap;
        }

        if (this.config.evdev.enabled) {
            this.sendSocketNotification("ENABLE_EVDEV", this.config.evdev);
        }

        this.currentKeyPressMode = "DEFAULT";

        // Generate a reverse key map
        this.reverseKeyMap = {};
        for (var eKey in this.config.keyMap) {
            if (this.config.keyMap.hasOwnProperty(eKey)) {
                this.reverseKeyMap[this.config.keyMap[eKey]] = eKey;
            }
        }
    },

    getScripts: function() {
        return ['keyHandler.js', 'mousetrap.min.js', 'mousetrap-global-bind.min.js'];
    },

    setupMousetrap: function() {
        var self = this;
        var keys = ['home', 'enter', 'left', 'right', 'up', 'down', 'return', 'playpause', 'nexttrack', 'previoustrack', 'Menu'];
        var keyCodes = { 179: 'playpause', 178: 'nexttrack', 177: 'previoustrack', 93: 'Menu' };
        var keyMap = { ContextMenu: "Menu" };

        Mousetrap.addKeycodes(keyCodes);

        // Add extra keys (must be in Mousetrap form)
        // TODO: Add ability to add extra keycodes as well
        keys = keys.concat(this.config.handleKeys);

        // Remove Disabled Keys
        for (var i = this.config.disableKeys.length - 1; i >= 0; i--) {
            var j = keys.indexOf(this.config.disableKeys[i]);
            if (j > -1) {
                keys.splice(j, 1);
            }
        }

        // console.log(keys);

        Mousetrap.bindGlobal(keys, (e) => {
            // Prevent the default action from occuring
            if (e.preventDefault) {
                e.preventDefault();
            } else {
                // internet explorer
                e.returnValue = false;
            }

            var payload = {};
            payload.keyName = e.key;

            // Standardize the name
            if (payload.keyName in keyMap) {
                payload.keyName = keyMap[payload.keyName];
            }

            if (this.config.evdev.rawMode) {
                payload.keyState = e.type;
            } else {
                payload.keyState = "KEY_PRESSED";
            }
            payload.currentMode = self.currentKeyPressMode;
            payload.sender = self.instance;
            payload.instance = self.instance;
            payload.protocol = "mousetrap";
            self.sendNotification("KEYPRESS", payload);
            self.doAction(payload);
        });

        // Squash bad actors:
        Mousetrap.bind(['home', 'Menu'], (e) => {
            e.preventDefault();
            return false;
        }, 'keyup');
    },

    handleEvDevKeyPressEvents: function(payload) {
        // Add the current mode to the payload
        payload.currentMode = this.currentKeyPressMode;

        // Add the sender to the payload (useful if you have multiple clients connected;
        // the evdev keys only work on the main server)
        payload.sender = "SERVER";
        payload.protocol = "evdev";
        payload.instance = this.instance;

        // Standardize the name
        if (payload.keyName in this.reverseKeyMap) {
            payload.keyName = this.reverseKeyMap[payload.keyName];
        }
        this.sendNotification("KEYPRESS", payload);
        this.doAction(payload);
    },

    // socketNotificationReceived from helper
    socketNotificationReceived: function(notification, payload) {
        // console.log("Working notification system. Notification:", notification, "payload: ", payload);
        if (notification === "KEYPRESS") {
            if (this.config.enabledKeyStates.indexOf(payload.keyState) > -1) {
                this.handleEvDevKeyPressEvents(payload);
            }
        }
    },

    notificationReceived: function(notification, payload, sender) {
        if (notification === "DOM_OBJECTS_CREATED") {
            if (this.config.enableKeyboard) {
                console.log("Setting up Mousetrap keybindings.");
                this.setupMousetrap();
            }
        }
        if (notification === "KEYPRESS_MODE_CHANGED") {
            this.currentKeyPressMode = payload || "DEFAULT";
        }
    },

    doAction: function(payload) {
        let action = this.config.actions.filter(k => k.key === payload.keyName);
        if (action) {
            action.forEach(a => {
                if (a.state && a.state !== payload.keyState) { return; }
                if (a.instance && a.instance !== payload.sender) { return; }
                if (a.mode && a.mode !== payload.currentMode) { return; }

                if ("changeMode" in a) {
                    this.currentKeyPressMode = a.changeMode;
                    this.sendNotification("KEYPRESS_MODE_CHANGED", a.changeMode);
                } else {
                    this.sendNotification(a.notification, a.payload);
                }
            });
        }
    }
});