Interface MicrobitWebBluetoothConnection

interface MicrobitWebBluetoothConnection {
    addEventListener: <
        T extends
            | "accelerometerdatachanged"
            | "buttonachanged"
            | "buttonbchanged"
            | "status"
            | "beforerequestdevice"
            | "afterrequestdevice"
            | "backgrounderror"
            | "magnetometerdatachanged"
            | "uartdata",
    >(
        type: T,
        listener:
            | null
            | TypedEventListenerOrEventListenerObject<
                DeviceConnectionEventMap & ServiceConnectionEventMap,
                T,
            >,
        options?: boolean | AddEventListenerOptions,
    ) => void;
    dispatchEvent: (event: Event) => boolean;
    removeEventListener: <
        T extends
            | "accelerometerdatachanged"
            | "buttonachanged"
            | "buttonbchanged"
            | "status"
            | "beforerequestdevice"
            | "afterrequestdevice"
            | "backgrounderror"
            | "magnetometerdatachanged"
            | "uartdata",
    >(
        type: T,
        callback:
            | null
            | TypedEventListenerOrEventListenerObject<
                DeviceConnectionEventMap & ServiceConnectionEventMap,
                T,
            >,
        options?: boolean | EventListenerOptions,
    ) => void;
    status: ConnectionStatus;
    clearDevice(): void | Promise<void>;
    connect(): Promise<ConnectionStatus>;
    disconnect(): Promise<void>;
    dispatchTypedEvent<
        T extends
            (keyof DeviceConnectionEventMap)
            | (keyof ServiceConnectionEventMap),
    >(
        _type: T,
        event: (DeviceConnectionEventMap & ServiceConnectionEventMap)[T],
    ): boolean;
    dispose(): void;
    eventActivated(type: string): void;
    eventDeactivated(type: string): void;
    getAccelerometerData(): Promise<undefined | AccelerometerData>;
    getAccelerometerPeriod(): Promise<undefined | number>;
    getActiveEvents(): string[];
    getBoardVersion(): undefined | BoardVersion;
    getLedMatrix(): Promise<undefined | LedMatrix>;
    getLedScrollingDelay(): Promise<undefined | number>;
    getMagnetometerBearing(): Promise<undefined | number>;
    getMagnetometerData(): Promise<undefined | MagnetometerData>;
    getMagnetometerPeriod(): Promise<undefined | number>;
    initialize(): Promise<void>;
    serialWrite(data: string): Promise<void>;
    setAccelerometerPeriod(value: number): Promise<void>;
    setLedMatrix(matrix: LedMatrix): Promise<void>;
    setLedScrollingDelay(delayInMillis: number): Promise<void>;
    setLedText(text: string): Promise<void>;
    setMagnetometerPeriod(value: number): Promise<void>;
    setNameFilter(name: string): void;
    triggerMagnetometerCalibration(): Promise<void>;
    uartWrite(data: Uint8Array): Promise<void>;
}

Hierarchy (View Summary)

Properties

addEventListener dispatchEvent removeEventListener status

Methods

clearDevice connect disconnect dispatchTypedEvent dispose eventActivated eventDeactivated getAccelerometerData getAccelerometerPeriod getActiveEvents getBoardVersion getLedMatrix getLedScrollingDelay getMagnetometerBearing getMagnetometerData getMagnetometerPeriod initialize serialWrite setAccelerometerPeriod setLedMatrix setLedScrollingDelay setLedText setMagnetometerPeriod setNameFilter triggerMagnetometerCalibration uartWrite

Properties

addEventListener

addEventListener: <
    T extends
        | "accelerometerdatachanged"
        | "buttonachanged"
        | "buttonbchanged"
        | "status"
        | "beforerequestdevice"
        | "afterrequestdevice"
        | "backgrounderror"
        | "magnetometerdatachanged"
        | "uartdata",
>(
    type: T,
    listener:
        | null
        | TypedEventListenerOrEventListenerObject<
            DeviceConnectionEventMap & ServiceConnectionEventMap,
            T,
        >,
    options?: boolean | AddEventListenerOptions,
) => void

Appends an event listener for events whose type attribute value is type. The callback argument sets the callback that will be invoked when the event is dispatched.

The options argument sets listener-specific options. For compatibility this can be a boolean, in which case the method behaves exactly as if the value was specified as options's capture.

When set to true, options's capture prevents callback from being invoked when the event's eventPhase attribute value is BUBBLING_PHASE. When false (or not present), callback will not be invoked when event's eventPhase attribute value is CAPTURING_PHASE. Either way, callback will be invoked if event's eventPhase attribute value is AT_TARGET.

