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

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":["../../src/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/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,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;