incyclist-devices 2.1.15 → 2.1.18

package/lib/interfaces.d.ts

@@ -0,0 +1,7 @@
+import { InterfaceProps } from "./types/interface";
+import { SerialInterface } from "./serial";
+import AntInterface from "./antv2/ant-interface";
+import { BleInterface } from "./ble";
+export default class InterfaceFactory {
+    static create(ifaceName: string, props?: InterfaceProps): AntInterface | BleInterface | SerialInterface;
+}

package/lib/interfaces.js

@@ -0,0 +1,27 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const serial_1 = require("./serial");
+const ant_interface_1 = __importDefault(require("./antv2/ant-interface"));
+const device_1 = require("./types/device");
+const ble_1 = require("./ble");
+class InterfaceFactory {
+    static create(ifaceName, props) {
+        switch (ifaceName) {
+            case device_1.INTERFACE.SERIAL:
+            case device_1.INTERFACE.TCPIP:
+                const serialProps = props;
+                serialProps.ifaceName = ifaceName;
+                return serial_1.SerialInterface.getInstance(serialProps);
+            case device_1.INTERFACE.ANT:
+                const antProps = props;
+                return ant_interface_1.default.getInstance(antProps);
+            case device_1.INTERFACE.BLE:
+                const bleProps = props;
+                return ble_1.BleInterface.getInstance(bleProps);
+        }
+    }
+}
+exports.default = InterfaceFactory;

package/lib/serial/SinglePathScanner.d.ts

@@ -0,0 +1,17 @@
+import { SerialDeviceSettings } from './adapter';
+import { EventLogger } from "gd-eventlog";
+import { SerialScannerProps } from "./types";
+import SerialInterface from "./serial-interface";
+export declare class SinglePathScanner {
+    path: string;
+    serial: SerialInterface;
+    result: SerialDeviceSettings;
+    isScanning: boolean;
+    props: SerialScannerProps;
+    logger: EventLogger;
+    isFound: boolean;
+    constructor(path: string, serial: SerialInterface, props: SerialScannerProps);
+    logEvent(event: any): void;
+    onStopRequest(resolve: any): Promise<void>;
+    scan(): Promise<SerialDeviceSettings | undefined>;
+}

package/lib/serial/SinglePathScanner.js

@@ -0,0 +1,87 @@
+"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());
+    });
+};
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.SinglePathScanner = void 0;
+const gd_eventlog_1 = require("gd-eventlog");
+const utils_1 = require("../utils/utils");
+const adapter_factory_1 = __importDefault(require("./adapter-factory"));
+const types_1 = require("./types");
+class SinglePathScanner {
+    constructor(path, serial, props) {
+        this.path = path;
+        this.serial = serial;
+        this.result = undefined;
+        this.isScanning = false;
+        this.isFound = false;
+        this.props = props;
+        this.logger = props.logger || new gd_eventlog_1.EventLogger('SerialScanner');
+    }
+    logEvent(event) {
+        if (this.logger) {
+            this.logger.logEvent(event);
+        }
+        const w = global.window;
+        if ((w === null || w === void 0 ? void 0 : w.DEVICE_DEBUG) || process.env.BLE_DEBUG) {
+            console.log('~~~ SerialScanner', event);
+        }
+    }
+    onStopRequest(resolve) {
+        return __awaiter(this, void 0, void 0, function* () {
+            this.logEvent({ message: 'stopping scan', path: this.path });
+            if (!this.isFound)
+                yield this.serial.closePort(this.path);
+            this.isScanning = false;
+            resolve(this.result);
+        });
+    }
+    scan() {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (this.isScanning)
+                return;
+            this.isScanning = true;
+            return new Promise((resolve, reject) => __awaiter(this, void 0, void 0, function* () {
+                this.logEvent({ message: 'starting scan', path: this.path, interface: this.serial.getName() });
+                this.serial.scanEvents.on('timeout', () => this.onStopRequest(resolve));
+                this.serial.scanEvents.on('stop', () => this.onStopRequest(resolve));
+                let found = false;
+                while (!found && this.isScanning) {
+                    try {
+                        const { protocol } = this.props;
+                        let host, port;
+                        if (this.serial.getName() === types_1.SerialInterfaceType.TCPIP) {
+                            [host, port] = this.path.split(':');
+                        }
+                        else {
+                            port = this.path;
+                        }
+                        const adapterSettings = { interface: this.serial.getName(), host, port, protocol };
+                        const adapter = adapter_factory_1.default.getInstance().createInstance(adapterSettings);
+                        found = yield adapter.check();
+                        if (found) {
+                            this.isFound = true;
+                            const name = adapter.getName();
+                            resolve(Object.assign(Object.assign({}, adapterSettings), { name }));
+                        }
+                        yield (0, utils_1.sleep)(100);
+                    }
+                    catch (err) {
+                        this.logEvent({ message: 'error', fn: 'scan()', error: err.message || err, stack: err.stack });
+                        yield (0, utils_1.sleep)(100);
+                    }
+                }
+            }));
+        });
+    }
+}
+exports.SinglePathScanner = SinglePathScanner;

