@microbit/microbit-connection 0.0.0-alpha.1

package/README.md

@@ -0,0 +1,36 @@
+# JavaScript library for micro:bit connections in browsers via USB and Bluetooth
+
+This project is a work in progress. We are extracting WebUSB and Web Bluetooth code from the [micro:bit Python Editor](https://github.com/microbit-foundation/python-editor-v3/) and other projects.
+
+It is intended to be used by other Micro:bit Educational Foundation projects that need to connect to a BBC micro:bit.
+
+The API is not stable and it's not yet recommended that third parties use this project.
+
+## License
+
+This software is under the MIT open source license.
+
+[SPDX-License-Identifier: MIT](LICENSE)
+
+We use dependencies via the NPM registry as specified by the package.json file under common Open Source licenses.
+
+Full details of each package can be found by running `license-checker`:
+
+```bash
+$ npx license-checker --direct --summary --production
+```
+
+Omit the flags as desired to obtain more detail.
+
+## Code of Conduct
+
+Trust, partnership, simplicity and passion are our core values we live and
+breathe in our daily work life and within our projects. Our open-source
+projects are no exception. We have an active community which spans the globe
+and we welcome and encourage participation and contributions to our projects
+by everyone. We work to foster a positive, open, inclusive and supportive
+environment and trust that our community respects the micro:bit code of
+conduct. Please see our [code of conduct](https://microbit.org/safeguarding/)
+which outlines our expectations for all those that participate in our
+community and details on how to report any concerns and what would happen
+should breaches occur.

package/build/accelerometer-service.d.ts

@@ -0,0 +1,17 @@
+import { AccelerometerData } from "./accelerometer";
+import { TypedServiceEventDispatcher } from "./service-events";
+export declare class AccelerometerService {
+    private accelerometerDataCharacteristic;
+    private accelerometerPeriodCharacteristic;
+    private dispatchTypedEvent;
+    private isNotifying;
+    constructor(accelerometerDataCharacteristic: BluetoothRemoteGATTCharacteristic, accelerometerPeriodCharacteristic: BluetoothRemoteGATTCharacteristic, dispatchTypedEvent: TypedServiceEventDispatcher, isNotifying: boolean);
+    static createService(gattServer: BluetoothRemoteGATTServer, dispatcher: TypedServiceEventDispatcher, isNotifying: boolean): Promise<AccelerometerService>;
+    private dataViewToData;
+    getData(): Promise<AccelerometerData>;
+    getPeriod(): Promise<number>;
+    setPeriod(value: number): Promise<void>;
+    private addDataEventListener;
+    startNotifications(): void;
+    stopNotifications(): void;
+}

package/build/accelerometer-service.js

@@ -0,0 +1,84 @@
+import { AccelerometerDataEvent } from "./accelerometer";
+import { profile } from "./bluetooth-profile";
+export class AccelerometerService {
+    constructor(accelerometerDataCharacteristic, accelerometerPeriodCharacteristic, dispatchTypedEvent, isNotifying) {
+        Object.defineProperty(this, "accelerometerDataCharacteristic", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: accelerometerDataCharacteristic
+        });
+        Object.defineProperty(this, "accelerometerPeriodCharacteristic", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: accelerometerPeriodCharacteristic
+        });
+        Object.defineProperty(this, "dispatchTypedEvent", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: dispatchTypedEvent
+        });
+        Object.defineProperty(this, "isNotifying", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: isNotifying
+        });
+        this.addDataEventListener();
+        if (this.isNotifying) {
+            this.startNotifications();
+        }
+    }
+    static async createService(gattServer, dispatcher, isNotifying) {
+        const accelerometerService = await gattServer.getPrimaryService(profile.accelerometer.id);
+        const accelerometerDataCharacteristic = await accelerometerService.getCharacteristic(profile.accelerometer.characteristics.data.id);
+        const accelerometerPeriodCharacteristic = await accelerometerService.getCharacteristic(profile.accelerometer.characteristics.period.id);
+        return new AccelerometerService(accelerometerDataCharacteristic, accelerometerPeriodCharacteristic, dispatcher, isNotifying);
+    }
+    dataViewToData(dataView) {
+        return {
+            x: dataView.getInt16(0, true),
+            y: dataView.getInt16(2, true),
+            z: dataView.getInt16(4, true),
+        };
+    }
+    async getData() {
+        const dataView = await this.accelerometerDataCharacteristic.readValue();
+        return this.dataViewToData(dataView);
+    }
+    async getPeriod() {
+        const dataView = await this.accelerometerPeriodCharacteristic.readValue();
+        return dataView.getUint16(0, true);
+    }
+    async setPeriod(value) {
+        if (value === 0) {
+            // Writing 0 causes the device to crash.
+            return;
+        }
+        // Allowed values: 2, 5, 10, 20, 40, 100, 1000
+        // Values passed are rounded up to the allowed values on device.
+        // Documentation for allowed values looks wrong.
+        // https://lancaster-university.github.io/microbit-docs/resources/bluetooth/bluetooth_profile.html
+        const dataView = new DataView(new ArrayBuffer(2));
+        dataView.setUint16(0, value, true);
+        await this.accelerometerPeriodCharacteristic.writeValueWithoutResponse(dataView);
+    }
+    addDataEventListener() {
+        this.accelerometerDataCharacteristic.addEventListener("characteristicvaluechanged", (event) => {
+            const target = event.target;
+            const data = this.dataViewToData(target.value);
+            this.dispatchTypedEvent("accelerometerdatachanged", new AccelerometerDataEvent(data));
+        });
+    }
+    startNotifications() {
+        this.accelerometerDataCharacteristic.startNotifications();
+        this.isNotifying = true;
+    }
+    stopNotifications() {
+        this.isNotifying = false;
+        this.accelerometerDataCharacteristic.stopNotifications();
+    }
+}
+//# sourceMappingURL=accelerometer-service.js.map

