@microbit/microbit-connection 0.0.0-alpha.1

package/build/bluetooth-profile.d.ts

@@ -0,0 +1,139 @@
+export declare const profile: {
+    uart: {
+        id: string;
+        characteristics: {
+            tx: {
+                id: string;
+            };
+            rx: {
+                id: string;
+            };
+        };
+    };
+    accelerometer: {
+        id: string;
+        characteristics: {
+            data: {
+                id: string;
+            };
+            period: {
+                id: string;
+            };
+        };
+    };
+    deviceInformation: {
+        id: string;
+        characteristics: {
+            modelNumber: {
+                id: string;
+            };
+            serialNumber: {
+                id: string;
+            };
+            firmwareRevision: {
+                id: string;
+            };
+            hardwareRevision: {
+                id: string;
+            };
+            manufacturer: {
+                id: string;
+            };
+        };
+    };
+    dfuControl: {
+        id: string;
+        characteristics: {
+            control: {
+                id: string;
+            };
+        };
+    };
+    led: {
+        id: string;
+        characteristics: {
+            matrixState: {
+                id: string;
+            };
+            text: {
+                id: string;
+            };
+            scrollingDelay: {
+                id: string;
+            };
+        };
+    };
+    ioPin: {
+        id: string;
+        characteristics: {
+            pinData: {
+                id: string;
+            };
+            pinAdConfiguration: {
+                id: string;
+            };
+            pinIoConfiguration: {
+                id: string;
+            };
+            pwmControl: {
+                id: string;
+            };
+        };
+    };
+    button: {
+        id: string;
+        characteristics: {
+            a: {
+                id: string;
+            };
+            b: {
+                id: string;
+            };
+        };
+    };
+    event: {
+        id: string;
+        characteristics: {
+            microBitRequirements: {
+                id: string;
+            };
+            microBitEvent: {
+                id: string;
+            };
+            clientRequirements: {
+                id: string;
+            };
+            clientEvent: {
+                id: string;
+            };
+        };
+    };
+    magnetometer: {
+        id: string;
+        characteristics: {
+            data: {
+                id: string;
+            };
+            period: {
+                id: string;
+            };
+            bearing: {
+                id: string;
+            };
+            calibration: {
+                id: string;
+            };
+        };
+    };
+    temperature: {
+        id: string;
+        characteristics: {
+            data: {
+                id: string;
+            };
+            period: {
+                id: string;
+            };
+        };
+    };
+};

package/build/bluetooth-profile.js

@@ -0,0 +1,83 @@
+// Very incomplete BT profile
+export const profile = {
+    uart: {
+        id: "6e400001-b5a3-f393-e0a9-e50e24dcca9e",
+        characteristics: {
+            tx: { id: "6e400002-b5a3-f393-e0a9-e50e24dcca9e" },
+            rx: { id: "6e400003-b5a3-f393-e0a9-e50e24dcca9e" },
+        },
+    },
+    accelerometer: {
+        id: "e95d0753-251d-470a-a062-fa1922dfa9a8",
+        characteristics: {
+            data: { id: "e95dca4b-251d-470a-a062-fa1922dfa9a8" },
+            period: { id: "e95dfb24-251d-470a-a062-fa1922dfa9a8" },
+        },
+    },
+    deviceInformation: {
+        id: "0000180a-0000-1000-8000-00805f9b34fb",
+        characteristics: {
+            modelNumber: { id: "00002a24-0000-1000-8000-00805f9b34fb" },
+            serialNumber: { id: "00002a25-0000-1000-8000-00805f9b34fb" },
+            firmwareRevision: { id: "00002a26-0000-1000-8000-00805f9b34fb" },
+            hardwareRevision: { id: "00002a27-0000-1000-8000-00805f9b34fb" },
+            manufacturer: { id: "00002a29-0000-1000-8000-00805f9b34fb" },
+        },
+    },
+    dfuControl: {
+        id: "e95d93b0-251d-470a-a062-fa1922dfa9a8",
+        characteristics: {
+            control: { id: "e95d93b1-251d-470a-a062-fa1922dfa9a8" },
+        },
+    },
+    led: {
+        id: "e95dd91d-251d-470a-a062-fa1922dfa9a8",
+        characteristics: {
+            matrixState: { id: "e95d7b77-251d-470a-a062-fa1922dfa9a8" },
+            text: { id: "e95d93ee-251d-470a-a062-fa1922dfa9a8" },
+            scrollingDelay: { id: "e95d0d2d-251d-470a-a062-fa1922dfa9a8" },
+        },
+    },
+    ioPin: {
+        id: "e95d127b-251d-470a-a062-fa1922dfa9a8",
+        characteristics: {
+            pinData: { id: "e95d8d00-251d-470a-a062-fa1922dfa9a8" },
+            pinAdConfiguration: { id: "e95d5899-251d-470a-a062-fa1922dfa9a8" },
+            pinIoConfiguration: { id: "e95db9fe-251d-470a-a062-fa1922dfa9a8" },
+            pwmControl: { id: "e95dd822-251d-470a-a062-fa1922dfa9a8" },
+        },
+    },
+    button: {
+        id: "e95d9882-251d-470a-a062-fa1922dfa9a8",
+        characteristics: {
+            a: { id: "e95dda90-251d-470a-a062-fa1922dfa9a8" },
+            b: { id: "e95dda91-251d-470a-a062-fa1922dfa9a8" },
+        },
+    },
+    event: {
+        id: "e95d93af-251d-470a-a062-fa1922dfa9a8",
+        characteristics: {
+            microBitRequirements: { id: "e95db84c-251d-470a-a062-fa1922dfa9a8" },
+            microBitEvent: { id: "e95d9775-251d-470a-a062-fa1922dfa9a8" },
+            clientRequirements: { id: "e95d23c4-251d-470a-a062-fa1922dfa9a8" },
+            clientEvent: { id: "e95d5404-251d-470a-a062-fa1922dfa9a8" },
+        },
+    },
+    magnetometer: {
+        id: "e95df2d8-251d-470a-a062-fa1922dfa9a8",
+        characteristics: {
+            data: { id: "e95dfb11-251d-470a-a062-fa1922dfa9a8" },
+            period: { id: "e95d386c-251d-470a-a062-fa1922dfa9a8" },
+            bearing: { id: "e95d9715-251d-470a-a062-fa1922dfa9a8" },
+            calibration: { id: "e95db358-251d-470a-a062-fa1922dfa9a8" },
+        },
+    },
+    temperature: {
+        id: "e95d6100-251d-470a-a062-fa1922dfa9a8",
+        characteristics: {
+            data: { id: "e95d9250-251d-470a-a062-fa1922dfa9a8" },
+            period: { id: "e95d1b25-251d-470a-a062-fa1922dfa9a8" },
+        },
+    },
+};
+//# sourceMappingURL=bluetooth-profile.js.map

