Public Instance Constructors
 SerialIO | Overloaded. Initializes a new instance of the SerialIO class. |
Public Instance Properties
 BaudRate | gets the Baud Rate of the serial connection set during initialisation |
| CommandPauseInterval | gets/sets the minimumn amount of time to pause between the sending of asynchronous data using the AsyncSend method. default is zero. |
| CommandTimeout | gets/sets the amount of time (milliseconds) a sychronous command has to complete before a CommandTimeoutException is thrown. default is 10000 milliseconds (10 secs) |
| COMPort | gets the COM port of the active serial connection set during initialisation |
| ConnectionState | gets the serial port connection status |
| Container (inherited from Component) | Gets the IContainer that contains the Component. |
| DefaultEndTokens | gets/sets the default endtokens to match against the response from any synchronous command |
| IsConnected | returns true if the serial port has an active connection, false otherwise |
| Site (inherited from Component) | Gets or sets the ISite of the Component. |
Public Instance Methods
| AsyncSend | Sends data to the serial connection asynchronously and therefore does not wait for any response. To prevent the serial port becoming overwhelmed by asynchronus sending, the CommandPauseInterval property is used to control the minimum pause between asynchronous commands |
| Close | closes the open connection to the serial port |
| CreateObjRef (inherited from MarshalByRefObject) | Creates an object that contains all the relevant information required to generate a proxy used to communicate with a remote object. |
| DisableLogging | disables logging, flushes any remaining data and closes the file |
| Dispose | Overloaded. called when during garbage collection, this closes the serial connection if it is still open and calls the base class's dispose method |
| EnableLogging | Turns logging on for all data send and received |
| Equals (inherited from Object) | Determines whether the specified Object is equal to the current Object. |
| GetHashCode (inherited from Object) | Serves as a hash function for a particular type, suitable for use in hashing algorithms and data structures like a hash table. |
| GetLifetimeService (inherited from MarshalByRefObject) | Retrieves the current lifetime service object that controls the lifetime policy for this instance. |
| GetType (inherited from Object) | Gets the Type of the current instance. |
| InitializeLifetimeService (inherited from MarshalByRefObject) | Obtains a lifetime service object to control the lifetime policy for this instance. |
| IsLogging | returns whether or not logging is enabled |
| Open | Opens a connection to the serial port |
| SendCommand | Overloaded. sends a command synchronously to the serial port and waits for one of the responses contained in endTokens. If no matching response is found before commandTimeout milliseconds elapse a CommandTimeoutException is thrown |
| ToString (inherited from Component) |
Public Instance Events
 Disposed (inherited from Component) | Adds an event handler to listen to the Disposed event on the component. |
| OnClose | fired when the serial connection closes |
| OnCommandResponse | fired whenever a synchronous command completes |
| OnOpen | fired when the serial connection is made |
| OnReceive | fired when any data is received by on the serial port |
Protected Instance Properties
 DesignMode (inherited from Component) | Gets a value that indicates whether the Component is currently in design mode. |
| Events (inherited from Component) | Gets the list of event handlers that are attached to this Component. |
Protected Instance Methods
 Dispose (inherited from Component) | Overloaded. Releases the unmanaged resources used by the Component and optionally releases the managed resources. |
| Finalize (inherited from Component) | Releases unmanaged resources and performs other cleanup operations before the Component is reclaimed by garbage collection. |
| GetService (inherited from Component) | Returns an object that represents a service provided by the Component or by its Container. |
| MemberwiseClone (inherited from Object) | Creates a shallow copy of the current Object. |
See Also
SerialIO Class | Whisperstream.SerialComm.IO Namespace