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

package/build/esm/board-id.d.ts

@@ -0,0 +1,36 @@
+/**
+ * (c) 2021, Micro:bit Educational Foundation and contributors
+ *
+ * SPDX-License-Identifier: MIT
+ */
+import { BoardVersion } from "./device.js";
+/**
+ * Validates micro:bit board IDs.
+ */
+export declare class BoardId {
+    id: number;
+    private static v1Normalized;
+    private static v2Normalized;
+    constructor(id: number);
+    toBoardVersion(): BoardVersion;
+    isV1(): boolean;
+    isV2(): boolean;
+    /**
+     * Return the board ID using the default ID for the board type.
+     * Used to integrate with MicropythonFsHex.
+     */
+    normalize(): BoardId;
+    /**
+     * toString matches the input to parse.
+     *
+     * @returns the ID as a string.
+     */
+    toString(): string;
+    /**
+     * @param value The ID as a hex string with no 0x prefix (e.g. 9900).
+     * @returns the valid board ID
+     * @throws if the ID isn't known.
+     */
+    static parse(value: string): BoardId;
+    static forVersion(boardVersion: BoardVersion): BoardId;
+}

package/build/esm/board-id.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"board-id.js","sourceRoot":"","sources":["../../lib/board-id.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAIH;;GAEG;AACH,MAAM,OAAO,OAAO;IAIlB,YAAmB,EAAU;QAAjB;;;;mBAAO,EAAE;WAAQ;QAC3B,IAAI,CAAC,IAAI,CAAC,IAAI,EAAE,IAAI,CAAC,IAAI,CAAC,IAAI,EAAE,EAAE,CAAC;YACjC,MAAM,IAAI,KAAK,CAAC,oCAAoC,EAAE,CAAC,QAAQ,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC;QACzE,CAAC;IACH,CAAC;IAED,cAAc;QACZ,OAAO,IAAI,CAAC,IAAI,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC;IACnC,CAAC;IAED,IAAI;QACF,OAAO,IAAI,CAAC,EAAE,KAAK,MAAM,IAAI,IAAI,CAAC,EAAE,KAAK,MAAM,CAAC;IAClD,CAAC;IAED,IAAI;QACF,OAAO,CACL,IAAI,CAAC,EAAE,KAAK,MAAM;YAClB,IAAI,CAAC,EAAE,KAAK,MAAM;YAClB,IAAI,CAAC,EAAE,KAAK,MAAM;YAClB,IAAI,CAAC,EAAE,KAAK,MAAM,CACnB,CAAC;IACJ,CAAC;IAED;;;OAGG;IACH,SAAS;QACP,OAAO,IAAI,CAAC,IAAI,EAAE,CAAC,CAAC,CAAC,OAAO,CAAC,YAAY,CAAC,CAAC,CAAC,OAAO,CAAC,YAAY,CAAC;IACnE,CAAC;IAED;;;;OAIG;IACH,QAAQ;QACN,OAAO,IAAI,CAAC,EAAE,CAAC,QAAQ,CAAC,EAAE,CAAC,CAAC;IAC9B,CAAC;IAED;;;;OAIG;IACH,MAAM,CAAC,KAAK,CAAC,KAAa;QACxB,OAAO,IAAI,OAAO,CAAC,QAAQ,CAAC,KAAK,EAAE,EAAE,CAAC,CAAC,CAAC;IAC1C,CAAC;IAED,MAAM,CAAC,UAAU,CAAC,YAA0B;QAC1C,QAAQ,YAAY,EAAE,CAAC;YACrB,KAAK,IAAI;gBACP,OAAO,IAAI,CAAC,YAAY,CAAC;YAC3B,KAAK,IAAI;gBACP,OAAO,IAAI,CAAC,YAAY,CAAC;QAC7B,CAAC;IACH,CAAC;;AA3Dc;;;;WAAe,IAAI,OAAO,CAAC,MAAM,CAAC;EAAtB,CAAuB;AACnC;;;;WAAe,IAAI,OAAO,CAAC,MAAM,CAAC;EAAtB,CAAuB"}

package/build/esm/board-serial-info.d.ts

@@ -0,0 +1,14 @@
+/**
+ * (c) 2021, Micro:bit Educational Foundation and contributors
+ *
+ * SPDX-License-Identifier: MIT
+ */
+import { BoardId } from "./board-id.js";
+export declare class BoardSerialInfo {
+    id: BoardId;
+    familyId: string;
+    hic: string;
+    constructor(id: BoardId, familyId: string, hic: string);
+    static parse(device: USBDevice, log: (msg: string) => void): BoardSerialInfo;
+    eq(other: BoardSerialInfo): boolean;
+}

