@microbit/microbit-connection 0.9.0-apps.alpha.2 → 0.9.0-apps.alpha.20

package/build/cjs/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/cjs/async-util.js

@@ -10,7 +10,11 @@ exports.disconnectErrorCallback = disconnectErrorCallback;
  *
  * SPDX-License-Identifier: MIT
  */
-class TimeoutError extends Error {
+const device_js_1 = require("./device.js");
+class TimeoutError extends device_js_1.DeviceError {
+    constructor(message = "Timeout") {
+        super({ code: "timeout", message });
+    }
 }
 exports.TimeoutError = TimeoutError;
 class DisconnectError extends Error {

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

@@ -1 +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"}
+{"version":3,"file":"async-util.js","sourceRoot":"","sources":["../../src/async-util.ts"],"names":[],"mappings":";;;AAwBA,kCAQC;AAED,sBAEC;AAED,8CAMC;AAED,0DAMC;AApDD;;;;GAIG;AACH,2CAA0C;AAE1C,MAAa,YAAa,SAAQ,uBAAW;IAC3C,YAAY,UAAkB,SAAS;QACrC,KAAK,CAAC,EAAE,IAAI,EAAE,SAAS,EAAE,OAAO,EAAE,CAAC,CAAC;IACtC,CAAC;CACF;AAJD,oCAIC;AAED,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/async-util.test.d.ts

@@ -0,0 +1 @@
+export {};

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

@@ -0,0 +1,20 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+/**
+ * (c) 2021, Micro:bit Educational Foundation and contributors
+ *
+ * SPDX-License-Identifier: MIT
+ */
+const vitest_1 = require("vitest");
+const async_util_js_1 = require("./async-util.js");
+(0, vitest_1.describe)("withTimeout", () => {
+    (0, vitest_1.it)("times out", async () => {
+        const neverResolves = new Promise(() => { });
+        await (0, vitest_1.expect)(() => (0, async_util_js_1.withTimeout)(neverResolves, 0)).rejects.toThrowError(async_util_js_1.TimeoutError);
+    });
+    (0, vitest_1.it)("returns the value", async () => {
+        const resolvesWithValue = async () => "foo";
+        (0, vitest_1.expect)(await (0, async_util_js_1.withTimeout)(resolvesWithValue(), 10)).toEqual("foo");
+    });
+});
+//# sourceMappingURL=async-util.test.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"async-util.test.js","sourceRoot":"","sources":["../../src/async-util.test.ts"],"names":[],"mappings":";;AAAA;;;;GAIG;AACH,mCAA8C;AAC9C,mDAA4D;AAE5D,IAAA,iBAAQ,EAAC,aAAa,EAAE,GAAG,EAAE;IAC3B,IAAA,WAAE,EAAC,WAAW,EAAE,KAAK,IAAI,EAAE;QACzB,MAAM,aAAa,GAAG,IAAI,OAAO,CAAC,GAAG,EAAE,GAAE,CAAC,CAAC,CAAC;QAC5C,MAAM,IAAA,eAAM,EAAC,GAAG,EAAE,CAAC,IAAA,2BAAW,EAAC,aAAa,EAAE,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,YAAY,CACpE,4BAAY,CACb,CAAC;IACJ,CAAC,CAAC,CAAC;IACH,IAAA,WAAE,EAAC,mBAAmB,EAAE,KAAK,IAAI,EAAE;QACjC,MAAM,iBAAiB,GAAG,KAAK,IAAI,EAAE,CAAC,KAAK,CAAC;QAC5C,IAAA,eAAM,EAAC,MAAM,IAAA,2BAAW,EAAC,iBAAiB,EAAE,EAAE,EAAE,CAAC,CAAC,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC;IACpE,CAAC,CAAC,CAAC;AACL,CAAC,CAAC,CAAC"}

package/build/cjs/availability.d.ts

@@ -0,0 +1,14 @@
+/**
+ * (c) 2021, Micro:bit Educational Foundation and contributors
+ *
+ * SPDX-License-Identifier: MIT
+ */
+import { ConnectionAvailabilityStatus } from "./device.js";
+/**
+ * Throws a DeviceError if the availability status indicates the connection is unavailable.
+ * The error codes align with ConnectionAvailabilityStatus values.
+ *
+ * @param status - The availability status to check.
+ * @throws {DeviceError} If status is not "available".
+ */
+export declare const throwIfUnavailable: (status: ConnectionAvailabilityStatus) => void;

package/build/cjs/availability.js

@@ -0,0 +1,44 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.throwIfUnavailable = void 0;
+/**
+ * (c) 2021, Micro:bit Educational Foundation and contributors
+ *
+ * SPDX-License-Identifier: MIT
+ */
+const device_js_1 = require("./device.js");
+/**
+ * Throws a DeviceError if the availability status indicates the connection is unavailable.
+ * The error codes align with ConnectionAvailabilityStatus values.
+ *
+ * @param status - The availability status to check.
+ * @throws {DeviceError} If status is not "available".
+ */
+const throwIfUnavailable = (status) => {
+    switch (status) {
+        case "available":
+            return;
+        case "unsupported":
+            throw new device_js_1.DeviceError({
+                code: "unsupported",
+                message: "Connection type not supported",
+            });
+        case "disabled":
+            throw new device_js_1.DeviceError({
+                code: "disabled",
+                message: "Connection is disabled",
+            });
+        case "permission-denied":
+            throw new device_js_1.DeviceError({
+                code: "permission-denied",
+                message: "Permission denied",
+            });
+        case "location-disabled":
+            throw new device_js_1.DeviceError({
+                code: "location-disabled",
+                message: "Location services disabled",
+            });
+    }
+};
+exports.throwIfUnavailable = throwIfUnavailable;
+//# sourceMappingURL=availability.js.map

package/build/cjs/availability.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"availability.js","sourceRoot":"","sources":["../../src/availability.ts"],"names":[],"mappings":";;;AAAA;;;;GAIG;AACH,2CAAwE;AAExE;;;;;;GAMG;AACI,MAAM,kBAAkB,GAAG,CAChC,MAAoC,EAC9B,EAAE;IACR,QAAQ,MAAM,EAAE,CAAC;QACf,KAAK,WAAW;YACd,OAAO;QACT,KAAK,aAAa;YAChB,MAAM,IAAI,uBAAW,CAAC;gBACpB,IAAI,EAAE,aAAa;gBACnB,OAAO,EAAE,+BAA+B;aACzC,CAAC,CAAC;QACL,KAAK,UAAU;YACb,MAAM,IAAI,uBAAW,CAAC;gBACpB,IAAI,EAAE,UAAU;gBAChB,OAAO,EAAE,wBAAwB;aAClC,CAAC,CAAC;QACL,KAAK,mBAAmB;YACtB,MAAM,IAAI,uBAAW,CAAC;gBACpB,IAAI,EAAE,mBAAmB;gBACzB,OAAO,EAAE,mBAAmB;aAC7B,CAAC,CAAC;QACL,KAAK,mBAAmB;YACtB,MAAM,IAAI,uBAAW,CAAC;gBACpB,IAAI,EAAE,mBAAmB;gBACzB,OAAO,EAAE,4BAA4B;aACtC,CAAC,CAAC;IACP,CAAC;AACH,CAAC,CAAC;AA3BW,QAAA,kBAAkB,sBA2B7B"}

package/build/cjs/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/cjs/bluetooth/ble-error.js

@@ -0,0 +1,47 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.mapBleError = void 0;
+exports.withBleErrorMapping = withBleErrorMapping;
+const device_js_1 = require("../device.js");
+/**
+ * Maps BLE errors from @capacitor-community/bluetooth-le (and Web Bluetooth)
+ * to DeviceError with an appropriate code.
+ */
+const mapBleError = (e) => {
+    if (e instanceof device_js_1.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 device_js_1.DeviceError({ code, message, cause: e });
+};
+exports.mapBleError = mapBleError;
+/**
+ * Wraps an async operation so that any BLE error is mapped to a DeviceError.
+ */
+async function withBleErrorMapping(fn) {
+    try {
+        return await fn();
+    }
+    catch (e) {
+        throw (0, exports.mapBleError)(e);
+    }
+}
+//# sourceMappingURL=ble-error.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"ble-error.js","sourceRoot":"","sources":["../../../src/bluetooth/ble-error.ts"],"names":[],"mappings":";;;AAoCA,kDAMC;AA1CD,4CAA4D;AAE5D;;;GAGG;AACI,MAAM,WAAW,GAAG,CAAC,CAAU,EAAe,EAAE;IACrD,IAAI,CAAC,YAAY,uBAAW,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,uBAAW,CAAC,EAAE,IAAI,EAAE,OAAO,EAAE,KAAK,EAAE,CAAC,EAAE,CAAC,CAAC;AACtD,CAAC,CAAC;AAzBW,QAAA,WAAW,eAyBtB;AAEF;;GAEG;AACI,KAAK,UAAU,mBAAmB,CAAI,EAAoB;IAC/D,IAAI,CAAC;QACH,OAAO,MAAM,EAAE,EAAE,CAAC;IACpB,CAAC;IAAC,OAAO,CAAC,EAAE,CAAC;QACX,MAAM,IAAA,mBAAW,EAAC,CAAC,CAAC,CAAC;IACvB,CAAC;AACH,CAAC"}

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

@@ -0,0 +1,378 @@
+import { BackgroundErrorData, ConnectionStatusChange, DeviceConnection, FlashDataSource, FlashOptions } from "../device.js";
+import { Logging } from "../logging.js";
+import { AccelerometerData, ButtonActionData, ButtonData, GestureData, LedMatrix, MagnetometerData, MicrobitEventData, PinData, PinValue, TemperatureData, UartData } from "../service-events.js";
+import { DeviceBondState } from "./device-bond-state.js";
+export interface MicrobitBluetoothConnectionOptions {
+    logging?: Logging;
+    deviceBondState?: DeviceBondState;
+}
+/**
+ * A Bluetooth connection to a micro:bit device.
+ *
+ * Events and methods rely on specific BLE services being present in the
+ * micro:bit's firmware. Which services are available depends on the firmware
+ * build for C++ and for a MakeCode program depends on the service blocks added
+ * from the Bluetooth extension.
+ *
+ * The table below maps each event and method to the BLE service it requires.
+ * If a service is not present, the event will silently not fire (no error is
+ * raised) and methods that depend on it will throw.
+ *
+ * ### Accelerometer Service
+ * - `accelerometerdatachanged` event
+ * - {@link getAccelerometerData}, {@link getAccelerometerPeriod}, {@link setAccelerometerPeriod}
+ *
+ * ### Button Service
+ * - `buttonachanged`, `buttonbchanged` events
+ *
+ * ### Event Service
+ * - `gesturechanged` event — also requires the accelerometer hardware to be
+ *   active; this happens automatically if the Accelerometer Service is present
+ * - `buttonaaction`, `buttonbaction`, `buttonabaction` events
+ * - `logoaction` event (V2 only)
+ * - `microbitevent` event
+ * - {@link subscribeToEvent}, {@link sendEvent}
+ *
+ * ### IO Pin Service
+ * - `pinchanged` event
+ * - {@link getAnalogPins}, {@link setAnalogPins}
+ * - {@link getInputPins}, {@link setInputPins}
+ * - {@link readPins}, {@link writePins}, {@link writePinPwm}
+ *
+ * ### LED Service
+ * - {@link setLedText}, {@link getLedScrollingDelay}, {@link setLedScrollingDelay}
+ * - {@link getLedMatrix}, {@link setLedMatrix}
+ *
+ * ### Magnetometer Service
+ * - `magnetometerdatachanged` event
+ * - {@link getMagnetometerData}, {@link getMagnetometerBearing}
+ * - {@link getMagnetometerPeriod}, {@link setMagnetometerPeriod}
+ * - {@link triggerMagnetometerCalibration}
+ *
+ * ### Temperature Service
+ * - `temperaturechanged` event
+ * - {@link getTemperature}, {@link getTemperaturePeriod}, {@link setTemperaturePeriod}
+ *
+ * ### UART Service
+ * - `uartdata` event
+ * - {@link uartWrite}
+ */
+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;
+    /** Requires: Accelerometer Service. */
+    addEventListener(type: "accelerometerdatachanged", listener: (data: AccelerometerData) => void): void;
+    /** Requires: Button Service. */
+    addEventListener(type: "buttonachanged" | "buttonbchanged", listener: (data: ButtonData) => void): void;
+    /** Requires: Magnetometer Service. */
+    addEventListener(type: "magnetometerdatachanged", listener: (data: MagnetometerData) => void): void;
+    /** Requires: Temperature Service. */
+    addEventListener(type: "temperaturechanged", listener: (data: TemperatureData) => void): void;
+    /** Requires: IO Pin Service. */
+    addEventListener(type: "pinchanged", listener: (data: PinData) => void): void;
+    /** Requires: Event Service. The accelerometer hardware must also be active (automatic if the Accelerometer Service is present). */
+    addEventListener(type: "gesturechanged", listener: (data: GestureData) => void): void;
+    /** Requires: Event Service. */
+    addEventListener(type: "buttonaaction" | "buttonbaction" | "buttonabaction", listener: (data: ButtonActionData) => void): void;
+    /** Requires: Event Service. V2 only. */
+    addEventListener(type: "logoaction", listener: (data: ButtonActionData) => void): void;
+    /**
+     * Requires: Event Service. Receives raw micro:bit message bus events
+     * registered via {@link subscribeToEvent}. Higher-level events supported
+     * by the event service, like `gesturechanged` and button actions, are not
+     * included here unless you subscribe to them using {@link subscribeToEvent}.
+     */
+    addEventListener(type: "microbitevent", listener: (data: MicrobitEventData) => void): void;
+    /** Requires: UART Service. */
+    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: "temperaturechanged", listener: (data: TemperatureData) => void): void;
+    removeEventListener(type: "pinchanged", listener: (data: PinData) => void): void;
+    removeEventListener(type: "gesturechanged", listener: (data: GestureData) => void): void;
+    removeEventListener(type: "buttonaaction" | "buttonbaction" | "buttonabaction", listener: (data: ButtonActionData) => void): void;
+    removeEventListener(type: "logoaction", listener: (data: ButtonActionData) => void): void;
+    removeEventListener(type: "microbitevent", listener: (data: MicrobitEventData) => 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.
+     *
+     * Requires: Accelerometer Service.
+     *
+     * @returns accelerometer data.
+     * @throws {DeviceError} with code `not-connected` if there is no connection.
+     */
+    getAccelerometerData(): Promise<AccelerometerData>;
+    /**
+     * Gets micro:bit accelerometer period.
+     *
+     * Requires: Accelerometer Service.
+     *
+     * @returns accelerometer period.
+     * @throws {DeviceError} with code `not-connected` if there is no connection.
+     */
+    getAccelerometerPeriod(): Promise<number>;
+    /**
+     * Sets micro:bit accelerometer period.
+     *
+     * Requires: Accelerometer Service.
+     *
+     * @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.
+     *
+     * Requires: LED Service.
+     *
+     * @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.
+     *
+     * Requires: LED Service.
+     *
+     * @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.
+     *
+     * Requires: LED Service.
+     *
+     * @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.
+     *
+     * Requires: LED Service.
+     *
+     * @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.
+     *
+     * Requires: LED Service.
+     *
+     * @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.
+     *
+     * Requires: Magnetometer Service.
+     *
+     * @returns magnetometer data.
+     * @throws {DeviceError} with code `not-connected` if there is no connection.
+     */
+    getMagnetometerData(): Promise<MagnetometerData>;
+    /**
+     * Gets micro:bit magnetometer bearing.
+     *
+     * Requires: Magnetometer Service.
+     *
+     * @returns magnetometer bearing.
+     * @throws {DeviceError} with code `not-connected` if there is no connection.
+     */
+    getMagnetometerBearing(): Promise<number>;
+    /**
+     * Gets micro:bit magnetometer period.
+     *
+     * Requires: Magnetometer Service.
+     *
+     * @returns magnetometer period.
+     * @throws {DeviceError} with code `not-connected` if there is no connection.
+     */
+    getMagnetometerPeriod(): Promise<number>;
+    /**
+     * Sets micro:bit magnetometer period.
+     *
+     * Requires: Magnetometer Service.
+     *
+     * @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.
+     *
+     * Requires: Magnetometer Service.
+     *
+     * @throws {DeviceError} with code `not-connected` if there is no connection.
+     */
+    triggerMagnetometerCalibration(): Promise<void>;
+    /**
+     * Gets the micro:bit temperature in degrees Celsius.
+     *
+     * Requires: Temperature Service.
+     *
+     * @returns temperature in degrees Celsius.
+     * @throws {DeviceError} with code `not-connected` if there is no connection.
+     */
+    getTemperature(): Promise<number>;
+    /**
+     * Gets the micro:bit temperature sensor period.
+     *
+     * Requires: Temperature Service.
+     *
+     * @returns temperature period in milliseconds.
+     * @throws {DeviceError} with code `not-connected` if there is no connection.
+     */
+    getTemperaturePeriod(): Promise<number>;
+    /**
+     * Sets the micro:bit temperature sensor period.
+     *
+     * Requires: Temperature Service.
+     *
+     * @param value period in milliseconds.
+     * @throws {DeviceError} with code `not-connected` if there is no connection.
+     */
+    setTemperaturePeriod(value: number): Promise<void>;
+    /**
+     * Gets which pins are configured as analog.
+     * All other pins are digital (the default).
+     *
+     * Requires: IO Pin Service.
+     *
+     * @returns array of pin numbers (0-18) configured as analog.
+     * @throws {DeviceError} with code `not-connected` if there is no connection.
+     */
+    getAnalogPins(): Promise<number[]>;
+    /**
+     * Sets which pins are configured as analog.
+     * All other pins become digital (the default).
+     *
+     * Requires: IO Pin Service.
+     *
+     * @param pins array of pin numbers (0-18) to configure as analog.
+     * @throws {DeviceError} with code `not-connected` if there is no connection.
+     */
+    setAnalogPins(pins: number[]): Promise<void>;
+    /**
+     * Gets which pins are configured as inputs.
+     * Input pins are monitored and their values reported via notifications.
+     * All other pins are outputs (the default).
+     *
+     * Requires: IO Pin Service.
+     *
+     * @returns array of pin numbers (0-18) configured as inputs.
+     * @throws {DeviceError} with code `not-connected` if there is no connection.
+     */
+    getInputPins(): Promise<number[]>;
+    /**
+     * Sets which pins are configured as inputs.
+     * Input pins are monitored and their values reported via notifications.
+     * All other pins become outputs (the default).
+     *
+     * Note: configuring a pin as input overrides any existing pin mode
+     * (e.g. touch sensing used by MakeCode "on pin pressed" blocks).
+     * The two cannot be used on the same pin simultaneously.
+     *
+     * Requires: IO Pin Service.
+     *
+     * @param pins array of pin numbers (0-18) to configure as inputs.
+     * @throws {DeviceError} with code `not-connected` if there is no connection.
+     */
+    setInputPins(pins: number[]): Promise<void>;
+    /**
+     * Reads current values of input pins. Unlike the `pinchanged` event
+     * (which only includes pins whose values changed), this returns every
+     * pin configured as an input, up to a firmware limit of 10 pins
+     * (lowest-numbered first).
+     *
+     * Requires: IO Pin Service.
+     *
+     * @returns array of pin/value pairs.
+     * @throws {DeviceError} with code `not-connected` if there is no connection.
+     */
+    readPins(): Promise<PinValue[]>;
+    /**
+     * Writes pin data for output pins.
+     *
+     * Requires: IO Pin Service.
+     *
+     * @param data array of pin/value pairs.
+     * @throws {DeviceError} with code `not-connected` if there is no connection.
+     */
+    writePins(data: PinValue[]): Promise<void>;
+    /**
+     * Sets PWM output on a pin.
+     *
+     * Requires: IO Pin Service.
+     *
+     * @param pin Pin number (0-18).
+     * @param options PWM configuration.
+     * @param options.value Analog value (0-1024).
+     * @param options.period Period in microseconds.
+     * @throws {DeviceError} with code `not-connected` if there is no connection.
+     */
+    writePinPwm(pin: number, options: {
+        value: number;
+        period: number;
+    }): Promise<void>;
+    /**
+     * Register interest in a specific micro:bit message bus event.
+     * Tells the micro:bit to forward matching message bus traffic over BLE.
+     * Matching events are dispatched as `microbitevent`.
+     * Use 0 as the value to match all events from a source.
+     *
+     * For common message bus events, consider the higher-level alternatives:
+     * `gesturechanged`, `buttonaaction`, `buttonbaction`, `buttonabaction`.
+     *
+     * Requires: Event Service.
+     *
+     * @param source Event source ID.
+     * @param value Event value to match, or 0 for any.
+     * @throws {DeviceError} with code `not-connected` if there is no connection.
+     */
+    subscribeToEvent(source: number, value: number): Promise<void>;
+    /**
+     * Send an event to the micro:bit's message bus.
+     *
+     * Requires: Event Service.
+     *
+     * @param source Event source ID.
+     * @param value Event value.
+     * @throws {DeviceError} with code `not-connected` if there is no connection.
+     */
+    sendEvent(source: number, value: number): Promise<void>;
+    /**
+     * Write UART messages.
+     *
+     * Requires: UART Service.
+     *
+     * @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;