package/lib/serial/adapter-factory.d.ts

@@ -0,0 +1,14 @@
+import { DeviceProperties } from '../types';
+import { SerialIncyclistDevice } from './adapter';
+import { SerialDeviceSettings } from "./types";
+export default class SerialAdapterFactory {
+    static _instance: SerialAdapterFactory;
+    adapters: Array<{
+        protocol: string;
+        AdapterClass: typeof SerialIncyclistDevice<DeviceProperties>;
+    }>;
+    static getInstance(): SerialAdapterFactory;
+    constructor();
+    registerAdapter(protocol: string, AdapterClass: typeof SerialIncyclistDevice<DeviceProperties>): void;
+    createInstance(props: SerialDeviceSettings, settings?: any): SerialIncyclistDevice<DeviceProperties>;
+}

package/lib/serial/adapter-factory.js

@@ -0,0 +1,30 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+class SerialAdapterFactory {
+    static getInstance() {
+        if (!SerialAdapterFactory._instance)
+            SerialAdapterFactory._instance = new SerialAdapterFactory();
+        return SerialAdapterFactory._instance;
+    }
+    constructor() {
+        this.adapters = [];
+    }
+    registerAdapter(protocol, AdapterClass) {
+        const existing = this.adapters.findIndex(a => a.protocol === protocol);
+        if (existing !== -1)
+            this.adapters[existing].AdapterClass = AdapterClass;
+        else
+            this.adapters.push({ protocol, AdapterClass });
+    }
+    createInstance(props, settings) {
+        const { protocol } = props;
+        if (!protocol)
+            return null;
+        const adapter = this.adapters.find(a => a.protocol === protocol);
+        if (!adapter)
+            return null;
+        const { AdapterClass } = adapter;
+        return new AdapterClass(props, settings);
+    }
+}
+exports.default = SerialAdapterFactory;

package/lib/serial/adapter.d.ts

@@ -0,0 +1,17 @@
+import IncyclistDevice from "../base/adpater";
+import { DeviceProperties } from "../types";
+import SerialInterface from "./base/serial-interface";
+import { SerialDeviceSettings } from "./types";
+export declare class SerialIncyclistDevice<P extends DeviceProperties> extends IncyclistDevice<P> {
+    pullFrequency: number;
+    check(): Promise<boolean>;
+    constructor(settings: SerialDeviceSettings, props?: P);
+    isEqual(settings: SerialDeviceSettings): boolean;
+    getPort(): string;
+    getUniqueName(): string;
+    getSerialInterface(): SerialInterface;
+    getInterface(): string;
+    setMaxUpdateFrequency(ms: number): void;
+    setPullFrequency(ms: number): void;
+    getPullFrequency(): number;
+}

package/lib/serial/adapter.js