package/build/esm/board-serial-info.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"board-serial-info.js","sourceRoot":"","sources":["../../lib/board-serial-info.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AACH,OAAO,EAAE,OAAO,EAAE,MAAM,eAAe,CAAC;AAExC,MAAM,OAAO,eAAe;IAC1B,YACS,EAAW,EACX,QAAgB,EAChB,GAAW;QAFlB;;;;mBAAO,EAAE;WAAS;QAClB;;;;mBAAO,QAAQ;WAAQ;QACvB;;;;mBAAO,GAAG;WAAQ;IACjB,CAAC;IACJ,MAAM,CAAC,KAAK,CAAC,MAAiB,EAAE,GAA0B;QACxD,MAAM,MAAM,GAAG,MAAM,CAAC,YAAY,CAAC;QACnC,IAAI,CAAC,MAAM,EAAE,CAAC;YACZ,MAAM,IAAI,KAAK,CAAC,6CAA6C,CAAC,CAAC;QACjE,CAAC;QACD,IAAI,MAAM,CAAC,MAAM,KAAK,EAAE,EAAE,CAAC;YACzB,GAAG,CAAC,wCAAwC,MAAM,CAAC,MAAM,EAAE,CAAC,CAAC;QAC/D,CAAC;QACD,MAAM,EAAE,GAAG,MAAM,CAAC,SAAS,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC;QAClC,MAAM,QAAQ,GAAG,MAAM,CAAC,SAAS,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC;QACxC,MAAM,GAAG,GAAG,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC;QAC7B,OAAO,IAAI,eAAe,CAAC,OAAO,CAAC,KAAK,CAAC,EAAE,CAAC,EAAE,QAAQ,EAAE,GAAG,CAAC,CAAC;IAC/D,CAAC;IAED,EAAE,CAAC,KAAsB;QACvB,OAAO,CACL,KAAK,CAAC,EAAE,KAAK,IAAI,CAAC,EAAE;YACpB,KAAK,CAAC,QAAQ,KAAK,IAAI,CAAC,QAAQ;YAChC,KAAK,CAAC,GAAG,KAAK,IAAI,CAAC,GAAG,CACvB,CAAC;IACJ,CAAC;CACF"}

package/build/esm/button-service.d.ts

@@ -0,0 +1,13 @@
+import { Service } from "./bluetooth-device-wrapper.js";
+import { TypedServiceEvent, TypedServiceEventDispatcher } from "./service-events.js";
+export declare class ButtonService implements Service {
+    private deviceId;
+    private dispatchTypedEvent;
+    uuid: string;
+    constructor(deviceId: string, dispatchTypedEvent: TypedServiceEventDispatcher);
+    getRelevantEvents(): TypedServiceEvent[];
+    private dataViewToButtonState;
+    startNotifications(type: TypedServiceEvent): Promise<void>;
+    stopNotifications(type: TypedServiceEvent): Promise<void>;
+    private characteristicForButtonEventType;
+}

package/build/esm/button-service.js

@@ -0,0 +1,62 @@
+import { BleClient } from "@capacitor-community/bluetooth-le";
+import { profile } from "./bluetooth-profile.js";
+import { ButtonEvent } from "./buttons.js";
+import { BackgroundErrorEvent } from "./device.js";
+export class ButtonService {
+    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: profile.button.id
+        });
+    }
+    getRelevantEvents() {
+        return ["buttonachanged", "buttonbchanged"];
+    }
+    dataViewToButtonState(dataView) {
+        return dataView.getUint8(0);
+    }
+    async startNotifications(type) {
+        switch (type) {
+            case "buttonachanged":
+            case "buttonbchanged": {
+                try {
+                    await BleClient.startNotifications(this.deviceId, profile.button.id, this.characteristicForButtonEventType(type).id, (value) => {
+                        const data = this.dataViewToButtonState(value);
+                        this.dispatchTypedEvent(type, new ButtonEvent(type, data));
+                    });
+                }
+                catch (e) {
+                    this.dispatchTypedEvent("backgrounderror", new BackgroundErrorEvent("Failed to start notifications", e));
+                }
+            }
+        }
+    }
+    async stopNotifications(type) {
+        switch (type) {
+            case "buttonachanged":
+            case "buttonbchanged": {
+                await BleClient.stopNotifications(this.deviceId, profile.button.id, this.characteristicForButtonEventType(type).id);
+            }
+        }
+    }
+    characteristicForButtonEventType(type) {
+        return type === "buttonachanged"
+            ? profile.button.characteristics.a
+            : profile.button.characteristics.b;
+    }
+}
+//# sourceMappingURL=button-service.js.map

