@microbit/microbit-connection 0.9.0-apps.alpha.16 → 0.9.0-apps.alpha.18

package/build/cjs/usb/transport.js

@@ -0,0 +1,155 @@
+"use strict";
+/**
+ * (c) 2026, Micro:bit Educational Foundation and contributors
+ *
+ * Derived from dapjs (https://github.com/ARMmbed/dapjs) which is
+ * Copyright (c) Arm Limited 2018
+ * Copyright (c) Microsoft Corporation
+ *
+ * SPDX-License-Identifier: MIT
+ *
+ * See arm-debug.ts for the full dapjs license.
+ *
+ * WebUSB transport layer. Handles opening/closing the USB interface,
+ * finding the correct CMSIS-DAP endpoints, and reading/writing raw packets.
+ *
+ * This is the lowest layer in the USB stack, sitting beneath the CMSIS-DAP
+ * protocol layer. It knows nothing about DAP commands — it just moves
+ * fixed-size packets between the host and the USB device.
+ *
+ * micro:bit V2 uses CMSIS-DAP v2 (bulk endpoints). micro:bit V1 uses
+ * CMSIS-DAP v1 (HID) which has no bulk endpoints — we fall back to
+ * control transfers (SET_REPORT/GET_REPORT) in that case.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.UsbTransport = exports.PACKET_SIZE = void 0;
+const device_js_1 = require("../device.js");
+// WebUSB interface class for CMSIS-DAP
+const CMSIS_DAP_INTERFACE_CLASS = 0xff;
+// HID report types for control transfer fallback (CMSIS-DAP v1 / no bulk endpoints)
+const GET_REPORT = 0x01;
+const SET_REPORT = 0x09;
+const OUT_REPORT = 0x200;
+const IN_REPORT = 0x100;
+exports.PACKET_SIZE = 64;
+class UsbTransport {
+    constructor(device) {
+        Object.defineProperty(this, "device", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: device
+        });
+        Object.defineProperty(this, "interfaceNumber", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: void 0
+        });
+        Object.defineProperty(this, "endpointIn", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: void 0
+        });
+        Object.defineProperty(this, "endpointOut", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: void 0
+        });
+    }
+    get isOpen() {
+        return this.interfaceNumber !== undefined;
+    }
+    async open() {
+        if (this.isOpen)
+            return;
+        await this.device.open();
+        await this.device.selectConfiguration(1);
+        const interfaces = this.device.configuration.interfaces.filter((iface) => iface.alternates[0].interfaceClass === CMSIS_DAP_INTERFACE_CLASS);
+        if (!interfaces.length) {
+            throw new device_js_1.DeviceError({
+                code: "firmware-update-required",
+                message: "No valid interfaces found.",
+            });
+        }
+        // Prefer interface with bulk endpoints (CMSIS-DAP v2).
+        // Fall back to an interface without endpoints (CMSIS-DAP v1 / HID),
+        // which will use control transfers instead.
+        const selectedInterface = interfaces.find((iface) => iface.alternates[0].endpoints.length > 0) ??
+            interfaces[0];
+        this.interfaceNumber = selectedInterface.interfaceNumber;
+        const endpoints = selectedInterface.alternates[0].endpoints;
+        this.endpointIn = undefined;
+        this.endpointOut = undefined;
+        for (const endpoint of endpoints) {
+            if (endpoint.direction === "in" && !this.endpointIn)
+                this.endpointIn = endpoint;
+            else if (endpoint.direction === "out" && !this.endpointOut)
+                this.endpointOut = endpoint;
+        }
+        await this.device.claimInterface(this.interfaceNumber);
+    }
+    async close() {
+        this.interfaceNumber = undefined;
+        this.endpointIn = undefined;
+        this.endpointOut = undefined;
+        await this.device.close();
+    }
+    async read() {
+        if (this.interfaceNumber === undefined) {
+            throw new device_js_1.DeviceError({
+                code: "connection-error",
+                message: "No device opened",
+            });
+        }
+        let result;
+        if (this.endpointIn) {
+            result = await this.device.transferIn(this.endpointIn.endpointNumber, exports.PACKET_SIZE);
+        }
+        else {
+            // Control transfer fallback for interfaces without bulk endpoints
+            result = await this.device.controlTransferIn({
+                requestType: "class",
+                recipient: "interface",
+                request: GET_REPORT,
+                value: IN_REPORT,
+                index: this.interfaceNumber,
+            }, exports.PACKET_SIZE);
+        }
+        if (result.status !== "ok" || !result.data) {
+            throw new device_js_1.DeviceError({
+                code: "connection-error",
+                message: "USB read failed",
+            });
+        }
+        return result.data;
+    }
+    async write(data) {
+        if (this.interfaceNumber === undefined) {
+            throw new device_js_1.DeviceError({
+                code: "connection-error",
+                message: "No device opened",
+            });
+        }
+        // Always pad to PACKET_SIZE (required for HID control transfer fallback)
+        const buffer = new Uint8Array(exports.PACKET_SIZE);
+        buffer.set(data.subarray(0, exports.PACKET_SIZE));
+        if (this.endpointOut) {
+            await this.device.transferOut(this.endpointOut.endpointNumber, buffer);
+        }
+        else {
+            // Control transfer fallback for interfaces without bulk endpoints
+            await this.device.controlTransferOut({
+                requestType: "class",
+                recipient: "interface",
+                request: SET_REPORT,
+                value: OUT_REPORT,
+                index: this.interfaceNumber,
+            }, buffer);
+        }
+    }
+}
+exports.UsbTransport = UsbTransport;
+//# sourceMappingURL=transport.js.map

package/build/cjs/usb/transport.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"transport.js","sourceRoot":"","sources":["../../../src/usb/transport.ts"],"names":[],"mappings":";AAAA;;;;;;;;;;;;;;;;;;;;;GAqBG;;;AAEH,4CAA2C;AAE3C,uCAAuC;AACvC,MAAM,yBAAyB,GAAG,IAAI,CAAC;AAEvC,oFAAoF;AACpF,MAAM,UAAU,GAAG,IAAI,CAAC;AACxB,MAAM,UAAU,GAAG,IAAI,CAAC;AACxB,MAAM,UAAU,GAAG,KAAK,CAAC;AACzB,MAAM,SAAS,GAAG,KAAK,CAAC;AAEX,QAAA,WAAW,GAAG,EAAE,CAAC;AAU9B,MAAa,YAAY;IAKvB,YAAoB,MAAiB;QAAzB;;;;mBAAQ,MAAM;WAAW;QAJ7B;;;;;WAAyB;QACzB;;;;;WAAyB;QACzB;;;;;WAA0B;IAEM,CAAC;IAEzC,IAAI,MAAM;QACR,OAAO,IAAI,CAAC,eAAe,KAAK,SAAS,CAAC;IAC5C,CAAC;IAED,KAAK,CAAC,IAAI;QACR,IAAI,IAAI,CAAC,MAAM;YAAE,OAAO;QAExB,MAAM,IAAI,CAAC,MAAM,CAAC,IAAI,EAAE,CAAC;QACzB,MAAM,IAAI,CAAC,MAAM,CAAC,mBAAmB,CAAC,CAAC,CAAC,CAAC;QAEzC,MAAM,UAAU,GAAG,IAAI,CAAC,MAAM,CAAC,aAAc,CAAC,UAAU,CAAC,MAAM,CAC7D,CAAC,KAAK,EAAE,EAAE,CACR,KAAK,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC,cAAc,KAAK,yBAAyB,CACnE,CAAC;QAEF,IAAI,CAAC,UAAU,CAAC,MAAM,EAAE,CAAC;YACvB,MAAM,IAAI,uBAAW,CAAC;gBACpB,IAAI,EAAE,0BAA0B;gBAChC,OAAO,EAAE,4BAA4B;aACtC,CAAC,CAAC;QACL,CAAC;QAED,uDAAuD;QACvD,oEAAoE;QACpE,4CAA4C;QAC5C,MAAM,iBAAiB,GACrB,UAAU,CAAC,IAAI,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC,MAAM,GAAG,CAAC,CAAC;YACpE,UAAU,CAAC,CAAC,CAAC,CAAC;QAEhB,IAAI,CAAC,eAAe,GAAG,iBAAiB,CAAC,eAAe,CAAC;QAEzD,MAAM,SAAS,GAAG,iBAAiB,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC;QAC5D,IAAI,CAAC,UAAU,GAAG,SAAS,CAAC;QAC5B,IAAI,CAAC,WAAW,GAAG,SAAS,CAAC;QAC7B,KAAK,MAAM,QAAQ,IAAI,SAAS,EAAE,CAAC;YACjC,IAAI,QAAQ,CAAC,SAAS,KAAK,IAAI,IAAI,CAAC,IAAI,CAAC,UAAU;gBACjD,IAAI,CAAC,UAAU,GAAG,QAAQ,CAAC;iBACxB,IAAI,QAAQ,CAAC,SAAS,KAAK,KAAK,IAAI,CAAC,IAAI,CAAC,WAAW;gBACxD,IAAI,CAAC,WAAW,GAAG,QAAQ,CAAC;QAChC,CAAC;QAED,MAAM,IAAI,CAAC,MAAM,CAAC,cAAc,CAAC,IAAI,CAAC,eAAe,CAAC,CAAC;IACzD,CAAC;IAED,KAAK,CAAC,KAAK;QACT,IAAI,CAAC,eAAe,GAAG,SAAS,CAAC;QACjC,IAAI,CAAC,UAAU,GAAG,SAAS,CAAC;QAC5B,IAAI,CAAC,WAAW,GAAG,SAAS,CAAC;QAC7B,MAAM,IAAI,CAAC,MAAM,CAAC,KAAK,EAAE,CAAC;IAC5B,CAAC;IAED,KAAK,CAAC,IAAI;QACR,IAAI,IAAI,CAAC,eAAe,KAAK,SAAS,EAAE,CAAC;YACvC,MAAM,IAAI,uBAAW,CAAC;gBACpB,IAAI,EAAE,kBAAkB;gBACxB,OAAO,EAAE,kBAAkB;aAC5B,CAAC,CAAC;QACL,CAAC;QAED,IAAI,MAA2B,CAAC;QAChC,IAAI,IAAI,CAAC,UAAU,EAAE,CAAC;YACpB,MAAM,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,UAAU,CACnC,IAAI,CAAC,UAAU,CAAC,cAAc,EAC9B,mBAAW,CACZ,CAAC;QACJ,CAAC;aAAM,CAAC;YACN,kEAAkE;YAClE,MAAM,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,iBAAiB,CAC1C;gBACE,WAAW,EAAE,OAAO;gBACpB,SAAS,EAAE,WAAW;gBACtB,OAAO,EAAE,UAAU;gBACnB,KAAK,EAAE,SAAS;gBAChB,KAAK,EAAE,IAAI,CAAC,eAAe;aAC5B,EACD,mBAAW,CACZ,CAAC;QACJ,CAAC;QACD,IAAI,MAAM,CAAC,MAAM,KAAK,IAAI,IAAI,CAAC,MAAM,CAAC,IAAI,EAAE,CAAC;YAC3C,MAAM,IAAI,uBAAW,CAAC;gBACpB,IAAI,EAAE,kBAAkB;gBACxB,OAAO,EAAE,iBAAiB;aAC3B,CAAC,CAAC;QACL,CAAC;QACD,OAAO,MAAM,CAAC,IAAI,CAAC;IACrB,CAAC;IAED,KAAK,CAAC,KAAK,CAAC,IAAgB;QAC1B,IAAI,IAAI,CAAC,eAAe,KAAK,SAAS,EAAE,CAAC;YACvC,MAAM,IAAI,uBAAW,CAAC;gBACpB,IAAI,EAAE,kBAAkB;gBACxB,OAAO,EAAE,kBAAkB;aAC5B,CAAC,CAAC;QACL,CAAC;QAED,yEAAyE;QACzE,MAAM,MAAM,GAAG,IAAI,UAAU,CAAC,mBAAW,CAAC,CAAC;QAC3C,MAAM,CAAC,GAAG,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC,EAAE,mBAAW,CAAC,CAAC,CAAC;QAE1C,IAAI,IAAI,CAAC,WAAW,EAAE,CAAC;YACrB,MAAM,IAAI,CAAC,MAAM,CAAC,WAAW,CAAC,IAAI,CAAC,WAAW,CAAC,cAAc,EAAE,MAAM,CAAC,CAAC;QACzE,CAAC;aAAM,CAAC;YACN,kEAAkE;YAClE,MAAM,IAAI,CAAC,MAAM,CAAC,kBAAkB,CAClC;gBACE,WAAW,EAAE,OAAO;gBACpB,SAAS,EAAE,WAAW;gBACtB,OAAO,EAAE,UAAU;gBACnB,KAAK,EAAE,UAAU;gBACjB,KAAK,EAAE,IAAI,CAAC,eAAe;aAC5B,EACD,MAAM,CACP,CAAC;QACJ,CAAC;IACH,CAAC;CACF;AA1HD,oCA0HC"}

package/build/esm/async-util.d.ts

@@ -3,7 +3,9 @@
  *
  * SPDX-License-Identifier: MIT
  */