package/build/bluetooth-profile.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"bluetooth-profile.js","sourceRoot":"","sources":["../lib/bluetooth-profile.ts"],"names":[],"mappings":"AAAA,6BAA6B;AAC7B,MAAM,CAAC,MAAM,OAAO,GAAG;IACrB,IAAI,EAAE;QACJ,EAAE,EAAE,sCAAsC;QAC1C,eAAe,EAAE;YACf,EAAE,EAAE,EAAE,EAAE,EAAE,sCAAsC,EAAE;YAClD,EAAE,EAAE,EAAE,EAAE,EAAE,sCAAsC,EAAE;SACnD;KACF;IACD,aAAa,EAAE;QACb,EAAE,EAAE,sCAAsC;QAC1C,eAAe,EAAE;YACf,IAAI,EAAE,EAAE,EAAE,EAAE,sCAAsC,EAAE;YACpD,MAAM,EAAE,EAAE,EAAE,EAAE,sCAAsC,EAAE;SACvD;KACF;IACD,iBAAiB,EAAE;QACjB,EAAE,EAAE,sCAAsC;QAC1C,eAAe,EAAE;YACf,WAAW,EAAE,EAAE,EAAE,EAAE,sCAAsC,EAAE;YAC3D,YAAY,EAAE,EAAE,EAAE,EAAE,sCAAsC,EAAE;YAC5D,gBAAgB,EAAE,EAAE,EAAE,EAAE,sCAAsC,EAAE;YAChE,gBAAgB,EAAE,EAAE,EAAE,EAAE,sCAAsC,EAAE;YAChE,YAAY,EAAE,EAAE,EAAE,EAAE,sCAAsC,EAAE;SAC7D;KACF;IACD,UAAU,EAAE;QACV,EAAE,EAAE,sCAAsC;QAC1C,eAAe,EAAE;YACf,OAAO,EAAE,EAAE,EAAE,EAAE,sCAAsC,EAAE;SACxD;KACF;IACD,GAAG,EAAE;QACH,EAAE,EAAE,sCAAsC;QAC1C,eAAe,EAAE;YACf,WAAW,EAAE,EAAE,EAAE,EAAE,sCAAsC,EAAE;YAC3D,IAAI,EAAE,EAAE,EAAE,EAAE,sCAAsC,EAAE;YACpD,cAAc,EAAE,EAAE,EAAE,EAAE,sCAAsC,EAAE;SAC/D;KACF;IACD,KAAK,EAAE;QACL,EAAE,EAAE,sCAAsC;QAC1C,eAAe,EAAE;YACf,OAAO,EAAE,EAAE,EAAE,EAAE,sCAAsC,EAAE;YACvD,kBAAkB,EAAE,EAAE,EAAE,EAAE,sCAAsC,EAAE;YAClE,kBAAkB,EAAE,EAAE,EAAE,EAAE,sCAAsC,EAAE;YAClE,UAAU,EAAE,EAAE,EAAE,EAAE,sCAAsC,EAAE;SAC3D;KACF;IACD,MAAM,EAAE;QACN,EAAE,EAAE,sCAAsC;QAC1C,eAAe,EAAE;YACf,CAAC,EAAE,EAAE,EAAE,EAAE,sCAAsC,EAAE;YACjD,CAAC,EAAE,EAAE,EAAE,EAAE,sCAAsC,EAAE;SAClD;KACF;IACD,KAAK,EAAE;QACL,EAAE,EAAE,sCAAsC;QAC1C,eAAe,EAAE;YACf,oBAAoB,EAAE,EAAE,EAAE,EAAE,sCAAsC,EAAE;YACpE,aAAa,EAAE,EAAE,EAAE,EAAE,sCAAsC,EAAE;YAC7D,kBAAkB,EAAE,EAAE,EAAE,EAAE,sCAAsC,EAAE;YAClE,WAAW,EAAE,EAAE,EAAE,EAAE,sCAAsC,EAAE;SAC5D;KACF;IACD,YAAY,EAAE;QACZ,EAAE,EAAE,sCAAsC;QAC1C,eAAe,EAAE;YACf,IAAI,EAAE,EAAE,EAAE,EAAE,sCAAsC,EAAE;YACpD,MAAM,EAAE,EAAE,EAAE,EAAE,sCAAsC,EAAE;YACtD,OAAO,EAAE,EAAE,EAAE,EAAE,sCAAsC,EAAE;YACvD,WAAW,EAAE,EAAE,EAAE,EAAE,sCAAsC,EAAE;SAC5D;KACF;IACD,WAAW,EAAE;QACX,EAAE,EAAE,sCAAsC;QAC1C,eAAe,EAAE;YACf,IAAI,EAAE,EAAE,EAAE,EAAE,sCAAsC,EAAE;YACpD,MAAM,EAAE,EAAE,EAAE,EAAE,sCAAsC,EAAE;SACvD;KACF;CACF,CAAC"}

