@sensslen/node-gamepad 1.0.3 → 1.0.5-beta.2

package/IConfig.d.ts

@@ -1,29 +1,34 @@
-import { IDeviceSpec } from './IDeviceSpec';
-export interface IConfig extends IDeviceSpec {
-    joysticks?: {
-        name: string;
-        x: {
-            pin: number;
-        };
-        y: {
-            pin: number;
-        };
-    }[];
-    buttons?: {
-        value: string;
-        pin: number;
-        name: string;
-    }[];
-    status?: {
-        name: string;
-        pin: number;
-        states: {
-            value: number;
-            state: string;
-        }[];
-    }[];
-    scale?: {
-        pin: number;
-        name: string;
-    }[];
-}
+import { IDeviceSpec } from './IDeviceSpec';
+export interface IJoyStickConfig {
+    name: string;
+    x: {
+        pin: number;
+    };
+    y: {
+        pin: number;
+    };
+}
+export interface IButtonConfig {
+    value: string;
+    pin: number;
+    name: string;
+}
+export interface IStatusConfig {
+    name: string;
+    pin: number;
+    states: IStateMappingConfig[];
+}
+export interface IStateMappingConfig {
+    value: number;
+    state: string;
+}
+export interface IScaleConfig {
+    pin: number;
+    name: string;
+}
+export interface IConfig extends IDeviceSpec {
+    joysticks?: IJoyStickConfig[];
+    buttons?: IButtonConfig[];
+    status?: IStatusConfig[];
+    scales?: IScaleConfig[];
+}

package/IConfig.js

@@ -1,3 +1,3 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
 //# sourceMappingURL=IConfig.js.map

package/IDeviceSpec.d.ts

@@ -1,5 +1,5 @@
-export interface IDeviceSpec {
-    vendorID: number;
-    productID: number;
-    serialNumber?: string;
-}
+export interface IDeviceSpec {
+    vendorID: number;
+    productID: number;
+    serialNumber?: string;
+}

package/IDeviceSpec.js

@@ -1,3 +1,3 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
 //# sourceMappingURL=IDeviceSpec.js.map

package/ILogger.d.ts

@@ -1,4 +1,4 @@
-export interface ILogger {
-    debug?: (toLog: string) => void;
-    info(toLog: string): void;
-}
+export interface ILogger {
+    debug?: (toLog: string) => void;
+    info(toLog: string): void;
+}

package/ILogger.js

@@ -1,3 +1,3 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
 //# sourceMappingURL=ILogger.js.map

package/JoyStickValue.d.ts

@@ -1,4 +1,4 @@
-export interface JoyStickValue {
-    x: number;
-    y: number;
-}
+export interface JoyStickValue {
+    x: number;
+    y: number;
+}

package/JoyStickValue.js

@@ -1,3 +1,3 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
 //# sourceMappingURL=JoyStickValue.js.map

package/NodeGamepad.d.ts

@@ -1,34 +1,38 @@
-/// <reference types="node" />
-import { HID } from 'node-hid';
-import { EventEmitter } from 'events';
-import { IConfig } from './IConfig';
-import { ILogger } from './ILogger';
-export declare class NodeGamepad extends EventEmitter {
-    private config;
-    private logger?;
-    protected _usb?: HID;
-    private _stopped;
-    private _joystickStates;
-    private _buttonStates;
-    private _statusStates;
-    private _scaleStates;
-    private _connectRetryTimeout?;
-    private readonly _connectionRetryTimeoutInMs;
-    constructor(config: IConfig, logger?: ILogger | undefined);
-    start(): void;
-    stop(): void;
-    rumble(_duration: number): void;
-    private logDebug;
-    private log;
-    private connect;
-    private stopConnectionProcess;
-    private registerStopProgramStopEvent;
-    private disconnect;
-    private toIDeviceSpec;
-    private onControllerFrame;
-    private processJoysticks;
-    private processButtons;
-    private processScales;
-    private processStatus;
-    private getStateName;
-}
+/// <reference types="node" />
+import { HID } from 'node-hid';
+import { IConfig } from './IConfig';
+import { EventEmitter } from 'events';
+import { ILogger } from './ILogger';
+export declare class NodeGamepad extends EventEmitter {
+    private config;
+    private logger?;
+    protected _usb?: HID;
+    private _running;
+    private _joystickStates;
+    private _buttonStates;
+    private _statusStates;
+    private _scaleStates;
+    private _connectRetryTimeout?;
+    private readonly _connectionRetryTimeoutInMs;
+    constructor(config: IConfig, logger?: ILogger | undefined);
+    start(): void;
+    stop(): void;
+    rumble(_intensity: number, _duration: number): void;
+    private logDebug;
+    private log;
+    private connect;
+    private stopConnectionProcess;
+    private registerProgramExitEvents;
+    private closeUsbDevice;
+    private toIDeviceSpec;
+    private onControllerFrame;
+    private processJoysticks;
+    private processJoystick;
+    private processButtons;
+    private processButton;
+    private processScales;
+    private processScale;
+    private processStates;
+    private processState;
+    private getStateName;
+}