-export declare class TimeoutError extends Error {
+import { DeviceError } from "./device.js";
+export declare class TimeoutError extends DeviceError {
+    constructor(message?: string);
 }
 export declare class DisconnectError extends Error {
     constructor(message?: string);

package/build/esm/async-util.js

@@ -3,7 +3,11 @@
  *
  * SPDX-License-Identifier: MIT
  */
-export class TimeoutError extends Error {
+import { DeviceError } from "./device.js";
+export class TimeoutError extends DeviceError {
+    constructor(message = "Timeout") {
+        super({ code: "timeout", message });
+    }
 }
 export class DisconnectError extends Error {
     constructor(message = "Disconnect") {

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

@@ -1 +1 @@
-{"version":3,"file":"async-util.js","sourceRoot":"","sources":["../../src/async-util.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AACH,MAAM,OAAO,YAAa,SAAQ,KAAK;CAAG;AAE1C,MAAM,OAAO,eAAgB,SAAQ,KAAK;IACxC,YAAY,UAAkB,YAAY;QACxC,KAAK,CAAC,OAAO,CAAC,CAAC;IACjB,CAAC;CACF;AAED;;;;GAIG;AACH,MAAM,CAAC,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;AAED,MAAM,CAAC,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;AAED,MAAM,CAAC,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,MAAM,UAAU,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"}
+{"version":3,"file":"async-util.js","sourceRoot":"","sources":["../../src/async-util.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AACH,OAAO,EAAE,WAAW,EAAE,MAAM,aAAa,CAAC;AAE1C,MAAM,OAAO,YAAa,SAAQ,WAAW;IAC3C,YAAY,UAAkB,SAAS;QACrC,KAAK,CAAC,EAAE,IAAI,EAAE,SAAS,EAAE,OAAO,EAAE,CAAC,CAAC;IACtC,CAAC;CACF;AAED,MAAM,OAAO,eAAgB,SAAQ,KAAK;IACxC,YAAY,UAAkB,YAAY;QACxC,KAAK,CAAC,OAAO,CAAC,CAAC;IACjB,CAAC;CACF;AAED;;;;GAIG;AACH,MAAM,CAAC,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;AAED,MAAM,CAAC,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;AAED,MAAM,CAAC,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,MAAM,UAAU,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/esm/bluetooth/ble-error.d.ts

@@ -0,0 +1,10 @@
+import { DeviceError } from "../device.js";
+/**
+ * Maps BLE errors from @capacitor-community/bluetooth-le (and Web Bluetooth)
+ * to DeviceError with an appropriate code.
+ */
+export declare const mapBleError: (e: unknown) => DeviceError;
+/**
+ * Wraps an async operation so that any BLE error is mapped to a DeviceError.
+ */
+export declare function withBleErrorMapping<T>(fn: () => Promise<T>): Promise<T>;

package/build/esm/bluetooth/ble-error.js

@@ -0,0 +1,42 @@
+import { DeviceError } from "../device.js";
+/**
+ * Maps BLE errors from @capacitor-community/bluetooth-le (and Web Bluetooth)
+ * to DeviceError with an appropriate code.
+ */
+export const mapBleError = (e) => {
+    if (e instanceof DeviceError) {
+        return e;
+    }
+    const message = e instanceof Error ? e.message : String(e);
+    let code = "connection-error";
+    if (e instanceof Error) {
+        // @capacitor-community/bluetooth-le error messages:
+        // https://github.com/capacitor-community/bluetooth-le/blob/main/ios/Plugin/DeviceManager.swift
+        // https://github.com/capacitor-community/bluetooth-le/blob/main/ios/Plugin/Device.swift
+        if (/timeout/i.test(message)) {
+            // BleClient throws plain Errors for its own timeouts:
+            // "Connection timeout", "Read timeout.", "Write timeout.",
+            // "Service discovery timeout.", "Disconnection timeout." etc.
+            code = "timeout";
+        }
+        else if (/disconnect/i.test(message)) {
+            code = "device-disconnected";
+        }
+        else if (/permission/i.test(message)) {
+            code = "permission-denied";
+        }
+    }
+    return new DeviceError({ code, message, cause: e });
+};
+/**
+ * Wraps an async operation so that any BLE error is mapped to a DeviceError.
+ */
+export async function withBleErrorMapping(fn) {
+    try {
+        return await fn();
+    }
+    catch (e) {
+        throw mapBleError(e);
+    }
+}
+//# sourceMappingURL=ble-error.js.map

package/build/esm/bluetooth/ble-error.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ble-error.js","sourceRoot":"","sources":["../../../src/bluetooth/ble-error.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAmB,MAAM,cAAc,CAAC;AAE5D;;;GAGG;AACH,MAAM,CAAC,MAAM,WAAW,GAAG,CAAC,CAAU,EAAe,EAAE;IACrD,IAAI,CAAC,YAAY,WAAW,EAAE,CAAC;QAC7B,OAAO,CAAC,CAAC;IACX,CAAC;IAED,MAAM,OAAO,GAAG,CAAC,YAAY,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC;IAC3D,IAAI,IAAI,GAAoB,kBAAkB,CAAC;IAE/C,IAAI,CAAC,YAAY,KAAK,EAAE,CAAC;QACvB,oDAAoD;QACpD,+FAA+F;QAC/F,wFAAwF;QACxF,IAAI,UAAU,CAAC,IAAI,CAAC,OAAO,CAAC,EAAE,CAAC;YAC7B,sDAAsD;YACtD,2DAA2D;YAC3D,8DAA8D;YAC9D,IAAI,GAAG,SAAS,CAAC;QACnB,CAAC;aAAM,IAAI,aAAa,CAAC,IAAI,CAAC,OAAO,CAAC,EAAE,CAAC;YACvC,IAAI,GAAG,qBAAqB,CAAC;QAC/B,CAAC;aAAM,IAAI,aAAa,CAAC,IAAI,CAAC,OAAO,CAAC,EAAE,CAAC;YACvC,IAAI,GAAG,mBAAmB,CAAC;QAC7B,CAAC;IACH,CAAC;IAED,OAAO,IAAI,WAAW,CAAC,EAAE,IAAI,EAAE,OAAO,EAAE,KAAK,EAAE,CAAC,EAAE,CAAC,CAAC;AACtD,CAAC,CAAC;AAEF;;GAEG;AACH,MAAM,CAAC,KAAK,UAAU,mBAAmB,CAAI,EAAoB;IAC/D,IAAI,CAAC;QACH,OAAO,MAAM,EAAE,EAAE,CAAC;IACpB,CAAC;IAAC,OAAO,CAAC,EAAE,CAAC;QACX,MAAM,WAAW,CAAC,CAAC,CAAC,CAAC;IACvB,CAAC;AACH,CAAC"}

package/build/esm/bluetooth/connection.d.ts

@@ -0,0 +1,137 @@
+import { BackgroundErrorData, ConnectionStatusChange, DeviceConnection, FlashDataSource, FlashOptions } from "../device.js";
+import { Logging } from "../logging.js";
+import { AccelerometerData, ButtonData, LedMatrix, MagnetometerData, UartData } from "../service-events.js";
+import { DeviceBondState } from "./device-bond-state.js";
+export interface MicrobitBluetoothConnectionOptions {
+    logging?: Logging;
+    deviceBondState?: DeviceBondState;
+}
+export interface MicrobitBluetoothConnection extends DeviceConnection {
+    readonly type: "bluetooth";
+    addEventListener(type: "status", listener: (data: ConnectionStatusChange) => void): void;
+    addEventListener(type: "backgrounderror", listener: (data: BackgroundErrorData) => void): void;
+    addEventListener(type: "beforerequestdevice", listener: () => void): void;
+    addEventListener(type: "afterrequestdevice", listener: () => void): void;
+    addEventListener(type: "flash", listener: () => void): void;
+    addEventListener(type: "accelerometerdatachanged", listener: (data: AccelerometerData) => void): void;
+    addEventListener(type: "buttonachanged" | "buttonbchanged", listener: (data: ButtonData) => void): void;
+    addEventListener(type: "magnetometerdatachanged", listener: (data: MagnetometerData) => void): void;
+    addEventListener(type: "uartdata", listener: (data: UartData) => void): void;
+    removeEventListener(type: "status", listener: (data: ConnectionStatusChange) => void): void;
+    removeEventListener(type: "backgrounderror", listener: (data: BackgroundErrorData) => void): void;
+    removeEventListener(type: "beforerequestdevice", listener: () => void): void;
+    removeEventListener(type: "afterrequestdevice", listener: () => void): void;
+    removeEventListener(type: "flash", listener: () => void): void;
+    removeEventListener(type: "accelerometerdatachanged", listener: (data: AccelerometerData) => void): void;
+    removeEventListener(type: "buttonachanged" | "buttonbchanged", listener: (data: ButtonData) => void): void;
+    removeEventListener(type: "magnetometerdatachanged", listener: (data: MagnetometerData) => void): void;
+    removeEventListener(type: "uartdata", listener: (data: UartData) => void): void;
+    /**
+     * Sets micro:bit name filter for device requesting.
+     *
+     * @param name The name of the micro:bit.
+     */
+    setNameFilter(name: string): void;
+    /**
+     * Gets micro:bit accelerometer data.
+     *
+     * @returns accelerometer data.
+     * @throws {DeviceError} with code `not-connected` if there is no connection.
+     */
+    getAccelerometerData(): Promise<AccelerometerData>;
+    /**
+     * Gets micro:bit accelerometer period.
+     *
+     * @returns accelerometer period.
+     * @throws {DeviceError} with code `not-connected` if there is no connection.
+     */
+    getAccelerometerPeriod(): Promise<number>;
+    /**
+     * Sets micro:bit accelerometer period.
+     *
+     * @param value The accelerometer period.
+     * @throws {DeviceError} with code `not-connected` if there is no connection.
+     */
+    setAccelerometerPeriod(value: number): Promise<void>;
+    /**
+     * Sets micro:bit LED text.
+     *
+     * @param text The text displayed on micro:bit LED.
+     * @throws {DeviceError} with code `not-connected` if there is no connection.
+     */
+    setLedText(text: string): Promise<void>;
+    /**
+     * Gets micro:bit LED scrolling delay.
+     *
+     * @returns LED scrolling delay in milliseconds.
+     * @throws {DeviceError} with code `not-connected` if there is no connection.
+     */
+    getLedScrollingDelay(): Promise<number>;
+    /**
+     * Sets micro:bit LED scrolling delay.
+     *
+     * @param delayInMillis LED scrolling delay in milliseconds.
+     * @throws {DeviceError} with code `not-connected` if there is no connection.
+     */
+    setLedScrollingDelay(delayInMillis: number): Promise<void>;
+    /**
+     * Gets micro:bit LED matrix.
+     *
+     * @returns a boolean matrix representing the micro:bit LED display.
+     * @throws {DeviceError} with code `not-connected` if there is no connection.
+     */
+    getLedMatrix(): Promise<LedMatrix>;
+    /**
+     * Sets micro:bit LED matrix.
+     *
+     * @param matrix an boolean matrix representing the micro:bit LED display.
+     * @throws {DeviceError} with code `not-connected` if there is no connection.
+     */
+    setLedMatrix(matrix: LedMatrix): Promise<void>;
+    /**
+     * Gets micro:bit magnetometer data.
+     *
+     * @returns magnetometer data.
+     * @throws {DeviceError} with code `not-connected` if there is no connection.
+     */
+    getMagnetometerData(): Promise<MagnetometerData>;
+    /**
+     * Gets micro:bit magnetometer bearing.
+     *
+     * @returns magnetometer bearing.
+     * @throws {DeviceError} with code `not-connected` if there is no connection.
+     */
+    getMagnetometerBearing(): Promise<number>;
+    /**
+     * Gets micro:bit magnetometer period.
+     *
+     * @returns magnetometer period.
+     * @throws {DeviceError} with code `not-connected` if there is no connection.
+     */
+    getMagnetometerPeriod(): Promise<number>;
+    /**
+     * Sets micro:bit magnetometer period.
+     *
+     * @param value magnetometer period.
+     * @throws {DeviceError} with code `not-connected` if there is no connection.
+     */
+    setMagnetometerPeriod(value: number): Promise<void>;
+    /**
+     * Triggers micro:bit magnetometer calibration.
+     *
+     * @throws {DeviceError} with code `not-connected` if there is no connection.
+     */
+    triggerMagnetometerCalibration(): Promise<void>;
+    /**
+     * Write UART messages.
+     *
+     * @param data UART message.
+     * @throws {DeviceError} with code `not-connected` if there is no connection.
+     */
+    uartWrite(data: Uint8Array): Promise<void>;
+    flash(dataSource: FlashDataSource, options: FlashOptions): Promise<void>;
+}
+/**
+ * A Bluetooth connection factory.
+ */
+export declare const createBluetoothConnection: (options?: MicrobitBluetoothConnectionOptions) => MicrobitBluetoothConnection;