incyclist-devices 2.1.8 → 2.1.9

package/lib/serial/comms.js

@@ -0,0 +1,280 @@
+"use strict";
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const gd_eventlog_1 = require("gd-eventlog");
+const utils_1 = require("./daum/premium/utils");
+const utils_2 = require("../utils/utils");
+const DEFAULT_BUSY_TIMEOUT = 5000;
+class SerialPortComms {
+    constructor(props) {
+        this.props = props;
+        const { logger, serial, path } = props;
+        this.serial = serial;
+        this.path = this.validatePath(path);
+        const w = global.window;
+        this.logger = logger || ((w === null || w === void 0 ? void 0 : w.DEVICE_DEBUG) || process.env.DEBUG ? utils_1.DEBUG_LOGGER : new gd_eventlog_1.EventLogger(this.getDefaultLoggerName()));
+        this.resetState();
+    }
+    getBusyTimeout() {
+        return DEFAULT_BUSY_TIMEOUT;
+    }
+    getDefaultLoggerName() {
+        return 'Serial';
+    }
+    getInitialCommsState() {
+        return { data: new utils_2.Queue() };
+    }
+    validatePath(path) {
+        return path;
+    }
+    getInterface() {
+        var _a;
+        return (_a = this.serial) === null || _a === void 0 ? void 0 : _a.ifaceName;
+    }
+    getPort() {
+        return this.path;
+    }
+    isConnected() {
+        return this.connectState === 'Connected' || this.connectState === 'Disconnecting';
+    }
+    pauseLogging() {
+        this.isLoggingPaused = true;
+    }
+    resumeLogging() {
+        this.isLoggingPaused = false;
+    }
+    logEvent(e) {
+        if (this.isLoggingPaused)
+            return;
+        this.logger.logEvent(e);
+        const w = global.window;
+        if (w === null || w === void 0 ? void 0 : w.DEVICE_DEBUG) {
+            console.log(`~~~ ${this.getDefaultLoggerName()}`, e);
+        }
+    }
+    connect() {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (this.isConnected() && this.sp) {
+                return true;
+            }
+            if (this.connectState === 'Connecting') {
+                if (this.connectPromise) {
+                    try {
+                        yield this.connectPromise;
+                    }
+                    catch (_a) {
+                    }
+                }
+                return this.isConnected();
+            }
+            try {
+                this.connectState = 'Connecting';
+                this.connectPromise = this.serial.openPort(this.path);
+                const port = yield this.connectPromise;
+                this.connectPromise = null;
+                if (port !== null) {
+                    this.connectState = 'Connected';
+                    this.sp = port;
+                    this.sp.on('close', this.onPortClose.bind(this));
+                    this.sp.on('error', this.onPortError.bind(this));
+                    this.onConnected();
+                    return true;
+                }
+                else {
+                    this.connectState = 'Disconnected';
+                    return false;
+                }
+            }
+            catch (_b) {
+                this.connectState = 'Disconnected';
+                return false;
+            }
+        });
+    }
+    onConnected() {
+    }
+    portFlush() {
+        if (this.sp)
+            this.sp.flush();
+    }
+    portPipe(destination, options) {
+        if (this.sp)
+            return this.sp.pipe(destination, options);
+    }
+    portUnpipe(destination) {
+        if (this.sp)
+            this.sp.unpipe(destination);
+    }
+    closePort() {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (!this.sp)
+                return true;
+            try {
+                yield this.flush();
+                yield this.serial.closePort(this.path);
+                return true;
+            }
+            catch (err) {
+                this.logEvent({ message: 'could not close ', reason: err.message });
+                return false;
+            }
+        });
+    }
+    resetState(isDisconnected = true) {
+        this.isLoggingPaused = false;
+        this.recvState = this.getInitialCommsState();
+        this.connectPromise = null;
+        this.disconnectPromise = null;
+        this.writePromise = null;
+        this.sendCmdPromise = null;
+        if (isDisconnected)
+            this.connectState = 'Disconnected';
+    }
+    cleanupPort(isDisconnected = true) {
+        if (this.sp) {
+            this.sp.removeAllListeners();
+        }
+        this.sp = null;
+        this.resetState(isDisconnected);
+    }
+    close() {
+        return __awaiter(this, void 0, void 0, function* () {
+            let isDisconnected = false;
+            if (this.disconnectPromise) {
+                try {
+                    isDisconnected = yield this.disconnectPromise;
+                }
+                catch (_a) {
+                }
+                return isDisconnected;
+            }
+            if (this.connectState === 'Disconnected') {
+                this.cleanupPort();
+                return true;
+            }
+            else if (this.connectState === 'Disconnecting' || this.connectState === 'Connected' || this.connectState === 'Connecting') {
+                this.connectState = 'Disconnecting';
+                this.disconnectPromise = this.closePort();
+                isDisconnected = yield this.disconnectPromise;
+                if (isDisconnected) {
+                    this.connectState = 'Disconnected';
+                    this.logEvent({ message: "port closed:", port: this.path });
+                }
+                this.cleanupPort(isDisconnected);
+            }
+            return isDisconnected;
+        });
+    }
+    flush() {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (this.writePromise) {
+                yield (0, utils_2.waitWithTimeout)(this.writePromise, 1000);
+                this.writePromise = null;
+            }
+        });
+    }
+    onPortClose() {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (this.connectState !== 'Disconnected' && this.connectState !== 'Disconnecting')
+                this.logEvent({ message: "port closed:", port: this.path });
+            this.connectState = 'Disconnected';
+            this.cleanupPort();
+        });
+    }
+    onPortError(error) {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (this.connectState === 'Disconnecting' || this.connectState === 'Disconnected') {
+                return;
+            }
+            this.logEvent({ message: "port error:", port: this.path, error: error.message, connected: this.isConnected(), state: this.connectState });
+            if (this.isSending()) {
+                this.rejectCurrent(error);
+            }
+            if (this.connectState === 'Connected')
+                this.close();
+        });
+    }
+    isSending() {
+        return (this.writePromise !== undefined && this.writePromise !== null) || (this.sendCmdPromise !== null && this.sendCmdPromise !== undefined);
+    }
+    rejectCurrent(error) {
+        this.recvState.data.enqueue({ type: 'Error', error });
+    }
+    getTimeoutValue() {
+        throw new Error('method not implemented');
+    }
+    onData(data, depth = 0) {
+        return __awaiter(this, void 0, void 0, function* () {
+        });
+    }
+    send(command) {
+        return __awaiter(this, void 0, void 0, function* () {
+            throw new Error('method not implemented');
+        });
+    }
+    portWrite(buffer) {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (!this.sp) {
+                this.logEvent({ message: 'write failed', error: 'port is not opened' });
+                return;
+            }
+            try {
+                yield this.sp.write(buffer);
+            }
+            catch (err) {
+                this.logEvent({ message: 'write failed', error: err.message });
+            }
+        });
+    }
+    write(buffer) {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (this.writePromise) {
+                try {
+                    yield this.writePromise;
+                }
+                catch (_a) {
+                }
+                this.writePromise = null;
+            }
+            this.writePromise = this.portWrite(buffer);
+            yield this.writePromise;
+            this.writePromise = null;
+        });
+    }
+    ensurePrevCmdFinish(logPayload) {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (this.sendCmdPromise) {
+                const tsRequest = Date.now();
+                this.logEvent(Object.assign({ message: 'sendCommand:waiting:' }, logPayload));
+                let busyTimedOut = false;
+                const onTimeout = () => {
+                    this.logEvent(Object.assign(Object.assign({ message: 'sendCommand:error:' }, logPayload), { error: 'BUSY timeout', duration: Date.now() - tsRequest }));
+                    busyTimedOut = true;
+                };
+                yield (0, utils_2.waitWithTimeout)(this.sendCmdPromise, this.getBusyTimeout(), onTimeout);
+                this.sendCmdPromise = null;
+                if (busyTimedOut)
+                    throw new Error('BUSY timeout');
+            }
+        });
+    }
+    ensureConnection() {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (!this.isConnected()) {
+                const connected = yield this.connect();
+                if (!connected) {
+                    throw new Error('not connected');
+                }
+            }
+        });
+    }
+}
+exports.default = SerialPortComms;

