BBSerialPort Class |
Encapsulates a Brainboxes Serial Port, communicates over TCP rather than using the Com port API, this means no drivers are required to be installed on the computer
Inheritance HierarchyNamespace: Brainboxes.IO
Assembly: Brainboxes.IO (in Brainboxes.IO.dll) Version: 1.5.0.8
SyntaxThe BBSerialPort type exposes the following members.
Properties| Name | Description | |
|---|---|---|
 | Connection |
The connection. If the connection is replaced and the previous connection was connected, the new connection will be connected too
(Inherited from DeviceConn, Proto.) |
| DataAvailable |
Indicates whether data is available, can be 0, for no data, 1 for 1 or more bytes,
or a number representing the precise number of bytes
|
| IsAvailable |
Whether the connection to this 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 DeviceConn, Proto.) |
| IsConnected |
Whether this Brainboxes Device instance has an active connection
(Inherited from DeviceConn, Proto.) |
| Label |
User definable label for the Device to help identify when many devices / when debugging
(Inherited from DeviceConn, Proto.) |
| Protocol |
Marking as virtual allows it to be overridden in the child class
(Inherited from DeviceConn, Proto.) |
Methods| Name | Description | |
|---|---|---|
 | Connect |
Connect the Brainboxes Device
(Inherited from DeviceConn, Proto.) |
| Describe |
Give a complete summary of the Device
(Inherited from DeviceConn, Proto.) |
| Disconnect |
Disconnect the Brainboxes Device
(Inherited from DeviceConn, Proto.) |
| Dispose |
Dispose of this Brainboxes device
(Inherited from DeviceConn, Proto.) |
| 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.) |
| Receive |
Receive data from the serial port
|
| Send |
Transmit data to the serial port
|
| ToString |
Describe this Brainboxes Device
(Inherited from DeviceConn, Proto.) |
Events| Name | Description | |
|---|---|---|
 | DeviceStatusChangedEvent |
Event When the status of the devices connection changes
for example goes from Disconnected to Connected
or from Available to Unavailable
(Inherited from DeviceConn, Proto.) |
Fields| Name | Description | |
|---|---|---|
 | BBSerialPortType |
The type of Serial port either RS232 or RS422/485
|
| PortNumber |
The port number of the device
|
See Also