package/build/esm/button-service.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"button-service.js","sourceRoot":"","sources":["../../lib/button-service.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,MAAM,mCAAmC,CAAC;AAE9D,OAAO,EAAE,OAAO,EAAE,MAAM,wBAAwB,CAAC;AACjD,OAAO,EAAE,WAAW,EAAe,MAAM,cAAc,CAAC;AAKxD,OAAO,EAAE,oBAAoB,EAAE,MAAM,aAAa,CAAC;AAEnD,MAAM,OAAO,aAAa;IAGxB,YACU,QAAgB,EAChB,kBAA+C;QADvD;;;;mBAAQ,QAAQ;WAAQ;QACxB;;;;mBAAQ,kBAAkB;WAA6B;QAJzD;;;;mBAAO,OAAO,CAAC,MAAM,CAAC,EAAE;WAAC;IAKtB,CAAC;IAEJ,iBAAiB;QACf,OAAO,CAAC,gBAAgB,EAAE,gBAAgB,CAAC,CAAC;IAC9C,CAAC;IAEO,qBAAqB,CAAC,QAAkB;QAC9C,OAAO,QAAQ,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC;IAC9B,CAAC;IAED,KAAK,CAAC,kBAAkB,CAAC,IAAuB;QAC9C,QAAQ,IAAI,EAAE,CAAC;YACb,KAAK,gBAAgB,CAAC;YACtB,KAAK,gBAAgB,CAAC,CAAC,CAAC;gBACtB,IAAI,CAAC;oBACH,MAAM,SAAS,CAAC,kBAAkB,CAChC,IAAI,CAAC,QAAQ,EACb,OAAO,CAAC,MAAM,CAAC,EAAE,EACjB,IAAI,CAAC,gCAAgC,CAAC,IAAI,CAAC,CAAC,EAAE,EAC9C,CAAC,KAAK,EAAE,EAAE;wBACR,MAAM,IAAI,GAAG,IAAI,CAAC,qBAAqB,CAAC,KAAK,CAAC,CAAC;wBAC/C,IAAI,CAAC,kBAAkB,CAAC,IAAI,EAAE,IAAI,WAAW,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC,CAAC;oBAC7D,CAAC,CACF,CAAC;gBACJ,CAAC;gBAAC,OAAO,CAAC,EAAE,CAAC;oBACX,IAAI,CAAC,kBAAkB,CACrB,iBAAiB,EACjB,IAAI,oBAAoB,CAAC,+BAA+B,EAAE,CAAC,CAAC,CAC7D,CAAC;gBACJ,CAAC;YACH,CAAC;QACH,CAAC;IACH,CAAC;IAED,KAAK,CAAC,iBAAiB,CAAC,IAAuB;QAC7C,QAAQ,IAAI,EAAE,CAAC;YACb,KAAK,gBAAgB,CAAC;YACtB,KAAK,gBAAgB,CAAC,CAAC,CAAC;gBACtB,MAAM,SAAS,CAAC,iBAAiB,CAC/B,IAAI,CAAC,QAAQ,EACb,OAAO,CAAC,MAAM,CAAC,EAAE,EACjB,IAAI,CAAC,gCAAgC,CAAC,IAAI,CAAC,CAAC,EAAE,CAC/C,CAAC;YACJ,CAAC;QACH,CAAC;IACH,CAAC;IAEO,gCAAgC,CACtC,IAAyC;QAEzC,OAAO,IAAI,KAAK,gBAAgB;YAC9B,CAAC,CAAC,OAAO,CAAC,MAAM,CAAC,eAAe,CAAC,CAAC;YAClC,CAAC,CAAC,OAAO,CAAC,MAAM,CAAC,eAAe,CAAC,CAAC,CAAC;IACvC,CAAC;CACF"}

package/build/esm/buttons.d.ts

@@ -0,0 +1,10 @@
+export declare enum ButtonState {
+    NotPressed = 0,
+    ShortPress = 1,
+    LongPress = 2
+}
+export type ButtonEventType = "buttonachanged" | "buttonbchanged";
+export declare class ButtonEvent extends Event {
+    readonly state: ButtonState;
+    constructor(type: ButtonEventType, state: ButtonState);
+}

package/build/esm/buttons.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"buttons.js","sourceRoot":"","sources":["../../lib/buttons.ts"],"names":[],"mappings":"AAAA,MAAM,CAAN,IAAY,WAIX;AAJD,WAAY,WAAW;IACrB,yDAAc,CAAA;IACd,yDAAc,CAAA;IACd,uDAAa,CAAA;AACf,CAAC,EAJW,WAAW,KAAX,WAAW,QAItB;AAID,MAAM,OAAO,WAAY,SAAQ,KAAK;IACpC,YACE,IAAqB,EACL,KAAkB;QAElC,KAAK,CAAC,IAAI,CAAC,CAAC;QAFZ;;;;mBAAgB,KAAK;WAAa;IAGpC,CAAC;CACF"}

