@microbit/microbit-connection 0.0.0-alpha.1

package/build/usb-radio-bridge.js

@@ -0,0 +1,318 @@
+// @ts-nocheck
+/**
+ * (c) 2023, Center for Computational Thinking and Design at Aarhus University and contributors
+ *
+ * SPDX-License-Identifier: MIT
+ */
+import * as protocol from "./usb-serial-protocol";
+const connectTimeoutDuration = 10000;
+class BridgeError extends Error {
+}
+class RemoteError extends Error {
+}
+export class MicrobitRadioBridgeConnection {
+    constructor(usb, logging, remoteDeviceId) {
+        Object.defineProperty(this, "usb", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: usb
+        });
+        Object.defineProperty(this, "logging", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: logging
+        });
+        Object.defineProperty(this, "remoteDeviceId", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: remoteDeviceId
+        });
+        Object.defineProperty(this, "responseMap", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: new Map()
+        });
+        // To avoid concurrent connect attempts
+        Object.defineProperty(this, "isConnecting", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: false
+        });
+        Object.defineProperty(this, "connectionCheckIntervalId", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: void 0
+        });
+        Object.defineProperty(this, "lastReceivedMessageTimestamp", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: void 0
+        });
+        Object.defineProperty(this, "isReconnect", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: false
+        });
+        // Whether this is the final reconnection attempt.
+        Object.defineProperty(this, "finalAttempt", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: false
+        });
+    }
+    async connect() {
+        this.logging.event({
+            type: this.isReconnect ? "Reconnect" : "Connect",
+            message: "Serial connect start",
+        });
+        if (this.isConnecting) {
+            this.logging.log("Skipping connect attempt when one is already in progress");
+            return;
+        }
+        this.isConnecting = true;
+        let unprocessedData = "";
+        let previousButtonState = { A: 0, B: 0 };
+        let onPeriodicMessageRecieved;
+        const handleError = (e) => {
+            this.logging.error("Serial error", e);
+            void this.disconnectInternal(false, "bridge");
+        };
+        const processMessage = (data) => {
+            const messages = protocol.splitMessages(unprocessedData + data);
+            unprocessedData = messages.remainingInput;
+            messages.messages.forEach(async (msg) => {
+                this.lastReceivedMessageTimestamp = Date.now();
+                // Messages are either periodic sensor data or command/response
+                const sensorData = protocol.processPeriodicMessage(msg);
+                if (sensorData) {
+                    // stateOnReconnected();
+                    // if (onPeriodicMessageRecieved) {
+                    //   onPeriodicMessageRecieved();
+                    //   onPeriodicMessageRecieved = undefined;
+                    // }
+                    // onAccelerometerChange(
+                    //   sensorData.accelerometerX,
+                    //   sensorData.accelerometerY,
+                    //   sensorData.accelerometerZ
+                    // );
+                    // if (sensorData.buttonA !== previousButtonState.A) {
+                    //   previousButtonState.A = sensorData.buttonA;
+                    //   onButtonChange(sensorData.buttonA, "A");
+                    // }
+                    // if (sensorData.buttonB !== previousButtonState.B) {
+                    //   previousButtonState.B = sensorData.buttonB;
+                    //   onButtonChange(sensorData.buttonB, "B");
+                    // }
+                }
+                else {
+                    const messageResponse = protocol.processResponseMessage(msg);
+                    if (!messageResponse) {
+                        return;
+                    }
+                    const responseResolve = this.responseMap.get(messageResponse.messageId);
+                    if (responseResolve) {
+                        this.responseMap.delete(messageResponse.messageId);
+                        responseResolve(messageResponse);
+                    }
+                }
+            });
+        };
+        try {
+            await this.usb.startSerial(processMessage, handleError);
+            await this.handshake();
+            // stateOnConnected(DeviceRequestStates.INPUT);
+            // Check for connection lost
+            if (this.connectionCheckIntervalId === undefined) {
+                this.connectionCheckIntervalId = setInterval(async () => {
+                    if (this.lastReceivedMessageTimestamp &&
+                        Date.now() - this.lastReceivedMessageTimestamp > 1_000) {
+                        // stateOnReconnectionAttempt();
+                    }
+                    if (this.lastReceivedMessageTimestamp &&
+                        Date.now() - this.lastReceivedMessageTimestamp >
+                            connectTimeoutDuration) {
+                        await this.handleReconnect();
+                    }
+                }, 1000);
+            }
+            this.logging.log(`Serial: using remote device id ${this.remoteDeviceId}`);
+            const remoteMbIdCommand = protocol.generateCmdRemoteMbId(this.remoteDeviceId);
+            const remoteMbIdResponse = await this.sendCmdWaitResponse(remoteMbIdCommand);
+            if (remoteMbIdResponse.type === protocol.ResponseTypes.Error ||
+                remoteMbIdResponse.value !== this.remoteDeviceId) {
+                throw new BridgeError(`Failed to set remote micro:bit ID. Expected ${this.remoteDeviceId}, got ${remoteMbIdResponse.value}`);
+            }
+            // For now we only support input state.
+            // TODO: when do we do this?
+            if (false) {
+                // Request the micro:bit to start sending the periodic messages
+                const startCmd = protocol.generateCmdStart({
+                    accelerometer: true,
+                    buttons: true,
+                });
+                const periodicMessagePromise = new Promise((resolve, reject) => {
+                    onPeriodicMessageRecieved = resolve;
+                    setTimeout(() => {
+                        onPeriodicMessageRecieved = undefined;
+                        reject(new Error("Failed to receive data from remote micro:bit"));
+                    }, 500);
+                });
+                const startCmdResponse = await this.sendCmdWaitResponse(startCmd);
+                if (startCmdResponse.type === protocol.ResponseTypes.Error) {
+                    throw new RemoteError(`Failed to start streaming sensors data. Error response received: ${startCmdResponse.message}`);
+                }
+                if (this.isReconnect) {
+                    await periodicMessagePromise;
+                }
+                else {
+                    periodicMessagePromise.catch(async (e) => {
+                        this.logging.error("Failed to initialise serial protocol", e);
+                        await this.disconnectInternal(false, "remote");
+                        this.isConnecting = false;
+                    });
+                }
+            }
+            // stateOnAssigned(DeviceRequestStates.INPUT, this.usb.getModelNumber());
+            // stateOnReady(DeviceRequestStates.INPUT);
+            this.logging.event({
+                type: this.isReconnect ? "Reconnect" : "Connect",
+                message: "Serial connect success",
+            });
+        }
+        catch (e) {
+            this.logging.error("Failed to initialise serial protocol", e);
+            this.logging.event({
+                type: this.isReconnect ? "Reconnect" : "Connect",
+                message: "Serial connect failed",
+            });
+            const reconnectHelp = e instanceof BridgeError ? "bridge" : "remote";
+            await this.disconnectInternal(false, reconnectHelp);
+            throw e;
+        }
+        finally {
+            this.finalAttempt = false;
+            this.isConnecting = false;
+        }
+    }
+    async disconnect() {
+        return this.disconnectInternal(true, "bridge");
+    }
+    stopConnectionCheck() {
+        clearInterval(this.connectionCheckIntervalId);
+        this.connectionCheckIntervalId = undefined;
+        this.lastReceivedMessageTimestamp = undefined;
+    }
+    async disconnectInternal(userDisconnect) {
+        this.stopConnectionCheck();
+        try {
+            await this.sendCmdWaitResponse(protocol.generateCmdStop());
+        }
+        catch (e) {
+            // If this fails the remote micro:bit has already gone away.
+        }
+        this.responseMap.clear();
+        await this.usb.stopSerial();
+        // stateOnDisconnected(
+        //   DeviceRequestStates.INPUT,
+        //   userDisconnect || this.finalAttempt
+        //     ? false
+        //     : this.isReconnect
+        //       ? "autoReconnect"
+        //       : "connect",
+        //   reconnectHelp
+        // );
+    }
+    async handleReconnect() {
+        if (this.isConnecting) {
+            this.logging.log("Serial disconnect ignored... reconnect already in progress");
+            return;
+        }
+        try {
+            this.stopConnectionCheck();
+            this.logging.log("Serial disconnected... automatically trying to reconnect");
+            this.responseMap.clear();
+            await this.usb.stopSerial();
+            await this.usb.softwareReset();
+            await this.reconnect();
+        }
+        catch (e) {
+            this.logging.error("Serial connect triggered by disconnect listener failed", e);
+        }
+        finally {
+            this.isConnecting = false;
+        }
+    }
+    async reconnect(finalAttempt = false) {
+        this.finalAttempt = finalAttempt;
+        this.logging.log("Serial reconnect");
+        this.isReconnect = true;
+        await this.connect();
+    }
+    async sendCmdWaitResponse(cmd) {
+        const responsePromise = new Promise((resolve, reject) => {
+            this.responseMap.set(cmd.messageId, resolve);
+            setTimeout(() => {
+                this.responseMap.delete(cmd.messageId);
+                reject(new Error(`Timeout waiting for response ${cmd.messageId}`));
+            }, 1_000);
+        });
+        await this.usb.serialWrite(cmd.message);
+        return responsePromise;
+    }
+    async handshake() {
+        // There is an issue where we cannot read data out from the micro:bit serial
+        // buffer until the buffer has been filled.
+        // As a workaround we can spam the micro:bit with handshake messages until
+        // enough responses have been queued in the buffer to fill it and the data
+        // starts to flow.
+        this.logging.log("Serial handshake");
+        const handshakeResult = await new Promise(async (resolve, reject) => {
+            const attempts = 20;
+            let attemptCounter = 0;
+            let failureCounter = 0;
+            let resolved = false;
+            while (attemptCounter < 20 && !resolved) {
+                attemptCounter++;
+                this.sendCmdWaitResponse(protocol.generateCmdHandshake())
+                    .then((value) => {
+                    if (!resolved) {
+                        resolved = true;
+                        resolve(value);
+                    }
+                })
+                    .catch(() => {
+                    // We expect some to time out, likely well after the handshake is completed.
+                    if (!resolved) {
+                        if (++failureCounter === attempts) {
+                            reject(new BridgeError("Handshake not completed"));
+                        }
+                    }
+                });
+                await new Promise((resolve) => setTimeout(resolve, 100));
+            }
+        });
+        if (handshakeResult.value !== protocol.version) {
+            throw new BridgeError(`Handshake failed. Unexpected protocol version ${protocol.version}`);
+        }
+    }
+}
+export const startSerialConnection = async (logging, usb, remoteDeviceId) => {
+    try {
+        const serial = new MicrobitRadioBridgeConnection(usb, logging, remoteDeviceId);
+        await serial.connect();
+        return serial;
+    }
+    catch (e) {
+        return undefined;
+    }
+};
+//# sourceMappingURL=usb-radio-bridge.js.map