package/NodeGamepad.js

@@ -1,210 +1,232 @@
-"use strict";
-var __extends = (this && this.__extends) || (function () {
-    var extendStatics = function (d, b) {
-        extendStatics = Object.setPrototypeOf ||
-            ({ __proto__: [] } instanceof Array && function (d, b) { d.__proto__ = b; }) ||
-            function (d, b) { for (var p in b) if (Object.prototype.hasOwnProperty.call(b, p)) d[p] = b[p]; };
-        return extendStatics(d, b);
-    };
-    return function (d, b) {
-        if (typeof b !== "function" && b !== null)
-            throw new TypeError("Class extends value " + String(b) + " is not a constructor or null");
-        extendStatics(d, b);
-        function __() { this.constructor = d; }
-        d.prototype = b === null ? Object.create(b) : (__.prototype = b.prototype, new __());
-    };
-})();
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.NodeGamepad = void 0;
-var node_hid_1 = require("node-hid");
-var events_1 = require("events");
-var mathjs_1 = require("mathjs");
-var NodeGamepad = /** @class */ (function (_super) {
-    __extends(NodeGamepad, _super);
-    function NodeGamepad(config, logger) {
-        var _this = _super.call(this) || this;
-        _this.config = config;
-        _this.logger = logger;
-        _this._stopped = false;
-        _this._joystickStates = {};
-        _this._buttonStates = {};
-        _this._statusStates = {};
-        _this._scaleStates = {};
-        _this._connectionRetryTimeoutInMs = 100;
-        return _this;
-    }
-    NodeGamepad.prototype.start = function () {
-        var _this = this;
-        this.log("Starting connection procedure to device:" + JSON.stringify(this.toIDeviceSpec(this.config)));
-        this.registerStopProgramStopEvent();
-        this.connect();
-        // on process exit, disconnect from any devices we may be connected to. and also stop any connection procedure
-        process.on('exit', function () { return _this.stop(); });
-    };
-    NodeGamepad.prototype.stop = function () {
-        if (!this._stopped) {
-            this.stopConnectionProcess();
-            this.disconnect();
-            this._stopped = true;
-        }
-    };
-    NodeGamepad.prototype.rumble = function (_duration) {
-        // do nothing here intentionally. gamepads supporting rumbling do need to override this method
-    };
-    NodeGamepad.prototype.logDebug = function (toLog) {
-        var _a;
-        if ((_a = this.logger) === null || _a === void 0 ? void 0 : _a.debug) {
-            this.logger.debug("NodeGamepad (Debug):" + toLog);
-        }
-    };
-    NodeGamepad.prototype.log = function (toLog) {
-        if (this.logger) {
-            this.logger.info("NodeGamepad:" + toLog);
-        }
-    };
-    NodeGamepad.prototype.connect = function () {
-        var _this = this;
-        if (this._stopped) {
-            return;
-        }
-        var deviceList = (0, node_hid_1.devices)(this.config.vendorID, this.config.productID);
-        if (this.config.serialNumber) {
-            deviceList = deviceList.filter(function (d) { return d.serialNumber === _this.config.serialNumber; });
-        }
-        if (deviceList.length < 1) {
-            this.logDebug('Device not found, trying again later');
-            this._connectRetryTimeout = setTimeout(function () { return _this.connect(); }, this._connectionRetryTimeoutInMs);
-            return;
-        }
-        var deviceToConnectTo = deviceList[0];
-        if ((deviceToConnectTo === null || deviceToConnectTo === void 0 ? void 0 : deviceToConnectTo.path) === undefined) {
-            this.logDebug('Failed to connect. Checking again later.');
-            this._connectRetryTimeout = setTimeout(function () { return _this.connect(); }, this._connectionRetryTimeoutInMs);
-            return;
-        }
-        this.logDebug("connecting to:" + JSON.stringify(deviceToConnectTo));
-        try {
-            this._usb = new node_hid_1.HID(deviceToConnectTo.path);
-            this.log('connected');
-            this.emit('connected');
-            this._connectRetryTimeout = undefined;
-            this._usb.on('data', function (data) { return _this.onControllerFrame(data); });
-            this._usb.on('error', function (error) {
-                _this.log("Error occurred:" + JSON.stringify(error));
-                setTimeout(function () {
-                    _this.log('reconnecting');
-                    _this.disconnect();
-                    _this.connect();
-                }, 0);
-            });
-        }
-        catch (error) {
-            var typedError = error;
-            this.log("Connecting failed: " + typedError.message);
-            this.log('trying again later.');
-            this._connectRetryTimeout = setTimeout(function () { return _this.connect(); }, this._connectionRetryTimeoutInMs);
-        }
-    };
-    NodeGamepad.prototype.stopConnectionProcess = function () {
-        if (this._connectRetryTimeout) {
-            clearTimeout(this._connectRetryTimeout);
-            this._connectRetryTimeout = undefined;
-        }
-    };
-    NodeGamepad.prototype.registerStopProgramStopEvent = function () {
-        var _this = this;
-        process.on('SIGINT', function () { return _this.stop(); });
-        process.on('exit', function () { return _this.stop(); });
-        process.on('uncaughtException', function () { return _this.stop(); });
-    };
-    NodeGamepad.prototype.disconnect = function () {
-        if (this._usb) {
-            this.emit('disconnected');
-            this._usb.close();
-            this._usb = undefined;
-        }
-    };
-    NodeGamepad.prototype.toIDeviceSpec = function (spec) {
-        return {
-            vendorID: spec.vendorID,
-            productID: spec.productID,
-            serialNumber: spec.serialNumber,
-        };
-    };
-    NodeGamepad.prototype.onControllerFrame = function (data) {
-        this.logDebug(JSON.stringify(data));
-        this.processJoysticks(data);
-        this.processButtons(data);
-        this.processStatus(data);
-        this.processScales(data);
-    };
-    NodeGamepad.prototype.processJoysticks = function (data) {
-        var _this = this;
-        var _a;
-        (_a = this.config.joysticks) === null || _a === void 0 ? void 0 : _a.forEach(function (joystick) {
-            var oldState = _this._joystickStates[joystick.name];
-            var newState = {
-                x: data[joystick.x.pin],
-                y: data[joystick.y.pin],
-            };
-            if (oldState === undefined || oldState.x !== newState.x || oldState.y !== newState.y) {
-                _this.emit(joystick.name + ':move', newState);
-            }
-            _this._joystickStates[joystick.name] = newState;
-        });
-    };
-    NodeGamepad.prototype.processButtons = function (data) {
-        var _this = this;
-        var _a;
-        (_a = this.config.buttons) === null || _a === void 0 ? void 0 : _a.forEach(function (button) {
-            var oldState = _this._buttonStates[button.name];
-            var newState = (0, mathjs_1.evaluate)(button.value, { value: data[button.pin] });
-            if (oldState == undefined) {
-                if (newState) {
-                    _this.emit(button.name + ':press');
-                }
-            }
-            else if (oldState !== newState) {
-                var emitEvent = newState ? button.name + ":press" : button.name + ":release";
-                _this.emit(emitEvent);
-            }
-            _this._buttonStates[button.name] = newState;
-        });
-    };
-    NodeGamepad.prototype.processScales = function (data) {
-        var _this = this;
-        var _a;
-        (_a = this.config.scale) === null || _a === void 0 ? void 0 : _a.forEach(function (scale) {
-            var oldState = _this._scaleStates[scale.name];
-            var newState = data[scale.pin];
-            if (oldState !== newState) {
-                _this.emit(scale.name + ':change', newState);
-            }
-            _this._scaleStates[scale.name] = newState;
-        });
-    };
-    NodeGamepad.prototype.processStatus = function (data) {
-        var _this = this;
-        var _a;
-        (_a = this.config.status) === null || _a === void 0 ? void 0 : _a.forEach(function (status) {
-            var oldState = _this._statusStates[status.name];
-            var newState = data[status.pin];
-            if (oldState !== newState) {
-                _this.emit(status.name + ':change', _this.getStateName(status.states, newState));
-            }
-            _this._statusStates[status.name] = newState;
-        });
-    };
-    NodeGamepad.prototype.getStateName = function (states, value) {
-        for (var _i = 0, states_1 = states; _i < states_1.length; _i++) {
-            var state = states_1[_i];
-            if (state.value === value) {
-                return state.state;
-            }
-        }
-        return "unknown state:" + value;
-    };
-    return NodeGamepad;
-}(events_1.EventEmitter));
-exports.NodeGamepad = NodeGamepad;
+"use strict";
+var __extends = (this && this.__extends) || (function () {
+    var extendStatics = function (d, b) {
+        extendStatics = Object.setPrototypeOf ||
+            ({ __proto__: [] } instanceof Array && function (d, b) { d.__proto__ = b; }) ||
+            function (d, b) { for (var p in b) if (Object.prototype.hasOwnProperty.call(b, p)) d[p] = b[p]; };
+        return extendStatics(d, b);
+    };
+    return function (d, b) {
+        if (typeof b !== "function" && b !== null)
+            throw new TypeError("Class extends value " + String(b) + " is not a constructor or null");
+        extendStatics(d, b);
+        function __() { this.constructor = d; }
+        d.prototype = b === null ? Object.create(b) : (__.prototype = b.prototype, new __());
+    };
+})();
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.NodeGamepad = void 0;
+var node_hid_1 = require("node-hid");
+var events_1 = require("events");
+var mathjs_1 = require("mathjs");
+var NodeGamepad = /** @class */ (function (_super) {
+    __extends(NodeGamepad, _super);
+    function NodeGamepad(config, logger) {
+        var _this = _super.call(this) || this;
+        _this.config = config;
+        _this.logger = logger;
+        _this._usb = undefined;
+        _this._running = false;
+        _this._joystickStates = {};
+        _this._buttonStates = {};
+        _this._statusStates = {};
+        _this._scaleStates = {};
+        _this._connectionRetryTimeoutInMs = 500;
+        return _this;
+    }
+    NodeGamepad.prototype.start = function () {
+        if (this._running) {
+            return;
+        }
+        this.log("Starting connection procedure to device:".concat(JSON.stringify(this.toIDeviceSpec(this.config))));
+        this.registerProgramExitEvents();
+        this._running = true;
+        this.connect();
+    };
+    NodeGamepad.prototype.stop = function () {
+        this._running = false;
+        this.stopConnectionProcess();
+        this.closeUsbDevice();
+    };
+    NodeGamepad.prototype.rumble = function (_intensity, _duration) {
+        // todo
+    };
+    NodeGamepad.prototype.logDebug = function (toLog) {
+        var _a;
+        if ((_a = this.logger) === null || _a === void 0 ? void 0 : _a.debug) {
+            this.logger.debug("NodeGamepad (Debug):".concat(toLog));
+        }
+    };
+    NodeGamepad.prototype.log = function (toLog) {
+        if (this.logger) {
+            this.logger.info("NodeGamepad:".concat(toLog));
+        }
+    };
+    NodeGamepad.prototype.connect = function () {
+        var _this = this;
+        if (!this._running) {
+            return;
+        }
+        var deviceList = (0, node_hid_1.devices)(this.config.vendorID, this.config.productID);
+        if (this.config.serialNumber) {
+            deviceList = deviceList.filter(function (d) { return d.serialNumber === _this.config.serialNumber; });
+        }
+        if (deviceList.length < 1) {
+            this.logDebug('Device not found, trying again later');
+            this._connectRetryTimeout = setTimeout(function () { return _this.connect(); }, this._connectionRetryTimeoutInMs);
+            return;
+        }
+        var deviceToConnectTo = deviceList[0];
+        if ((deviceToConnectTo === null || deviceToConnectTo === void 0 ? void 0 : deviceToConnectTo.path) === undefined) {
+            this.logDebug('Failed to connect. Checking again later.');
+            this._connectRetryTimeout = setTimeout(function () { return _this.connect(); }, this._connectionRetryTimeoutInMs);
+            return;
+        }
+        this.logDebug("connecting to:".concat(JSON.stringify(deviceToConnectTo)));
+        try {
+            this._usb = new node_hid_1.HID(deviceToConnectTo.path);
+            this.log('connected');
+            this.emit('connected');
+            this._connectRetryTimeout = undefined;
+            this._usb.on('data', function (data) { return _this.onControllerFrame(data); });
+            this._usb.on('error', function (error) {
+                _this.log("Error occurred:".concat(JSON.stringify(error)));
+                _this.emit('disconnected');
+                _this.closeUsbDevice();
+                setTimeout(function () {
+                    _this.log('reconnecting');
+                    _this.connect();
+                }, 0);
+            });
+        }
+        catch (error) {
+            var typedError = error;
+            this.log("Connecting failed: ".concat(typedError.message));
+            this.log('trying again later.');
+            this.closeUsbDevice();
+            this._connectRetryTimeout = setTimeout(function () { return _this.connect(); }, this._connectionRetryTimeoutInMs);
+        }
+    };
+    NodeGamepad.prototype.stopConnectionProcess = function () {
+        if (this._connectRetryTimeout) {
+            clearTimeout(this._connectRetryTimeout);
+            this._connectRetryTimeout = undefined;
+        }
+    };
+    NodeGamepad.prototype.registerProgramExitEvents = function () {
+        var _this = this;
+        process.on('exit', function () {
+            _this.logDebug('exit encontered, cleaning up');
+            _this.stop();
+        });
+    };
+    NodeGamepad.prototype.closeUsbDevice = function () {
+        if (this._usb) {
+            this._usb.close();
+            this._usb = undefined;
+        }
+    };
+    NodeGamepad.prototype.toIDeviceSpec = function (spec) {
+        return {
+            vendorID: spec.vendorID,
+            productID: spec.productID,
+            serialNumber: spec.serialNumber,
+        };
+    };
+    NodeGamepad.prototype.onControllerFrame = function (data) {
+        this.logDebug(JSON.stringify(data));
+        this.processJoysticks(data);
+        this.processButtons(data);
+        this.processStates(data);
+        this.processScales(data);
+    };
+    NodeGamepad.prototype.processJoysticks = function (data) {
+        var _this = this;
+        var _a;
+        (_a = this.config.joysticks) === null || _a === void 0 ? void 0 : _a.forEach(function (joystick) {
+            if (data.length > joystick.x.pin || data.length > joystick.y.pin) {
+                _this.processJoystick(joystick, data);
+            }
+        });
+    };
+    NodeGamepad.prototype.processJoystick = function (joystick, data) {
+        var oldState = this._joystickStates[joystick.name];
+        var newState = {
+            x: data[joystick.x.pin],
+            y: data[joystick.y.pin],
+        };
+        if (oldState === undefined || oldState.x !== newState.x || oldState.y !== newState.y) {
+            this.emit(joystick.name + ':move', newState);
+        }
+        this._joystickStates[joystick.name] = newState;
+    };
+    NodeGamepad.prototype.processButtons = function (data) {
+        var _this = this;
+        var _a;
+        (_a = this.config.buttons) === null || _a === void 0 ? void 0 : _a.forEach(function (button) {
+            if (data.length > button.pin) {
+                _this.processButton(data, button);
+            }
+        });
+    };
+    NodeGamepad.prototype.processButton = function (data, config) {
+        var oldState = this._buttonStates[config.name];
+        var newState = (0, mathjs_1.evaluate)(config.value, { value: data[config.pin] });
+        if (oldState == undefined) {
+            if (newState) {
+                this.emit(config.name + ':press');
+            }
+        }
+        else if (oldState !== newState) {
+            var emitEvent = newState ? "".concat(config.name, ":press") : "".concat(config.name, ":release");
+            this.emit(emitEvent);
+        }
+        this._buttonStates[config.name] = newState;
+    };
+    NodeGamepad.prototype.processScales = function (data) {
+        var _this = this;
+        var _a;
+        (_a = this.config.scales) === null || _a === void 0 ? void 0 : _a.forEach(function (scale) {
+            if (data.length > scale.pin) {
+                _this.processScale(scale, data);
+            }
+        });
+    };
+    NodeGamepad.prototype.processScale = function (config, data) {
+        var oldState = this._scaleStates[config.name];
+        var newState = data[config.pin];
+        if (oldState !== newState) {
+            this.emit(config.name + ':change', newState);
+        }
+        this._scaleStates[config.name] = newState;
+    };
+    NodeGamepad.prototype.processStates = function (data) {
+        var _this = this;
+        var _a;
+        (_a = this.config.status) === null || _a === void 0 ? void 0 : _a.forEach(function (status) {
+            if (data.length > status.pin) {
+                _this.processState(status, data);
+            }
+        });
+    };
+    NodeGamepad.prototype.processState = function (config, data) {
+        var oldState = this._statusStates[config.name];
+        var newState = data[config.pin];
+        if (oldState !== newState) {
+            this.emit(config.name + ':change', this.getStateName(config.states, newState));
+        }
+        this._statusStates[config.name] = newState;
+    };
+    NodeGamepad.prototype.getStateName = function (states, value) {
+        for (var _i = 0, states_1 = states; _i < states_1.length; _i++) {
+            var state = states_1[_i];
+            if (state.value === value) {
+                return state.state;
+            }
+        }
+        return "unknown state:".concat(value);
+    };
+    return NodeGamepad;
+}(events_1.EventEmitter));
+exports.NodeGamepad = NodeGamepad;
 //# sourceMappingURL=NodeGamepad.js.map