package/build/esm/constants.d.ts

@@ -0,0 +1,48 @@
+/**
+ * (c) 2021, Micro:bit Educational Foundation and contributors
+ *
+ * SPDX-License-Identifier: MIT
+ */
+export declare const FICR: {
+    CODEPAGESIZE: number;
+    CODESIZE: number;
+    DEVICE_ID_1: number;
+};
+export declare const DapCmd: {
+    DAP_INFO: number;
+    DAP_CONNECT: number;
+    DAP_DISCONNECT: number;
+    DAP_TRANSFER: number;
+    DAP_TRANSFER_BLOCK: number;
+};
+export declare const Csw: {
+    CSW_SIZE: number;
+    CSW_SIZE32: number;
+    CSW_ADDRINC: number;
+    CSW_SADDRINC: number;
+    CSW_DBGSTAT: number;
+    CSW_HPROT: number;
+    CSW_MSTRDBG: number;
+    CSW_RESERVED: number;
+    CSW_VALUE: number;
+};
+export declare const DapVal: {
+    AP_ACC: number;
+    READ: number;
+    WRITE: number;
+};
+export declare const ApReg: {
+    CSW: number;
+    TAR: number;
+    DRW: number;
+};
+export declare const CortexSpecialReg: {
+    DEMCR: number;
+    DEMCR_VC_CORERESET: number;
+    CPUID: number;
+    DHCSR: number;
+    S_RESET_ST: number;
+    NVIC_AIRCR: number;
+    NVIC_AIRCR_VECTKEY: number;
+    NVIC_AIRCR_SYSRESETREQ: number;
+};

package/build/esm/constants.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"constants.js","sourceRoot":"","sources":["../../lib/constants.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAEH,sGAAsG;AACtG,yGAAyG;AAEzG,sGAAsG;AACtG,kEAAkE;AAClE,0EAA0E;AAE1E,iBAAiB;AACjB,MAAM,CAAC,MAAM,IAAI,GAAG;IAClB,YAAY,EAAE,UAAU,GAAG,IAAI;IAC/B,QAAQ,EAAE,UAAU,GAAG,IAAI;IAE3B,WAAW,EAAE,UAAU,GAAG,IAAI;CAC/B,CAAC;AAEF,MAAM,CAAC,MAAM,MAAM,GAAG;IACpB,QAAQ,EAAE,IAAI;IACd,WAAW,EAAE,IAAI;IACjB,cAAc,EAAE,IAAI;IACpB,YAAY,EAAE,IAAI;IAClB,kBAAkB,EAAE,IAAI;IACxB,aAAa;CACd,CAAC;AAEF,MAAM,CAAC,MAAM,GAAG,GAAG;IACjB,QAAQ,EAAE,UAAU;IACpB,UAAU,EAAE,UAAU;IACtB,WAAW,EAAE,UAAU;IACvB,YAAY,EAAE,UAAU;IACxB,WAAW,EAAE,UAAU;IACvB,SAAS,EAAE,UAAU;IACrB,WAAW,EAAE,UAAU;IACvB,YAAY,EAAE,UAAU;IACxB,SAAS,EAAE,CAAC,CAAC,EAAE,YAAY;IAC3B,aAAa;CACd,CAAC;AACF,GAAG,CAAC,SAAS;IACX,GAAG,CAAC,YAAY;QAChB,GAAG,CAAC,WAAW;QACf,GAAG,CAAC,SAAS;QACb,GAAG,CAAC,WAAW;QACf,GAAG,CAAC,YAAY,CAAC;AAEnB,MAAM,CAAC,MAAM,MAAM,GAAG;IACpB,MAAM,EAAE,CAAC,IAAI,CAAC;IACd,IAAI,EAAE,CAAC,IAAI,CAAC;IACZ,KAAK,EAAE,CAAC,IAAI,CAAC;IACb,QAAQ;CACT,CAAC;AAEF,MAAM,CAAC,MAAM,KAAK,GAAG;IACnB,GAAG,EAAE,IAAI;IACT,GAAG,EAAE,IAAI;IACT,GAAG,EAAE,IAAI;IACT,QAAQ;CACT,CAAC;AAEF,MAAM,CAAC,MAAM,gBAAgB,GAAG;IAC9B,+CAA+C;IAC/C,KAAK,EAAE,UAAU;IACjB,gDAAgD;IAChD,kBAAkB,EAAE,CAAC,IAAI,CAAC;IAE1B,iBAAiB;IACjB,KAAK,EAAE,UAAU;IAEjB,4CAA4C;IAC5C,KAAK,EAAE,UAAU;IACjB,UAAU,EAAE,CAAC,IAAI,EAAE;IAEnB,UAAU,EAAE,UAAU;IACtB,kBAAkB,EAAE,KAAK,IAAI,EAAE;IAC/B,sBAAsB,EAAE,CAAC,IAAI,CAAC;IAE9B,aAAa;CACd,CAAC"}