package/build/accelerometer-service.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"accelerometer-service.js","sourceRoot":"","sources":["../lib/accelerometer-service.ts"],"names":[],"mappings":"AAAA,OAAO,EAAqB,sBAAsB,EAAE,MAAM,iBAAiB,CAAC;AAC5E,OAAO,EAAE,OAAO,EAAE,MAAM,qBAAqB,CAAC;AAM9C,MAAM,OAAO,oBAAoB;IAC/B,YACU,+BAAkE,EAClE,iCAAoE,EACpE,kBAA+C,EAC/C,WAAoB;QAH5B;;;;mBAAQ,+BAA+B;WAAmC;QAC1E;;;;mBAAQ,iCAAiC;WAAmC;QAC5E;;;;mBAAQ,kBAAkB;WAA6B;QACvD;;;;mBAAQ,WAAW;WAAS;QAE5B,IAAI,CAAC,oBAAoB,EAAE,CAAC;QAC5B,IAAI,IAAI,CAAC,WAAW,EAAE,CAAC;YACrB,IAAI,CAAC,kBAAkB,EAAE,CAAC;QAC5B,CAAC;IACH,CAAC;IAED,MAAM,CAAC,KAAK,CAAC,aAAa,CACxB,UAAqC,EACrC,UAAuC,EACvC,WAAoB;QAEpB,MAAM,oBAAoB,GAAG,MAAM,UAAU,CAAC,iBAAiB,CAC7D,OAAO,CAAC,aAAa,CAAC,EAAE,CACzB,CAAC;QACF,MAAM,+BAA+B,GACnC,MAAM,oBAAoB,CAAC,iBAAiB,CAC1C,OAAO,CAAC,aAAa,CAAC,eAAe,CAAC,IAAI,CAAC,EAAE,CAC9C,CAAC;QACJ,MAAM,iCAAiC,GACrC,MAAM,oBAAoB,CAAC,iBAAiB,CAC1C,OAAO,CAAC,aAAa,CAAC,eAAe,CAAC,MAAM,CAAC,EAAE,CAChD,CAAC;QACJ,OAAO,IAAI,oBAAoB,CAC7B,+BAA+B,EAC/B,iCAAiC,EACjC,UAAU,EACV,WAAW,CACZ,CAAC;IACJ,CAAC;IAEO,cAAc,CAAC,QAAkB;QACvC,OAAO;YACL,CAAC,EAAE,QAAQ,CAAC,QAAQ,CAAC,CAAC,EAAE,IAAI,CAAC;YAC7B,CAAC,EAAE,QAAQ,CAAC,QAAQ,CAAC,CAAC,EAAE,IAAI,CAAC;YAC7B,CAAC,EAAE,QAAQ,CAAC,QAAQ,CAAC,CAAC,EAAE,IAAI,CAAC;SAC9B,CAAC;IACJ,CAAC;IAED,KAAK,CAAC,OAAO;QACX,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,+BAA+B,CAAC,SAAS,EAAE,CAAC;QACxE,OAAO,IAAI,CAAC,cAAc,CAAC,QAAQ,CAAC,CAAC;IACvC,CAAC;IAED,KAAK,CAAC,SAAS;QACb,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,iCAAiC,CAAC,SAAS,EAAE,CAAC;QAC1E,OAAO,QAAQ,CAAC,SAAS,CAAC,CAAC,EAAE,IAAI,CAAC,CAAC;IACrC,CAAC;IAED,KAAK,CAAC,SAAS,CAAC,KAAa;QAC3B,IAAI,KAAK,KAAK,CAAC,EAAE,CAAC;YAChB,wCAAwC;YACxC,OAAO;QACT,CAAC;QACD,8CAA8C;QAC9C,gEAAgE;QAChE,gDAAgD;QAChD,kGAAkG;QAClG,MAAM,QAAQ,GAAG,IAAI,QAAQ,CAAC,IAAI,WAAW,CAAC,CAAC,CAAC,CAAC,CAAC;QAClD,QAAQ,CAAC,SAAS,CAAC,CAAC,EAAE,KAAK,EAAE,IAAI,CAAC,CAAC;QACnC,MAAM,IAAI,CAAC,iCAAiC,CAAC,yBAAyB,CACpE,QAAQ,CACT,CAAC;IACJ,CAAC;IAEO,oBAAoB;QAC1B,IAAI,CAAC,+BAA+B,CAAC,gBAAgB,CACnD,4BAA4B,EAC5B,CAAC,KAAY,EAAE,EAAE;YACf,MAAM,MAAM,GAAG,KAAK,CAAC,MAAkC,CAAC;YACxD,MAAM,IAAI,GAAG,IAAI,CAAC,cAAc,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;YAC/C,IAAI,CAAC,kBAAkB,CACrB,0BAA0B,EAC1B,IAAI,sBAAsB,CAAC,IAAI,CAAC,CACjC,CAAC;QACJ,CAAC,CACF,CAAC;IACJ,CAAC;IAED,kBAAkB;QAChB,IAAI,CAAC,+BAA+B,CAAC,kBAAkB,EAAE,CAAC;QAC1D,IAAI,CAAC,WAAW,GAAG,IAAI,CAAC;IAC1B,CAAC;IAED,iBAAiB;QACf,IAAI,CAAC,WAAW,GAAG,KAAK,CAAC;QACzB,IAAI,CAAC,+BAA+B,CAAC,iBAAiB,EAAE,CAAC;IAC3D,CAAC;CACF"}

