Class WebUSBSerialPort

constructor

• new WebUSBSerialPort(usbDevice): WebUSBSerialPort

• Wrap an already-selected USBDevice.

  Parameters

  • usbDevice: USBDevice

    CH340/CH341 USB device.

  Returns WebUSBSerialPort

readable

writable

asSerialPort

• asSerialPort(): BaudRateConfigurablePort

• Use with Transport, which is typed against the Web Serial SerialPort.

  Returns BaudRateConfigurablePort

  This adapter as a SerialPort-like object.

close

• close(): Promise<void>

• Release the USB interface and close the device.

  Returns Promise<void>

getInfo

• getInfo(): SerialPortInfo

• USB vendor and product identifiers.

  Returns SerialPortInfo

  Vendor and product IDs.

open

• open(options?): Promise<void>

• Open the device, claim the vendor bulk interface, and initialize CH340 UART.

  Parameters

  • options: SerialOptions = {}

    Serial options. Only baudRate is applied on CH340.

  Returns Promise<void>

setBaudRate

• setBaudRate(baudRate): Promise<void>

• Change baud rate in place using CH340 vendor request 0x9A.

  Parameters

  • baudRate: number

    New baud rate.

  Returns Promise<void>

setSignals

• setSignals(signals): Promise<void>

• Set DTR/RTS via CH340 handshake request 0xA4.

  Parameters

  • signals: {
        dataTerminalReady?: boolean;
        requestToSend?: boolean;
    }

    Control-line values.

    • Optional dataTerminalReady?: boolean

      DTR line.

    • Optional requestToSend?: boolean

      RTS line.

  Returns Promise<void>

Static requestPort

• requestPort(): Promise<WebUSBSerialPort>

• Prompt for a WCH USB-serial device (VID 0x1a86). CH343 (PID 0x55d3) is rejected.

  Returns Promise<WebUSBSerialPort>

  Adapter for the selected device.