package/build/usb-radio-bridge.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"usb-radio-bridge.js","sourceRoot":"","sources":["../lib/usb-radio-bridge.ts"],"names":[],"mappings":"AAAA,cAAc;AACd;;;;GAIG;AAGH,OAAO,KAAK,QAAQ,MAAM,uBAAuB,CAAC;AAGlD,MAAM,sBAAsB,GAAW,KAAK,CAAC;AAE7C,MAAM,WAAY,SAAQ,KAAK;CAAG;AAClC,MAAM,WAAY,SAAQ,KAAK;CAAG;AAElC,MAAM,OAAO,6BAA6B;IAiBxC,YACU,GAA6B,EAC7B,OAAgB,EAChB,cAAsB;QAF9B;;;;mBAAQ,GAAG;WAA0B;QACrC;;;;mBAAQ,OAAO;WAAS;QACxB;;;;mBAAQ,cAAc;WAAQ;QAnBxB;;;;mBAAc,IAAI,GAAG,EAK1B;WAAC;QAEJ,uCAAuC;QAC/B;;;;mBAAwB,KAAK;WAAC;QAE9B;;;;;WAAsE;QACtE;;;;;WAAiD;QACjD;;;;mBAAuB,KAAK;WAAC;QACrC,kDAAkD;QAC1C;;;;mBAAe,KAAK;WAAC;IAM1B,CAAC;IAEJ,KAAK,CAAC,OAAO;QACX,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC;YACjB,IAAI,EAAE,IAAI,CAAC,WAAW,CAAC,CAAC,CAAC,WAAW,CAAC,CAAC,CAAC,SAAS;YAChD,OAAO,EAAE,sBAAsB;SAChC,CAAC,CAAC;QACH,IAAI,IAAI,CAAC,YAAY,EAAE,CAAC;YACtB,IAAI,CAAC,OAAO,CAAC,GAAG,CACd,0DAA0D,CAC3D,CAAC;YACF,OAAO;QACT,CAAC;QACD,IAAI,CAAC,YAAY,GAAG,IAAI,CAAC;QACzB,IAAI,eAAe,GAAG,EAAE,CAAC;QACzB,IAAI,mBAAmB,GAAG,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC;QACzC,IAAI,yBAAmD,CAAC;QAExD,MAAM,WAAW,GAAG,CAAC,CAAU,EAAE,EAAE;YACjC,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,cAAc,EAAE,CAAC,CAAC,CAAC;YACtC,KAAK,IAAI,CAAC,kBAAkB,CAAC,KAAK,EAAE,QAAQ,CAAC,CAAC;QAChD,CAAC,CAAC;QACF,MAAM,cAAc,GAAG,CAAC,IAAY,EAAE,EAAE;YACtC,MAAM,QAAQ,GAAG,QAAQ,CAAC,aAAa,CAAC,eAAe,GAAG,IAAI,CAAC,CAAC;YAChE,eAAe,GAAG,QAAQ,CAAC,cAAc,CAAC;YAC1C,QAAQ,CAAC,QAAQ,CAAC,OAAO,CAAC,KAAK,EAAE,GAAG,EAAE,EAAE;gBACtC,IAAI,CAAC,4BAA4B,GAAG,IAAI,CAAC,GAAG,EAAE,CAAC;gBAE/C,+DAA+D;gBAC/D,MAAM,UAAU,GAAG,QAAQ,CAAC,sBAAsB,CAAC,GAAG,CAAC,CAAC;gBACxD,IAAI,UAAU,EAAE,CAAC;oBACf,wBAAwB;oBACxB,mCAAmC;oBACnC,iCAAiC;oBACjC,2CAA2C;oBAC3C,IAAI;oBACJ,yBAAyB;oBACzB,+BAA+B;oBAC/B,+BAA+B;oBAC/B,8BAA8B;oBAC9B,KAAK;oBACL,sDAAsD;oBACtD,gDAAgD;oBAChD,6CAA6C;oBAC7C,IAAI;oBACJ,sDAAsD;oBACtD,gDAAgD;oBAChD,6CAA6C;oBAC7C,IAAI;gBACN,CAAC;qBAAM,CAAC;oBACN,MAAM,eAAe,GAAG,QAAQ,CAAC,sBAAsB,CAAC,GAAG,CAAC,CAAC;oBAC7D,IAAI,CAAC,eAAe,EAAE,CAAC;wBACrB,OAAO;oBACT,CAAC;oBACD,MAAM,eAAe,GAAG,IAAI,CAAC,WAAW,CAAC,GAAG,CAC1C,eAAe,CAAC,SAAS,CAC1B,CAAC;oBACF,IAAI,eAAe,EAAE,CAAC;wBACpB,IAAI,CAAC,WAAW,CAAC,MAAM,CAAC,eAAe,CAAC,SAAS,CAAC,CAAC;wBACnD,eAAe,CAAC,eAAe,CAAC,CAAC;oBACnC,CAAC;gBACH,CAAC;YACH,CAAC,CAAC,CAAC;QACL,CAAC,CAAC;QACF,IAAI,CAAC;YACH,MAAM,IAAI,CAAC,GAAG,CAAC,WAAW,CAAC,cAAc,EAAE,WAAW,CAAC,CAAC;YACxD,MAAM,IAAI,CAAC,SAAS,EAAE,CAAC;YACvB,+CAA+C;YAE/C,4BAA4B;YAC5B,IAAI,IAAI,CAAC,yBAAyB,KAAK,SAAS,EAAE,CAAC;gBACjD,IAAI,CAAC,yBAAyB,GAAG,WAAW,CAAC,KAAK,IAAI,EAAE;oBACtD,IACE,IAAI,CAAC,4BAA4B;wBACjC,IAAI,CAAC,GAAG,EAAE,GAAG,IAAI,CAAC,4BAA4B,GAAG,KAAK,EACtD,CAAC;wBACD,gCAAgC;oBAClC,CAAC;oBACD,IACE,IAAI,CAAC,4BAA4B;wBACjC,IAAI,CAAC,GAAG,EAAE,GAAG,IAAI,CAAC,4BAA4B;4BAC5C,sBAAsB,EACxB,CAAC;wBACD,MAAM,IAAI,CAAC,eAAe,EAAE,CAAC;oBAC/B,CAAC;gBACH,CAAC,EAAE,IAAI,CAAC,CAAC;YACX,CAAC;YAED,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,kCAAkC,IAAI,CAAC,cAAc,EAAE,CAAC,CAAC;YAC1E,MAAM,iBAAiB,GAAG,QAAQ,CAAC,qBAAqB,CACtD,IAAI,CAAC,cAAc,CACpB,CAAC;YACF,MAAM,kBAAkB,GACtB,MAAM,IAAI,CAAC,mBAAmB,CAAC,iBAAiB,CAAC,CAAC;YACpD,IACE,kBAAkB,CAAC,IAAI,KAAK,QAAQ,CAAC,aAAa,CAAC,KAAK;gBACxD,kBAAkB,CAAC,KAAK,KAAK,IAAI,CAAC,cAAc,EAChD,CAAC;gBACD,MAAM,IAAI,WAAW,CACnB,+CAA+C,IAAI,CAAC,cAAc,SAAS,kBAAkB,CAAC,KAAK,EAAE,CACtG,CAAC;YACJ,CAAC;YAED,uCAAuC;YACvC,4BAA4B;YAC5B,IAAI,KAAK,EAAE,CAAC;gBACV,+DAA+D;gBAC/D,MAAM,QAAQ,GAAG,QAAQ,CAAC,gBAAgB,CAAC;oBACzC,aAAa,EAAE,IAAI;oBACnB,OAAO,EAAE,IAAI;iBACd,CAAC,CAAC;gBACH,MAAM,sBAAsB,GAAG,IAAI,OAAO,CAAO,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;oBACnE,yBAAyB,GAAG,OAAO,CAAC;oBACpC,UAAU,CAAC,GAAG,EAAE;wBACd,yBAAyB,GAAG,SAAS,CAAC;wBACtC,MAAM,CAAC,IAAI,KAAK,CAAC,8CAA8C,CAAC,CAAC,CAAC;oBACpE,CAAC,EAAE,GAAG,CAAC,CAAC;gBACV,CAAC,CAAC,CAAC;gBAEH,MAAM,gBAAgB,GAAG,MAAM,IAAI,CAAC,mBAAmB,CAAC,QAAQ,CAAC,CAAC;gBAClE,IAAI,gBAAgB,CAAC,IAAI,KAAK,QAAQ,CAAC,aAAa,CAAC,KAAK,EAAE,CAAC;oBAC3D,MAAM,IAAI,WAAW,CACnB,oEAAoE,gBAAgB,CAAC,OAAO,EAAE,CAC/F,CAAC;gBACJ,CAAC;gBAED,IAAI,IAAI,CAAC,WAAW,EAAE,CAAC;oBACrB,MAAM,sBAAsB,CAAC;gBAC/B,CAAC;qBAAM,CAAC;oBACN,sBAAsB,CAAC,KAAK,CAAC,KAAK,EAAE,CAAC,EAAE,EAAE;wBACvC,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,sCAAsC,EAAE,CAAC,CAAC,CAAC;wBAC9D,MAAM,IAAI,CAAC,kBAAkB,CAAC,KAAK,EAAE,QAAQ,CAAC,CAAC;wBAC/C,IAAI,CAAC,YAAY,GAAG,KAAK,CAAC;oBAC5B,CAAC,CAAC,CAAC;gBACL,CAAC;YACH,CAAC;YAED,yEAAyE;YACzE,2CAA2C;YAC3C,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC;gBACjB,IAAI,EAAE,IAAI,CAAC,WAAW,CAAC,CAAC,CAAC,WAAW,CAAC,CAAC,CAAC,SAAS;gBAChD,OAAO,EAAE,wBAAwB;aAClC,CAAC,CAAC;QACL,CAAC;QAAC,OAAO,CAAC,EAAE,CAAC;YACX,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,sCAAsC,EAAE,CAAC,CAAC,CAAC;YAC9D,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC;gBACjB,IAAI,EAAE,IAAI,CAAC,WAAW,CAAC,CAAC,CAAC,WAAW,CAAC,CAAC,CAAC,SAAS;gBAChD,OAAO,EAAE,uBAAuB;aACjC,CAAC,CAAC;YACH,MAAM,aAAa,GAAG,CAAC,YAAY,WAAW,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,QAAQ,CAAC;YACrE,MAAM,IAAI,CAAC,kBAAkB,CAAC,KAAK,EAAE,aAAa,CAAC,CAAC;YACpD,MAAM,CAAC,CAAC;QACV,CAAC;gBAAS,CAAC;YACT,IAAI,CAAC,YAAY,GAAG,KAAK,CAAC;YAC1B,IAAI,CAAC,YAAY,GAAG,KAAK,CAAC;QAC5B,CAAC;IACH,CAAC;IAED,KAAK,CAAC,UAAU;QACd,OAAO,IAAI,CAAC,kBAAkB,CAAC,IAAI,EAAE,QAAQ,CAAC,CAAC;IACjD,CAAC;IAEO,mBAAmB;QACzB,aAAa,CAAC,IAAI,CAAC,yBAAyB,CAAC,CAAC;QAC9C,IAAI,CAAC,yBAAyB,GAAG,SAAS,CAAC;QAC3C,IAAI,CAAC,4BAA4B,GAAG,SAAS,CAAC;IAChD,CAAC;IAEO,KAAK,CAAC,kBAAkB,CAAC,cAAuB;QACtD,IAAI,CAAC,mBAAmB,EAAE,CAAC;QAC3B,IAAI,CAAC;YACH,MAAM,IAAI,CAAC,mBAAmB,CAAC,QAAQ,CAAC,eAAe,EAAE,CAAC,CAAC;QAC7D,CAAC;QAAC,OAAO,CAAC,EAAE,CAAC;YACX,4DAA4D;QAC9D,CAAC;QACD,IAAI,CAAC,WAAW,CAAC,KAAK,EAAE,CAAC;QACzB,MAAM,IAAI,CAAC,GAAG,CAAC,UAAU,EAAE,CAAC;QAC5B,uBAAuB;QACvB,+BAA+B;QAC/B,wCAAwC;QACxC,cAAc;QACd,yBAAyB;QACzB,0BAA0B;QAC1B,qBAAqB;QACrB,kBAAkB;QAClB,KAAK;IACP,CAAC;IAED,KAAK,CAAC,eAAe;QACnB,IAAI,IAAI,CAAC,YAAY,EAAE,CAAC;YACtB,IAAI,CAAC,OAAO,CAAC,GAAG,CACd,4DAA4D,CAC7D,CAAC;YACF,OAAO;QACT,CAAC;QACD,IAAI,CAAC;YACH,IAAI,CAAC,mBAAmB,EAAE,CAAC;YAC3B,IAAI,CAAC,OAAO,CAAC,GAAG,CACd,0DAA0D,CAC3D,CAAC;YACF,IAAI,CAAC,WAAW,CAAC,KAAK,EAAE,CAAC;YACzB,MAAM,IAAI,CAAC,GAAG,CAAC,UAAU,EAAE,CAAC;YAC5B,MAAM,IAAI,CAAC,GAAG,CAAC,aAAa,EAAE,CAAC;YAC/B,MAAM,IAAI,CAAC,SAAS,EAAE,CAAC;QACzB,CAAC;QAAC,OAAO,CAAC,EAAE,CAAC;YACX,IAAI,CAAC,OAAO,CAAC,KAAK,CAChB,wDAAwD,EACxD,CAAC,CACF,CAAC;QACJ,CAAC;gBAAS,CAAC;YACT,IAAI,CAAC,YAAY,GAAG,KAAK,CAAC;QAC5B,CAAC;IACH,CAAC;IAED,KAAK,CAAC,SAAS,CAAC,eAAwB,KAAK;QAC3C,IAAI,CAAC,YAAY,GAAG,YAAY,CAAC;QACjC,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,kBAAkB,CAAC,CAAC;QACrC,IAAI,CAAC,WAAW,GAAG,IAAI,CAAC;QACxB,MAAM,IAAI,CAAC,OAAO,EAAE,CAAC;IACvB,CAAC;IAEO,KAAK,CAAC,mBAAmB,CAC/B,GAAwB;QAExB,MAAM,eAAe,GAAG,IAAI,OAAO,CACjC,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;YAClB,IAAI,CAAC,WAAW,CAAC,GAAG,CAAC,GAAG,CAAC,SAAS,EAAE,OAAO,CAAC,CAAC;YAC7C,UAAU,CAAC,GAAG,EAAE;gBACd,IAAI,CAAC,WAAW,CAAC,MAAM,CAAC,GAAG,CAAC,SAAS,CAAC,CAAC;gBACvC,MAAM,CAAC,IAAI,KAAK,CAAC,gCAAgC,GAAG,CAAC,SAAS,EAAE,CAAC,CAAC,CAAC;YACrE,CAAC,EAAE,KAAK,CAAC,CAAC;QACZ,CAAC,CACF,CAAC;QACF,MAAM,IAAI,CAAC,GAAG,CAAC,WAAW,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC;QACxC,OAAO,eAAe,CAAC;IACzB,CAAC;IAEO,KAAK,CAAC,SAAS;QACrB,4EAA4E;QAC5E,2CAA2C;QAC3C,0EAA0E;QAC1E,0EAA0E;QAC1E,kBAAkB;QAClB,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,kBAAkB,CAAC,CAAC;QACrC,MAAM,eAAe,GAAG,MAAM,IAAI,OAAO,CACvC,KAAK,EAAE,OAAO,EAAE,MAAM,EAAE,EAAE;YACxB,MAAM,QAAQ,GAAG,EAAE,CAAC;YACpB,IAAI,cAAc,GAAG,CAAC,CAAC;YACvB,IAAI,cAAc,GAAG,CAAC,CAAC;YACvB,IAAI,QAAQ,GAAG,KAAK,CAAC;YACrB,OAAO,cAAc,GAAG,EAAE,IAAI,CAAC,QAAQ,EAAE,CAAC;gBACxC,cAAc,EAAE,CAAC;gBACjB,IAAI,CAAC,mBAAmB,CAAC,QAAQ,CAAC,oBAAoB,EAAE,CAAC;qBACtD,IAAI,CAAC,CAAC,KAAK,EAAE,EAAE;oBACd,IAAI,CAAC,QAAQ,EAAE,CAAC;wBACd,QAAQ,GAAG,IAAI,CAAC;wBAChB,OAAO,CAAC,KAAK,CAAC,CAAC;oBACjB,CAAC;gBACH,CAAC,CAAC;qBACD,KAAK,CAAC,GAAG,EAAE;oBACV,4EAA4E;oBAC5E,IAAI,CAAC,QAAQ,EAAE,CAAC;wBACd,IAAI,EAAE,cAAc,KAAK,QAAQ,EAAE,CAAC;4BAClC,MAAM,CAAC,IAAI,WAAW,CAAC,yBAAyB,CAAC,CAAC,CAAC;wBACrD,CAAC;oBACH,CAAC;gBACH,CAAC,CAAC,CAAC;gBACL,MAAM,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC,UAAU,CAAC,OAAO,EAAE,GAAG,CAAC,CAAC,CAAC;YAC3D,CAAC;QACH,CAAC,CACF,CAAC;QACF,IAAI,eAAe,CAAC,KAAK,KAAK,QAAQ,CAAC,OAAO,EAAE,CAAC;YAC/C,MAAM,IAAI,WAAW,CACnB,iDAAiD,QAAQ,CAAC,OAAO,EAAE,CACpE,CAAC;QACJ,CAAC;IACH,CAAC;CACF;AAED,MAAM,CAAC,MAAM,qBAAqB,GAAG,KAAK,EACxC,OAAgB,EAChB,GAA6B,EAC7B,cAAsB,EAC8B,EAAE;IACtD,IAAI,CAAC;QACH,MAAM,MAAM,GAAG,IAAI,6BAA6B,CAC9C,GAAG,EACH,OAAO,EACP,cAAc,CACf,CAAC;QACF,MAAM,MAAM,CAAC,OAAO,EAAE,CAAC;QACvB,OAAO,MAAM,CAAC;IAChB,CAAC;IAAC,OAAO,CAAC,EAAE,CAAC;QACX,OAAO,SAAS,CAAC;IACnB,CAAC;AACH,CAAC,CAAC"}

