incyclist-devices 3.0.24 → 3.0.26

package/lib/cjs/ble/base/adapter.js

@@ -55,7 +55,7 @@ class BleAdapter extends adpater_js_1.default {
             const info = peripheral.getInfo();
             const settings = { ...this.settings };
             settings.id = settings.id ?? info.id;
-            settings.address = settings.address ?? info.address;
+            settings.address = info.address ?? settings.address;
             settings.name = settings.name ?? info.name;
             this.settings = settings;
         }
@@ -77,11 +77,13 @@ class BleAdapter extends adpater_js_1.default {
         if (as.profile || settings.profile) {
             return (as.protocol === settings.protocol && as.profile === settings.profile && as.name === settings.name);
         }
-        else {
-            return (as.protocol === settings.protocol && ((as.name && settings.name && as.name === settings.name) ||
-                (as.address && settings.address && as.address === settings.address) ||
-                (as.id && settings.id && as.id === settings.id)));
-        }
+        if (as.protocol !== settings.protocol)
+            return false;
+        if (as.id && settings.id)
+            return as.id === settings.id;
+        if (as.address && settings.address)
+            return as.address === settings.address;
+        return !!(as.name && settings.name && as.name === settings.name);
     }
     isSame(adapter) {
         return this.isEqual(adapter.getSettings());
@@ -251,6 +253,8 @@ class BleAdapter extends adpater_js_1.default {
     }
     async initControl(_props) {
     }
+    async initControlBestEffort(_props) {
+    }
     getStartLogProps(props) {
         const capabilities = this.props?.capabilities;
         const { user, userWeight, bikeWeight, timeout, wheelDiameter, restart, scanOnly } = props ?? {};
@@ -286,11 +290,16 @@ class BleAdapter extends adpater_js_1.default {
                 this.stopped = true;
                 return false;
             }
-            await this.waitForInitialData(timeout);
             await this.checkCapabilities();
             const skipControl = this.props.capabilities && !this.props.capabilities.includes(index_js_1.IncyclistCapability.Control);
-            if (this.hasCapability(index_js_1.IncyclistCapability.Control) && !skipControl)
+            const isControllable = this.hasCapability(index_js_1.IncyclistCapability.Control) && !skipControl;
+            if (isControllable) {
                 await this.initControl(startProps);
+            }
+            else {
+                await this.initControlBestEffort(startProps);
+            }
+            await this.waitForInitialData(timeout);
             this.stopped = false;
             this.started = true;
             if (wasPaused)

package/lib/cjs/ble/fm/adapter.js

@@ -12,6 +12,7 @@ const adapter_js_1 = __importDefault(require("../base/adapter.js"));
 const consts_js_1 = require("./consts.js");
 const index_js_1 = require("../../types/index.js");
 const utils_js_1 = require("../../utils/utils.js");
+const task_js_1 = require("../../utils/task.js");
 const index_js_2 = require("../zwift/play/index.js");
 const index_js_3 = require("../../features/index.js");
 const fm_resistance_js_1 = __importDefault(require("../../modes/fm-resistance.js"));
@@ -21,6 +22,7 @@ class BleFmAdapter extends adapter_js_1.default {
     distanceInternal = 0;
     connectPromise;
     requestControlRetryDelay = 1000;
+    requestControlTimeout = 10000;
     promiseSendUpdate;
     zwiftPlay;
     isHubInitialized = false;
@@ -168,8 +170,36 @@ class BleFmAdapter extends adapter_js_1.default {
         if (!this.hasCapability(index_js_1.IncyclistCapability.Control))
             return;
         await this.establishControl();
+        await this.attemptStartRequest();
         await this.sendInitialRequest();
     }
+    async initControlBestEffort(_startProps) {
+        if (!this.isStarting())
+            return;
+        this.setConstants();
+        try {
+            const hasControl = await this.getSensor().requestControl();
+            if (hasControl) {
+                this.logEvent({ message: 'control granted (downgraded device)', device: this.getName(), interface: this.getInterface() });
+                await this.attemptStartRequest();
+            }
+            else {
+                this.logEvent({ message: 'could not establish control (downgraded device, non-fatal)', device: this.getName(), interface: this.getInterface() });
+            }
+        }
+        catch (err) {
+            this.logEvent({ message: 'could not establish control (downgraded device, non-fatal)', device: this.getName(), interface: this.getInterface(), error: err.message });
+        }
+    }
+    async attemptStartRequest() {
+        try {
+            const started = await this.getSensor().startRequest();
+            this.logEvent({ message: started ? 'start request acknowledged' : 'start request not acknowledged (non-fatal)', device: this.getName(), interface: this.getInterface() });
+        }
+        catch (err) {
+            this.logEvent({ message: 'start request failed (non-fatal)', device: this.getName(), interface: this.getInterface(), error: err.message });
+        }
+    }
     setConstants() {
         const mode = this.getCyclingMode();
         const sensor = this.getSensor();
@@ -195,7 +225,7 @@ class BleFmAdapter extends adapter_js_1.default {
         let hasControl = false;
         let tryCnt = 0;
         const sensor = this.getSensor();
-        return new Promise((resolve) => {
+        const controlPromise = new Promise((resolve) => {
             this.startTask.notifyOnStop(() => {
                 resolve(false);
             });
@@ -219,6 +249,18 @@ class BleFmAdapter extends adapter_js_1.default {
             };
             waitUntilControl();
         });
+        const waitTask = new task_js_1.InteruptableTask(controlPromise, {
+            timeout: this.requestControlTimeout,
+            name: 'establishControl',
+            errorOnTimeout: false,
+            log: this.logEvent.bind(this)
+        });
+        const granted = await waitTask.run();
+        if (!granted && this.isStarting()) {
+            this.logEvent({ message: 'could not establish control', device: this.getName(), interface: this.getInterface() });
+            throw new Error('could not establish control');
+        }
+        return granted;
     }
     async sendInitialRequest() {
         const startRequest = this.getCyclingMode().getBikeInitRequest();

package/lib/cjs/ble/fm/sensor.js

@@ -111,9 +111,6 @@ class BleFitnessMachineDevice extends sensor_js_1.TBleSensor {
         }
         if (!this.isSubscribed())
             return false;
-        if (this.features?.setPower === false && this.features?.setSlope === false && this.features?.setResistance === false) {
-            return true;
-        }
         this.logEvent({ message: 'requestControl' });
         this.isCheckingControl = true;
         const data = Buffer.alloc(1);

package/lib/cjs/direct-connect/base/interface.js

@@ -72,14 +72,18 @@ class DirectConnectInterface extends node_events_1.EventEmitter {
             const protocol = this.getProtocol(service);
             const address = service.address;
             const services = service.serviceUUIDs?.map(uuid => (0, index_js_1.beautifyUUID)(uuid, false))?.join(',');
-            return { interface: DirectConnectInterface.INTERFACE_NAME, name, protocol, address, services };
+            const id = service.serialNo || undefined;
+            return { interface: DirectConnectInterface.INTERFACE_NAME, name, protocol, address, services, ...(id ? { id } : {}) };
         }
         catch {
             return null;
         }
     }
     createPeripheralFromSettings(settings) {
-        const info = this.getAll().find(a => a.service.name === settings.name);
+        const bleSettings = settings;
+        const all = this.getAll();
+        const info = (bleSettings.address && all.find(a => a.service.name === settings.name && a.service.address === bleSettings.address))
+            ?? all.find(a => a.service.name === settings.name);
         if (!info?.service)
             return null;
         return this.createPeripheral(info.service);
@@ -247,35 +251,68 @@ class DirectConnectInterface extends node_events_1.EventEmitter {
         const src = source === 'known-device' ? 'known-device' : 'mdns';
         try {
             service.transport = this.getName();
-            const existing = this.find(service);
-            if (existing) {
-                const idx = this.services.indexOf(existing);
-                this.services[idx] = { ts: Date.now(), service };
-                if (src !== 'known-device' && existing.source === 'known-device') {
-                    this.services[idx].source = src;
-                    this.logEvent({ message: 'device re-announced', device: service.name, announcement: service, source });
-                    this.emitDevice(service);
-                }
+            const sameAddress = this.findByNameAndAddress(service.name, service.address);
+            if (sameAddress) {
+                this.refreshSameAddressEntry(sameAddress, service, src, source);
+                return;
+            }
+            const sameName = this.findAllByName(service.name);
+            if (src === 'known-device' && sameName.some(a => a.source !== 'known-device')) {
+                return;
+            }
+            if (sameName.length === 0) {
+                this.announceNewEntry(service, src, source, 'device announced');
+                return;
             }
-            else {
-                this.services.push({ ts: Date.now(), service, source: src });
-                if (!service.serviceUUIDs?.length)
-                    return;
-                this.logEvent({ message: 'device announced', device: service.name, announcement: service, source });
-                this.emitDevice(service);
-                this.matching?.push(service.name);
+            const realEntries = sameName.filter(a => a.source !== 'known-device');
+            if (src !== 'known-device' && realEntries.length >= 1) {
+                this.announceNewEntry(service, src, source, 'device announced (name collision, distinct address)');
+                return;
             }
+            this.reannounceExistingEntry(sameName[0], service, src, source);
         }
         catch (err) {
             this.logError(err, 'addService');
         }
     }
-    find(service) {
-        return this.services.find(a => a.service.name === service.name && a.ts > Date.now() - DC_EXPIRATION_TIMEOUT);
+    refreshSameAddressEntry(sameAddress, service, src, source) {
+        const idx = this.services.indexOf(sameAddress);
+        const wasKnownDevicePlaceholder = sameAddress.source === 'known-device';
+        const nextSource = (wasKnownDevicePlaceholder && src !== 'known-device') ? src : sameAddress.source;
+        this.services[idx] = { ts: Date.now(), service, source: nextSource };
+        if (src !== 'known-device' && wasKnownDevicePlaceholder) {
+            this.logEvent({ message: 'device re-announced', device: service.name, announcement: service, source });
+            this.emitDevice(service);
+        }
+    }
+    announceNewEntry(service, src, source, message) {
+        this.services.push({ ts: Date.now(), service, source: src });
+        if (!service.serviceUUIDs?.length)
+            return;
+        this.logEvent({ message, device: service.name, announcement: service, source });
+        this.emitDevice(service);
+        this.matching?.push(service.name);
+    }
+    reannounceExistingEntry(existing, service, src, source) {
+        const idx = this.services.indexOf(existing);
+        this.services[idx] = { ts: Date.now(), service, source: src };
+        if (src !== 'known-device') {
+            this.logEvent({ message: 'device re-announced', device: service.name, announcement: service, source });
+            this.emitDevice(service);
+        }
+    }
+    findByNameAndAddress(name, address) {
+        return this.services.find(a => a.service.name === name && a.service.address === address && a.ts > Date.now() - DC_EXPIRATION_TIMEOUT);
+    }
+    findAllByName(name) {
+        return this.services.filter(a => a.service.name === name && a.ts > Date.now() - DC_EXPIRATION_TIMEOUT);
     }
     getAll() {
         return this.services.filter(a => a.ts > Date.now() - DC_EXPIRATION_TIMEOUT);
     }
+    hasNameCollision(name) {
+        return this.findAllByName(name).length > 1;
+    }
     setDebug(enabled) {
         this.debug = enabled;
     }

package/lib/esm/ble/base/adapter.js

@@ -50,7 +50,7 @@ export default class BleAdapter extends IncyclistDevice {
             const info = peripheral.getInfo();
             const settings = { ...this.settings };
             settings.id = settings.id ?? info.id;
-            settings.address = settings.address ?? info.address;
+            settings.address = info.address ?? settings.address;
             settings.name = settings.name ?? info.name;
             this.settings = settings;
         }
@@ -72,11 +72,13 @@ export default class BleAdapter extends IncyclistDevice {
         if (as.profile || settings.profile) {
             return (as.protocol === settings.protocol && as.profile === settings.profile && as.name === settings.name);
         }
-        else {
-            return (as.protocol === settings.protocol && ((as.name && settings.name && as.name === settings.name) ||
-                (as.address && settings.address && as.address === settings.address) ||
-                (as.id && settings.id && as.id === settings.id)));
-        }
+        if (as.protocol !== settings.protocol)
+            return false;
+        if (as.id && settings.id)
+            return as.id === settings.id;
+        if (as.address && settings.address)
+            return as.address === settings.address;
+        return !!(as.name && settings.name && as.name === settings.name);
     }
     isSame(adapter) {
         return this.isEqual(adapter.getSettings());
@@ -246,6 +248,8 @@ export default class BleAdapter extends IncyclistDevice {
     }
     async initControl(_props) {
     }
+    async initControlBestEffort(_props) {
+    }
     getStartLogProps(props) {
         const capabilities = this.props?.capabilities;
         const { user, userWeight, bikeWeight, timeout, wheelDiameter, restart, scanOnly } = props ?? {};
@@ -281,11 +285,16 @@ export default class BleAdapter extends IncyclistDevice {
                 this.stopped = true;
                 return false;
             }
-            await this.waitForInitialData(timeout);
             await this.checkCapabilities();
             const skipControl = this.props.capabilities && !this.props.capabilities.includes(IncyclistCapability.Control);
-            if (this.hasCapability(IncyclistCapability.Control) && !skipControl)
+            const isControllable = this.hasCapability(IncyclistCapability.Control) && !skipControl;
+            if (isControllable) {
                 await this.initControl(startProps);
+            }
+            else {
+                await this.initControlBestEffort(startProps);
+            }
+            await this.waitForInitialData(timeout);
             this.stopped = false;
             this.started = true;
             if (wasPaused)

package/lib/esm/ble/fm/adapter.js

@@ -7,6 +7,7 @@ import BleAdapter from '../base/adapter.js';
 import { cRR, cwABike } from './consts.js';
 import { IncyclistCapability } from '../../types/index.js';
 import { sleep } from '../../utils/utils.js';
+import { InteruptableTask } from '../../utils/task.js';
 import { BleZwiftPlaySensor } from '../zwift/play/index.js';
 import { useFeatureToggle } from '../../features/index.js';
 import FMResistanceMode from '../../modes/fm-resistance.js';
@@ -16,6 +17,7 @@ export default class BleFmAdapter extends BleAdapter {
     distanceInternal = 0;
     connectPromise;
     requestControlRetryDelay = 1000;
+    requestControlTimeout = 10000;
     promiseSendUpdate;
     zwiftPlay;
     isHubInitialized = false;
@@ -163,8 +165,36 @@ export default class BleFmAdapter extends BleAdapter {
         if (!this.hasCapability(IncyclistCapability.Control))
             return;
         await this.establishControl();
+        await this.attemptStartRequest();
         await this.sendInitialRequest();
     }
+    async initControlBestEffort(_startProps) {
+        if (!this.isStarting())
+            return;
+        this.setConstants();
+        try {
+            const hasControl = await this.getSensor().requestControl();
+            if (hasControl) {
+                this.logEvent({ message: 'control granted (downgraded device)', device: this.getName(), interface: this.getInterface() });
+                await this.attemptStartRequest();
+            }
+            else {
+                this.logEvent({ message: 'could not establish control (downgraded device, non-fatal)', device: this.getName(), interface: this.getInterface() });
+            }
+        }
+        catch (err) {
+            this.logEvent({ message: 'could not establish control (downgraded device, non-fatal)', device: this.getName(), interface: this.getInterface(), error: err.message });
+        }
+    }
+    async attemptStartRequest() {
+        try {
+            const started = await this.getSensor().startRequest();
+            this.logEvent({ message: started ? 'start request acknowledged' : 'start request not acknowledged (non-fatal)', device: this.getName(), interface: this.getInterface() });
+        }
+        catch (err) {
+            this.logEvent({ message: 'start request failed (non-fatal)', device: this.getName(), interface: this.getInterface(), error: err.message });
+        }
+    }
     setConstants() {
         const mode = this.getCyclingMode();
         const sensor = this.getSensor();
@@ -190,7 +220,7 @@ export default class BleFmAdapter extends BleAdapter {
         let hasControl = false;
         let tryCnt = 0;
         const sensor = this.getSensor();
-        return new Promise((resolve) => {
+        const controlPromise = new Promise((resolve) => {
             this.startTask.notifyOnStop(() => {
                 resolve(false);
             });
@@ -214,6 +244,18 @@ export default class BleFmAdapter extends BleAdapter {
             };
             waitUntilControl();
         });
+        const waitTask = new InteruptableTask(controlPromise, {
+            timeout: this.requestControlTimeout,
+            name: 'establishControl',
+            errorOnTimeout: false,
+            log: this.logEvent.bind(this)
+        });
+        const granted = await waitTask.run();
+        if (!granted && this.isStarting()) {
+            this.logEvent({ message: 'could not establish control', device: this.getName(), interface: this.getInterface() });
+            throw new Error('could not establish control');
+        }
+        return granted;
     }
     async sendInitialRequest() {
         const startRequest = this.getCyclingMode().getBikeInitRequest();

package/lib/esm/ble/fm/sensor.js

@@ -109,9 +109,6 @@ export default class BleFitnessMachineDevice extends TBleSensor {
         }
         if (!this.isSubscribed())
             return false;
-        if (this.features?.setPower === false && this.features?.setSlope === false && this.features?.setResistance === false) {
-            return true;
-        }
         this.logEvent({ message: 'requestControl' });
         this.isCheckingControl = true;
         const data = Buffer.alloc(1);

package/lib/esm/direct-connect/base/interface.js

@@ -69,14 +69,18 @@ export default class DirectConnectInterface extends EventEmitter {
             const protocol = this.getProtocol(service);
             const address = service.address;
             const services = service.serviceUUIDs?.map(uuid => beautifyUUID(uuid, false))?.join(',');
-            return { interface: DirectConnectInterface.INTERFACE_NAME, name, protocol, address, services };
+            const id = service.serialNo || undefined;
+            return { interface: DirectConnectInterface.INTERFACE_NAME, name, protocol, address, services, ...(id ? { id } : {}) };
         }
         catch {
             return null;
         }
     }
     createPeripheralFromSettings(settings) {
-        const info = this.getAll().find(a => a.service.name === settings.name);
+        const bleSettings = settings;
+        const all = this.getAll();
+        const info = (bleSettings.address && all.find(a => a.service.name === settings.name && a.service.address === bleSettings.address))
+            ?? all.find(a => a.service.name === settings.name);
         if (!info?.service)
             return null;
         return this.createPeripheral(info.service);
@@ -244,35 +248,68 @@ export default class DirectConnectInterface extends EventEmitter {
         const src = source === 'known-device' ? 'known-device' : 'mdns';
         try {
             service.transport = this.getName();
-            const existing = this.find(service);
-            if (existing) {
-                const idx = this.services.indexOf(existing);
-                this.services[idx] = { ts: Date.now(), service };
-                if (src !== 'known-device' && existing.source === 'known-device') {
-                    this.services[idx].source = src;
-                    this.logEvent({ message: 'device re-announced', device: service.name, announcement: service, source });
-                    this.emitDevice(service);
-                }
+            const sameAddress = this.findByNameAndAddress(service.name, service.address);
+            if (sameAddress) {
+                this.refreshSameAddressEntry(sameAddress, service, src, source);
+                return;
+            }
+            const sameName = this.findAllByName(service.name);
+            if (src === 'known-device' && sameName.some(a => a.source !== 'known-device')) {
+                return;
+            }
+            if (sameName.length === 0) {
+                this.announceNewEntry(service, src, source, 'device announced');
+                return;
             }
-            else {
-                this.services.push({ ts: Date.now(), service, source: src });
-                if (!service.serviceUUIDs?.length)
-                    return;
-                this.logEvent({ message: 'device announced', device: service.name, announcement: service, source });
-                this.emitDevice(service);
-                this.matching?.push(service.name);
+            const realEntries = sameName.filter(a => a.source !== 'known-device');
+            if (src !== 'known-device' && realEntries.length >= 1) {
+                this.announceNewEntry(service, src, source, 'device announced (name collision, distinct address)');
+                return;
             }
+            this.reannounceExistingEntry(sameName[0], service, src, source);
         }
         catch (err) {
             this.logError(err, 'addService');
         }
     }
-    find(service) {
-        return this.services.find(a => a.service.name === service.name && a.ts > Date.now() - DC_EXPIRATION_TIMEOUT);
+    refreshSameAddressEntry(sameAddress, service, src, source) {
+        const idx = this.services.indexOf(sameAddress);
+        const wasKnownDevicePlaceholder = sameAddress.source === 'known-device';
+        const nextSource = (wasKnownDevicePlaceholder && src !== 'known-device') ? src : sameAddress.source;
+        this.services[idx] = { ts: Date.now(), service, source: nextSource };
+        if (src !== 'known-device' && wasKnownDevicePlaceholder) {
+            this.logEvent({ message: 'device re-announced', device: service.name, announcement: service, source });
+            this.emitDevice(service);
+        }
+    }
+    announceNewEntry(service, src, source, message) {
+        this.services.push({ ts: Date.now(), service, source: src });
+        if (!service.serviceUUIDs?.length)
+            return;
+        this.logEvent({ message, device: service.name, announcement: service, source });
+        this.emitDevice(service);
+        this.matching?.push(service.name);
+    }
+    reannounceExistingEntry(existing, service, src, source) {
+        const idx = this.services.indexOf(existing);
+        this.services[idx] = { ts: Date.now(), service, source: src };
+        if (src !== 'known-device') {
+            this.logEvent({ message: 'device re-announced', device: service.name, announcement: service, source });
+            this.emitDevice(service);
+        }
+    }
+    findByNameAndAddress(name, address) {
+        return this.services.find(a => a.service.name === name && a.service.address === address && a.ts > Date.now() - DC_EXPIRATION_TIMEOUT);
+    }
+    findAllByName(name) {
+        return this.services.filter(a => a.service.name === name && a.ts > Date.now() - DC_EXPIRATION_TIMEOUT);
     }
     getAll() {
         return this.services.filter(a => a.ts > Date.now() - DC_EXPIRATION_TIMEOUT);
     }
+    hasNameCollision(name) {
+        return this.findAllByName(name).length > 1;
+    }
     setDebug(enabled) {
         this.debug = enabled;
     }

package/lib/types/ble/base/adapter.d.ts

@@ -48,6 +48,7 @@ export default class BleAdapter<TDeviceData extends BleDeviceData, TDevice exten
     protected waitForInitialData(startupTimeout: any): Promise<void>;
     protected checkCapabilities(): Promise<void>;
     protected initControl(_props?: BleStartProperties): Promise<void>;
+    protected initControlBestEffort(_props?: BleStartProperties): Promise<void>;
     protected getStartLogProps(props: BleStartProperties): BleStartProperties;
     protected startAdapter(startProps?: BleStartProperties): Promise<boolean>;
     startSensor(): Promise<boolean>;

package/lib/types/ble/fm/adapter.d.ts

@@ -12,6 +12,7 @@ export default class BleFmAdapter extends BleAdapter<IndoorBikeData, BleFitnessM
     protected distanceInternal: number;
     protected connectPromise: Promise<boolean> | undefined;
     protected requestControlRetryDelay: number;
+    protected requestControlTimeout: number;
     protected promiseSendUpdate: Promise<UpdateRequest | void> | undefined;
     protected zwiftPlay: BleZwiftPlaySensor | undefined;
     protected isHubInitialized: boolean;
@@ -28,6 +29,8 @@ export default class BleFmAdapter extends BleAdapter<IndoorBikeData, BleFitnessM
     protected checkResume(): boolean[];
     protected initVirtualShifting(initHub?: boolean): Promise<void>;
     protected initControl(_startProps?: BleStartProperties): Promise<void>;
+    protected initControlBestEffort(_startProps?: BleStartProperties): Promise<void>;
+    protected attemptStartRequest(): Promise<void>;
     protected setConstants(): void;
     protected establishControl(): Promise<boolean>;
     protected sendInitialRequest(): Promise<void>;

package/lib/types/direct-connect/base/interface.d.ts

@@ -62,8 +62,13 @@ export default class DirectConnectInterface extends EventEmitter implements IBle
         name: string;
     }[];
     protected addService(service: MulticastDnsAnnouncement, source?: string): void;
-    protected find(service: MulticastDnsAnnouncement): Announcement;
+    private refreshSameAddressEntry;
+    private announceNewEntry;
+    private reannounceExistingEntry;
+    protected findByNameAndAddress(name: string, address: string): Announcement;
+    protected findAllByName(name: string): Announcement[];
     protected getAll(): Announcement[];
+    hasNameCollision(name: string): boolean;
     setDebug(enabled: boolean): void;
     logEvent(event: any): void;
     logError(err: Error, fn: string, args?: any): void;

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "incyclist-devices",
-    "version": "3.0.24",
+    "version": "3.0.26",
     "scripts": {
         "lint": "eslint . --ext .ts",
         "build": "npm run build:esm && npm run build:cjs",