package/build/accelerometer.d.ts

@@ -0,0 +1,9 @@
+export interface AccelerometerData {
+    x: number;
+    y: number;
+    z: number;
+}
+export declare class AccelerometerDataEvent extends Event {
+    readonly data: AccelerometerData;
+    constructor(data: AccelerometerData);
+}

package/build/accelerometer.js

@@ -0,0 +1,12 @@
+export class AccelerometerDataEvent extends Event {
+    constructor(data) {
+        super("accelerometerdatachanged");
+        Object.defineProperty(this, "data", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: data
+        });
+    }
+}
+//# sourceMappingURL=accelerometer.js.map

package/build/accelerometer.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"accelerometer.js","sourceRoot":"","sources":["../lib/accelerometer.ts"],"names":[],"mappings":"AAMA,MAAM,OAAO,sBAAuB,SAAQ,KAAK;IAC/C,YAA4B,IAAuB;QACjD,KAAK,CAAC,0BAA0B,CAAC,CAAC;QADxB;;;;mBAAgB,IAAI;WAAmB;IAEnD,CAAC;CACF"}

package/build/async-util.d.ts

@@ -0,0 +1,13 @@
+/**
+ * (c) 2021, Micro:bit Educational Foundation and contributors
+ *
+ * SPDX-License-Identifier: MIT
+ */
+export declare class TimeoutError extends Error {
+}
+/**
+ * Utility to time out an action after a delay.
+ *
+ * The action cannot be cancelled; it may still proceed after the timeout.
+ */
+export declare function withTimeout<T>(actionPromise: Promise<T>, timeout: number): Promise<T>;

package/build/async-util.js

@@ -0,0 +1,22 @@
+/**
+ * (c) 2021, Micro:bit Educational Foundation and contributors
+ *
+ * SPDX-License-Identifier: MIT
+ */
+export class TimeoutError extends Error {
+}
+/**
+ * Utility to time out an action after a delay.
+ *
+ * The action cannot be cancelled; it may still proceed after the timeout.
+ */
+export async function withTimeout(actionPromise, timeout) {
+    const timeoutPromise = new Promise((_, reject) => {
+        setTimeout(() => {
+            reject(new TimeoutError());
+        }, timeout);
+    });
+    // timeoutPromise never resolves so result must be from action
+    return Promise.race([actionPromise, timeoutPromise]);
+}
+//# sourceMappingURL=async-util.js.map

package/build/async-util.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"async-util.js","sourceRoot":"","sources":["../lib/async-util.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AACH,MAAM,OAAO,YAAa,SAAQ,KAAK;CAAG;AAE1C;;;;GAIG;AACH,MAAM,CAAC,KAAK,UAAU,WAAW,CAC/B,aAAyB,EACzB,OAAe;IAEf,MAAM,cAAc,GAAG,IAAI,OAAO,CAAC,CAAC,CAAC,EAAE,MAAM,EAAE,EAAE;QAC/C,UAAU,CAAC,GAAG,EAAE;YACd,MAAM,CAAC,IAAI,YAAY,EAAE,CAAC,CAAC;QAC7B,CAAC,EAAE,OAAO,CAAC,CAAC;IACd,CAAC,CAAC,CAAC;IACH,8DAA8D;IAC9D,OAAO,OAAO,CAAC,IAAI,CAAC,CAAC,aAAa,EAAE,cAAc,CAAC,CAAe,CAAC;AACrE,CAAC"}

package/build/bluetooth-device-wrapper.d.ts

@@ -0,0 +1,39 @@
+/**
+ * (c) 2023, Center for Computational Thinking and Design at Aarhus University and contributors
+ *
+ * SPDX-License-Identifier: MIT
+ */
+import { AccelerometerService } from "./accelerometer-service";
+import { BoardVersion } from "./device";
+import { Logging } from "./logging";
+import { TypedServiceEventDispatcher } from "./service-events";
+export declare class BluetoothDeviceWrapper {
+    readonly device: BluetoothDevice;
+    private logging;
+    private dispatchTypedEvent;
+    private duringExplicitConnectDisconnect;
+    private gattConnectPromise;
+    private disconnectPromise;
+    private connecting;
+    private isReconnect;
+    private reconnectReadyPromise;
+    private accelerometerService;
+    boardVersion: BoardVersion | undefined;
+    serviceListeners: {
+        accelerometerdatachanged: {
+            notifying: boolean;
+            service: () => Promise<AccelerometerService>;
+        };
+    };
+    constructor(device: BluetoothDevice, logging: Logging, dispatchTypedEvent: TypedServiceEventDispatcher);
+    connect(): Promise<void>;
+    disconnect(): Promise<void>;
+    private disconnectInternal;
+    reconnect(): Promise<void>;
+    handleDisconnectEvent: () => Promise<void>;
+    private assertGattServer;
+    private getBoardVersion;
+    getAccelerometerService(): Promise<AccelerometerService>;
+    private disposeServices;
+}
+export declare const createBluetoothDeviceWrapper: (device: BluetoothDevice, logging: Logging, dispatchTypedEvent: TypedServiceEventDispatcher) => Promise<BluetoothDeviceWrapper | undefined>;

