Class SerialPortTransportOptions
Holds connection settings for SerialPortTransport.
Inheritance
Namespace: Wss.CoreModule
Assembly: WSS.Transport.Serial.dll
Syntax
public sealed class SerialPortTransportOptionsRemarks
Exactly one port selection mode must be used: either set AutoSelectPort to true, or provide a non-empty PortName.
Properties
AutoSelectPort
Gets or sets whether the transport should automatically select the best available serial port. When true, PortName must be left empty.
Declaration
public bool AutoSelectPort { get; set; }Property Value
| Type | Description |
|---|---|
| bool |
Baud
Gets or sets the baud rate. The default is 115200.
Declaration
public int Baud { get; set; }Property Value
| Type | Description |
|---|---|
| int |
DataBits
Gets or sets the number of data bits. The default is 8.
Declaration
public int DataBits { get; set; }Property Value
| Type | Description |
|---|---|
| int |
Parity
Gets or sets the parity mode. The default is System.IO.Ports.Parity.None.
Declaration
public Parity Parity { get; set; }Property Value
| Type | Description |
|---|---|
| Parity |
PortName
Gets or sets the explicit port name.
Use values such as COM5 on Windows or /dev/ttyUSB0 on Linux/macOS.
This must be provided when AutoSelectPort is false.
Declaration
public string PortName { get; set; }Property Value
| Type | Description |
|---|---|
| string |
ReadTimeoutMs
Gets or sets the synchronous serial read timeout, in milliseconds. The default is 10.
Declaration
public int ReadTimeoutMs { get; set; }Property Value
| Type | Description |
|---|---|
| int |
StopBits
Gets or sets the stop-bit configuration. The default is System.IO.Ports.StopBits.One.
Declaration
public StopBits StopBits { get; set; }Property Value
| Type | Description |
|---|---|
| StopBits |