package/build/usb-serial-protocol.d.ts

@@ -0,0 +1,66 @@
+/**
+ * (c) 2024, Micro:bit Educational Foundation and contributors
+ *
+ * SPDX-License-Identifier: MIT
+ */
+export type SplittedMessages = {
+    messages: string[];
+    remainingInput: string;
+};
+export declare enum CommandTypes {
+    Handshake = "HS",
+    RadioFrequency = "RF",
+    RemoteMbId = "RMBID",
+    SoftwareVersion = "SWVER",
+    HardwareVersion = "HWVER",
+    Zstart = "ZSTART",
+    Stop = "STOP"
+}
+declare enum ResponseExtraTypes {
+    Error = "ERROR"
+}
+export type ResponseTypes = CommandTypes | ResponseExtraTypes;
+export declare const ResponseTypes: {
+    Error: ResponseExtraTypes.Error;
+    Handshake: CommandTypes.Handshake;
+    RadioFrequency: CommandTypes.RadioFrequency;
+    RemoteMbId: CommandTypes.RemoteMbId;
+    SoftwareVersion: CommandTypes.SoftwareVersion;
+    HardwareVersion: CommandTypes.HardwareVersion;
+    Zstart: CommandTypes.Zstart;
+    Stop: CommandTypes.Stop;
+};
+export type MessageCmd = {
+    message: string;
+    messageId: number;
+    type: CommandTypes;
+    value: number | string;
+};
+export type MessageResponse = {
+    message: string;
+    messageId: number;
+    type: ResponseTypes;
+    value: number | string;
+};
+export type MicrobitSensors = {
+    accelerometer: boolean;
+    buttons: boolean;
+};
+export type MicrobitSensorState = {
+    accelerometerX: number;
+    accelerometerY: number;
+    accelerometerZ: number;
+    buttonA: number;
+    buttonB: number;
+};
+export declare const version = 1;
+export declare const splitMessages: (message: string) => SplittedMessages;
+export declare const processResponseMessage: (message: string) => MessageResponse | undefined;
+export declare const processPeriodicMessage: (message: string) => MicrobitSensorState | undefined;
+export declare const generateCmdHandshake: () => MessageCmd;
+export declare const generateCmdStart: (sensors: MicrobitSensors) => MessageCmd;
+export declare const generateCmdStop: () => MessageCmd;
+export declare const generateCmdRadioFrequency: (frequency: number) => MessageCmd;
+export declare const generateCmdRemoteMbId: (remoteMicrobitId: number) => MessageCmd;
+export declare const generateRandomRadioFrequency: () => number;
+export {};