package/build/bluetooth-device-wrapper.js

@@ -0,0 +1,316 @@
+/**
+ * (c) 2023, Center for Computational Thinking and Design at Aarhus University and contributors
+ *
+ * SPDX-License-Identifier: MIT
+ */
+import { AccelerometerService } from "./accelerometer-service";
+import { profile } from "./bluetooth-profile";
+import { NullLogging } from "./logging";
+const deviceIdToWrapper = new Map();
+const connectTimeoutDuration = 10000;
+function findPlatform() {
+    const navigator = window.navigator;
+    const platform = navigator.userAgentData?.platform;
+    if (platform) {
+        return platform;
+    }
+    const isAndroid = /android/.test(navigator.userAgent.toLowerCase());
+    return isAndroid ? "android" : navigator.platform ?? "unknown";
+}
+const platform = findPlatform();
+const isWindowsOS = platform && /^Win/.test(platform);
+export class BluetoothDeviceWrapper {
+    constructor(device, logging = new NullLogging(), dispatchTypedEvent) {
+        Object.defineProperty(this, "device", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: device
+        });
+        Object.defineProperty(this, "logging", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: logging
+        });
+        Object.defineProperty(this, "dispatchTypedEvent", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: dispatchTypedEvent
+        });
+        // Used to avoid automatic reconnection during user triggered connect/disconnect
+        // or reconnection itself.
+        Object.defineProperty(this, "duringExplicitConnectDisconnect", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: 0
+        });
+        // On ChromeOS and Mac there's no timeout and no clear way to abort
+        // device.gatt.connect(), so we accept that sometimes we'll still
+        // be trying to connect when we'd rather not be. If it succeeds when
+        // we no longer intend to be connected then we disconnect at that
+        // point. If we try to connect when a previous connection attempt is
+        // still around then we wait for it for our timeout period.
+        //
+        // On Windows it times out after 7s.
+        // https://bugs.chromium.org/p/chromium/issues/detail?id=684073
+        Object.defineProperty(this, "gattConnectPromise", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: void 0
+        });
+        Object.defineProperty(this, "disconnectPromise", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: void 0
+        });
+        Object.defineProperty(this, "connecting", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: false
+        });
+        Object.defineProperty(this, "isReconnect", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: false
+        });
+        Object.defineProperty(this, "reconnectReadyPromise", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: void 0
+        });
+        Object.defineProperty(this, "accelerometerService", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: void 0
+        });
+        Object.defineProperty(this, "boardVersion", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: void 0
+        });
+        Object.defineProperty(this, "serviceListeners", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: {
+                accelerometerdatachanged: {
+                    notifying: false,
+                    service: this.getAccelerometerService,
+                },
+            }
+        });
+        Object.defineProperty(this, "handleDisconnectEvent", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: async () => {
+                // this.outputWriteQueue = { busy: false, queue: [] };
+                try {
+                    if (!this.duringExplicitConnectDisconnect) {
+                        this.logging.log("Bluetooth GATT disconnected... automatically trying reconnect");
+                        // stateOnReconnectionAttempt();
+                        this.disposeServices();
+                        await this.reconnect();
+                    }
+                    else {
+                        this.logging.log("Bluetooth GATT disconnect ignored during explicit disconnect");
+                    }
+                }
+                catch (e) {
+                    this.logging.error("Bluetooth connect triggered by disconnect listener failed", e);
+                }
+            }
+        });
+        device.addEventListener("gattserverdisconnected", this.handleDisconnectEvent);
+    }
+    async connect() {
+        this.logging.event({
+            type: this.isReconnect ? "Reconnect" : "Connect",
+            message: "Bluetooth connect start",
+        });
+        if (this.duringExplicitConnectDisconnect) {
+            this.logging.log("Skipping connect attempt when one is already in progress");
+            // Wait for the gattConnectPromise while showing a "connecting" dialog.
+            // If the user clicks disconnect while the automatic reconnect is in progress,
+            // then clicks reconnect, we need to wait rather than return immediately.
+            await this.gattConnectPromise;
+            return;
+        }
+        this.duringExplicitConnectDisconnect++;
+        if (this.device.gatt === undefined) {
+            throw new Error("BluetoothRemoteGATTServer for micro:bit device is undefined");
+        }
+        try {
+            // A previous connect might have completed in the background as a device was replugged etc.
+            await this.disconnectPromise;
+            this.gattConnectPromise =
+                this.gattConnectPromise ??
+                    this.device.gatt
+                        .connect()
+                        .then(async () => {
+                        // We always do this even if we might immediately disconnect as disconnecting
+                        // without using services causes getPrimaryService calls to hang on subsequent
+                        // reconnect - probably a device-side issue.
+                        this.boardVersion = await this.getBoardVersion();
+                        // This connection could be arbitrarily later when our manual timeout may have passed.
+                        // Do we still want to be connected?
+                        if (!this.connecting) {
+                            this.logging.log("Bluetooth GATT server connect after timeout, triggering disconnect");
+                            this.disconnectPromise = (async () => {
+                                await this.disconnectInternal(false);
+                                this.disconnectPromise = undefined;
+                            })();
+                        }
+                        else {
+                            this.logging.log("Bluetooth GATT server connected when connecting");
+                        }
+                    })
+                        .catch((e) => {
+                        if (this.connecting) {
+                            // Error will be logged by main connect error handling.
+                            throw e;
+                        }
+                        else {
+                            this.logging.error("Bluetooth GATT server connect error after our timeout", e);
+                            return undefined;
+                        }
+                    })
+                        .finally(() => {
+                        this.logging.log("Bluetooth GATT server promise field cleared");
+                        this.gattConnectPromise = undefined;
+                    });
+            this.connecting = true;
+            try {
+                const gattConnectResult = await Promise.race([
+                    this.gattConnectPromise,
+                    new Promise((resolve) => setTimeout(() => resolve("timeout"), connectTimeoutDuration)),
+                ]);
+                if (gattConnectResult === "timeout") {
+                    this.logging.log("Bluetooth GATT server connect timeout");
+                    throw new Error("Bluetooth GATT server connect timeout");
+                }
+            }
+            finally {
+                this.connecting = false;
+            }
+            // Restart notifications for services and characteristics
+            // the user has listened to.
+            for (const serviceListener of Object.values(this.serviceListeners)) {
+                if (serviceListener.notifying) {
+                    serviceListener.service.call(this);
+                }
+            }
+            this.logging.event({
+                type: this.isReconnect ? "Reconnect" : "Connect",
+                message: "Bluetooth connect success",
+            });
+        }
+        catch (e) {
+            this.logging.error("Bluetooth connect error", e);
+            this.logging.event({
+                type: this.isReconnect ? "Reconnect" : "Connect",
+                message: "Bluetooth connect failed",
+            });
+            await this.disconnectInternal(false);
+            throw new Error("Failed to establish a connection!");
+        }
+        finally {
+            this.duringExplicitConnectDisconnect--;
+        }
+    }
+    async disconnect() {
+        return this.disconnectInternal(true);
+    }
+    async disconnectInternal(userTriggered) {
+        this.logging.log(`Bluetooth disconnect ${userTriggered ? "(user triggered)" : "(programmatic)"}`);
+        this.duringExplicitConnectDisconnect++;
+        try {
+            if (this.device.gatt?.connected) {
+                this.device.gatt?.disconnect();
+            }
+        }
+        catch (e) {
+            this.logging.error("Bluetooth GATT disconnect error (ignored)", e);
+            // We might have already lost the connection.
+        }
+        finally {
+            this.disposeServices();
+            this.duringExplicitConnectDisconnect--;
+        }
+        this.reconnectReadyPromise = new Promise((resolve) => setTimeout(resolve, 3_500));
+    }
+    async reconnect() {
+        this.logging.log("Bluetooth reconnect");
+        this.isReconnect = true;
+        if (isWindowsOS) {
+            // On Windows, the micro:bit can take around 3 seconds to respond to gatt.disconnect().
+            // Attempting to reconnect before the micro:bit has responded results in another
+            // gattserverdisconnected event being fired. We then fail to get primaryService on a
+            // disconnected GATT server.
+            await this.reconnectReadyPromise;
+        }
+        await this.connect();
+    }
+    assertGattServer() {
+        if (!this.device.gatt?.connected) {
+            throw new Error("Could not listen to services, no microbit connected!");
+        }
+        return this.device.gatt;
+    }
+    async getBoardVersion() {
+        this.assertGattServer();
+        const serviceMeta = profile.deviceInformation;
+        try {
+            const deviceInfo = await this.assertGattServer().getPrimaryService(serviceMeta.id);
+            const characteristic = await deviceInfo.getCharacteristic(serviceMeta.characteristics.modelNumber.id);
+            const modelNumberBytes = await characteristic.readValue();
+            const modelNumber = new TextDecoder().decode(modelNumberBytes);
+            if (modelNumber.toLowerCase() === "BBC micro:bit".toLowerCase()) {
+                return "V1";
+            }
+            if (modelNumber.toLowerCase().includes("BBC micro:bit v2".toLowerCase())) {
+                return "V2";
+            }
+            throw new Error(`Unexpected model number ${modelNumber}`);
+        }
+        catch (e) {
+            this.logging.error("Could not read model number", e);
+            throw new Error("Could not read model number");
+        }
+    }
+    async getAccelerometerService() {
+        if (!this.accelerometerService) {
+            const gattServer = this.assertGattServer();
+            this.accelerometerService = await AccelerometerService.createService(gattServer, this.dispatchTypedEvent, this.serviceListeners.accelerometerdatachanged.notifying);
+        }
+        return this.accelerometerService;
+    }
+    disposeServices() {
+        this.accelerometerService = undefined;
+    }
+}
+export const createBluetoothDeviceWrapper = async (device, logging, dispatchTypedEvent) => {
+    try {
+        // Reuse our connection objects for the same device as they
+        // track the GATT connect promise that never resolves.
+        const bluetooth = deviceIdToWrapper.get(device.id) ??
+            new BluetoothDeviceWrapper(device, logging, dispatchTypedEvent);
+        deviceIdToWrapper.set(device.id, bluetooth);
+        await bluetooth.connect();
+        return bluetooth;
+    }
+    catch (e) {
+        return undefined;
+    }
+};
+//# sourceMappingURL=bluetooth-device-wrapper.js.map

