Serial |
A Connection to a Brainboxes Devices using a serial port
Note this is different to a Brainboxes device WITH a serial connection (e.g. an Ethernet to Serial Device)
Inheritance HierarchyNamespace: Brainboxes.IO
Assembly: Brainboxes.IO (in Brainboxes.IO.dll) Version: 1.0.0.0 (1.0.0.0)
SyntaxThe SerialConnection type exposes the following members.
Constructors| Name | Description | |
|---|---|---|
 | SerialConnection | Create a Serial connection to a Brainboxes EDDevice First install the virtual com port for the device using Brainboxes Boost.IO Manager |
Properties| Name | Description | |
|---|---|---|
 | BaudRate | The serial port baud rate |
| IsAvailable |
Whether this connection to a Brainboxes Device is available, e.g. online or offline​.
In case of network TCP connection: this is if the device is pingable on the network.
In case of serial connection: this is if the device COM port is listed on the system and not open by another process.
(Inherited from Connection) |
| IsConnected |
Whether this connection instance to a Brainboxes Device is active
(Inherited from Connection) |
| PortName | The name of the serial port |
| Stream |
The Connections underlying stream class
(Inherited from Connection) |
| Timeout | (Overrides Connection.Timeout) |
Methods| Name | Description | |
|---|---|---|
| Connect |
Connect to the ED Device
(Inherited from Connection) |
| Disconnect |
Disconnect from the ED Device
(Inherited from Connection) |
| Dispose |
Dispose of this Brainboxes device
(Inherited from Connection) |
| Equals | Determines whether the specified object is equal to the current object. (Inherited from Object) |
| GetHashCode | Serves as the default hash function. (Inherited from Object) |
| GetType | Gets the Type of the current instance. (Inherited from Object) |
| ToString |
ToString
(Overrides Connection.ToString()) |
Events| Name | Description | |
|---|---|---|
 | ConnectionStatusChangedEvent |
When the status of the connection changes this event is raised
e.g. when IsConnected changes from false to true
or when IsAvailable changes:
* for example for a TCPConnection if the IP address is goes from on-line to off-line
* or for example for a SerialConnection when the COM name is no longer present or in use by another program
(Inherited from Connection) |
See Also