package/lib/serial/daum/DaumAdapter.d.ts

@@ -33,7 +33,7 @@ export default class DaumAdapter<S extends SerialDeviceSettings, P extends Devic
     performCheck(): Promise<boolean>;
     waitForPrevStartFinished(): Promise<void>;
     start(props?: P): Promise<boolean>;
-    performStart(props?: P, isRelaunch?: boolean): Promise<boolean>;
+    performStart(props?: P, isRelaunch?: boolean, wasPaused?: boolean): Promise<boolean>;
     startUpdatePull(): void;
     stopUpdatePull(): void;
     connect(): Promise<boolean>;

package/lib/serial/daum/DaumAdapter.js

@@ -112,9 +112,10 @@ class DaumAdapter extends adapter_1.SerialIncyclistDevice {
         const _super = Object.create(null, {
             pause: { get: () => super.pause }
         });
+        var _a;
         return __awaiter(this, void 0, void 0, function* () {
             const paused = yield _super.pause.call(this);
-            this.comms.pauseLogging();
+            (_a = this.comms) === null || _a === void 0 ? void 0 : _a.pauseLogging();
             return paused;
         });
     }
@@ -122,9 +123,10 @@ class DaumAdapter extends adapter_1.SerialIncyclistDevice {
         const _super = Object.create(null, {
             resume: { get: () => super.resume }
         });
+        var _a;
         return __awaiter(this, void 0, void 0, function* () {
             const resumed = yield _super.resume.call(this);
-            this.comms.resumeLogging();
+            (_a = this.comms) === null || _a === void 0 ? void 0 : _a.resumeLogging();
             return resumed;
         });
     }