When set to true, options's passive indicates that the callback will not cancel the event by invoking preventDefault(). This is used to enable performance optimizations described in § 2.8 Observing event listeners.

When set to true, options's once indicates that the callback will only be invoked once after which the event listener will be removed.

The event listener is appended to target's event listener list and is not appended if it has the same type, callback, and capture.

dispatchEvent

dispatchEvent: (event: Event) => boolean

Dispatches a synthetic event event to target and returns true if either event's cancelable attribute value is false or its preventDefault() method was not invoked, and false otherwise.

Deprecated

To ensure type safety use dispatchTypedEvent instead.

removeEventListener

removeEventListener: <
    T extends
        | "accelerometerdatachanged"
        | "buttonachanged"
        | "buttonbchanged"
        | "status"
        | "beforerequestdevice"
        | "afterrequestdevice"
        | "backgrounderror"
        | "magnetometerdatachanged"
        | "uartdata",
>(
    type: T,
    callback:
        | null
        | TypedEventListenerOrEventListenerObject<
            DeviceConnectionEventMap & ServiceConnectionEventMap,
            T,
        >,
    options?: boolean | EventListenerOptions,
) => void

Removes the event listener in target's event listener list with the same type, callback, and options.

status

status: ConnectionStatus

Methods

clearDevice

connect

disconnect

dispatchTypedEvent

dispose

ProtectedeventActivated

ProtectedeventDeactivated

getAccelerometerData

getAccelerometerPeriod

  • getAccelerometerPeriod(): Promise<undefined | number>

  • Gets micro:bit accelerometer period.

    Returns Promise<undefined | number>

    accelerometer period or undefined if there is no connection.

ProtectedgetActiveEvents

getBoardVersion

getLedMatrix

  • getLedMatrix(): Promise<undefined | LedMatrix>

  • Gets micro:bit LED matrix.

    Returns Promise<undefined | LedMatrix>

    a boolean matrix representing the micro:bit LED display.

getLedScrollingDelay

  • getLedScrollingDelay(): Promise<undefined | number>

  • Gets micro:bit LED scrolling delay.

    Returns Promise<undefined | number>

    LED scrolling delay in milliseconds.

getMagnetometerBearing

  • getMagnetometerBearing(): Promise<undefined | number>

  • Gets micro:bit magnetometer bearing.

    Returns Promise<undefined | number>

    magnetometer bearing.

getMagnetometerData

getMagnetometerPeriod

  • getMagnetometerPeriod(): Promise<undefined | number>

  • Gets micro:bit magnetometer period.

    Returns Promise<undefined | number>

    magnetometer period.

initialize

serialWrite

  • serialWrite(data: string): Promise<void>

  • Write serial data to the device.

    Does nothing if there is no connection.

    Parameters

    • data: string

      The data to write.

    Returns Promise<void>

    A promise that resolves when the write is complete.

setAccelerometerPeriod

  • setAccelerometerPeriod(value: number): Promise<void>

  • Sets micro:bit accelerometer period.

    Parameters

    • value: number

      The accelerometer period.

    Returns Promise<void>

setLedMatrix

  • setLedMatrix(matrix: LedMatrix): Promise<void>

  • Sets micro:bit LED matrix.

    Parameters

    • matrix: LedMatrix

      an boolean matrix representing the micro:bit LED display.

    Returns Promise<void>

setLedScrollingDelay

  • setLedScrollingDelay(delayInMillis: number): Promise<void>

  • Sets micro:bit LED scrolling delay.

    Parameters

    • delayInMillis: number

      LED scrolling delay in milliseconds.

    Returns Promise<void>

setLedText

  • setLedText(text: string): Promise<void>

  • Sets micro:bit LED text.

    Parameters

    • text: string

      The text displayed on micro:bit LED.

    Returns Promise<void>

setMagnetometerPeriod

  • setMagnetometerPeriod(value: number): Promise<void>

  • Sets micro:bit magnetometer period.

    Parameters

    • value: number

      magnetometer period.

    Returns Promise<void>

setNameFilter

  • setNameFilter(name: string): void

  • Sets micro:bit name filter for device requesting.

    Parameters

    • name: string

      The name of the micro:bit.

    Returns void

triggerMagnetometerCalibration

  • triggerMagnetometerCalibration(): Promise<void>

  • Triggers micro:bit magnetometer calibration.

    Returns Promise<void>

uartWrite

  • uartWrite(data: Uint8Array): Promise<void>

  • Write UART messages.

    Parameters

    • data: Uint8Array

      UART message.

    Returns Promise<void>

Settings

Member Visibility

On This Page

Properties
Methods