package/build/bluetooth.d.ts

@@ -0,0 +1,50 @@
+/**
+ * (c) 2021, Micro:bit Educational Foundation and contributors
+ *
+ * SPDX-License-Identifier: MIT
+ */
+import { AccelerometerData } from "./accelerometer";
+import { BluetoothDeviceWrapper } from "./bluetooth-device-wrapper";
+import { BoardVersion, ConnectOptions, ConnectionStatus, DeviceConnection, DeviceConnectionEventMap } from "./device";
+import { TypedEventTarget } from "./events";
+import { Logging } from "./logging";
+import { ServiceConnectionEventMap } from "./service-events";
+export interface MicrobitWebBluetoothConnectionOptions {
+    logging?: Logging;
+}
+/**
+ * A Bluetooth connection to a micro:bit device.
+ */
+export declare class MicrobitWebBluetoothConnection extends TypedEventTarget<DeviceConnectionEventMap & ServiceConnectionEventMap> implements DeviceConnection {
+    status: ConnectionStatus;
+    /**
+     * The USB device we last connected to.
+     * Cleared if it is disconnected.
+     */
+    private device;
+    private logging;
+    connection: BluetoothDeviceWrapper | undefined;
+    private _addEventListener;
+    private _removeEventListener;
+    constructor(options?: MicrobitWebBluetoothConnectionOptions);
+    private log;
+    initialize(): Promise<void>;
+    dispose(): void;
+    connect(options?: ConnectOptions): Promise<ConnectionStatus>;
+    getBoardVersion(): BoardVersion | undefined;
+    private startSerialInternal;
+    private stopSerialInternal;
+    disconnect(): Promise<void>;
+    private setStatus;
+    serialWrite(data: string): Promise<void>;
+    clearDevice(): Promise<void>;
+    private connectInternal;
+    private chooseDevice;
+    getAccelerometerData(): Promise<AccelerometerData | undefined>;
+    getAccelerometerPeriod(): Promise<number | undefined>;
+    setAccelerometerPeriod(value: number): Promise<void>;
+    private startAccelerometerNotifications;
+    private stopAccelerometerNotifications;
+    private startNotifications;
+    private stopNotifications;
+}

package/build/bluetooth.js

