Interface SerialConnectionSettings

interface SerialConnectionSettings {
    baudRate: number;
    bufferSize?: number;
    dataBits?: number;
    endOfLineString: string;
    flowControl?: FlowControlType;
    parity?: ParityType;
    parseValue?: boolean;
    productIdFilter?: number;
    splitReadingOn?: string;
    stopBits?: number;
    valueIndex?: number;
    vendorIdFilter?: number;
}

Properties

baudRate bufferSize? dataBits? endOfLineString flowControl? parity? parseValue? productIdFilter? splitReadingOn? stopBits? valueIndex? vendorIdFilter?

Properties

baudRate

baudRate: number

Baud rate of the device

OptionalbufferSize

bufferSize?: number

Size of the read buffer

OptionaldataBits

dataBits?: number

Number of data bits per frame (either 7 or 8)

endOfLineString

endOfLineString: string

The end of line characters

OptionalflowControl

flowControl?: FlowControlType

Flow control (aka handshake) type

Optionalparity

parity?: ParityType

Parity mode of the device

OptionalparseValue

parseValue?: boolean

Whether or not the value should be parsed by splitting the reading into columns and getting the value from one of the columns.

OptionalproductIdFilter

productIdFilter?: number

Number identifying the device. You must provide the Vendor ID if you provide this.

OptionalsplitReadingOn

splitReadingOn?: string

If parseValue is set to true, the reading will be split into columns with this string. Must be set if parseValue is set to true.

OptionalstopBits

stopBits?: number

Number of stop bits at the end of each frame (either 1 or 2)

OptionalvalueIndex

valueIndex?: number

If parseValue is set to true, this is the index of the column for the value. Must be set if parseValue is set to true.

OptionalvendorIdFilter

vendorIdFilter?: number

Number identifying the device's vendor

Settings

Member Visibility

On This Page

Properties