package/build/bluetooth-device-wrapper.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"bluetooth-device-wrapper.js","sourceRoot":"","sources":["../lib/bluetooth-device-wrapper.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAEH,OAAO,EAAE,oBAAoB,EAAE,MAAM,yBAAyB,CAAC;AAC/D,OAAO,EAAE,OAAO,EAAE,MAAM,qBAAqB,CAAC;AAE9C,OAAO,EAAW,WAAW,EAAE,MAAM,WAAW,CAAC;AAGjD,MAAM,iBAAiB,GAAwC,IAAI,GAAG,EAAE,CAAC;AAEzE,MAAM,sBAAsB,GAAW,KAAK,CAAC;AAE7C,SAAS,YAAY;IACnB,MAAM,SAAS,GAAQ,MAAM,CAAC,SAAS,CAAC;IACxC,MAAM,QAAQ,GAAG,SAAS,CAAC,aAAa,EAAE,QAAQ,CAAC;IACnD,IAAI,QAAQ,EAAE,CAAC;QACb,OAAO,QAAQ,CAAC;IAClB,CAAC;IACD,MAAM,SAAS,GAAG,SAAS,CAAC,IAAI,CAAC,SAAS,CAAC,SAAS,CAAC,WAAW,EAAE,CAAC,CAAC;IACpE,OAAO,SAAS,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,SAAS,CAAC,QAAQ,IAAI,SAAS,CAAC;AACjE,CAAC;AACD,MAAM,QAAQ,GAAG,YAAY,EAAE,CAAC;AAChC,MAAM,WAAW,GAAG,QAAQ,IAAI,MAAM,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;AAEtD,MAAM,OAAO,sBAAsB;IA6BjC,YACkB,MAAuB,EAC/B,UAAmB,IAAI,WAAW,EAAE,EACpC,kBAA+C;QAFvD;;;;mBAAgB,MAAM;WAAiB;QACvC;;;;mBAAQ,OAAO;WAA6B;QAC5C;;;;mBAAQ,kBAAkB;WAA6B;QA/BzD,gFAAgF;QAChF,0BAA0B;QAClB;;;;mBAA0C,CAAC;WAAC;QAEpD,mEAAmE;QACnE,iEAAiE;QACjE,oEAAoE;QACpE,iEAAiE;QACjE,oEAAoE;QACpE,2DAA2D;QAC3D,EAAE;QACF,oCAAoC;QACpC,+DAA+D;QACvD;;;;;WAA8C;QAC9C;;;;;WAAgD;QAChD;;;;mBAAa,KAAK;WAAC;QACnB;;;;mBAAc,KAAK;WAAC;QACpB;;;;;WAAiD;QACjD;;;;;WAAuD;QAE/D;;;;;WAAuC;QACvC;;;;mBAAmB;gBACjB,wBAAwB,EAAE;oBACxB,SAAS,EAAE,KAAK;oBAChB,OAAO,EAAE,IAAI,CAAC,uBAAuB;iBACtC;aACF;WAAC;QA8JF;;;;mBAAwB,KAAK,IAAmB,EAAE;gBAChD,sDAAsD;gBAEtD,IAAI,CAAC;oBACH,IAAI,CAAC,IAAI,CAAC,+BAA+B,EAAE,CAAC;wBAC1C,IAAI,CAAC,OAAO,CAAC,GAAG,CACd,+DAA+D,CAChE,CAAC;wBACF,gCAAgC;wBAChC,IAAI,CAAC,eAAe,EAAE,CAAC;wBACvB,MAAM,IAAI,CAAC,SAAS,EAAE,CAAC;oBACzB,CAAC;yBAAM,CAAC;wBACN,IAAI,CAAC,OAAO,CAAC,GAAG,CACd,8DAA8D,CAC/D,CAAC;oBACJ,CAAC;gBACH,CAAC;gBAAC,OAAO,CAAC,EAAE,CAAC;oBACX,IAAI,CAAC,OAAO,CAAC,KAAK,CAChB,2DAA2D,EAC3D,CAAC,CACF,CAAC;gBACJ,CAAC;YACH,CAAC;WAAC;QA7KA,MAAM,CAAC,gBAAgB,CACrB,wBAAwB,EACxB,IAAI,CAAC,qBAAqB,CAC3B,CAAC;IACJ,CAAC;IAED,KAAK,CAAC,OAAO;QACX,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC;YACjB,IAAI,EAAE,IAAI,CAAC,WAAW,CAAC,CAAC,CAAC,WAAW,CAAC,CAAC,CAAC,SAAS;YAChD,OAAO,EAAE,yBAAyB;SACnC,CAAC,CAAC;QACH,IAAI,IAAI,CAAC,+BAA+B,EAAE,CAAC;YACzC,IAAI,CAAC,OAAO,CAAC,GAAG,CACd,0DAA0D,CAC3D,CAAC;YACF,uEAAuE;YACvE,8EAA8E;YAC9E,yEAAyE;YACzE,MAAM,IAAI,CAAC,kBAAkB,CAAC;YAC9B,OAAO;QACT,CAAC;QACD,IAAI,CAAC,+BAA+B,EAAE,CAAC;QACvC,IAAI,IAAI,CAAC,MAAM,CAAC,IAAI,KAAK,SAAS,EAAE,CAAC;YACnC,MAAM,IAAI,KAAK,CACb,6DAA6D,CAC9D,CAAC;QACJ,CAAC;QACD,IAAI,CAAC;YACH,2FAA2F;YAC3F,MAAM,IAAI,CAAC,iBAAiB,CAAC;YAC7B,IAAI,CAAC,kBAAkB;gBACrB,IAAI,CAAC,kBAAkB;oBACvB,IAAI,CAAC,MAAM,CAAC,IAAI;yBACb,OAAO,EAAE;yBACT,IAAI,CAAC,KAAK,IAAI,EAAE;wBACf,6EAA6E;wBAC7E,8EAA8E;wBAC9E,4CAA4C;wBAC5C,IAAI,CAAC,YAAY,GAAG,MAAM,IAAI,CAAC,eAAe,EAAE,CAAC;wBACjD,sFAAsF;wBACtF,oCAAoC;wBACpC,IAAI,CAAC,IAAI,CAAC,UAAU,EAAE,CAAC;4BACrB,IAAI,CAAC,OAAO,CAAC,GAAG,CACd,oEAAoE,CACrE,CAAC;4BACF,IAAI,CAAC,iBAAiB,GAAG,CAAC,KAAK,IAAI,EAAE;gCACnC,MAAM,IAAI,CAAC,kBAAkB,CAAC,KAAK,CAAC,CAAC;gCACrC,IAAI,CAAC,iBAAiB,GAAG,SAAS,CAAC;4BACrC,CAAC,CAAC,EAAE,CAAC;wBACP,CAAC;6BAAM,CAAC;4BACN,IAAI,CAAC,OAAO,CAAC,GAAG,CACd,iDAAiD,CAClD,CAAC;wBACJ,CAAC;oBACH,CAAC,CAAC;yBACD,KAAK,CAAC,CAAC,CAAC,EAAE,EAAE;wBACX,IAAI,IAAI,CAAC,UAAU,EAAE,CAAC;4BACpB,uDAAuD;4BACvD,MAAM,CAAC,CAAC;wBACV,CAAC;6BAAM,CAAC;4BACN,IAAI,CAAC,OAAO,CAAC,KAAK,CAChB,uDAAuD,EACvD,CAAC,CACF,CAAC;4BACF,OAAO,SAAS,CAAC;wBACnB,CAAC;oBACH,CAAC,CAAC;yBACD,OAAO,CAAC,GAAG,EAAE;wBACZ,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,6CAA6C,CAAC,CAAC;wBAChE,IAAI,CAAC,kBAAkB,GAAG,SAAS,CAAC;oBACtC,CAAC,CAAC,CAAC;YAEP,IAAI,CAAC,UAAU,GAAG,IAAI,CAAC;YACvB,IAAI,CAAC;gBACH,MAAM,iBAAiB,GAAG,MAAM,OAAO,CAAC,IAAI,CAAC;oBAC3C,IAAI,CAAC,kBAAkB;oBACvB,IAAI,OAAO,CAAY,CAAC,OAAO,EAAE,EAAE,CACjC,UAAU,CAAC,GAAG,EAAE,CAAC,OAAO,CAAC,SAAS,CAAC,EAAE,sBAAsB,CAAC,CAC7D;iBACF,CAAC,CAAC;gBACH,IAAI,iBAAiB,KAAK,SAAS,EAAE,CAAC;oBACpC,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,uCAAuC,CAAC,CAAC;oBAC1D,MAAM,IAAI,KAAK,CAAC,uCAAuC,CAAC,CAAC;gBAC3D,CAAC;YACH,CAAC;oBAAS,CAAC;gBACT,IAAI,CAAC,UAAU,GAAG,KAAK,CAAC;YAC1B,CAAC;YAED,yDAAyD;YACzD,4BAA4B;YAC5B,KAAK,MAAM,eAAe,IAAI,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,gBAAgB,CAAC,EAAE,CAAC;gBACnE,IAAI,eAAe,CAAC,SAAS,EAAE,CAAC;oBAC9B,eAAe,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;gBACrC,CAAC;YACH,CAAC;YAED,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC;gBACjB,IAAI,EAAE,IAAI,CAAC,WAAW,CAAC,CAAC,CAAC,WAAW,CAAC,CAAC,CAAC,SAAS;gBAChD,OAAO,EAAE,2BAA2B;aACrC,CAAC,CAAC;QACL,CAAC;QAAC,OAAO,CAAC,EAAE,CAAC;YACX,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,yBAAyB,EAAE,CAAC,CAAC,CAAC;YACjD,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC;gBACjB,IAAI,EAAE,IAAI,CAAC,WAAW,CAAC,CAAC,CAAC,WAAW,CAAC,CAAC,CAAC,SAAS;gBAChD,OAAO,EAAE,0BAA0B;aACpC,CAAC,CAAC;YACH,MAAM,IAAI,CAAC,kBAAkB,CAAC,KAAK,CAAC,CAAC;YACrC,MAAM,IAAI,KAAK,CAAC,mCAAmC,CAAC,CAAC;QACvD,CAAC;gBAAS,CAAC;YACT,IAAI,CAAC,+BAA+B,EAAE,CAAC;QACzC,CAAC;IACH,CAAC;IAED,KAAK,CAAC,UAAU;QACd,OAAO,IAAI,CAAC,kBAAkB,CAAC,IAAI,CAAC,CAAC;IACvC,CAAC;IAEO,KAAK,CAAC,kBAAkB,CAAC,aAAsB;QACrD,IAAI,CAAC,OAAO,CAAC,GAAG,CACd,wBAAwB,aAAa,CAAC,CAAC,CAAC,kBAAkB,CAAC,CAAC,CAAC,gBAAgB,EAAE,CAChF,CAAC;QACF,IAAI,CAAC,+BAA+B,EAAE,CAAC;QACvC,IAAI,CAAC;YACH,IAAI,IAAI,CAAC,MAAM,CAAC,IAAI,EAAE,SAAS,EAAE,CAAC;gBAChC,IAAI,CAAC,MAAM,CAAC,IAAI,EAAE,UAAU,EAAE,CAAC;YACjC,CAAC;QACH,CAAC;QAAC,OAAO,CAAC,EAAE,CAAC;YACX,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,2CAA2C,EAAE,CAAC,CAAC,CAAC;YACnE,6CAA6C;QAC/C,CAAC;gBAAS,CAAC;YACT,IAAI,CAAC,eAAe,EAAE,CAAC;YACvB,IAAI,CAAC,+BAA+B,EAAE,CAAC;QACzC,CAAC;QACD,IAAI,CAAC,qBAAqB,GAAG,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,EAAE,CACnD,UAAU,CAAC,OAAO,EAAE,KAAK,CAAC,CAC3B,CAAC;IACJ,CAAC;IAED,KAAK,CAAC,SAAS;QACb,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,qBAAqB,CAAC,CAAC;QACxC,IAAI,CAAC,WAAW,GAAG,IAAI,CAAC;QACxB,IAAI,WAAW,EAAE,CAAC;YAChB,uFAAuF;YACvF,gFAAgF;YAChF,oFAAoF;YACpF,4BAA4B;YAC5B,MAAM,IAAI,CAAC,qBAAqB,CAAC;QACnC,CAAC;QACD,MAAM,IAAI,CAAC,OAAO,EAAE,CAAC;IACvB,CAAC;IA0BO,gBAAgB;QACtB,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,IAAI,EAAE,SAAS,EAAE,CAAC;YACjC,MAAM,IAAI,KAAK,CAAC,sDAAsD,CAAC,CAAC;QAC1E,CAAC;QACD,OAAO,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC;IAC1B,CAAC;IAEO,KAAK,CAAC,eAAe;QAC3B,IAAI,CAAC,gBAAgB,EAAE,CAAC;QACxB,MAAM,WAAW,GAAG,OAAO,CAAC,iBAAiB,CAAC;QAC9C,IAAI,CAAC;YACH,MAAM,UAAU,GAAG,MAAM,IAAI,CAAC,gBAAgB,EAAE,CAAC,iBAAiB,CAChE,WAAW,CAAC,EAAE,CACf,CAAC;YACF,MAAM,cAAc,GAAG,MAAM,UAAU,CAAC,iBAAiB,CACvD,WAAW,CAAC,eAAe,CAAC,WAAW,CAAC,EAAE,CAC3C,CAAC;YACF,MAAM,gBAAgB,GAAG,MAAM,cAAc,CAAC,SAAS,EAAE,CAAC;YAC1D,MAAM,WAAW,GAAG,IAAI,WAAW,EAAE,CAAC,MAAM,CAAC,gBAAgB,CAAC,CAAC;YAC/D,IAAI,WAAW,CAAC,WAAW,EAAE,KAAK,eAAe,CAAC,WAAW,EAAE,EAAE,CAAC;gBAChE,OAAO,IAAI,CAAC;YACd,CAAC;YACD,IACE,WAAW,CAAC,WAAW,EAAE,CAAC,QAAQ,CAAC,kBAAkB,CAAC,WAAW,EAAE,CAAC,EACpE,CAAC;gBACD,OAAO,IAAI,CAAC;YACd,CAAC;YACD,MAAM,IAAI,KAAK,CAAC,2BAA2B,WAAW,EAAE,CAAC,CAAC;QAC5D,CAAC;QAAC,OAAO,CAAC,EAAE,CAAC;YACX,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,6BAA6B,EAAE,CAAC,CAAC,CAAC;YACrD,MAAM,IAAI,KAAK,CAAC,6BAA6B,CAAC,CAAC;QACjD,CAAC;IACH,CAAC;IAED,KAAK,CAAC,uBAAuB;QAC3B,IAAI,CAAC,IAAI,CAAC,oBAAoB,EAAE,CAAC;YAC/B,MAAM,UAAU,GAAG,IAAI,CAAC,gBAAgB,EAAE,CAAC;YAC3C,IAAI,CAAC,oBAAoB,GAAG,MAAM,oBAAoB,CAAC,aAAa,CAClE,UAAU,EACV,IAAI,CAAC,kBAAkB,EACvB,IAAI,CAAC,gBAAgB,CAAC,wBAAwB,CAAC,SAAS,CACzD,CAAC;QACJ,CAAC;QACD,OAAO,IAAI,CAAC,oBAAoB,CAAC;IACnC,CAAC;IAEO,eAAe;QACrB,IAAI,CAAC,oBAAoB,GAAG,SAAS,CAAC;IACxC,CAAC;CACF;AAED,MAAM,CAAC,MAAM,4BAA4B,GAAG,KAAK,EAC/C,MAAuB,EACvB,OAAgB,EAChB,kBAA+C,EACF,EAAE;IAC/C,IAAI,CAAC;QACH,2DAA2D;QAC3D,sDAAsD;QACtD,MAAM,SAAS,GACb,iBAAiB,CAAC,GAAG,CAAC,MAAM,CAAC,EAAE,CAAC;YAChC,IAAI,sBAAsB,CAAC,MAAM,EAAE,OAAO,EAAE,kBAAkB,CAAC,CAAC;QAClE,iBAAiB,CAAC,GAAG,CAAC,MAAM,CAAC,EAAE,EAAE,SAAS,CAAC,CAAC;QAC5C,MAAM,SAAS,CAAC,OAAO,EAAE,CAAC;QAC1B,OAAO,SAAS,CAAC;IACnB,CAAC;IAAC,OAAO,CAAC,EAAE,CAAC;QACX,OAAO,SAAS,CAAC;IACnB,CAAC;AACH,CAAC,CAAC"}