Class CreateSerialPort

Namespace

Bonsai.IO.Ports

Assembly

Bonsai.System.dll

Represents an operator that creates and configures a connection to a system serial port.

public class CreateSerialPort : Source<SerialPort>, INamedElement

Inheritance

object

Source<SerialPort>

CreateSerialPort

Implements

INamedElement

Inherited Members

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

Properties

BaudRate

Gets or sets the serial baud rate.

[TypeConverter(typeof(BaudRateConverter))]
public int BaudRate { get; set; }

Property Value

int

DataBits

Gets or sets the number of data bits per byte.

public int DataBits { get; set; }

Property Value

int

DiscardNull

Gets or sets a value indicating whether null bytes are ignored when transmitted between the port and the receive buffer.

public bool DiscardNull { get; set; }

Property Value

bool

DtrEnable

Gets or sets a value indicating whether the Data Terminal Ready (DTR) signal should be enabled during serial communication.

public bool DtrEnable { get; set; }

Property Value

bool

Encoding

Gets or sets the byte encoding used for pre- and post-transmission conversion of text.

[TypeConverter(typeof(SerialPortEncodingConverter))]
public string Encoding { get; set; }

Property Value

string

Handshake

Gets or sets the handshaking protocol for serial port transmission of data.

public Handshake Handshake { get; set; }

Property Value

Handshake

Name

Gets or sets the optional alias for the serial port connection.

public string Name { get; set; }

Property Value

string

NewLine

Gets or sets the new line separator used to delimit reads from the serial port.

public string NewLine { get; set; }

Property Value

string

Parity

Gets or sets the parity bit for the SerialPort object.

public Parity Parity { get; set; }

Property Value

Parity

ParityReplace

Gets or sets the byte that replaces invalid bytes in the data stream when a parity error occurs.

public byte ParityReplace { get; set; }

Property Value

byte

PortName

Gets or sets the name of the serial port.

[TypeConverter(typeof(SerialPortNameConverter))]
public string PortName { get; set; }

Property Value

string

ReadBufferSize

Gets or sets the size of the read buffer, in bytes. This is the maximum number of read bytes which can be buffered.

public int ReadBufferSize { get; set; }

Property Value

int

ReceivedBytesThreshold

Gets or sets the number of bytes received into the internal input buffer before the read event is fired.

public int ReceivedBytesThreshold { get; set; }

Property Value

int

RtsEnable

Gets or sets a value indicating whether the Request to Send (RTS) signal should be enabled during serial communication.

public bool RtsEnable { get; set; }

Property Value

bool

StopBits

Gets or sets the number of stop bits per byte.

public StopBits StopBits { get; set; }

Property Value

StopBits

WriteBufferSize

Gets or sets the size of the write buffer, in bytes. This is the maximum number of bytes which can be queued for write.

public int WriteBufferSize { get; set; }

Property Value

int

Methods

Generate()

Generates an observable sequence that contains the serial port connection object.

public override IObservable<SerialPort> Generate()

Returns

IObservable<SerialPort>

A sequence containing a single instance of the SerialPort class representing the serial connection.