Click or drag to resize

SerialConnection Class

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 Hierarchy

Namespace:  Brainboxes.IO
Assembly:  Brainboxes.IO (in Brainboxes.IO.dll) Version: 1.5.0.8
Syntax
public class SerialConnection : Connection

The SerialConnection type exposes the following members.

Constructors
  NameDescription
Public methodSerialConnection
Create a Serial connection to a Brainboxes EDDevice First install the virtual com port for the device using Brainboxes Boost.IO Manager
Top
Properties
  NameDescription
Public propertyBaudRate
The serial port baud rate
Public propertyIsAvailable
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.)
Public propertyIsConnected
Whether this connection instance to a Brainboxes Device is active
(Inherited from Connection.)
Public propertyPortName
The name of the serial port
Public propertyStream
The Connections underlying stream class
(Inherited from Connection.)
Public propertyTimeout (Overrides ConnectionTimeout.)
Top
Methods
  NameDescription
Public methodConnect
Connect to the ED Device
(Inherited from Connection.)
Public methodDisconnect
Disconnect from the ED Device
(Inherited from Connection.)
Public methodDispose
Dispose of this Brainboxes device
(Inherited from Connection.)
Public methodEquals
Determines whether the specified object is equal to the current object.
(Inherited from Object.)
Public methodGetHashCode
Serves as the default hash function.
(Inherited from Object.)
Public methodGetType
Gets the Type of the current instance.
(Inherited from Object.)
Public methodToString
ToString
(Overrides ConnectionToString.)
Top
Events
  NameDescription
Public eventConnectionStatusChangedEvent
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.)
Top
See Also