@@ -0,0 +1,67 @@
+"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());
+    });
+};
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.SerialIncyclistDevice = void 0;
+const adpater_1 = __importDefault(require("../base/adpater"));
+const DEFAULT_PULL_FREQUENCY = 1000;
+class SerialIncyclistDevice extends adpater_1.default {
+    check() {
+        return __awaiter(this, void 0, void 0, function* () { throw new Error('not implemnted'); });
+    }
+    ;
+    constructor(settings, props) {
+        super(settings, props);
+        this.pullFrequency = DEFAULT_PULL_FREQUENCY;
+    }
+    isEqual(settings) {
+        if (settings.interface !== this.getInterface())
+            return false;
+        const s = this.settings;
+        if (settings.protocol !== s.protocol)
+            return false;
+        if (settings.port !== s.port)
+            return false;
+        if (settings.host && (!s.host || s.host !== settings.host))
+            return false;
+        return true;
+    }
+    getPort() {
+        const settings = this.settings;
+        return settings.port;
+    }
+    getUniqueName() {
+        return `${this.getName()} (${this.getPort()})`;
+    }
+    getSerialInterface() {
+        throw new Error('not implemented');
+    }
+    getInterface() {
+        return 'serial';
+    }
+    setMaxUpdateFrequency(ms) {
+        if (ms <= this.pullFrequency)
+            this.updateFrequency = -1;
+        else
+            this.updateFrequency = ms;
+    }
+    setPullFrequency(ms) {
+        this.pullFrequency = ms;
+        if (this.updateFrequency <= this.pullFrequency)
+            this.updateFrequency = -1;
+    }
+    getPullFrequency() {
+        return this.pullFrequency;
+    }
+}
+exports.SerialIncyclistDevice = SerialIncyclistDevice;

package/lib/serial/base/serial-interface.js

@@ -207,8 +207,7 @@ class SerialInterface extends events_1.default {
             do {
                 if (attemptNo === 0)
                     this.logEvent({ message: 'checking for ports', interface: this.ifaceName, port, excludes: this.inUse });
-                else
-                    attemptNo++;
+                attemptNo++;
                 try {
                     if (isTcpip) {
                         const _binding = binding;

package/lib/serial/comm.d.ts

@@ -0,0 +1,7 @@
+import { EventLogger } from "gd-eventlog";
+import SerialInterface from "./serial-interface";
+export type SerialCommProps = {
+    serial: SerialInterface;
+    path: string;
+    logger?: EventLogger;
+};

package/lib/serial/comm.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/lib/serial/comms.d.ts

@@ -0,0 +1,62 @@
+/// <reference types="node" />
+import { EventLogger } from "gd-eventlog";
+import SerialInterface from "./base/serial-interface";
+import { SerialCommProps } from "./types";
+import { SerialPortStream } from "@serialport/stream";
+import { Queue } from "../utils/utils";
+export type ConnectionState = 'Connecting' | 'Connected' | 'Disconnected' | 'Disconnecting';
+export type Request = {
+    logString?: string;
+    isBinary?: boolean;
+};
+export type Response = {};
+export interface CommsState {
+    data?: Queue<Response>;
+}
+export default class SerialPortComms<T extends CommsState, C extends Request, R extends Response> {
+    logger: EventLogger;
+    serial: SerialInterface;
+    protected path: string;
+    protected props: SerialCommProps;
+    protected sp: SerialPortStream;
+    protected connectState: ConnectionState;
+    protected connectPromise: Promise<SerialPortStream>;
+    protected disconnectPromise: Promise<boolean>;
+    protected writePromise: Promise<void>;
+    protected sendCmdPromise: Promise<R>;
+    protected actualBikeType?: string;
+    protected recvState: T;
+    protected isLoggingPaused: boolean;
+    constructor(props: SerialCommProps);
+    getBusyTimeout(): number;
+    getDefaultLoggerName(): string;
+    getInitialCommsState(): T;
+    validatePath(path: string): string;
+    getInterface(): string;
+    getPort(): string;
+    isConnected(): boolean;
+    pauseLogging(): void;
+    resumeLogging(): void;
+    logEvent(e: any): void;
+    connect(): Promise<boolean>;
+    onConnected(): void;
+    portFlush(): void;
+    portPipe(destination: any, options?: any): any;
+    portUnpipe(destination?: any): void;
+    closePort(): Promise<boolean>;
+    resetState(isDisconnected?: boolean): void;
+    cleanupPort(isDisconnected?: boolean): void;
+    close(): Promise<boolean>;
+    flush(): Promise<void>;
+    onPortClose(): Promise<void>;
+    onPortError(error: Error): Promise<void>;
+    isSending(): boolean;
+    rejectCurrent(error: Error): void;
+    getTimeoutValue(): number;
+    onData(data: any, depth?: number): Promise<void>;
+    send(command: C): Promise<R>;
+    portWrite(buffer: Buffer): Promise<void>;
+    write(buffer: Buffer): Promise<void>;
+    ensurePrevCmdFinish(logPayload: any): Promise<void>;
+    ensureConnection(): Promise<void>;
+}