@@ -0,0 +1,247 @@
+import { createBluetoothDeviceWrapper, } from "./bluetooth-device-wrapper";
+import { profile } from "./bluetooth-profile";
+import { AfterRequestDevice, BeforeRequestDevice, ConnectionStatus, ConnectionStatusEvent, SerialResetEvent, } from "./device";
+import { TypedEventTarget } from "./events";
+import { NullLogging } from "./logging";
+const requestDeviceTimeoutDuration = 30000;
+/**
+ * A Bluetooth connection to a micro:bit device.
+ */
+export class MicrobitWebBluetoothConnection extends TypedEventTarget {
+    constructor(options = {}) {
+        super();
+        // TODO: when do we call getAvailable() ?
+        Object.defineProperty(this, "status", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: navigator.bluetooth
+                ? ConnectionStatus.NO_AUTHORIZED_DEVICE
+                : ConnectionStatus.NOT_SUPPORTED
+        });
+        /**
+         * The USB device we last connected to.
+         * Cleared if it is disconnected.
+         */
+        Object.defineProperty(this, "device", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: void 0
+        });
+        Object.defineProperty(this, "logging", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: void 0
+        });
+        Object.defineProperty(this, "connection", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: void 0
+        });
+        Object.defineProperty(this, "_addEventListener", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: this.addEventListener
+        });
+        Object.defineProperty(this, "_removeEventListener", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: this.removeEventListener
+        });
+        this.logging = options.logging || new NullLogging();
+        this.addEventListener = (type, ...args) => {
+            this._addEventListener(type, ...args);
+            this.startNotifications(type);
+        };
+        this.removeEventListener = (type, ...args) => {
+            this.stopNotifications(type);
+            this._removeEventListener(type, ...args);
+        };
+    }
+    log(v) {
+        this.logging.log(v);
+    }
+    async initialize() {
+        if (navigator.bluetooth) {
+            // TODO: availabilitychanged
+        }
+    }
+    dispose() {
+        if (navigator.bluetooth) {
+            // TODO: availabilitychanged
+        }
+    }
+    async connect(options = {}) {
+        await this.connectInternal(options);
+        return this.status;
+    }
+    getBoardVersion() {
+        return this.connection?.boardVersion;
+    }
+    // @ts-ignore
+    async startSerialInternal() {
+        if (!this.connection) {
+            // As connecting then starting serial are async we could disconnect between them,
+            // so handle this gracefully.
+            return;
+        }
+        // TODO
+    }
+    // @ts-ignore
+    async stopSerialInternal() {
+        if (this.connection) {
+            // TODO
+            this.dispatchTypedEvent("serialreset", new SerialResetEvent());
+        }
+    }
+    async disconnect() {
+        try {
+            if (this.connection) {
+                await this.connection.disconnect();
+            }
+        }
+        catch (e) {
+            this.log("Error during disconnection:\r\n" + e);
+            this.logging.event({
+                type: "Bluetooth-error",
+                message: "error-disconnecting",
+            });
+        }
+        finally {
+            this.connection = undefined;
+            this.setStatus(ConnectionStatus.NOT_CONNECTED);
+            this.logging.log("Disconnection complete");
+            this.logging.event({
+                type: "Bluetooth-info",
+                message: "disconnected",
+            });
+        }
+    }
+    setStatus(newStatus) {
+        this.status = newStatus;
+        this.log("Device status " + newStatus);
+        this.dispatchTypedEvent("status", new ConnectionStatusEvent(newStatus));
+    }
+    serialWrite(data) {
+        if (this.connection) {
+            // TODO
+        }
+        return Promise.resolve();
+    }
+    async clearDevice() {
+        await this.disconnect();
+        this.device = undefined;
+        this.setStatus(ConnectionStatus.NO_AUTHORIZED_DEVICE);
+    }
+    async connectInternal(options) {
+        if (!this.connection) {
+            const device = await this.chooseDevice(options);
+            if (!device) {
+                return;
+            }
+            this.connection = await createBluetoothDeviceWrapper(device, this.logging, (type, event) => this.dispatchTypedEvent(type, event));
+        }
+        // TODO: timeout unification?
+        // Connection happens inside createBluetoothDeviceWrapper.
+        // await this.connection?.connect();
+        this.setStatus(ConnectionStatus.CONNECTED);
+    }
+    async chooseDevice(options) {
+        if (this.device) {
+            return this.device;
+        }
+        this.dispatchTypedEvent("beforerequestdevice", new BeforeRequestDevice());
+        try {
+            // In some situations the Chrome device prompt simply doesn't appear so we time this out after 30 seconds and reload the page
+            // TODO: give control over this to the caller
+            const result = await Promise.race([
+                navigator.bluetooth.requestDevice({
+                    filters: [
+                        {
+                            namePrefix: options.name
+                                ? `BBC micro:bit [${options.name}]`
+                                : "BBC micro:bit",
+                        },
+                    ],
+                    optionalServices: [
+                        profile.accelerometer.id,
+                        profile.button.id,
+                        profile.deviceInformation.id,
+                        profile.dfuControl.id,
+                        profile.event.id,
+                        profile.ioPin.id,
+                        profile.led.id,
+                        profile.magnetometer.id,
+                        profile.temperature.id,
+                        profile.uart.id,
+                    ],
+                }),
+                new Promise((resolve) => setTimeout(() => resolve("timeout"), requestDeviceTimeoutDuration)),
+            ]);
+            if (result === "timeout") {
+                // btSelectMicrobitDialogOnLoad.set(true);
+                window.location.reload();
+                return undefined;
+            }
+            this.device = result;
+            return result;
+        }
+        catch (e) {
+            this.logging.error("Bluetooth request device failed/cancelled", e);
+            return undefined;
+        }
+        finally {
+            this.dispatchTypedEvent("afterrequestdevice", new AfterRequestDevice());
+        }
+    }
+    async getAccelerometerData() {
+        const accelerometerService = await this.connection?.getAccelerometerService();
+        return accelerometerService?.getData();
+    }
+    async getAccelerometerPeriod() {
+        const accelerometerService = await this.connection?.getAccelerometerService();
+        return accelerometerService?.getPeriod();
+    }
+    async setAccelerometerPeriod(value) {
+        const accelerometerService = await this.connection?.getAccelerometerService();
+        accelerometerService?.setPeriod(value);
+    }
+    async startAccelerometerNotifications() {
+        const accelerometerService = await this.connection?.getAccelerometerService();
+        accelerometerService?.startNotifications();
+        if (this.connection) {
+            this.connection.serviceListeners.accelerometerdatachanged.notifying =
+                true;
+        }
+    }
+    async stopAccelerometerNotifications() {
+        const accelerometerService = await this.connection?.getAccelerometerService();
+        if (this.connection) {
+            this.connection.serviceListeners.accelerometerdatachanged.notifying =
+                false;
+        }
+        accelerometerService?.stopNotifications();
+    }
+    async startNotifications(type) {
+        switch (type) {
+            case "accelerometerdatachanged": {
+                this.startAccelerometerNotifications();
+                break;
+            }
+        }
+    }
+    async stopNotifications(type) {
+        switch (type) {
+            case "accelerometerdatachanged": {
+                this.stopAccelerometerNotifications();
+                break;
+            }
+        }
+    }
+}
+//# sourceMappingURL=bluetooth.js.map

