incyclist-devices 3.0.25 → 3.0.26

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

@@ -253,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 ?? {};
@@ -288,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/esm/ble/base/adapter.js

@@ -248,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 ?? {};
@@ -283,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/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/package.json

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