package/build/usb-serial-protocol.js

@@ -0,0 +1,171 @@
+/**
+ * (c) 2024, Micro:bit Educational Foundation and contributors
+ *
+ * SPDX-License-Identifier: MIT
+ */
+var MessageTypes;
+(function (MessageTypes) {
+    MessageTypes["Command"] = "C";
+    MessageTypes["Response"] = "R";
+    MessageTypes["Periodic"] = "P";
+})(MessageTypes || (MessageTypes = {}));
+export var CommandTypes;
+(function (CommandTypes) {
+    CommandTypes["Handshake"] = "HS";
+    CommandTypes["RadioFrequency"] = "RF";
+    CommandTypes["RemoteMbId"] = "RMBID";
+    CommandTypes["SoftwareVersion"] = "SWVER";
+    CommandTypes["HardwareVersion"] = "HWVER";
+    CommandTypes["Zstart"] = "ZSTART";
+    CommandTypes["Stop"] = "STOP";
+})(CommandTypes || (CommandTypes = {}));
+var ResponseExtraTypes;
+(function (ResponseExtraTypes) {
+    ResponseExtraTypes["Error"] = "ERROR";
+})(ResponseExtraTypes || (ResponseExtraTypes = {}));
+export const ResponseTypes = { ...CommandTypes, ...ResponseExtraTypes };
+// Currently implemented protocol version
+export const version = 1;
+export const splitMessages = (message) => {
+    if (!message) {
+        return {
+            messages: [],
+            remainingInput: "",
+        };
+    }
+    let messages = message.split("\n");
+    let remainingInput = messages.pop() || "";
+    // Throw away any empty messages and messages that don't start with a valid type
+    messages = messages.filter((msg) => msg.length > 0 &&
+        Object.values(MessageTypes).includes(msg[0]));
+    // Any remaining input will be the start of the next message, so if it doesn't start
+    // with a valid type throw it away as it'll be prepended to the next serial string
+    if (remainingInput.length > 0 &&
+        !Object.values(MessageTypes).includes(remainingInput[0])) {
+        remainingInput = "";
+    }
+    return {
+        messages,
+        remainingInput,
+    };
+};
+export const processResponseMessage = (message) => {
+    // Regex for a message response with 3 groups:
+    // id    -> The message ID, 1-8 hex characters
+    // cmd   -> The command type, a string, only capital letters, matching CommandTypes
+    // value -> The response value, empty string or a word, number,
+    //          or version (e.g 1.2.3) depending on the command type
+    const responseMatch = /^R\[(?<id>[0-9A-Fa-f]{1,8})\](?<cmd>[A-Z]+)\[(?<value>-?[\w.]*)\]$/.exec(message);
+    if (!responseMatch || !responseMatch.groups) {
+        return undefined;
+    }
+    const messageId = parseInt(responseMatch.groups["id"], 16);
+    if (isNaN(messageId)) {
+        return undefined;
+    }
+    const responseType = responseMatch.groups["cmd"];
+    if (!Object.values(ResponseTypes).includes(responseType)) {
+        return undefined;
+    }
+    let value = responseMatch.groups["value"];
+    switch (responseType) {
+        // Commands with numeric values
+        case ResponseTypes.Handshake:
+        case ResponseTypes.RadioFrequency:
+        case ResponseTypes.RemoteMbId:
+        case ResponseTypes.HardwareVersion:
+        case ResponseTypes.Error:
+            value = Number(value);
+            if (isNaN(value) || value < 0 || value > 0xffffffff) {
+                return undefined;
+            }
+            break;
+        // Commands without values
+        case ResponseTypes.Zstart:
+        case ResponseTypes.Stop:
+            if (value !== "") {
+                return undefined;
+            }
+            break;
+        // Semver-ish values (valid range 00.00.00 to 99.99.99)
+        case ResponseTypes.SoftwareVersion:
+            if (!/^[0-9]{1,2}\.[0-9]{1,2}\.[0-9]{1,2}$/.test(value)) {
+                return undefined;
+            }
+            break;
+    }
+    return {
+        message,
+        messageId,
+        type: responseType,
+        value,
+    };
+};
+export const processPeriodicMessage = (message) => {
+    // Basic checks to match the message being a compact periodic message
+    if (message.length !== 13 || message[0] !== MessageTypes.Periodic) {
+        return undefined;
+    }
+    // All characters except the first one should be hex
+    if (!/^[0-9A-Fa-f]+$/.test(message.substring(1))) {
+        return undefined;
+    }
+    // Only the two Least Significant Bits from the buttons are used
+    const buttons = parseInt(message[12], 16);
+    if (buttons > 3) {
+        return undefined;
+    }
+    return {
+        // The accelerometer data has been clamped to -2048 to 2047, and an offset
+        // added to make the values positive, so that needs to be reversed
+        accelerometerX: parseInt(message.substring(3, 6), 16) - 2048,
+        accelerometerY: parseInt(message.substring(6, 9), 16) - 2048,
+        accelerometerZ: parseInt(message.substring(9, 12), 16) - 2048,
+        // Button A is the LSB, button B is the next bit
+        buttonA: buttons & 1,
+        buttonB: (buttons >> 1) & 1,
+    };
+};
+const generateCommand = (cmdType, cmdData = "") => {
+    // Generate an random (enough) ID with max value of 8 hex digits
+    const msgID = Math.floor(Math.random() * 0xffffffff);
+    return {
+        message: `C[${msgID.toString(16).toUpperCase()}]${cmdType}[${cmdData}]\n`,
+        messageId: msgID,
+        type: cmdType,
+        value: cmdData,
+    };
+};
+export const generateCmdHandshake = () => {
+    return generateCommand(CommandTypes.Handshake);
+};
+export const generateCmdStart = (sensors) => {
+    let cmdData = "";
+    if (sensors.accelerometer) {
+        cmdData += "A";
+    }
+    if (sensors.buttons) {
+        cmdData += "B";
+    }
+    return generateCommand(CommandTypes.Zstart, cmdData);
+};
+export const generateCmdStop = () => {
+    return generateCommand(CommandTypes.Stop);
+};
+export const generateCmdRadioFrequency = (frequency) => {
+    if (frequency < 0 || frequency > 83) {
+        throw new Error("Radio frequency out of range");
+    }
+    return generateCommand(CommandTypes.RadioFrequency, frequency.toString());
+};
+export const generateCmdRemoteMbId = (remoteMicrobitId) => {
+    if (remoteMicrobitId < 0 || remoteMicrobitId > 0xffffffff) {
+        throw new Error("Remote micro:bit ID out of range");
+    }
+    return generateCommand(CommandTypes.RemoteMbId, remoteMicrobitId.toString());
+};
+export const generateRandomRadioFrequency = () => {
+    // The value range for radio frequencies is 0 to 83
+    return Math.floor(Math.random() * 84);
+};
+//# sourceMappingURL=usb-serial-protocol.js.map

