Interface MicrobitRadioBridgeConnectionExperimental

A connection to a remote micro:bit via a USB-connected micro:bit running radio bridge firmware. Sensor data is relayed over a serial protocol.

This connection type has limited service support compared to direct Bluetooth connections:

  • accelerometerdatachanged, buttonachanged, buttonbchanged events are supported.
  • flash is not supported.
interface MicrobitRadioBridgeConnection {
    status: ConnectionStatus;
    type: "radio-bridge";
    addEventListener(
        type: "status",
        listener: (data: ConnectionStatusChange) => void,
    ): void;
    addEventListener(
        type: "backgrounderror",
        listener: (data: BackgroundErrorData) => void,
    ): void;
    addEventListener(type: "beforerequestdevice", listener: () => void): void;
    addEventListener(type: "afterrequestdevice", listener: () => void): void;
    addEventListener(type: "flash", listener: () => void): void;
    addEventListener(
        type: "accelerometerdatachanged",
        listener: (data: AccelerometerData) => void,
    ): void;
    addEventListener(
        type: "buttonachanged" | "buttonbchanged",
        listener: (data: ButtonData) => void,
    ): void;
    checkAvailability(): Promise<ConnectionAvailabilityStatus>;
    clearDevice(): void | Promise<void>;
    connect(options?: ConnectOptions): Promise<void>;
    disconnect(): Promise<void>;
    dispose(): void;
    flash(dataSource: FlashDataSource, options: FlashOptions): Promise<void>;
    getBoardVersion(): BoardVersion;
    initialize(): Promise<void>;
    removeEventListener(
        type: "status",
        listener: (data: ConnectionStatusChange) => void,
    ): void;
    removeEventListener(
        type: "backgrounderror",
        listener: (data: BackgroundErrorData) => void,
    ): void;
    removeEventListener(
        type: "beforerequestdevice",
        listener: () => void,
    ): void;
    removeEventListener(type: "afterrequestdevice", listener: () => void): void;
    removeEventListener(type: "flash", listener: () => void): void;
    removeEventListener(
        type: "accelerometerdatachanged",
        listener: (data: AccelerometerData) => void,
    ): void;
    removeEventListener(
        type: "buttonachanged" | "buttonbchanged",
        listener: (data: ButtonData) => void,
    ): void;
    setRemoteDeviceId(deviceId: number): void;
}

Hierarchy (View Summary)

Properties

status type

Methods

addEventListener checkAvailability clearDevice connect disconnect dispose flash? getBoardVersion initialize removeEventListener setRemoteDeviceId

Properties

Experimentalstatus

status: ConnectionStatus

Readonly Experimentaltype

type: "radio-bridge"

Methods

addEventListener

checkAvailability

clearDevice

connect

disconnect

dispose

Optionalflash

  • flash(dataSource: FlashDataSource, options: FlashOptions): Promise<void>
    Experimental

    Flash the micro:bit.

    Not all connection types support flashing. For example, radio bridge connections do not support flashing, and Bluetooth connections only support flashing on native platforms (not Web).

    Post-flash connection state differs by transport:

    • USB: The connection remains in ConnectionStatus.Connected state. USB connects to the micro:bit's interface chip (running DAPLink firmware), which is not affected by flashing the application processor, so the connection persists and serial communication is automatically reinitialised.

    • Bluetooth: The connection is always left in ConnectionStatus.Disconnected state. Bluetooth connects to the application processor directly, which reboots after flashing, so the connection is necessarily lost. Callers must call connect again after flashing.

    Parameters

    Returns Promise<void>

    Throws

    On flash failure. The error.code property indicates the failure type.

    Throws

    If data preparation fails.

getBoardVersion

initialize

removeEventListener

setRemoteDeviceId

Settings

Member Visibility

On This Page

Properties
Methods