Define more methods to interface

Author: microbit-grace

lib/device.ts

@@ -3,7 +3,10 @@
  *
  * SPDX-License-Identifier: MIT
  */
+import { AccelerometerData } from "./accelerometer.js";
 import { TypedEventTarget } from "./events.js";
+import { LedMatrix } from "./led.js";
+import { MagnetometerData } from "./magnetometer.js";
 import { UARTDataEvent } from "./uart.js";
 
 /**
@@ -239,12 +242,17 @@ export interface DeviceConnection
 
 export interface DeviceWebUSBConnection extends DeviceConnection {
   /**
-   * Get the deviceId.
+   * Gets micro:bit deviceId.
    *
    * @returns the device id or undefined if there is no connection.
    */
   getDeviceId(): number | undefined;
 
+  /**
+   * Sets device request exclusion filters.
+   */
+  setRequestDeviceExclusionFilters(exclusionFilters: USBDeviceFilter[]): void;
+
   /**
    * Flash the micro:bit.
    *
@@ -254,11 +262,16 @@ export interface DeviceWebUSBConnection extends DeviceConnection {
   flash(dataSource: FlashDataSource, options: {}): Promise<void>;
 
   /**
-   * Get the device.
+   * Gets micro:bit device.
    *
    * @returns the USB device or undefined if there is no connection.
    */
   getDevice(): USBDevice | undefined;
+
+  /**
+   * Resets the micro:bit in software.
+   */
+  softwareReset(): Promise<void>;
 }
 
 export interface DeviceWebBluetoothConnection extends DeviceConnection {
@@ -268,6 +281,102 @@ export interface DeviceWebBluetoothConnection extends DeviceConnection {
    * @param name The name of the micro:bit.
    */
   setNameFilter(name: string): void;
+
+  /**
+   * Gets micro:bit accelerometer data.
+   *
+   * @returns accelerometer data or undefined if there is no connection.
+   */
+  getAccelerometerData(): Promise<AccelerometerData | undefined>;
+
+  /**
+   * Gets micro:bit accelerometer period.
+   *
+   * @returns accelerometer period or undefined if there is no connection.
+   */
+  getAccelerometerPeriod(): Promise<number | undefined>;
+
+  /**
+   * Sets micro:bit accelerometer period.
+   *
+   * @param value The accelerometer period.
+   */
+  setAccelerometerPeriod(value: number): Promise<void>;
+
+  /**
+   * Sets micro:bit LED text.
+   *
+   * @param text The text displayed on micro:bit LED.
+   */
+  setLedText(text: string): Promise<void>;
+
+  /**
+   * Gets micro:bit LED scrolling delay.
+   *
+   * @returns LED scrolling delay in milliseconds.
+   */
+  getLedScrollingDelay(): Promise<number | undefined>;
+
+  /**
+   * Sets micro:bit LED scrolling delay.
+   *
+   * @param delayInMillis LED scrolling delay in milliseconds.
+   */
+  setLedScrollingDelay(delayInMillis: number): Promise<void>;
+
+  /**
+   * Gets micro:bit LED matrix.
+   *
+   * @returns a boolean matrix representing the micro:bit LED display.
+   */
+  getLedMatrix(): Promise<LedMatrix | undefined>;
+
+  /**
+   * Sets micro:bit LED matrix.
+   *
+   * @param matrix an boolean matrix representing the micro:bit LED display.
+   */
+  setLedMatrix(matrix: LedMatrix): Promise<void>;
+
+  /**
+   * Gets micro:bit magnetometer data.
+   *
+   * @returns magnetometer data.
+   */
+  getMagnetometerData(): Promise<MagnetometerData | undefined>;
+
+  /**
+   * Gets micro:bit magnetometer bearing.
+   *
+   * @returns magnetometer bearing.
+   */
+  getMagnetometerBearing(): Promise<number | undefined>;
+
+  /**
+   * Gets micro:bit magnetometer period.
+   *
+   * @returns magnetometer period.
+   */
+  getMagnetometerPeriod(): Promise<number | undefined>;
+
+  /**
+   * Sets micro:bit magnetometer period.
+   *
+   * @param value magnetometer period.
+   */
+  setMagnetometerPeriod(value: number): Promise<void>;
+
+  /**
+   * Triggers micro:bit magnetometer calibration.
+   */
+  triggerMagnetometerCalibration(): Promise<void>;
+
+  /**
+   * Write UART messages.
+   *
+   * @param data UART message.
+   */
+  writeUART(data: Uint8Array): Promise<void>;
 }
 
 export interface DeviceRadioBridgeConnection extends DeviceConnection {

lib/index.ts

@@ -25,6 +25,7 @@ import {
 } from "./device.js";
 import { TypedEventTarget } from "./events.js";
 import { createUniversalHexFlashDataSource } from "./hex-flash-data-source.js";
+import { LedMatrix } from "./led.js";
 import { MagnetometerData, MagnetometerDataEvent } from "./magnetometer.js";
 import { ServiceConnectionEventMap } from "./service-events.js";
 import { MicrobitRadioBridgeConnection } from "./usb-radio-bridge.js";
@@ -65,6 +66,7 @@ export type {
   DeviceWebUSBConnection,
   FlashOptions,
   FlashDataSource,
+  LedMatrix,
   MagnetometerData,
   MagnetometerDataEvent,
 };