package/build/usb-serial-protocol.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"usb-serial-protocol.js","sourceRoot":"","sources":["../lib/usb-serial-protocol.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAOH,IAAK,YAIJ;AAJD,WAAK,YAAY;IACf,6BAAa,CAAA;IACb,8BAAc,CAAA;IACd,8BAAc,CAAA;AAChB,CAAC,EAJI,YAAY,KAAZ,YAAY,QAIhB;AAED,MAAM,CAAN,IAAY,YAQX;AARD,WAAY,YAAY;IACtB,gCAAgB,CAAA;IAChB,qCAAqB,CAAA;IACrB,oCAAoB,CAAA;IACpB,yCAAyB,CAAA;IACzB,yCAAyB,CAAA;IACzB,iCAAiB,CAAA;IACjB,6BAAa,CAAA;AACf,CAAC,EARW,YAAY,KAAZ,YAAY,QAQvB;AAED,IAAK,kBAEJ;AAFD,WAAK,kBAAkB;IACrB,qCAAe,CAAA;AACjB,CAAC,EAFI,kBAAkB,KAAlB,kBAAkB,QAEtB;AAGD,MAAM,CAAC,MAAM,aAAa,GAAG,EAAE,GAAG,YAAY,EAAE,GAAG,kBAAkB,EAAE,CAAC;AA8BxE,yCAAyC;AACzC,MAAM,CAAC,MAAM,OAAO,GAAG,CAAC,CAAC;AAEzB,MAAM,CAAC,MAAM,aAAa,GAAG,CAAC,OAAe,EAAoB,EAAE;IACjE,IAAI,CAAC,OAAO,EAAE,CAAC;QACb,OAAO;YACL,QAAQ,EAAE,EAAE;YACZ,cAAc,EAAE,EAAE;SACnB,CAAC;IACJ,CAAC;IACD,IAAI,QAAQ,GAAG,OAAO,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;IACnC,IAAI,cAAc,GAAG,QAAQ,CAAC,GAAG,EAAE,IAAI,EAAE,CAAC;IAE1C,gFAAgF;IAChF,QAAQ,GAAG,QAAQ,CAAC,MAAM,CACxB,CAAC,GAAW,EAAE,EAAE,CACd,GAAG,CAAC,MAAM,GAAG,CAAC;QACd,MAAM,CAAC,MAAM,CAAC,YAAY,CAAC,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC,CAAiB,CAAC,CAC/D,CAAC;IAEF,oFAAoF;IACpF,kFAAkF;IAClF,IACE,cAAc,CAAC,MAAM,GAAG,CAAC;QACzB,CAAC,MAAM,CAAC,MAAM,CAAC,YAAY,CAAC,CAAC,QAAQ,CAAC,cAAc,CAAC,CAAC,CAAiB,CAAC,EACxE,CAAC;QACD,cAAc,GAAG,EAAE,CAAC;IACtB,CAAC;IAED,OAAO;QACL,QAAQ;QACR,cAAc;KACf,CAAC;AACJ,CAAC,CAAC;AAEF,MAAM,CAAC,MAAM,sBAAsB,GAAG,CACpC,OAAe,EACc,EAAE;IAC/B,8CAA8C;IAC9C,8CAA8C;IAC9C,mFAAmF;IACnF,+DAA+D;IAC/D,gEAAgE;IAChE,MAAM,aAAa,GACjB,oEAAoE,CAAC,IAAI,CACvE,OAAO,CACR,CAAC;IACJ,IAAI,CAAC,aAAa,IAAI,CAAC,aAAa,CAAC,MAAM,EAAE,CAAC;QAC5C,OAAO,SAAS,CAAC;IACnB,CAAC;IACD,MAAM,SAAS,GAAG,QAAQ,CAAC,aAAa,CAAC,MAAM,CAAC,IAAI,CAAC,EAAE,EAAE,CAAC,CAAC;IAC3D,IAAI,KAAK,CAAC,SAAS,CAAC,EAAE,CAAC;QACrB,OAAO,SAAS,CAAC;IACnB,CAAC;IACD,MAAM,YAAY,GAAG,aAAa,CAAC,MAAM,CAAC,KAAK,CAAkB,CAAC;IAClE,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC,aAAa,CAAC,CAAC,QAAQ,CAAC,YAAY,CAAC,EAAE,CAAC;QACzD,OAAO,SAAS,CAAC;IACnB,CAAC;IACD,IAAI,KAAK,GAAoB,aAAa,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC;IAC3D,QAAQ,YAAY,EAAE,CAAC;QACrB,+BAA+B;QAC/B,KAAK,aAAa,CAAC,SAAS,CAAC;QAC7B,KAAK,aAAa,CAAC,cAAc,CAAC;QAClC,KAAK,aAAa,CAAC,UAAU,CAAC;QAC9B,KAAK,aAAa,CAAC,eAAe,CAAC;QACnC,KAAK,aAAa,CAAC,KAAK;YACtB,KAAK,GAAG,MAAM,CAAC,KAAK,CAAC,CAAC;YACtB,IAAI,KAAK,CAAC,KAAK,CAAC,IAAI,KAAK,GAAG,CAAC,IAAI,KAAK,GAAG,UAAU,EAAE,CAAC;gBACpD,OAAO,SAAS,CAAC;YACnB,CAAC;YACD,MAAM;QACR,0BAA0B;QAC1B,KAAK,aAAa,CAAC,MAAM,CAAC;QAC1B,KAAK,aAAa,CAAC,IAAI;YACrB,IAAI,KAAK,KAAK,EAAE,EAAE,CAAC;gBACjB,OAAO,SAAS,CAAC;YACnB,CAAC;YACD,MAAM;QACR,uDAAuD;QACvD,KAAK,aAAa,CAAC,eAAe;YAChC,IAAI,CAAC,sCAAsC,CAAC,IAAI,CAAC,KAAK,CAAC,EAAE,CAAC;gBACxD,OAAO,SAAS,CAAC;YACnB,CAAC;YACD,MAAM;IACV,CAAC;IACD,OAAO;QACL,OAAO;QACP,SAAS;QACT,IAAI,EAAE,YAAY;QAClB,KAAK;KACN,CAAC;AACJ,CAAC,CAAC;AAEF,MAAM,CAAC,MAAM,sBAAsB,GAAG,CACpC,OAAe,EACkB,EAAE;IACnC,qEAAqE;IACrE,IAAI,OAAO,CAAC,MAAM,KAAK,EAAE,IAAI,OAAO,CAAC,CAAC,CAAC,KAAK,YAAY,CAAC,QAAQ,EAAE,CAAC;QAClE,OAAO,SAAS,CAAC;IACnB,CAAC;IACD,oDAAoD;IACpD,IAAI,CAAC,gBAAgB,CAAC,IAAI,CAAC,OAAO,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC;QACjD,OAAO,SAAS,CAAC;IACnB,CAAC;IAED,gEAAgE;IAChE,MAAM,OAAO,GAAG,QAAQ,CAAC,OAAO,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC,CAAC;IAC1C,IAAI,OAAO,GAAG,CAAC,EAAE,CAAC;QAChB,OAAO,SAAS,CAAC;IACnB,CAAC;IAED,OAAO;QACL,0EAA0E;QAC1E,kEAAkE;QAClE,cAAc,EAAE,QAAQ,CAAC,OAAO,CAAC,SAAS,CAAC,CAAC,EAAE,CAAC,CAAC,EAAE,EAAE,CAAC,GAAG,IAAI;QAC5D,cAAc,EAAE,QAAQ,CAAC,OAAO,CAAC,SAAS,CAAC,CAAC,EAAE,CAAC,CAAC,EAAE,EAAE,CAAC,GAAG,IAAI;QAC5D,cAAc,EAAE,QAAQ,CAAC,OAAO,CAAC,SAAS,CAAC,CAAC,EAAE,EAAE,CAAC,EAAE,EAAE,CAAC,GAAG,IAAI;QAC7D,gDAAgD;QAChD,OAAO,EAAE,OAAO,GAAG,CAAC;QACpB,OAAO,EAAE,CAAC,OAAO,IAAI,CAAC,CAAC,GAAG,CAAC;KAC5B,CAAC;AACJ,CAAC,CAAC;AAEF,MAAM,eAAe,GAAG,CACtB,OAAqB,EACrB,UAAkB,EAAE,EACR,EAAE;IACd,gEAAgE;IAChE,MAAM,KAAK,GAAG,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,MAAM,EAAE,GAAG,UAAU,CAAC,CAAC;IACrD,OAAO;QACL,OAAO,EAAE,KAAK,KAAK,CAAC,QAAQ,CAAC,EAAE,CAAC,CAAC,WAAW,EAAE,IAAI,OAAO,IAAI,OAAO,KAAK;QACzE,SAAS,EAAE,KAAK;QAChB,IAAI,EAAE,OAAO;QACb,KAAK,EAAE,OAAO;KACf,CAAC;AACJ,CAAC,CAAC;AAEF,MAAM,CAAC,MAAM,oBAAoB,GAAG,GAAe,EAAE;IACnD,OAAO,eAAe,CAAC,YAAY,CAAC,SAAS,CAAC,CAAC;AACjD,CAAC,CAAC;AAEF,MAAM,CAAC,MAAM,gBAAgB,GAAG,CAAC,OAAwB,EAAc,EAAE;IACvE,IAAI,OAAO,GAAG,EAAE,CAAC;IACjB,IAAI,OAAO,CAAC,aAAa,EAAE,CAAC;QAC1B,OAAO,IAAI,GAAG,CAAC;IACjB,CAAC;IACD,IAAI,OAAO,CAAC,OAAO,EAAE,CAAC;QACpB,OAAO,IAAI,GAAG,CAAC;IACjB,CAAC;IACD,OAAO,eAAe,CAAC,YAAY,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;AACvD,CAAC,CAAC;AAEF,MAAM,CAAC,MAAM,eAAe,GAAG,GAAe,EAAE;IAC9C,OAAO,eAAe,CAAC,YAAY,CAAC,IAAI,CAAC,CAAC;AAC5C,CAAC,CAAC;AAEF,MAAM,CAAC,MAAM,yBAAyB,GAAG,CAAC,SAAiB,EAAc,EAAE;IACzE,IAAI,SAAS,GAAG,CAAC,IAAI,SAAS,GAAG,EAAE,EAAE,CAAC;QACpC,MAAM,IAAI,KAAK,CAAC,8BAA8B,CAAC,CAAC;IAClD,CAAC;IACD,OAAO,eAAe,CAAC,YAAY,CAAC,cAAc,EAAE,SAAS,CAAC,QAAQ,EAAE,CAAC,CAAC;AAC5E,CAAC,CAAC;AAEF,MAAM,CAAC,MAAM,qBAAqB,GAAG,CAAC,gBAAwB,EAAc,EAAE;IAC5E,IAAI,gBAAgB,GAAG,CAAC,IAAI,gBAAgB,GAAG,UAAU,EAAE,CAAC;QAC1D,MAAM,IAAI,KAAK,CAAC,kCAAkC,CAAC,CAAC;IACtD,CAAC;IACD,OAAO,eAAe,CAAC,YAAY,CAAC,UAAU,EAAE,gBAAgB,CAAC,QAAQ,EAAE,CAAC,CAAC;AAC/E,CAAC,CAAC;AAEF,MAAM,CAAC,MAAM,4BAA4B,GAAG,GAAW,EAAE;IACvD,mDAAmD;IACnD,OAAO,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,MAAM,EAAE,GAAG,EAAE,CAAC,CAAC;AACxC,CAAC,CAAC"}