package/build/esm/device-information-service.d.ts

@@ -0,0 +1,6 @@
+import { BoardVersion } from "./device";
+export declare class DeviceInformationService {
+    private deviceId;
+    constructor(deviceId: string);
+    getBoardVersion(): Promise<BoardVersion>;
+}

package/build/esm/device-information-service.js

@@ -0,0 +1,30 @@
+import { BleClient } from "@capacitor-community/bluetooth-le";
+import { profile } from "./bluetooth-profile";
+export class DeviceInformationService {
+    constructor(deviceId) {
+        Object.defineProperty(this, "deviceId", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: deviceId
+        });
+    }
+    async getBoardVersion() {
+        const serviceMeta = profile.deviceInformation;
+        try {
+            const modelNumberBytes = await BleClient.read(this.deviceId, serviceMeta.id, serviceMeta.characteristics.modelNumber.id);
+            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) {
+            throw new Error(`Could not read model number: ${e instanceof Error ? e.message : e}`);
+        }
+    }
+}
+//# sourceMappingURL=device-information-service.js.map

package/build/esm/device-information-service.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"device-information-service.js","sourceRoot":"","sources":["../../lib/device-information-service.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,MAAM,mCAAmC,CAAC;AAE9D,OAAO,EAAE,OAAO,EAAE,MAAM,qBAAqB,CAAC;AAE9C,MAAM,OAAO,wBAAwB;IACnC,YAAoB,QAAgB;QAAxB;;;;mBAAQ,QAAQ;WAAQ;IAAG,CAAC;IAExC,KAAK,CAAC,eAAe;QACnB,MAAM,WAAW,GAAG,OAAO,CAAC,iBAAiB,CAAC;QAC9C,IAAI,CAAC;YACH,MAAM,gBAAgB,GAAG,MAAM,SAAS,CAAC,IAAI,CAC3C,IAAI,CAAC,QAAQ,EACb,WAAW,CAAC,EAAE,EACd,WAAW,CAAC,eAAe,CAAC,WAAW,CAAC,EAAE,CAC3C,CAAC;YACF,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,MAAM,IAAI,KAAK,CACb,gCAAgC,CAAC,YAAY,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,EAAE,CACrE,CAAC;QACJ,CAAC;IACH,CAAC;CACF"}

package/build/esm/device.d.ts