package/build/bluetooth.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"bluetooth.js","sourceRoot":"","sources":["../lib/bluetooth.ts"],"names":[],"mappings":"AAMA,OAAO,EAEL,4BAA4B,GAC7B,MAAM,4BAA4B,CAAC;AACpC,OAAO,EAAE,OAAO,EAAE,MAAM,qBAAqB,CAAC;AAC9C,OAAO,EACL,kBAAkB,EAClB,mBAAmB,EAGnB,gBAAgB,EAChB,qBAAqB,EAGrB,gBAAgB,GACjB,MAAM,UAAU,CAAC;AAClB,OAAO,EAAE,gBAAgB,EAAE,MAAM,UAAU,CAAC;AAC5C,OAAO,EAAW,WAAW,EAAE,MAAM,WAAW,CAAC;AAGjD,MAAM,4BAA4B,GAAW,KAAK,CAAC;AAMnD;;GAEG;AACH,MAAM,OAAO,8BACX,SAAQ,gBAAsE;IAoB9E,YAAY,UAAiD,EAAE;QAC7D,KAAK,EAAE,CAAC;QAlBV,yCAAyC;QACzC;;;;mBAA2B,SAAS,CAAC,SAAS;gBAC5C,CAAC,CAAC,gBAAgB,CAAC,oBAAoB;gBACvC,CAAC,CAAC,gBAAgB,CAAC,aAAa;WAAC;QAEnC;;;WAGG;QACK;;;;;WAAoC;QAEpC;;;;;WAAiB;QACzB;;;;;WAA+C;QAEvC;;;;mBAAoB,IAAI,CAAC,gBAAgB;WAAC;QAC1C;;;;mBAAuB,IAAI,CAAC,mBAAmB;WAAC;QAItD,IAAI,CAAC,OAAO,GAAG,OAAO,CAAC,OAAO,IAAI,IAAI,WAAW,EAAE,CAAC;QACpD,IAAI,CAAC,gBAAgB,GAAG,CAAC,IAAI,EAAE,GAAG,IAAI,EAAE,EAAE;YACxC,IAAI,CAAC,iBAAiB,CAAC,IAAI,EAAE,GAAG,IAAI,CAAC,CAAC;YACtC,IAAI,CAAC,kBAAkB,CAAC,IAAI,CAAC,CAAC;QAChC,CAAC,CAAC;QACF,IAAI,CAAC,mBAAmB,GAAG,CAAC,IAAI,EAAE,GAAG,IAAI,EAAE,EAAE;YAC3C,IAAI,CAAC,iBAAiB,CAAC,IAAI,CAAC,CAAC;YAC7B,IAAI,CAAC,oBAAoB,CAAC,IAAI,EAAE,GAAG,IAAI,CAAC,CAAC;QAC3C,CAAC,CAAC;IACJ,CAAC;IAEO,GAAG,CAAC,CAAM;QAChB,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC;IACtB,CAAC;IAED,KAAK,CAAC,UAAU;QACd,IAAI,SAAS,CAAC,SAAS,EAAE,CAAC;YACxB,4BAA4B;QAC9B,CAAC;IACH,CAAC;IAED,OAAO;QACL,IAAI,SAAS,CAAC,SAAS,EAAE,CAAC;YACxB,4BAA4B;QAC9B,CAAC;IACH,CAAC;IAED,KAAK,CAAC,OAAO,CAAC,UAA0B,EAAE;QACxC,MAAM,IAAI,CAAC,eAAe,CAAC,OAAO,CAAC,CAAC;QACpC,OAAO,IAAI,CAAC,MAAM,CAAC;IACrB,CAAC;IAED,eAAe;QACb,OAAO,IAAI,CAAC,UAAU,EAAE,YAAY,CAAC;IACvC,CAAC;IAED,aAAa;IACL,KAAK,CAAC,mBAAmB;QAC/B,IAAI,CAAC,IAAI,CAAC,UAAU,EAAE,CAAC;YACrB,iFAAiF;YACjF,6BAA6B;YAC7B,OAAO;QACT,CAAC;QACD,OAAO;IACT,CAAC;IAED,aAAa;IACL,KAAK,CAAC,kBAAkB;QAC9B,IAAI,IAAI,CAAC,UAAU,EAAE,CAAC;YACpB,OAAO;YACP,IAAI,CAAC,kBAAkB,CAAC,aAAa,EAAE,IAAI,gBAAgB,EAAE,CAAC,CAAC;QACjE,CAAC;IACH,CAAC;IAED,KAAK,CAAC,UAAU;QACd,IAAI,CAAC;YACH,IAAI,IAAI,CAAC,UAAU,EAAE,CAAC;gBACpB,MAAM,IAAI,CAAC,UAAU,CAAC,UAAU,EAAE,CAAC;YACrC,CAAC;QACH,CAAC;QAAC,OAAO,CAAC,EAAE,CAAC;YACX,IAAI,CAAC,GAAG,CAAC,iCAAiC,GAAG,CAAC,CAAC,CAAC;YAChD,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC;gBACjB,IAAI,EAAE,iBAAiB;gBACvB,OAAO,EAAE,qBAAqB;aAC/B,CAAC,CAAC;QACL,CAAC;gBAAS,CAAC;YACT,IAAI,CAAC,UAAU,GAAG,SAAS,CAAC;YAC5B,IAAI,CAAC,SAAS,CAAC,gBAAgB,CAAC,aAAa,CAAC,CAAC;YAC/C,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,wBAAwB,CAAC,CAAC;YAC3C,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC;gBACjB,IAAI,EAAE,gBAAgB;gBACtB,OAAO,EAAE,cAAc;aACxB,CAAC,CAAC;QACL,CAAC;IACH,CAAC;IAEO,SAAS,CAAC,SAA2B;QAC3C,IAAI,CAAC,MAAM,GAAG,SAAS,CAAC;QACxB,IAAI,CAAC,GAAG,CAAC,gBAAgB,GAAG,SAAS,CAAC,CAAC;QACvC,IAAI,CAAC,kBAAkB,CAAC,QAAQ,EAAE,IAAI,qBAAqB,CAAC,SAAS,CAAC,CAAC,CAAC;IAC1E,CAAC;IAED,WAAW,CAAC,IAAY;QACtB,IAAI,IAAI,CAAC,UAAU,EAAE,CAAC;YACpB,OAAO;QACT,CAAC;QACD,OAAO,OAAO,CAAC,OAAO,EAAE,CAAC;IAC3B,CAAC;IAED,KAAK,CAAC,WAAW;QACf,MAAM,IAAI,CAAC,UAAU,EAAE,CAAC;QACxB,IAAI,CAAC,MAAM,GAAG,SAAS,CAAC;QACxB,IAAI,CAAC,SAAS,CAAC,gBAAgB,CAAC,oBAAoB,CAAC,CAAC;IACxD,CAAC;IAEO,KAAK,CAAC,eAAe,CAAC,OAAuB;QACnD,IAAI,CAAC,IAAI,CAAC,UAAU,EAAE,CAAC;YACrB,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,YAAY,CAAC,OAAO,CAAC,CAAC;YAChD,IAAI,CAAC,MAAM,EAAE,CAAC;gBACZ,OAAO;YACT,CAAC;YACD,IAAI,CAAC,UAAU,GAAG,MAAM,4BAA4B,CAClD,MAAM,EACN,IAAI,CAAC,OAAO,EACZ,CAAC,IAAI,EAAE,KAAK,EAAE,EAAE,CAAC,IAAI,CAAC,kBAAkB,CAAC,IAAI,EAAE,KAAK,CAAC,CACtD,CAAC;QACJ,CAAC;QACD,6BAA6B;QAC7B,0DAA0D;QAC1D,oCAAoC;QACpC,IAAI,CAAC,SAAS,CAAC,gBAAgB,CAAC,SAAS,CAAC,CAAC;IAC7C,CAAC;IAEO,KAAK,CAAC,YAAY,CACxB,OAAuB;QAEvB,IAAI,IAAI,CAAC,MAAM,EAAE,CAAC;YAChB,OAAO,IAAI,CAAC,MAAM,CAAC;QACrB,CAAC;QACD,IAAI,CAAC,kBAAkB,CAAC,qBAAqB,EAAE,IAAI,mBAAmB,EAAE,CAAC,CAAC;QAC1E,IAAI,CAAC;YACH,6HAA6H;YAC7H,6CAA6C;YAC7C,MAAM,MAAM,GAAG,MAAM,OAAO,CAAC,IAAI,CAAC;gBAChC,SAAS,CAAC,SAAS,CAAC,aAAa,CAAC;oBAChC,OAAO,EAAE;wBACP;4BACE,UAAU,EAAE,OAAO,CAAC,IAAI;gCACtB,CAAC,CAAC,kBAAkB,OAAO,CAAC,IAAI,GAAG;gCACnC,CAAC,CAAC,eAAe;yBACpB;qBACF;oBACD,gBAAgB,EAAE;wBAChB,OAAO,CAAC,aAAa,CAAC,EAAE;wBACxB,OAAO,CAAC,MAAM,CAAC,EAAE;wBACjB,OAAO,CAAC,iBAAiB,CAAC,EAAE;wBAC5B,OAAO,CAAC,UAAU,CAAC,EAAE;wBACrB,OAAO,CAAC,KAAK,CAAC,EAAE;wBAChB,OAAO,CAAC,KAAK,CAAC,EAAE;wBAChB,OAAO,CAAC,GAAG,CAAC,EAAE;wBACd,OAAO,CAAC,YAAY,CAAC,EAAE;wBACvB,OAAO,CAAC,WAAW,CAAC,EAAE;wBACtB,OAAO,CAAC,IAAI,CAAC,EAAE;qBAChB;iBACF,CAAC;gBACF,IAAI,OAAO,CAAY,CAAC,OAAO,EAAE,EAAE,CACjC,UAAU,CAAC,GAAG,EAAE,CAAC,OAAO,CAAC,SAAS,CAAC,EAAE,4BAA4B,CAAC,CACnE;aACF,CAAC,CAAC;YACH,IAAI,MAAM,KAAK,SAAS,EAAE,CAAC;gBACzB,0CAA0C;gBAC1C,MAAM,CAAC,QAAQ,CAAC,MAAM,EAAE,CAAC;gBACzB,OAAO,SAAS,CAAC;YACnB,CAAC;YACD,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC;YACrB,OAAO,MAAM,CAAC;QAChB,CAAC;QAAC,OAAO,CAAC,EAAE,CAAC;YACX,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,2CAA2C,EAAE,CAAC,CAAC,CAAC;YACnE,OAAO,SAAS,CAAC;QACnB,CAAC;gBAAS,CAAC;YACT,IAAI,CAAC,kBAAkB,CAAC,oBAAoB,EAAE,IAAI,kBAAkB,EAAE,CAAC,CAAC;QAC1E,CAAC;IACH,CAAC;IAED,KAAK,CAAC,oBAAoB;QACxB,MAAM,oBAAoB,GACxB,MAAM,IAAI,CAAC,UAAU,EAAE,uBAAuB,EAAE,CAAC;QACnD,OAAO,oBAAoB,EAAE,OAAO,EAAE,CAAC;IACzC,CAAC;IAED,KAAK,CAAC,sBAAsB;QAC1B,MAAM,oBAAoB,GACxB,MAAM,IAAI,CAAC,UAAU,EAAE,uBAAuB,EAAE,CAAC;QACnD,OAAO,oBAAoB,EAAE,SAAS,EAAE,CAAC;IAC3C,CAAC;IAED,KAAK,CAAC,sBAAsB,CAAC,KAAa;QACxC,MAAM,oBAAoB,GACxB,MAAM,IAAI,CAAC,UAAU,EAAE,uBAAuB,EAAE,CAAC;QACnD,oBAAoB,EAAE,SAAS,CAAC,KAAK,CAAC,CAAC;IACzC,CAAC;IAEO,KAAK,CAAC,+BAA+B;QAC3C,MAAM,oBAAoB,GACxB,MAAM,IAAI,CAAC,UAAU,EAAE,uBAAuB,EAAE,CAAC;QACnD,oBAAoB,EAAE,kBAAkB,EAAE,CAAC;QAC3C,IAAI,IAAI,CAAC,UAAU,EAAE,CAAC;YACpB,IAAI,CAAC,UAAU,CAAC,gBAAgB,CAAC,wBAAwB,CAAC,SAAS;gBACjE,IAAI,CAAC;QACT,CAAC;IACH,CAAC;IAEO,KAAK,CAAC,8BAA8B;QAC1C,MAAM,oBAAoB,GACxB,MAAM,IAAI,CAAC,UAAU,EAAE,uBAAuB,EAAE,CAAC;QACnD,IAAI,IAAI,CAAC,UAAU,EAAE,CAAC;YACpB,IAAI,CAAC,UAAU,CAAC,gBAAgB,CAAC,wBAAwB,CAAC,SAAS;gBACjE,KAAK,CAAC;QACV,CAAC;QACD,oBAAoB,EAAE,iBAAiB,EAAE,CAAC;IAC5C,CAAC;IAEO,KAAK,CAAC,kBAAkB,CAAC,IAAY;QAC3C,QAAQ,IAAyB,EAAE,CAAC;YAClC,KAAK,0BAA0B,CAAC,CAAC,CAAC;gBAChC,IAAI,CAAC,+BAA+B,EAAE,CAAC;gBACvC,MAAM;YACR,CAAC;QACH,CAAC;IACH,CAAC;IAEO,KAAK,CAAC,iBAAiB,CAAC,IAAY;QAC1C,QAAQ,IAAyB,EAAE,CAAC;YAClC,KAAK,0BAA0B,CAAC,CAAC,CAAC;gBAChC,IAAI,CAAC,8BAA8B,EAAE,CAAC;gBACtC,MAAM;YACR,CAAC;QACH,CAAC;IACH,CAAC;CACF"}