package/build/usb.d.ts

@@ -0,0 +1,61 @@
+/**
+ * (c) 2021, Micro:bit Educational Foundation and contributors
+ *
+ * SPDX-License-Identifier: MIT
+ */
+import { Logging } from "./logging";
+import { BoardVersion, ConnectionStatus, ConnectOptions, DeviceConnection, DeviceConnectionEventMap, FlashDataSource } from "./device";
+import { TypedEventTarget } from "./events";
+export declare const isChromeOS105: () => boolean;
+export interface MicrobitWebUSBConnectionOptions {
+    logging: Logging;
+}
+/**
+ * A WebUSB connection to a micro:bit device.
+ */
+export declare class MicrobitWebUSBConnection extends TypedEventTarget<DeviceConnectionEventMap> implements DeviceConnection {
+    status: ConnectionStatus;
+    /**
+     * The USB device we last connected to.
+     * Cleared if it is disconnected.
+     */
+    private device;
+    /**
+     * The connection to the device.
+     */
+    private connection;
+    /**
+     * DAPLink gives us a promise that lasts as long as we're serial reading.
+     * When stopping serial we await it to be sure we're done.
+     */
+    private serialReadInProgress;
+    private serialListener;
+    private flashing;
+    private disconnectAfterFlash;
+    private visibilityReconnect;
+    private visibilityChangeListener;
+    private unloading;
+    private beforeUnloadListener;
+    private logging;
+    constructor(options?: MicrobitWebUSBConnectionOptions);
+    private log;
+    initialize(): Promise<void>;
+    dispose(): void;
+    connect(options?: ConnectOptions): Promise<ConnectionStatus>;
+    getBoardVersion(): BoardVersion | undefined;
+    flash(dataSource: FlashDataSource, options: {
+        partial: boolean;
+        progress: (percentage: number | undefined) => void;
+    }): Promise<void>;
+    private flashInternal;
+    private startSerialInternal;
+    private stopSerialInternal;
+    disconnect(): Promise<void>;
+    private setStatus;
+    private withEnrichedErrors;
+    serialWrite(data: string): Promise<void>;
+    private handleDisconnect;
+    clearDevice(): Promise<void>;
+    private connectInternal;
+    private chooseDevice;
+}