@@ -0,0 +1,238 @@
+/**
+ * (c) 2021, Micro:bit Educational Foundation and contributors
+ *
+ * SPDX-License-Identifier: MIT
+ */
+import { TypedEventTarget, ValueIsEvent } from "./events.js";
+/**
+ * Specific identified error types.
+ *
+ * New members may be added over time.
+ */
+export type DeviceErrorCode = 
+/**
+ * Device not selected, e.g. because the user cancelled the dialog.
+ */
+"no-device-selected"
+/**
+ * Device not found, perhaps because it doesn't have new enough firmware (for V1).
+ */
+ | "update-req"
+/**
+ * Unable to claim the interface, usually because it's in use in another tab/window.
+ */
+ | "clear-connect"
+/**
+ * The device was found to be disconnected.
+ */
+ | "device-disconnected"
+/**
+ * A communication timeout occurred.
+ */
+ | "timeout-error"
+/**
+ * This is the fallback error case suggesting that the user reconnects their device.
+ */
+ | "reconnect-microbit"
+/**
+ * Error occured during serial or bluetooth communication.
+ */
+ | "background-comms-error"
+/**
+ * Bluetooth service is missing on device.
+ */
+ | "service-missing"
+/**
+ * Failed to establish Bluetooth connection.
+ */
+ | "bluetooth-connection-failed"
+/**
+ * Bluetooth is disabled on the device.
+ */
+ | "bluetooth-disabled"
+/**
+ * Missing required Bluetooth permissions.
+ */
+ | "bluetooth-missing-permissions"
+/**
+ * Partial flash operation failed.
+ */
+ | "flash-partial-failed"
+/**
+ * Full flash operation failed.
+ */
+ | "flash-full-failed"
+/**
+ * Flash operation was cancelled.
+ */
+ | "flash-cancelled";
+export declare enum ProgressStage {
+    Initializing = "Initializing",
+    FindingDevice = "FindingDevice",
+    Connecting = "Connecting",
+    PartialFlashing = "PartialFlashing",
+    FullFlashing = "FullFlashing"
+}
+/**
+ * Progress callback for tracking operation stages (connection and flashing).
+ *
+ * @param stage - The current stage of the operation
+ * @param progress - Optional progress value (0-1) for PartialFlashing and FullFlashing stages.
+ *                   Initializing, FindingDevice, and Connecting stages are called once
+ *                   without progress values to indicate stage entry.
+ *
+ * @example
+ * const progressCallback = (stage, progress) => {
+ *   if (progress !== undefined) {
+ *     console.log(`${stage}: ${Math.round(progress * 100)}%`);
+ *   } else {
+ *     console.log(`Stage: ${stage}`);
+ *   }
+ * };
+ */
+export type ProgressCallback = (stage: ProgressStage, progress?: number) => void;
+/**
+ * Error type used for all interactions with this module.
+ *
+ * The code indicates the error type and may be suitable for providing
+ * translated error messages.
+ *
+ * The message is the underlying message text and will usually be in
+ * English.
+ */
+export declare class DeviceError extends Error {
+    code: DeviceErrorCode;
+    constructor({ code, message }: {
+        code: DeviceErrorCode;
+        message?: string;
+    });
+}
+/**
+ * Tracks connection status,
+ */
+export declare enum ConnectionStatus {
+    /**
+     * Determining whether the connection type is supported requires
+     * initialize() to complete.
+     */
+    SUPPORT_NOT_KNOWN = "SUPPORT_NOT_KNOWN",
+    /**
+     * Not supported.
+     */
+    NOT_SUPPORTED = "NOT_SUPPORTED",
+    /**
+     * Supported but no device available.
+     *
+     * This will be the case even when a device is physically connected
+     * but has not been connected via the browser security UI.
+     */
+    NO_AUTHORIZED_DEVICE = "NO_AUTHORIZED_DEVICE",
+    /**
+     * Authorized device available but we haven't connected to it.
+     */
+    DISCONNECTED = "DISCONNECTED",
+    /**
+     * Connected.
+     */
+    CONNECTED = "CONNECTED",
+    /**
+     * Connecting.
+     */
+    CONNECTING = "CONNECTING",
+    /**
+     * Reconnecting. When there is unexpected disruption in the connection,
+     * a reconnection is attempted.
+     */
+    RECONNECTING = "RECONNECTING"
+}
+export interface ConnectOptions {
+    /**
+     * Optional progress callback for tracking connection stages.
+     */
+    progress?: ProgressCallback;
+}
+export interface FlashOptions {
+    /**
+     * True to use a partial flash where possible, false to force a full flash.
+     * Default: true.
+     */
+    partial?: boolean;
+    /**
+     * Optional progress callback for tracking connection and flash stages.
+     *
+     * Requesting a partial flash doesn't guarantee one is performed. Partial flashes are avoided
+     * if too many blocks have changed and failed partial flashes are retried as full flashes.
+     * The partial parameter reports the flash type currently in progress.
+     */
+    progress?: ProgressCallback;
+    /**
+     * Smallest possible progress increment to limit callback rate.
+     */
+    minimumProgressIncrement?: number;
+}
+export declare class FlashDataError extends Error {
+}
+export type FlashDataSource = (boardVersion: BoardVersion) => Promise<string | Uint8Array>;
+export type BoardVersion = "V1" | "V2";
+export declare class ConnectionStatusEvent extends Event {
+    readonly status: ConnectionStatus;
+    constructor(status: ConnectionStatus);
+}
+export declare class BeforeRequestDevice extends Event {
+    constructor();
+}
+export declare class AfterRequestDevice extends Event {
+    constructor();
+}
+export declare class BackgroundErrorEvent extends Event {
+    readonly errorMessage: string;
+    readonly error?: unknown | undefined;
+    constructor(errorMessage: string, error?: unknown | undefined);
+}
+export declare class DeviceConnectionEventMap {
+    "status": ConnectionStatusEvent;
+    "backgrounderror": BackgroundErrorEvent;
+    "beforerequestdevice": Event;
+    "afterrequestdevice": Event;
+}
+export interface DeviceConnection<M extends ValueIsEvent<M>> extends TypedEventTarget<DeviceConnectionEventMap & M> {
+    status: ConnectionStatus;
+    /**
+     * Initializes the device.
+     */
+    initialize(): Promise<void>;
+    /**
+     * Removes all listeners.
+     */
+    dispose(): void;
+    /**
+     * Connects to a currently paired device or requests pairing.
+     *
+     * @param options Optional connection options including progress callback.
+     * @throws {DeviceError} On connection failure. The error.code property indicates the failure type.
+     */
+    connect(options?: ConnectOptions): Promise<void>;
+    /**
+     * Get the board version.
+     *
+     * @returns the board version or undefined if there is no connection.
+     */
+    getBoardVersion(): BoardVersion | undefined;
+    /**
+     * Disconnect from the device.
+     */
+    disconnect(): Promise<void>;
+    /**
+     * Write serial data to the device.
+     *
+     * Does nothing if there is no connection.
+     *
+     * @param data The data to write.
+     * @returns A promise that resolves when the write is complete.
+     */
+    serialWrite(data: string): Promise<void>;
+    /**
+     * Clear device to enable chooseDevice.
+     */
+    clearDevice(): Promise<void> | void;
+}

