ESDevice Class

Brainboxes Ethernet to Serial Device

Inheritance Hierarchy

Namespace: Brainboxes.IO
Assembly: Brainboxes.IO (in Brainboxes.IO.dll) Version: 1.0.0.0 (1.0.0.0)

Syntax

public class ESDevice : Device<IConnection, ISerialProtocol>, 
	IESDevice

Public Class ESDevice
	Inherits Device(Of IConnection, ISerialProtocol)
	Implements IESDevice

type ESDevice = 
    class
        inherit Device<IConnection, ISerialProtocol>
        interface IESDevice
    end

The ESDevice type exposes the following members.

Constructors

	Name	Description
	ESDevice(String, Int32, Int32)	Create a generic ES Device uses the DefaultSerialProtocol and has its connection provided by the args
	ESDevice(String, Int32, Int32, Int32, BBSerialPortType)	Create a generic ES Device uses the DefaultSerialProtocol and has its connection provided by the args

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)
	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. (Overrides DeviceConn, ProtoIsAvailable)
	IsConnected	If there is an active connection from this instance to any of the serial ports attached to the ES device (Overrides DeviceConn, ProtoIsConnected)
	Label	User definable label for the Device to help identify when many devices / when debugging (Inherited from DeviceConn, Proto)
	Ports	List of Brainboxes Serial Ports on this Ethernet to Serial Device
	Protocol	Get/Set the Serial Protocol Used when communicating with all Serial ports of device (Overrides DeviceConn, ProtoProtocol)

Methods

	Name	Description
	Connect	Connect the To All the serial ports on the brainboxes device (Overrides DeviceConn, ProtoConnect)
	Create(String, ISerialProtocol)	Connects to the IP Address provided and determines what kind of Brainboxes Ethernet to Serial Device is present, creates the object and sets all serial ports to use the provided protocol
	Create(String, Int32, Int32)	Connects to the IP Address given and determines what kind of Brainboxes Ethernet to Serial Device is there, creates the object and returns it
	Describe	Give a complete summary of the Device (Inherited from DeviceConn, Proto)
	Disconnect	Disconnect from all the serial ports on the Brainboxes Device (Overrides DeviceConn, ProtoDisconnect)
	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)
	ToString	Returns a short description of the Brainboxes Ethernet to Serial Product (Overrides DeviceConn, ProtoToString)

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

Fields

	Name	Description
	IPAddress	The IP address of the Brainboxes Ethernet to Serial Device
	NumberOfPorts	Number of Serial Ports on Brainboxes Ethernet to Serial Device
	PortType	The type of Serial ports on the Brainboxes Ethernet to Serial Port Either RS232 or RS422/485

Inheritance Hierarchy