Scripting API / core/serial/SerialConnectionApi / External
External
Interfaces
SerialConnectionSettings
Properties
| Property | Type | Description |
|---|---|---|
baudRate |
number |
Baud rate of the device |
bufferSize? |
number |
Size of the read buffer |
dataBits? |
8 | 7 |
Number of data bits per frame (either 7 or 8) |
endOfLineString |
string |
The end of line characters |
flowControl? |
FlowControlType |
Flow control (aka handshake) type |
parity? |
ParityType |
Parity mode of the device |
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. |
productIdFilter? |
number |
Number identifying the device. You must provide the Vendor ID if you provide this. |
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. |
stopBits? |
1 | 2 |
Number of stop bits at the end of each frame (either 1 or 2) |
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. |
vendorIdFilter? |
number |
Number identifying the device's vendor |
Type Aliases
FlowControlType
FlowControlType =
"none"|"hardware"
ParityType
ParityType =
"none"|"even"|"odd"