@@ -178,16 +180,20 @@ class DaumAdapter extends adapter_1.SerialIncyclistDevice {
         });
     }
     start(props) {
+        var _a;
         return __awaiter(this, void 0, void 0, function* () {
             yield this.waitForPrevCheckFinished();
             yield this.waitForPrevStartFinished();
             const isRelaunch = this.started;
             const message = isRelaunch ? 'relaunch of device' : 'initial start of device';
-            this.logEvent({ message });
+            (_a = this.logger) === null || _a === void 0 ? void 0 : _a.logEvent({ message });
             try {
-                if (isRelaunch && this.isPaused())
+                let wasPaused = false;
+                if (isRelaunch && this.isPaused()) {
                     this.resume();
-                this.startPromise = this.performStart(props, isRelaunch).then((started) => __awaiter(this, void 0, void 0, function* () {
+                    wasPaused = true;
+                }
+                this.startPromise = this.performStart(props, isRelaunch, wasPaused).then((started) => __awaiter(this, void 0, void 0, function* () {
                     if (!started) {
                         this.logEvent({ message: 'start result: not started' });
                         this.started = false;
@@ -198,7 +204,7 @@ class DaumAdapter extends adapter_1.SerialIncyclistDevice {
                             const deviceInfo = yield this.getDeviceInfo();
                             this.logEvent({ message: 'device info', deviceInfo });
                         }
-                        catch (_a) { }
+                        catch (_b) { }
                     }
                     this.logEvent({ message: 'start result: success' });
                     this.started = true;
@@ -216,7 +222,7 @@ class DaumAdapter extends adapter_1.SerialIncyclistDevice {
             }
         });
     }
-    performStart(props, isRelaunch = false) {
+    performStart(props, isRelaunch = false, wasPaused = false) {
         throw new Error('Method not implemented.');
     }
     startUpdatePull() {

package/lib/serial/daum/classic/PROTOCOL_NAME.d.ts

@@ -0,0 +1,2 @@
+export declare const PROTOCOL_NAME = "Daum Classic";
+export declare const DEFAULT_GEAR = 10;

package/lib/serial/daum/classic/PROTOCOL_NAME.js

@@ -0,0 +1,5 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.DEFAULT_GEAR = exports.PROTOCOL_NAME = void 0;
+exports.PROTOCOL_NAME = "Daum Classic";
+exports.DEFAULT_GEAR = 10;

package/lib/serial/daum/classic/adapter.d.ts

@@ -14,7 +14,7 @@ export default class DaumClassicAdapter extends DaumAdapter<SerialDeviceSettings
     setName(name: string): void;
     getProtocolName(): string;
     performCheck(): Promise<boolean>;
-    performStart(props?: DaumClassicProperties, isRelaunch?: boolean): Promise<boolean>;
+    performStart(props?: DaumClassicProperties, isRelaunch?: boolean, wasPaused?: boolean): Promise<boolean>;
     getCurrentBikeData(): Promise<IncyclistBikeData>;
     getDeviceInfo(): Promise<any>;
 }

package/lib/serial/daum/classic/adapter.js

@@ -92,7 +92,7 @@ class DaumClassicAdapter extends DaumAdapter_1.default {
             });
         });
     }
-    performStart(props = {}, isRelaunch = false) {
+    performStart(props = {}, isRelaunch = false, wasPaused = false) {
         this.stopUpdatePull();
         this.setBikeProps(props);
         const user = this.getUser();

package/lib/serial/daum/premium/adapter.d.ts

@@ -20,7 +20,7 @@ export default class DaumPremiumAdapter extends DaumAdapter<SerialDeviceSettings
     performCheck(): Promise<boolean>;
     getStartRetries(): number;
     getStartRetryTimeout(): number;
-    performStart(props?: DaumPremiumDeviceProperties, _isRelaunch?: boolean): Promise<boolean>;
+    performStart(props?: DaumPremiumDeviceProperties, _isRelaunch?: boolean, wasPaused?: boolean): Promise<boolean>;
     requiresProgramUpload(): boolean;
     getCurrentBikeData(): Promise<IncyclistBikeData>;
     getDeviceInfo(): Promise<any>;

package/lib/serial/daum/premium/adapter.js

@@ -122,14 +122,19 @@ class DaumPremiumAdapter extends DaumAdapter_1.default {
     getStartRetryTimeout() {
         return START_RETRY_TIMEOUT;
     }
-    performStart(props = {}, _isRelaunch = false) {
+    performStart(props = {}, _isRelaunch = false, wasPaused = false) {
         return __awaiter(this, void 0, void 0, function* () {
             this.setBikeProps(props);
             this.initData();
-            yield this.stop();
+            if (!wasPaused)
+                yield this.stop();
             var info = {};
             yield (0, utils_1.runWithRetries)(() => __awaiter(this, void 0, void 0, function* () {
                 try {
+                    if (wasPaused) {
+                        info.deviceType = 'Resumed';
+                        info.version = "Resumed";
+                    }
                     info.connected = yield this.connect();
                     if (!info.connected)
                         throw new Error('not connected');

package/lib/serial/serial-interface.d.ts

@@ -0,0 +1,36 @@
+/// <reference types="node" />
+/// <reference types="node" />
+import EventEmitter from "events";
+import { BindingInterface } from "@serialport/bindings-interface";
+import { SerialPortStream } from '@serialport/stream';
+import { SerialDeviceSettings, SerialScannerProps, PortMapping, SerialInterfaceProps } from "./types";
+import { IncyclistInterface } from "../types";
+import { EventLogger } from "gd-eventlog";
+export default class SerialInterface extends EventEmitter implements IncyclistInterface {
+    ifaceName: string;
+    binding: BindingInterface;
+    ports: PortMapping[];
+    isScanning: boolean;
+    isStopScanRequested: boolean;
+    scanEvents: EventEmitter;
+    logger: EventLogger;
+    toScan: NodeJS.Timeout;
+    connected: boolean;
+    inUse: string[];
+    static _instances: SerialInterface[];
+    static getInstance(props: SerialInterfaceProps): SerialInterface;
+    static _add(instance: SerialInterface): void;
+    constructor(props: SerialInterfaceProps);
+    logEvent(event: any): void;
+    setBinding(binding: BindingInterface): void;
+    getName(): string;
+    isConnected(): boolean;
+    setInUse(path: string): void;
+    releaseInUse(path: string): void;
+    connect(): Promise<boolean>;
+    disconnect(): Promise<boolean>;
+    openPort(path: string): Promise<SerialPortStream | null>;
+    closePort(path: string): Promise<Boolean>;
+    scan(props: SerialScannerProps): Promise<SerialDeviceSettings[]>;
+    stopScan(): Promise<boolean>;
+}