package/build/board-id.d.ts

@@ -0,0 +1,35 @@
+/**
+ * (c) 2021, Micro:bit Educational Foundation and contributors
+ *
+ * SPDX-License-Identifier: MIT
+ */
+import { BoardVersion } from "./device";
+/**
+ * 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;
+}

package/build/board-id.js

@@ -0,0 +1,69 @@
+/**
+ * (c) 2021, Micro:bit Educational Foundation and contributors
+ *
+ * SPDX-License-Identifier: MIT
+ */
+/**
+ * Validates micro:bit board IDs.
+ */
+export class BoardId {
+    constructor(id) {
+        Object.defineProperty(this, "id", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: id
+        });
+        if (!this.isV1() && !this.isV2()) {
+            throw new Error(`Could not recognise the Board ID ${id.toString(16)}`);
+        }
+    }
+    toBoardVersion() {
+        return this.isV1() ? "V1" : "V2";
+    }
+    isV1() {
+        return this.id === 0x9900 || this.id === 0x9901;
+    }
+    isV2() {
+        return (this.id === 0x9903 ||
+            this.id === 0x9904 ||
+            this.id === 0x9905 ||
+            this.id === 0x9906);
+    }
+    /**
+     * Return the board ID using the default ID for the board type.
+     * Used to integrate with MicropythonFsHex.
+     */
+    normalize() {
+        return this.isV1() ? BoardId.v1Normalized : BoardId.v2Normalized;
+    }
+    /**
+     * toString matches the input to parse.
+     *
+     * @returns the ID as a string.
+     */
+    toString() {
+        return this.id.toString(16);
+    }
+    /**
+     * @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) {
+        return new BoardId(parseInt(value, 16));
+    }
+}
+Object.defineProperty(BoardId, "v1Normalized", {
+    enumerable: true,
+    configurable: true,
+    writable: true,
+    value: new BoardId(0x9900)
+});
+Object.defineProperty(BoardId, "v2Normalized", {
+    enumerable: true,
+    configurable: true,
+    writable: true,
+    value: new BoardId(0x9903)
+});
+//# sourceMappingURL=board-id.js.map

package/build/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;;AAlDc;;;;WAAe,IAAI,OAAO,CAAC,MAAM,CAAC;EAAtB,CAAuB;AACnC;;;;WAAe,IAAI,OAAO,CAAC,MAAM,CAAC;EAAtB,CAAuB"}

package/build/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";
+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;
+}