Click or drag to resize

ESDevice Class

Brainboxes Ethernet to Serial Device
Inheritance Hierarchy
SystemObject
  Brainboxes.IODeviceIConnection, ISerialProtocol
    Brainboxes.IOESDevice
      More...

Namespace:  Brainboxes.IO
Assembly:  Brainboxes.IO (in Brainboxes.IO.dll) Version: 1.5.0.8
Syntax
public class ESDevice : Device<IConnection, ISerialProtocol>, 
	IESDevice

The ESDevice type exposes the following members.

Constructors
  NameDescription
Public methodESDevice(String, Int32, Int32)
Create a generic ES Device uses the DefaultSerialProtocol and has its connection provided by the args
Public methodESDevice(String, Int32, Int32, Int32, BBSerialPortType)
Create a generic ES Device uses the DefaultSerialProtocol and has its connection provided by the args
Top
Properties
  NameDescription
Public propertyConnection
The connection. If the connection is replaced and the previous connection was connected, the new connection will be connected too
(Inherited from DeviceConn, Proto.)
Public propertyIsAvailable
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.)
Public propertyIsConnected
If there is an active connection from this instance to any of the serial ports attached to the ES device
(Overrides DeviceConn, ProtoIsConnected.)
Public propertyLabel
User definable label for the Device to help identify when many devices / when debugging
(Inherited from DeviceConn, Proto.)
Public propertyPorts
List of Brainboxes Serial Ports on this Ethernet to Serial Device
Public propertyProtocol
Get/Set the Serial Protocol Used when communicating with all Serial ports of device
(Overrides DeviceConn, ProtoProtocol.)
Top
Methods
  NameDescription
Public methodConnect
Connect the To All the serial ports on the brainboxes device
(Overrides DeviceConn, ProtoConnect.)
Public methodStatic memberCreate(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
Public methodStatic memberCreate(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
Public methodDescribe
Give a complete summary of the Device
(Inherited from DeviceConn, Proto.)
Public methodDisconnect
Disconnect from all the serial ports on the Brainboxes Device
(Overrides DeviceConn, ProtoDisconnect.)
Public methodDispose
Dispose of this Brainboxes device
(Inherited from DeviceConn, Proto.)
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
Returns a short description of the Brainboxes Ethernet to Serial Product
(Overrides DeviceConn, ProtoToString.)
Top
Events
  NameDescription
Public eventDeviceStatusChangedEvent
Event When the status of the devices connection changes for example goes from Disconnected to Connected or from Available to Unavailable
Top
Fields
  NameDescription
Public fieldIPAddress
The IP address of the Brainboxes Ethernet to Serial Device
Public fieldNumberOfPorts
Number of Serial Ports on Brainboxes Ethernet to Serial Device
Public fieldPortType
The type of Serial ports on the Brainboxes Ethernet to Serial Port Either RS232 or RS422/485
Top
See Also
Inheritance Hierarchy
SystemObject
  Brainboxes.IODeviceIConnection, ISerialProtocol
    Brainboxes.IOESDevice
      Brainboxes.IOES246
      Brainboxes.IOES257
      Brainboxes.IOES279
      Brainboxes.IOES313
      Brainboxes.IOES320
      Brainboxes.IOES346
      Brainboxes.IOES357
      Brainboxes.IOES413
      Brainboxes.IOES420
      Brainboxes.IOES446
      Brainboxes.IOES457
      Brainboxes.IOES511
      Brainboxes.IOES522
      Brainboxes.IOES551
      Brainboxes.IOES571
      Brainboxes.IOES701
      Brainboxes.IOES842