Click or drag to resize
Solid Soils Solutions

IStringProtocol Interface

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

Defines members for sending and receiving ASCII string messages.

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

The IStringProtocol type exposes the following members.

Properties
  NameDescription
Public propertyNewLine
Gets or sets the value used to interpret the end of strings received and sent.
Top
Methods
  NameDescription
Public methodCreateReceivedStringMonitor
Creates an observable object tracking received ASCII String messages.
Public methodRead
Reads a specified number of characters.
Public methodReadAsync
Reads a specified number of characters asynchronous.
Public methodReadLine
Reads a string up to the next NewLine character.
Public methodReadLineAsync
Reads a string asynchronous up to the next NewLine character.
Public methodReadTo
Reads a string up to the first terminating character.
Public methodReadToAsync
Reads a string asynchronous up to the first terminating character.
Public methodWrite
Writes a string to the serial output data stream.
Public methodWriteLine
Writes the specified string and the NewLine value to the serial output stream.
Top
Events
  NameDescription
Public eventStringReceived
Event, raised for every ASCII stringmessage not handled by an IStringProtocol's Read, ReadAsync, ReadLine, ReadLineAsync, ReadTo or ReadToAsync method
Top
See Also