@microbit/microbit-connection 0.0.0-tab.change.177 → 0.9.0-apps.alpha.0

package/LICENSE.md

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024-2025 Micro:bit Educational Foundation and contributors
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -1,10 +1,99 @@
-# JavaScript library for micro:bit connections in browsers via USB and Bluetooth
+# micro:bit connection library
 
-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.
+<a href="https://microbit-foundation.github.io/microbit-connection/" class="typedoc-ignore">This documentation is best viewed on the documentation site rather than GitHub or NPM package site.</a>
 
-It is intended to be used by other Micro:bit Educational Foundation projects that need to connect to a BBC micro:bit.
+This is a JavaScript library for micro:bit connections in browsers via USB and Bluetooth.
 
-The API is not stable and it's not yet recommended that third parties use this project.
+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. The API is not stable and it's not yet recommended that third parties use this project unless they are happy to update usage as the API evolves.
+
+[Demo page](https://microbit-connection.pages.dev/) for this library.
+
+[Alpha releases are now on NPM](https://www.npmjs.com/package/@microbit/microbit-connection).
+
+[micro:bit CreateAI](https://github.com/microbit-foundation/ml-trainer/) is already using this library for WebUSB and Web Bluetooth.
+
+[This Python Editor PR](https://github.com/microbit-foundation/python-editor-v3/pull/1190) tracks updating the micro:bit Python Editor to use this library.
+
+## Usage
+
+### Flash a micro:bit
+
+Instantiate a WebUSB connection using {@link createWebUSBConnection} class and use it to connect to a micro:bit.
+
+```ts
+import { createWebUSBConnection } from "@microbit/microbit-connection";
+
+const usb = createWebUSBConnection();
+const connectionStatus = await usb.connect();
+
+console.log("Connection status: ", connectionStatus);
+```
+
+{@link ConnectionStatus | Connection status} is `"CONNECTED"` if connection succeeds.
+
+Flash a universal hex that supports both V1 and V2:
+
+```ts
+import { createUniversalHexFlashDataSource } from "@microbit/microbit-connection";
+
+await usb.flash(createUniversalHexFlashDataSource(universalHexString), {
+  partial: true,
+  progress: (stage, percentage) => {
+    console.log(stage, percentage);
+  },
+});
+```
+
+This code will also work for non-universal hex files so is a good default for unknown hex files.
+
+Alternatively, you can create and flash a hex for a specific micro:bit version by providing a function that takes a {@link BoardVersion} and returns a hex.
+This can reduce download size or help integrate with APIs that produce a hex for a particular device version.
+This example uses the [@microbit/microbit-fs library](https://microbit-foundation.github.io/microbit-fs/) which can return a hex based on board id.
+
+```ts
+import { MicropythonFsHex, microbitBoardId } from "@microbit/microbit-fs";
+import { BoardId } from "@microbit/microbit-connection";
+
+const micropythonFs = new MicropythonFsHex([
+  { hex: microPythonV1HexFile, boardId: microbitBoardId.V1 },
+  { hex: microPythonV2HexFile, boardId: microbitBoardId.V2 },
+]);
+// Add files to MicroPython file system here (omitted for simplicity)
+// Flash the device
+await usb.flash(
+  async (boardVersion) => {
+    const boardId = BoardId.forVersion(boardVersion).id;
+    return micropythonFs.getIntelHex(boardId);
+  },
+  {
+    partial: true,
+    progress: (stage, percentage) => {
+      console.log(stage, percentage);
+    },
+  },
+);
+```
+
+For more examples of using other methods in the {@link MicrobitWebUSBConnection} class, see our [demo code](https://github.com/microbit-foundation/microbit-connection/blob/main/src/demo.ts) for our [demo site](https://microbit-connection.pages.dev/).
+
+### Connect via Bluetooth
+
+By default, the micro:bit's Bluetooth service is not enabled. Visit our [Bluetooth tech site page](https://tech.microbit.org/bluetooth/) to download a hex file that would enable the bluetooth service.
+
+Instantiate a Bluetooth connection using {@link createWebBluetoothConnection} class and use it to connect to a micro:bit.
+
+```ts
+import { createWebBluetoothConnection } from "@microbit/microbit-connection";
+
+const bluetooth = createWebBluetoothConnection();
+const connectionStatus = await bluetooth.connect();
+
+console.log("Connection status: ", connectionStatus);
+```
+
+{@link ConnectionStatus | Connection status} is `"CONNECTED"` if connection succeeds.
+
+For more examples of using other methods in the {@link createWebBluetoothConnection} class, see our [demo code](https://github.com/microbit-foundation/microbit-connection/blob/main/src/demo.ts) for our [demo site](https://microbit-connection.pages.dev/).
 
 ## License
 
@@ -22,7 +111,7 @@ $ npx license-checker --direct --summary --production
 
 Omit the flags as desired to obtain more detail.
 
-## Code of Conduct
+## 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

package/build/cjs/accelerometer-service.d.ts

@@ -0,0 +1,18 @@
+import { AccelerometerData } from "./accelerometer.js";
+import { Service } from "./bluetooth-device-wrapper.js";
+import { TypedServiceEvent, TypedServiceEventDispatcher } from "./service-events.js";
+export declare class AccelerometerService implements Service {
+    private deviceId;
+    private dispatchTypedEvent;
+    uuid: string;
+    static createService(deviceId: string, dispatchTypedEvent: TypedServiceEventDispatcher): AccelerometerService;
+    constructor(deviceId: string, dispatchTypedEvent: TypedServiceEventDispatcher);
+    getRelevantEvents(): TypedServiceEvent[];
+    private dataViewToData;
+    getData(): Promise<AccelerometerData>;
+    getPeriod(): Promise<number>;
+    setPeriod(value: number): Promise<void>;
+    startNotifications(type: TypedServiceEvent): Promise<void>;
+    stopNotifications(type: TypedServiceEvent): Promise<void>;
+    private characteristicForEvent;
+}

package/build/cjs/accelerometer-service.js

@@ -0,0 +1,105 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.AccelerometerService = void 0;
+const bluetooth_le_1 = require("@capacitor-community/bluetooth-le");
+const accelerometer_js_1 = require("./accelerometer.js");
+const bluetooth_profile_js_1 = require("./bluetooth-profile.js");
+const device_js_1 = require("./device.js");
+class AccelerometerService {
+    static createService(deviceId, dispatchTypedEvent) {
+        return new AccelerometerService(deviceId, dispatchTypedEvent);
+    }
+    constructor(deviceId, dispatchTypedEvent) {
+        Object.defineProperty(this, "deviceId", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: deviceId
+        });
+        Object.defineProperty(this, "dispatchTypedEvent", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: dispatchTypedEvent
+        });
+        Object.defineProperty(this, "uuid", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: bluetooth_profile_js_1.profile.accelerometer.id
+        });
+    }
+    getRelevantEvents() {
+        return ["accelerometerdatachanged"];
+    }
+    dataViewToData(dataView) {
+        return {
+            x: dataView.getInt16(0, true),
+            y: dataView.getInt16(2, true),
+            z: dataView.getInt16(4, true),
+        };
+    }
+    async getData() {
+        const dataView = await bluetooth_le_1.BleClient.read(this.deviceId, bluetooth_profile_js_1.profile.accelerometer.id, bluetooth_profile_js_1.profile.accelerometer.characteristics.data.id);
+        return this.dataViewToData(dataView);
+    }
+    async getPeriod() {
+        const dataView = await bluetooth_le_1.BleClient.read(this.deviceId, bluetooth_profile_js_1.profile.accelerometer.id, bluetooth_profile_js_1.profile.accelerometer.characteristics.period.id);
+        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/ble/profile/#about-the-accelerometer-service
+        const dataView = new DataView(new ArrayBuffer(2));
+        dataView.setUint16(0, value, true);
+        await bluetooth_le_1.BleClient.write(this.deviceId, bluetooth_profile_js_1.profile.accelerometer.id, bluetooth_profile_js_1.profile.accelerometer.characteristics.period.id, dataView);
+    }
+    async startNotifications(type) {
+        const result = this.characteristicForEvent(type);
+        if (result) {
+            const { service, characteristic } = result;
+            try {
+                await bluetooth_le_1.BleClient.startNotifications(this.deviceId, service, characteristic, (value) => {
+                    const data = this.dataViewToData(value);
+                    this.dispatchTypedEvent("accelerometerdatachanged", new accelerometer_js_1.AccelerometerDataEvent(data));
+                });
+            }
+            catch (e) {
+                this.dispatchTypedEvent("backgrounderror", new device_js_1.BackgroundErrorEvent("Failed to start notifications", e));
+            }
+        }
+    }
+    async stopNotifications(type) {
+        const result = this.characteristicForEvent(type);
+        if (result) {
+            const { service, characteristic } = result;
+            try {
+                await bluetooth_le_1.BleClient.stopNotifications(this.deviceId, service, characteristic);
+            }
+            catch (e) {
+                this.dispatchTypedEvent("backgrounderror", new device_js_1.BackgroundErrorEvent("Failed to stop notifications", e));
+            }
+        }
+    }
+    characteristicForEvent(type) {
+        switch (type) {
+            case "accelerometerdatachanged": {
+                return {
+                    service: bluetooth_profile_js_1.profile.accelerometer.id,
+                    characteristic: bluetooth_profile_js_1.profile.accelerometer.characteristics.data.id,
+                };
+            }
+            default: {
+                return undefined;
+            }
+        }
+    }
+}
+exports.AccelerometerService = AccelerometerService;
+//# sourceMappingURL=accelerometer-service.js.map

package/build/cjs/accelerometer-service.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"accelerometer-service.js","sourceRoot":"","sources":["../../lib/accelerometer-service.ts"],"names":[],"mappings":";;;AAAA,oEAA8D;AAC9D,yDAA+E;AAM/E,iEAAiD;AACjD,2CAAmD;AAEnD,MAAa,oBAAoB;IAG/B,MAAM,CAAC,aAAa,CAClB,QAAgB,EAChB,kBAA+C;QAE/C,OAAO,IAAI,oBAAoB,CAAC,QAAQ,EAAE,kBAAkB,CAAC,CAAC;IAChE,CAAC;IAED,YACU,QAAgB,EAChB,kBAA+C;QADvD;;;;mBAAQ,QAAQ;WAAQ;QACxB;;;;mBAAQ,kBAAkB;WAA6B;QAXzD;;;;mBAAO,8BAAO,CAAC,aAAa,CAAC,EAAE;WAAC;IAY7B,CAAC;IAEJ,iBAAiB;QACf,OAAO,CAAC,0BAA0B,CAAC,CAAC;IACtC,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,wBAAS,CAAC,IAAI,CACnC,IAAI,CAAC,QAAQ,EACb,8BAAO,CAAC,aAAa,CAAC,EAAE,EACxB,8BAAO,CAAC,aAAa,CAAC,eAAe,CAAC,IAAI,CAAC,EAAE,CAC9C,CAAC;QACF,OAAO,IAAI,CAAC,cAAc,CAAC,QAAQ,CAAC,CAAC;IACvC,CAAC;IAED,KAAK,CAAC,SAAS;QACb,MAAM,QAAQ,GAAG,MAAM,wBAAS,CAAC,IAAI,CACnC,IAAI,CAAC,QAAQ,EACb,8BAAO,CAAC,aAAa,CAAC,EAAE,EACxB,8BAAO,CAAC,aAAa,CAAC,eAAe,CAAC,MAAM,CAAC,EAAE,CAChD,CAAC;QACF,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,oGAAoG;QACpG,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,wBAAS,CAAC,KAAK,CACnB,IAAI,CAAC,QAAQ,EACb,8BAAO,CAAC,aAAa,CAAC,EAAE,EACxB,8BAAO,CAAC,aAAa,CAAC,eAAe,CAAC,MAAM,CAAC,EAAE,EAC/C,QAAQ,CACT,CAAC;IACJ,CAAC;IAED,KAAK,CAAC,kBAAkB,CAAC,IAAuB;QAC9C,MAAM,MAAM,GAAG,IAAI,CAAC,sBAAsB,CAAC,IAAI,CAAC,CAAC;QACjD,IAAI,MAAM,EAAE,CAAC;YACX,MAAM,EAAE,OAAO,EAAE,cAAc,EAAE,GAAG,MAAM,CAAC;YAC3C,IAAI,CAAC;gBACH,MAAM,wBAAS,CAAC,kBAAkB,CAChC,IAAI,CAAC,QAAQ,EACb,OAAO,EACP,cAAc,EACd,CAAC,KAAK,EAAE,EAAE;oBACR,MAAM,IAAI,GAAG,IAAI,CAAC,cAAc,CAAC,KAAK,CAAC,CAAC;oBACxC,IAAI,CAAC,kBAAkB,CACrB,0BAA0B,EAC1B,IAAI,yCAAsB,CAAC,IAAI,CAAC,CACjC,CAAC;gBACJ,CAAC,CACF,CAAC;YACJ,CAAC;YAAC,OAAO,CAAC,EAAE,CAAC;gBACX,IAAI,CAAC,kBAAkB,CACrB,iBAAiB,EACjB,IAAI,gCAAoB,CAAC,+BAA+B,EAAE,CAAC,CAAC,CAC7D,CAAC;YACJ,CAAC;QACH,CAAC;IACH,CAAC;IAED,KAAK,CAAC,iBAAiB,CAAC,IAAuB;QAC7C,MAAM,MAAM,GAAG,IAAI,CAAC,sBAAsB,CAAC,IAAI,CAAC,CAAC;QACjD,IAAI,MAAM,EAAE,CAAC;YACX,MAAM,EAAE,OAAO,EAAE,cAAc,EAAE,GAAG,MAAM,CAAC;YAC3C,IAAI,CAAC;gBACH,MAAM,wBAAS,CAAC,iBAAiB,CAC/B,IAAI,CAAC,QAAQ,EACb,OAAO,EACP,cAAc,CACf,CAAC;YACJ,CAAC;YAAC,OAAO,CAAC,EAAE,CAAC;gBACX,IAAI,CAAC,kBAAkB,CACrB,iBAAiB,EACjB,IAAI,gCAAoB,CAAC,8BAA8B,EAAE,CAAC,CAAC,CAC5D,CAAC;YACJ,CAAC;QACH,CAAC;IACH,CAAC;IAEO,sBAAsB,CAAC,IAAuB;QACpD,QAAQ,IAAI,EAAE,CAAC;YACb,KAAK,0BAA0B,CAAC,CAAC,CAAC;gBAChC,OAAO;oBACL,OAAO,EAAE,8BAAO,CAAC,aAAa,CAAC,EAAE;oBACjC,cAAc,EAAE,8BAAO,CAAC,aAAa,CAAC,eAAe,CAAC,IAAI,CAAC,EAAE;iBAC9D,CAAC;YACJ,CAAC;YACD,OAAO,CAAC,CAAC,CAAC;gBACR,OAAO,SAAS,CAAC;YACnB,CAAC;QACH,CAAC;IACH,CAAC;CACF;AA1HD,oDA0HC"}

package/build/cjs/accelerometer.js

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

package/build/cjs/accelerometer.js.map

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

package/build/{async-util.d.ts → cjs/async-util.d.ts}

@@ -5,9 +5,18 @@
  */
 export declare class TimeoutError extends Error {
 }
+export declare class DisconnectError extends Error {
+    constructor(message?: string);
+}
 /**
  * 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>;
+export declare function delay(millis: number): Promise<unknown>;
+export declare function timeoutErrorAfter<T>(millis: number, message?: string): Promise<T>;
+export declare function disconnectErrorCallback<T>(message?: string): {
+    promise: Promise<T>;
+    callback: () => void | undefined;
+};

package/build/cjs/async-util.js

@@ -0,0 +1,47 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.DisconnectError = exports.TimeoutError = void 0;
+exports.withTimeout = withTimeout;
+exports.delay = delay;
+exports.timeoutErrorAfter = timeoutErrorAfter;
+exports.disconnectErrorCallback = disconnectErrorCallback;
+/**
+ * (c) 2021, Micro:bit Educational Foundation and contributors
+ *
+ * SPDX-License-Identifier: MIT
+ */
+class TimeoutError extends Error {
+}
+exports.TimeoutError = TimeoutError;
+class DisconnectError extends Error {
+    constructor(message = "Disconnect") {
+        super(message);
+    }
+}
+exports.DisconnectError = DisconnectError;
+/**
+ * Utility to time out an action after a delay.
+ *
+ * The action cannot be cancelled; it may still proceed after the timeout.
+ */
+async function withTimeout(actionPromise, timeout) {
+    return Promise.race([
+        actionPromise,
+        timeoutErrorAfter(timeout),
+    ]);
+}
+async function delay(millis) {
+    return new Promise((resolve) => setTimeout(resolve, millis));
+}
+async function timeoutErrorAfter(millis, message = "Timeout") {
+    await delay(millis);
+    throw new TimeoutError(message);
+}
+function disconnectErrorCallback(message = "Disconnect") {
+    let callback;
+    const promise = new Promise((_, reject) => {
+        callback = () => reject(new DisconnectError(message));
+    });
+    return { promise, callback: callback };
+}
+//# sourceMappingURL=async-util.js.map

package/build/cjs/async-util.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"async-util.js","sourceRoot":"","sources":["../../lib/async-util.ts"],"names":[],"mappings":";;;AAkBA,kCAQC;AAED,sBAEC;AAED,8CAMC;AAED,0DAMC;AA9CD;;;;GAIG;AACH,MAAa,YAAa,SAAQ,KAAK;CAAG;AAA1C,oCAA0C;AAE1C,MAAa,eAAgB,SAAQ,KAAK;IACxC,YAAY,UAAkB,YAAY;QACxC,KAAK,CAAC,OAAO,CAAC,CAAC;IACjB,CAAC;CACF;AAJD,0CAIC;AAED;;;;GAIG;AACI,KAAK,UAAU,WAAW,CAC/B,aAAyB,EACzB,OAAe;IAEf,OAAO,OAAO,CAAC,IAAI,CAAC;QAClB,aAAa;QACb,iBAAiB,CAAC,OAAO,CAAC;KAC3B,CAAe,CAAC;AACnB,CAAC;AAEM,KAAK,UAAU,KAAK,CAAC,MAAc;IACxC,OAAO,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC,UAAU,CAAC,OAAO,EAAE,MAAM,CAAC,CAAC,CAAC;AAC/D,CAAC;AAEM,KAAK,UAAU,iBAAiB,CACrC,MAAc,EACd,UAAkB,SAAS;IAE3B,MAAM,KAAK,CAAC,MAAM,CAAC,CAAC;IACpB,MAAM,IAAI,YAAY,CAAC,OAAO,CAAC,CAAC;AAClC,CAAC;AAED,SAAgB,uBAAuB,CAAI,UAAkB,YAAY;IACvE,IAAI,QAAgC,CAAC;IACrC,MAAM,OAAO,GAAG,IAAI,OAAO,CAAI,CAAC,CAAC,EAAE,MAAM,EAAE,EAAE;QAC3C,QAAQ,GAAG,GAAG,EAAE,CAAC,MAAM,CAAC,IAAI,eAAe,CAAC,OAAO,CAAC,CAAC,CAAC;IACxD,CAAC,CAAC,CAAC;IACH,OAAO,EAAE,OAAO,EAAE,QAAQ,EAAE,QAAS,EAAE,CAAC;AAC1C,CAAC"}

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

@@ -0,0 +1,97 @@
+/**
+ * (c) 2023, Center for Computational Thinking and Design at Aarhus University and contributors
+ *
+ * SPDX-License-Identifier: MIT
+ */
+import { BleDevice, TimeoutOptions } from "@capacitor-community/bluetooth-le";
+import { AccelerometerService } from "./accelerometer-service.js";
+import { ButtonService } from "./button-service.js";
+import { DeviceInformationService } from "./device-information-service.js";
+import { BoardVersion } from "./device.js";
+import { LedService } from "./led-service.js";
+import { Logging, LoggingEvent } from "./logging.js";
+import { MagnetometerService } from "./magnetometer-service.js";
+import { ServiceConnectionEventMap, TypedServiceEvent, TypedServiceEventDispatcher } from "./service-events.js";
+import { UARTService } from "./uart-service.js";
+export declare const bondingTimeoutInMs = 40000;
+export declare const connectTimeoutInMs = 10000;
+export declare const scanningTimeoutInMs = 10000;
+export declare const isAndroid: () => boolean;
+export interface Service {
+    readonly uuid: string;
+    getRelevantEvents(): TypedServiceEvent[];
+    startNotifications(type: TypedServiceEvent): Promise<void>;
+    stopNotifications(type: TypedServiceEvent): Promise<void>;
+}
+interface ConnectCallbacks {
+    onConnecting: () => void;
+    onReconnecting: () => void;
+    onFail: () => void;
+    onSuccess: () => void;
+}
+export declare class BluetoothDeviceWrapper implements Logging {
+    readonly device: BleDevice;
+    private logging;
+    private currentEvents;
+    private callbacks;
+    private duringExplicitConnectDisconnect;
+    private connected;
+    private isReconnect;
+    private serviceIds;
+    accelerometer: AccelerometerService;
+    buttons: ButtonService;
+    deviceInformation: DeviceInformationService;
+    led: LedService;
+    magnetometer: MagnetometerService;
+    uart: UARTService;
+    /**
+     * Only defined after connection.
+     */
+    boardVersion: BoardVersion | undefined;
+    private services;
+    private waitingForDisconnectEventCallbacks;
+    private internalNotificationListeners;
+    constructor(device: BleDevice, logging: Logging, dispatchTypedEvent: TypedServiceEventDispatcher, currentEvents: () => Array<keyof ServiceConnectionEventMap>, callbacks: ConnectCallbacks);
+    connect(): Promise<void>;
+    private connectInternal;
+    disconnect(): Promise<void>;
+    private disconnectInternal;
+    reconnect(): Promise<void>;
+    handleDisconnectEvent: () => Promise<void>;
+    getBoardVersion(): Promise<BoardVersion>;
+    startNotifications(type: TypedServiceEvent): Promise<void>;
+    stopNotifications(type: TypedServiceEvent): Promise<void>;
+    private getServicesForEvent;
+    startInternalNotifications(serviceId: string, characteristicId: string, options?: TimeoutOptions): Promise<void>;
+    subscribe(serviceId: string, characteristicId: string, callback: (data: Uint8Array) => void): void;
+    unsubscribe(serviceId: string, characteristicId: string, callback: (data: Uint8Array) => void): void;
+    stopInternalNotifications(serviceId: string, characteristicId: string): Promise<void>;
+    /**
+     * Write to characteristic and wait for a notification response.
+     *
+     * It is the responsibility of the caller to have started notifications
+     * for the characteristic.
+     */
+    writeForNotification(serviceId: string, characteristicId: string, value: DataView, notificationId: number, isFinalNotification?: (p: Uint8Array) => boolean): Promise<Uint8Array>;
+    waitForDisconnect(timeout: number): Promise<void>;
+    /**
+     * Suitable for running a series of BLE interactions with an overall timeout
+     * and general disconnection
+     */
+    raceDisconnectAndTimeout<T>(promise: Promise<T>, options?: {
+        actionName?: string;
+        timeout?: number;
+    }): Promise<T>;
+    private disconnectErrorPromise;
+    event(event: LoggingEvent): void;
+    log(message: string): void;
+    error(message: string, e?: unknown): void;
+    private getNotificationKey;
+    /**
+     * Bonds with device and handles the post-bond device state only returning
+     * when we can reattempt a connection with the device.
+     */
+    private connectHandlingBond;
+    private bondConnectDeviceInternal;
+}
+export {};