Interface SerialPortOptions

Serial port configuration options

interface SerialPortOptions {
    baudRate: number;
    dataBits?: 5 | 6 | 7 | 8;
    parity?: "none" | "even" | "odd" | "mark" | "space";
    path: string;
    rtscts?: boolean;
    stopBits?: 1 | 2 | 1.5;
    xoff?: boolean;
    xon?: boolean;
}

Properties

baudRate dataBits? parity? path rtscts? stopBits? xoff? xon?

Properties

baudRate

baudRate: number

Baud rate (e.g., 9600, 115200)

OptionaldataBits

dataBits?: 5 | 6 | 7 | 8

Data bits: 5, 6, 7, or 8 (default: 8)

Optionalparity

parity?: "none" | "even" | "odd" | "mark" | "space"

Parity: 'none', 'even', 'odd', 'mark', or 'space' (default: 'none')

path

path: string

Serial port path (e.g., 'COM3' on Windows, '/dev/ttyUSB0' on Linux)

Optionalrtscts

rtscts?: boolean

Enable RTS/CTS hardware flow control (default: false)

OptionalstopBits

stopBits?: 1 | 2 | 1.5

Stop bits: 1, 1.5, or 2 (default: 1)

Optionalxoff

xoff?: boolean

Enable XOFF software flow control (default: false)

Optionalxon

xon?: boolean

Enable XON software flow control (default: false)

Settings

Member Visibility

On This Page

Properties