constructor

• new Transport(device, tracing?, enableSlipReader?): Transport

• Parameters

  • device: SerialPort
  • tracing: boolean = false
  • enableSlipReader: boolean = true

  Returns Transport

_DTR_state

baudrate

device

slipReaderEnabled

tracing

appendArray

• appendArray(arr1, arr2): Uint8Array

• Append a buffer array after another buffer array

  Parameters

  • arr1: Uint8Array

    First array buffer.
  • arr2: Uint8Array

    magic hex number to select ROM.

  Returns Uint8Array

  Return a 8 bit unsigned array.

changeBaudrate

• changeBaudrate(baud, serialOptions?): Promise<boolean>

• Change the host-side baud rate, preferring an in-place capability when the serial-port implementation provides one.

  Parameters

  • baud: number

    New baud rate.
  • serialOptions: SerialOptions = {}

    Options to preserve when a reopen is required.

  Returns Promise<boolean>

  True when the port had to be closed and reopened.

connect

• connect(baud?, serialOptions?): Promise<void>

• Connect to serial device using the Webserial open method.

  Parameters

  • baud: number = 115200

    Number baud rate for serial connection. Default is 115200.
  • serialOptions: SerialOptions = {}

    Serial Options for WebUSB SerialPort class.

  Returns Promise<void>

disconnect

• disconnect(): Promise<void>

• Disconnect from serial device by running SerialPort.close() after streams unlock.

  Returns Promise<void>

drainInput

• drainInput(quietMs?, maxMs?): Promise<void>

• Actively drain the input buffer: wait for in-flight bytes to arrive (the ROM repeats an unsupported command response 8 times) and discard them. Flushing alone only drops the bytes already buffered.

  Parameters

  • quietMs: number = 100

    Time without new bytes before considering the stream drained
  • maxMs: number = 400

    Upper bound on the total wait

  Returns Promise<void>

flushInput

• flushInput(): void

• Returns void

flushOutput

• flushOutput(): Promise<void>

• Returns Promise<void>

getInfo

• getInfo(): string

• Request the serial device vendor ID and Product ID as string.

  Returns string

  Return the device VendorID and ProductID from SerialPortInfo as formatted string.

getPid

• getPid(): undefined | number

• Request the serial device product id from SerialPortInfo.

  Returns undefined | number

  Return the product ID.

getVid

• getVid(): undefined | number

• Request the serial device vendor id from SerialPortInfo.

  Returns undefined | number

  Return the vendor ID.

hexConvert

• hexConvert(uint8Array, autoSplit?): string

• Parameters

  • uint8Array: Uint8Array
  • autoSplit: boolean = true

  Returns string

hexify

• hexify(s): string

• Parameters

  • s: Uint8Array

  Returns string

inWaiting

• inWaiting(): number

• Returns number

peek

• peek(): Uint8Array

• Returns Uint8Array

rawRead

• rawRead(onData, isClosed): Promise<void>

• Read from serial device without SLIP formatting. Calls onData for each chunk. Stops when isClosed() returns true, the stream ends/errors, or disconnect() is called.

  The reader is stored on the instance so that disconnect() can cancel a pending read: isClosed() is only evaluated after each chunk arrives, so on an idle device a function-local reader would keep the stream locked forever and make disconnect() block in waitForUnlock().

  Parameters

  • onData: ((data) => void)

    Callback for each chunk of data read

    • • (data): void

      • Parameters

        • data: Uint8Array

        Returns void

  • isClosed: (() => boolean)

    Function that returns true when reading should stop (e.g. when console is closed)

    • • (): boolean

      • Returns boolean

  Returns Promise<void>

read

• read(timeout): Promise<Uint8Array>

• Take a data array and return the first well formed packet after replacing the escape sequence. Reads at least 8 bytes.

  Parameters

  • timeout: number

    Timeout read data.

  Returns Promise<Uint8Array>

  Formatted packet using SLIP escape sequences.

readLoop

• readLoop(): Promise<void>

• Read from serial device and append to buffer

  Returns Promise<void>

returnTrace

• returnTrace(): Promise<void>

• Returns Promise<void>

setDTR

• setDTR(state): Promise<void>

• Send the dataTerminalReady (DTS) signal to given state

  True for IO0=LOW, chip in reset and False IO0=HIGH

  Parameters

  • state: boolean

    Boolean state to set the signal

  Returns Promise<void>

setDeviceLostCallback

• setDeviceLostCallback(callback): void

• Set callback for when device is lost

  Parameters

  • callback: null | (() => void)

    Function to call when device is lost

  Returns void

setRTS

• setRTS(state): Promise<void>

• Send the RequestToSend (RTS) signal to given state

  True for EN=LOW, chip in reset and False EN=HIGH, chip out of reset

  Parameters

  • state: boolean

    Boolean state to set the signal

  Returns Promise<void>

setSignals

• setSignals(dtr?, rts?, breakSignal?): Promise<void>

• Set the device signals to given states

  True for IO0=LOW, chip in reset and False IO0=HIGH

  Parameters

  • Optional dtr: boolean

    dataTerminalReady (DTS) signal boolean state
  • Optional rts: boolean

    requestToSend (RTS) signal boolean state
  • Optional breakSignal: boolean

    break signal boolean state

  Returns Promise<void>

slipWriter

• slipWriter(data): Uint8Array

• Format data packet using the Serial Line Internet Protocol (SLIP).

  Parameters

  • data: Uint8Array

    Binary unsigned 8 bit array data to format.

  Returns Uint8Array

  Formatted unsigned 8 bit data array.

trace

• trace(message): void

• Format received or sent data for tracing output.

  Parameters

  • message: string

    Message to format as trace line.

  Returns void

updateDevice

• updateDevice(newDevice): void

• Update the device reference (used when re-selecting device after reset)

  Parameters

  • newDevice: SerialPort

    New SerialPort device

  Returns void

waitForUnlock

• waitForUnlock(timeout): Promise<void>

• Wait for a given timeout ms for serial device unlock.

  Parameters

  • timeout: number

    Timeout time in milliseconds (ms) to sleep

  Returns Promise<void>

write

• write(data): Promise<void>

• Write binary data to device using the WebSerial device writable stream.

  Parameters

  • data: Uint8Array

    8 bit unsigned data array to write to device.

  Returns Promise<void>