package/build/{device.js → esm/device.js}

@@ -1,3 +1,11 @@
+export var ProgressStage;
+(function (ProgressStage) {
+    ProgressStage["Initializing"] = "Initializing";
+    ProgressStage["FindingDevice"] = "FindingDevice";
+    ProgressStage["Connecting"] = "Connecting";
+    ProgressStage["PartialFlashing"] = "PartialFlashing";
+    ProgressStage["FullFlashing"] = "FullFlashing";
+})(ProgressStage || (ProgressStage = {}));
 /**
  * Error type used for all interactions with this module.
  *
@@ -71,38 +79,6 @@ export class ConnectionStatusEvent extends Event {
         });
     }
 }
-export class SerialDataEvent extends Event {
-    constructor(data) {
-        super("serialdata");
-        Object.defineProperty(this, "data", {
-            enumerable: true,
-            configurable: true,
-            writable: true,
-            value: data
-        });
-    }
-}
-export class SerialResetEvent extends Event {
-    constructor() {
-        super("serialreset");
-    }
-}
-export class SerialErrorEvent extends Event {
-    constructor(error) {
-        super("serialerror");
-        Object.defineProperty(this, "error", {
-            enumerable: true,
-            configurable: true,
-            writable: true,
-            value: error
-        });
-    }
-}
-export class FlashEvent extends Event {
-    constructor() {
-        super("flash");
-    }
-}
 export class BeforeRequestDevice extends Event {
     constructor() {
         super("beforerequestdevice");
@@ -114,7 +90,7 @@ export class AfterRequestDevice extends Event {
     }
 }
 export class BackgroundErrorEvent extends Event {
-    constructor(errorMessage) {
+    constructor(errorMessage, error) {
         super("backgrounderror");
         Object.defineProperty(this, "errorMessage", {
             enumerable: true,
@@ -122,6 +98,12 @@ export class BackgroundErrorEvent extends Event {
             writable: true,
             value: errorMessage
         });
+        Object.defineProperty(this, "error", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: error
+        });
     }
 }
 export class DeviceConnectionEventMap {
@@ -132,25 +114,7 @@ export class DeviceConnectionEventMap {
             writable: true,
             value: void 0
         });
-        Object.defineProperty(this, "serialdata", {
-            enumerable: true,
-            configurable: true,
-            writable: true,
-            value: void 0
-        });
-        Object.defineProperty(this, "serialreset", {
-            enumerable: true,
-            configurable: true,
-            writable: true,
-            value: void 0
-        });
-        Object.defineProperty(this, "serialerror", {
-            enumerable: true,
-            configurable: true,
-            writable: true,
-            value: void 0
-        });
-        Object.defineProperty(this, "flash", {
+        Object.defineProperty(this, "backgrounderror", {
             enumerable: true,
             configurable: true,
             writable: true,
@@ -168,12 +132,6 @@ export class DeviceConnectionEventMap {
             writable: true,
             value: void 0
         });
-        Object.defineProperty(this, "backgrounderror", {
-            enumerable: true,
-            configurable: true,
-            writable: true,
-            value: void 0
-        });
     }
 }
 //# sourceMappingURL=device.js.map

package/build/esm/device.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"device.js","sourceRoot":"","sources":["../../lib/device.ts"],"names":[],"mappings":"AAsEA,MAAM,CAAN,IAAY,aAMX;AAND,WAAY,aAAa;IACvB,8CAA6B,CAAA;IAC7B,gDAA+B,CAAA;IAC/B,0CAAyB,CAAA;IACzB,oDAAmC,CAAA;IACnC,8CAA6B,CAAA;AAC/B,CAAC,EANW,aAAa,KAAb,aAAa,QAMxB;AAwBD;;;;;;;;GAQG;AACH,MAAM,OAAO,WAAY,SAAQ,KAAK;IAEpC,YAAY,EAAE,IAAI,EAAE,OAAO,EAA+C;QACxE,KAAK,CAAC,OAAO,CAAC,CAAC;QAFjB;;;;;WAAsB;QAGpB,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC;IACnB,CAAC;CACF;AAED;;GAEG;AACH,MAAM,CAAN,IAAY,gBAkCX;AAlCD,WAAY,gBAAgB;IAC1B;;;OAGG;IACH,2DAAuC,CAAA;IACvC;;OAEG;IACH,mDAA+B,CAAA;IAC/B;;;;;OAKG;IACH,iEAA6C,CAAA;IAC7C;;OAEG;IACH,iDAA6B,CAAA;IAC7B;;OAEG;IACH,2CAAuB,CAAA;IACvB;;OAEG;IACH,6CAAyB,CAAA;IACzB;;;OAGG;IACH,iDAA6B,CAAA;AAC/B,CAAC,EAlCW,gBAAgB,KAAhB,gBAAgB,QAkC3B;AA6BD,MAAM,OAAO,cAAe,SAAQ,KAAK;CAAG;AAQ5C,MAAM,OAAO,qBAAsB,SAAQ,KAAK;IAC9C,YAA4B,MAAwB;QAClD,KAAK,CAAC,QAAQ,CAAC,CAAC;QADN;;;;mBAAgB,MAAM;WAAkB;IAEpD,CAAC;CACF;AAED,MAAM,OAAO,mBAAoB,SAAQ,KAAK;IAC5C;QACE,KAAK,CAAC,qBAAqB,CAAC,CAAC;IAC/B,CAAC;CACF;AAED,MAAM,OAAO,kBAAmB,SAAQ,KAAK;IAC3C;QACE,KAAK,CAAC,oBAAoB,CAAC,CAAC;IAC9B,CAAC;CACF;AAED,MAAM,OAAO,oBAAqB,SAAQ,KAAK;IAC7C,YACkB,YAAoB,EACpB,KAAe;QAE/B,KAAK,CAAC,iBAAiB,CAAC,CAAC;QAHzB;;;;mBAAgB,YAAY;WAAQ;QACpC;;;;mBAAgB,KAAK;WAAU;IAGjC,CAAC;CACF;AAED,MAAM,OAAO,wBAAwB;IAArC;QACE,4BAAA,QAAQ;;;;;WAAwB;QAChC,4BAAA,iBAAiB;;;;;WAAuB;QACxC,4BAAA,qBAAqB;;;;;WAAQ;QAC7B,4BAAA,oBAAoB;;;;;WAAQ;IAC9B,CAAC;CAAA"}

package/build/esm/dfu-service.d.ts

@@ -0,0 +1,9 @@
+export declare const NORDIC_DFU_SERVICE = "00001530-1212-EFDE-1523-785FEABCD123";
+export declare class DfuService {
+    private deviceId;
+    constructor(deviceId: string);
+    /**
+     * We do this for V1 only.
+     */
+    requestRebootToBootloader(): Promise<void>;
+}

