Click or drag to resize
Solid Soils Solutions

ISerialConnection Interface

[This is preliminary documentation and is subject to change.]

Defines a serial port connection.

Namespace:  Solid.Arduino
Assembly:  Solid.Arduino (in Solid.Arduino.dll) Version: 1.0.0.0 (1.0.0.0)
Syntax
C#
public interface ISerialConnection : IDisposable

The ISerialConnection type exposes the following members.

Properties
  NameDescription
Public propertyBaudRate
Public propertyBytesToRead
Gets the number of bytes of data in the receive buffer.
Public propertyIsOpen
Gets a value indicating the open or closed status of the ISerialConnection object.
Public propertyNewLine
Gets or sets the value used to interpret the end of strings received and sent using ReadLine and WriteLine(String) methods.
Public propertyPortName
Top
Methods
  NameDescription
Public methodClose
Closes the connection.
Public methodOpen
Opens the connection.
Public methodReadByte
Reads a byte from the underlying serial input data stream.
Public methodWrite(String)
Writes a string to the serial output data stream.
Public methodWrite(Byte, Int32, Int32)
Writes a specified number of bytes to the serial output stream using data from a byte array.
Public methodWriteLine
Writes the specified string and the NewLine value to the serial output stream.
Top
Events
  NameDescription
Public eventDataReceived
Represents the method that will handle the data received event of a ISerialConnection object.
Top
See Also