Fill out BT profile. Demo connect/disconnect.

Name filter something of a cludge

Author: microbit-matt-hillsdon

lib/bluetooth-profile.ts

@@ -11,24 +11,40 @@ export const profile = {
     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" },
     },
   },
-  io: {
+  ioPin: {
     id: "e95d127b-251d-470a-a062-fa1922dfa9a8",
     characteristics: {
-      data: { id: "e95d8d00-251d-470a-a062-fa1922dfa9a8" },
+      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: {
@@ -38,4 +54,29 @@ export const profile = {
       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" },
+    },
+  },
 };

lib/bluetooth.ts

@@ -91,7 +91,7 @@ export class MicrobitWebBluetoothConnection
        * A progress callback. Called with undefined when the process is complete or has failed.
        */
       progress: (percentage: number | undefined) => void;
-    },
+    }
   ): Promise<void> {
     throw new Error("Unsupported");
   }
@@ -157,21 +157,23 @@ export class MicrobitWebBluetoothConnection
 
   private async connectInternal(options: ConnectOptions): Promise<void> {
     if (!this.connection) {
-      const device = await this.chooseDevice();
+      const device = await this.chooseDevice(options);
       if (!device) {
         return;
       }
       this.connection = await createBluetoothDeviceWrapper(
         device,
-        this.logging,
+        this.logging
       );
     }
     // TODO: timeout unification?
     this.connection?.connect();
     this.setStatus(ConnectionStatus.CONNECTED);
   }
 
-  private async chooseDevice(): Promise<BluetoothDevice | undefined> {
+  private async chooseDevice(
+    options: ConnectOptions
+  ): Promise<BluetoothDevice | undefined> {
     if (this.device) {
       return this.device;
     }
@@ -181,20 +183,28 @@ export class MicrobitWebBluetoothConnection
       // TODO: give control over this to the caller
       const result = await Promise.race([
         navigator.bluetooth.requestDevice({
-          // TODO: this is limiting
-          filters: [{ namePrefix: `BBC micro:bit [${name}]` }],
+          filters: [
+            {
+              namePrefix: options.name
+                ? `BBC micro:bit [${options.name}]`
+                : "BBC micro:bit",
+            },
+          ],
           optionalServices: [
-            // TODO: include everything or perhaps parameterise?
-            profile.uart.id,
             profile.accelerometer.id,
+            profile.button.id,
             profile.deviceInformation.id,
+            profile.dfuControl.id,
+            profile.event.id,
+            profile.ioPin.id,
             profile.led.id,
-            profile.io.id,
-            profile.button.id,
+            profile.magnetometer.id,
+            profile.temperature.id,
+            profile.uart.id,
           ],
         }),
         new Promise<"timeout">((resolve) =>
-          setTimeout(() => resolve("timeout"), requestDeviceTimeoutDuration),
+          setTimeout(() => resolve("timeout"), requestDeviceTimeoutDuration)
         ),
       ]);
       if (result === "timeout") {

lib/device.ts

@@ -111,6 +111,8 @@ export interface FlashDataSource {
 
 export interface ConnectOptions {
   serial?: boolean;
+  // Name filter used for Web Bluetooth
+  name?: string;
 }
 
 export type BoardVersion = "V1" | "V2";
@@ -216,7 +218,7 @@ export interface DeviceConnection
        * The partial parameter reports the flash type currently in progress.
        */
       progress: (percentage: number | undefined, partial: boolean) => void;
-    },
+    }
   ): Promise<void>;
 
   /**

src/demo.ts

@@ -6,11 +6,19 @@
 import "./demo.css";
 import { MicrobitWebUSBConnection } from "../lib/webusb";
 import { HexFlashDataSource } from "../lib/hex-flash-data-source";
-import { ConnectionStatus } from "../lib/device";
+import { ConnectionStatus, DeviceConnection } from "../lib/device";
+import { MicrobitWebBluetoothConnection } from "../lib/bluetooth";
 
 document.querySelector<HTMLDivElement>("#app")!.innerHTML = `
-  <section id="webusb">
-    <h2>WebUSB</h2>
+  <section id="flash">
+    <h2>Connect and flash</h2>
+    <label><div>Name</div>
+      <input id="name" type="text">
+    </label>
+    <select class="transport">
+      <option value="usb">WebUSB</option>
+      <option value="bluetooth">Web Bluetooth</option>
+    </select>
     <button class="connect">Connect</button>
     <button class="disconnect">Disconnect</button>
     <p class="status"></p>
@@ -19,18 +27,38 @@ document.querySelector<HTMLDivElement>("#app")!.innerHTML = `
   </section>
 `;
 
-const connect = document.querySelector("#webusb > .connect")!;
-const disconnect = document.querySelector("#webusb > .disconnect")!;
-const flash = document.querySelector("#webusb > .flash")!;
+const transport = document.querySelector(
+  "#flash > .transport"
+)! as HTMLSelectElement;
+const connect = document.querySelector("#flash > .connect")!;
+const disconnect = document.querySelector("#flash > .disconnect")!;
+const flash = document.querySelector("#flash > .flash")!;
 const fileInput = document.querySelector(
-  "#webusb input[type=file]",
+  "#flash input[type=file]"
 )! as HTMLInputElement;
-const statusParagraph = document.querySelector("#webusb > .status")!;
-const connection = new MicrobitWebUSBConnection();
+const statusParagraph = document.querySelector("#flash > .status")!;
+
+const usb = new MicrobitWebUSBConnection();
+const bluetooth = new MicrobitWebBluetoothConnection();
+let connection: DeviceConnection = usb;
+
 const initialisePromise = connection.initialize();
 const displayStatus = (status: ConnectionStatus) => {
   statusParagraph.textContent = status.toString();
 };
+transport.addEventListener("change", (e) => {
+  switch (transport.value) {
+    case "bluetooth": {
+      connection = bluetooth;
+      break;
+    }
+    case "usb": {
+      connection = usb;
+      break;
+    }
+  }
+});
+
 connection.addEventListener("status", (event) => {
   displayStatus(event.status);
 });