constructor

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

• Parameters

  • device: SerialPort

  • tracing: boolean = false

  • enableSlipReader: boolean = true

  Returns Transport

_DTR_state

baudrate

device

leftOver

slipReaderEnabled

tracing

_appendBuffer

• _appendBuffer(buffer1, buffer2): ArrayBufferLike

• Concatenate buffer2 to buffer1 and return the resulting ArrayBuffer.

  Parameters

  • buffer1: ArrayBuffer

    First buffer to concatenate.

  • buffer2: ArrayBuffer

    Second buffer to concatenate.

  Returns ArrayBufferLike

  Result Array buffer.

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.

  • 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>

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.

hexConvert

• hexConvert(uint8Array, autoSplit?): string

• Parameters

  • uint8Array: Uint8Array

  • autoSplit: boolean = true

  Returns string

hexify

• hexify(s): string

• Parameters

  • s: Uint8Array

  Returns string

rawRead

• rawRead(timeout?): Promise<undefined | Uint8Array>

• Read from serial device without slip formatting.

  Parameters

  • timeout: number = 0

    Read timeout in milliseconds (ms)

  Returns Promise<undefined | Uint8Array>

  8 bit unsigned data array read from device.

read

• read(timeout?, minData?): Promise<Uint8Array>

• Read from serial device using the device ReadableStream.

  Parameters

  • timeout: number = 0

    Read timeout number

  • minData: number = 12

    Minimum packet array length

  Returns Promise<Uint8Array>

  8 bit unsigned data array read from device.

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>

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>

sleep

• sleep(ms): Promise<unknown>

• Parameters

  • ms: number

  Returns Promise<unknown>

slipReader

• slipReader(data): Uint8Array

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

  Parameters

  • data: Uint8Array

    Unsigned 8 bit array from the device read stream.

  Returns Uint8Array

  Formatted packet using SLIP escape sequences.

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

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>