package/build/esm/dfu-service.js

@@ -0,0 +1,22 @@
+import { BleClient, numbersToDataView, } from "@capacitor-community/bluetooth-le";
+import { profile } from "./bluetooth-profile";
+// This is the service that should be available on V1 after the reboot.
+// We don't use it directly (the Nordic DFU library does) but we check it's there.
+export const NORDIC_DFU_SERVICE = "00001530-1212-EFDE-1523-785FEABCD123";
+export class DfuService {
+    constructor(deviceId) {
+        Object.defineProperty(this, "deviceId", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: deviceId
+        });
+    }
+    /**
+     * We do this for V1 only.
+     */
+    async requestRebootToBootloader() {
+        await BleClient.write(this.deviceId, profile.dfuControl.id, profile.dfuControl.characteristics.control.id, numbersToDataView([0x01]));
+    }
+}
+//# sourceMappingURL=dfu-service.js.map

package/build/esm/dfu-service.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"dfu-service.js","sourceRoot":"","sources":["../../lib/dfu-service.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,SAAS,EACT,iBAAiB,GAClB,MAAM,mCAAmC,CAAC;AAC3C,OAAO,EAAE,OAAO,EAAE,MAAM,qBAAqB,CAAC;AAE9C,uEAAuE;AACvE,kFAAkF;AAClF,MAAM,CAAC,MAAM,kBAAkB,GAAG,sCAAsC,CAAC;AAEzE,MAAM,OAAO,UAAU;IACrB,YAAoB,QAAgB;QAAxB;;;;mBAAQ,QAAQ;WAAQ;IAAG,CAAC;IAExC;;OAEG;IACH,KAAK,CAAC,yBAAyB;QAC7B,MAAM,SAAS,CAAC,KAAK,CACnB,IAAI,CAAC,QAAQ,EACb,OAAO,CAAC,UAAU,CAAC,EAAE,EACrB,OAAO,CAAC,UAAU,CAAC,eAAe,CAAC,OAAO,CAAC,EAAE,EAC7C,iBAAiB,CAAC,CAAC,IAAI,CAAC,CAAC,CAC1B,CAAC;IACJ,CAAC;CACF"}