Interface BaudRateConfigurablePort

Optional capability exposed by serial-port implementations which can change baud rate without closing the port. This is not part of the Web Serial API, but can be implemented by WebUSB adapters using device-specific control transfers.

interface BaudRateConfigurablePort {
    onconnect: null | ((this, ev) => any);
    ondisconnect: null | ((this, ev) => any);
    readable: null | ReadableStream<Uint8Array>;
    setBaudRate?: ((baudRate) => Promise<void>);
    writable: null | WritableStream<Uint8Array>;
    addEventListener(type, listener, useCapture?): void;
    addEventListener(type, listener, options?): void;
    close(): Promise<void>;
    dispatchEvent(event): boolean;
    forget(): Promise<void>;
    getInfo(): SerialPortInfo;
    getSignals(): Promise<SerialInputSignals>;
    open(options): Promise<void>;
    removeEventListener(type, callback, useCapture?): void;
    removeEventListener(type, callback, options?): void;
    setSignals(signals): Promise<void>;
}

Hierarchy

  • SerialPort
    • BaudRateConfigurablePort

Properties

onconnect ondisconnect readable setBaudRate? writable

Methods

addEventListener close dispatchEvent forget getInfo getSignals open removeEventListener setSignals

Properties

onconnect

onconnect: null | ((this, ev) => any)

Type declaration

    • (this, ev): any

    • Parameters

      • this: this
      • ev: Event

      Returns any

ondisconnect

ondisconnect: null | ((this, ev) => any)

Type declaration

    • (this, ev): any

    • Parameters

      • this: this
      • ev: Event

      Returns any

Readonly readable

readable: null | ReadableStream<Uint8Array>

Optional setBaudRate

setBaudRate?: ((baudRate) => Promise<void>)

Type declaration

    • (baudRate): Promise<void>

    • Parameters

      • baudRate: number

      Returns Promise<void>

Readonly writable

writable: null | WritableStream<Uint8Array>

Methods

addEventListener

  • addEventListener(type, listener, useCapture?): void

  • Parameters

    • type: "connect" | "disconnect"
    • listener: ((this, ev) => any)
        • (this, ev): any

        • Parameters

          • this: this
          • ev: Event

          Returns any

    • Optional useCapture: boolean

    Returns void

  • addEventListener(type, listener, options?): void

  • Parameters

    • type: string
    • listener: null | EventListenerOrEventListenerObject
    • Optional options: boolean | AddEventListenerOptions

    Returns void

close

  • close(): Promise<void>

  • Returns Promise<void>

dispatchEvent

  • dispatchEvent(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.

    MDN Reference

    Parameters

    • event: Event

    Returns boolean

forget

  • forget(): Promise<void>

  • Returns Promise<void>

getInfo

  • getInfo(): SerialPortInfo

  • Returns SerialPortInfo

getSignals

  • getSignals(): Promise<SerialInputSignals>

  • Returns Promise<SerialInputSignals>

open

  • open(options): Promise<void>

  • Parameters

    • options: SerialOptions

    Returns Promise<void>

removeEventListener

  • removeEventListener(type, callback, useCapture?): void

  • Parameters

    • type: "connect" | "disconnect"
    • callback: ((this, ev) => any)
        • (this, ev): any

        • Parameters

          • this: this
          • ev: Event

          Returns any

    • Optional useCapture: boolean

    Returns void

  • removeEventListener(type, callback, options?): void

  • Parameters

    • type: string
    • callback: null | EventListenerOrEventListenerObject
    • Optional options: boolean | EventListenerOptions

    Returns void

setSignals

  • setSignals(signals): Promise<void>

  • Parameters

    • signals: SerialOutputSignals

    Returns Promise<void>

Settings

Member Visibility

Theme

On This Page

onconnectondisconnectreadablesetBaudRatewritableaddEventListenerclosedispatchEventforgetgetInfogetSignalsopenremoveEventListenersetSignals