FtdDeviceInfo Class for USB Device Info

NModbus FtdAdapter Namespace
Namespaces ► FtdAdapter C#
.NET wrapper for Future Device Technologies USB driver. This assembly
contains unsafe code and must be run with full trust.
Declaration Syntax
C# Visual Basic Visual C++
namespace FtdAdapter
Namespace FtdAdapter
namespace FtdAdapter
Types
All Types Classes Structures Enumerations
Icon Type Description
FtdDeviceInfo Provides information about an attached
FTDI USB device.
FtdFlowControl Specifies the flow control used on the

UsbPort object.
FtdParity Specifies the parity used on the UsbPort

object.
FtdStopBits Specifies the number of stop bits used on

the UsbPort object.
FtdUsbPort Wrapper class for the FTD2XX USB

resource.
NModbus FtdDeviceInfo Structure
Namespaces ► FtdAdapter ► FtdDeviceInfo C#
Provides information about an attached FTDI USB device.
Declaration Syntax
public struct FtdDeviceInfo
Public Structure FtdDeviceInfo
public value class FtdDeviceInfo
Members
All Members Methods Properties
Public Instance Declared
Protected Static Inherited
Icon Member Description
Description Description of device.
Equality(FtdDeviceInfo, Implements the operator ==.

FtdDeviceInfo)
Equals(Object) Indicates whether this instance and a

specified object are equal.
(Overrides ValueType.Equals(Object).)
Finalize() Allows an Object to attempt to free
resources and perform other cleanup
operations before the Object is reclaimed
by garbage collection.
(Inherited from Object.)

Flags Device flags.
GetHashCode() Returns the hash code for this instance.
(Overrides ValueType.GetHashCode().)
GetType() Gets the Type of the current instance.

Id Complete device ID, comprising Vendor
ID and Product ID.
Inequality(FtdDeviceInfo, Implements the operator !=.

FtdDeviceInfo)
IsOpen Gets a value indicating if the device is

already open.
LocationId LocID
MemberwiseClone() Creates a shallow copy of the current

Object.

ProductId Product ID
SerialNumber Serial number of device.
ToString() Returns the fully qualified type name of

this instance.
(Inherited from ValueType.)

Type Device type.
VendorId Vendor ID.

Assembly: FtdAdapter (Module: FtdAdapter) Version: 1.11.0.0 (1.11.0.0)
NModbus Description Property
Namespaces ► FtdAdapter ► FtdDeviceInfo ► Description C#
Description of device.
Declaration Syntax
public string Description { get; }
Public ReadOnly Property Description As String
public:
property String^ Description {
String^ get ();
}

NModbus Equality Operator
Namespaces ► FtdAdapter ► FtdDeviceInfo ► Equality(FtdDeviceInfo,
FtdDeviceInfo)
C#
Implements the operator ==.
Declaration Syntax
public static bool operator ==(
FtdDeviceInfo left,
FtdDeviceInfo right
)
Public Shared Operator = ( _

left As FtdDeviceInfo, _
right As FtdDeviceInfo _
) As Boolean
public:
static bool operator ==(
FtdDeviceInfo left,
FtdDeviceInfo right
)
Parameters
left (FtdDeviceInfo)
The left.
right (FtdDeviceInfo)
The right.
Return Value
The result of the operator.

NModbus Equals Method (obj)
Namespaces ► FtdAdapter ► FtdDeviceInfo ► Equals(Object) C#
Indicates whether this instance and a specified object are equal.
Declaration Syntax
public override bool Equals(
Object obj
)
Public Overrides Function Equals ( _

obj As Object _
) As Boolean
public:
virtual bool Equals(
Object^ obj
) override
Parameters
obj (Object)
Another object to compare to.
Return Value
true if obj and this instance are the same type and represent the same value;
otherwise, false.

NModbus Flags Property
Namespaces ► FtdAdapter ► FtdDeviceInfo ► Flags C#
Device flags.
Declaration Syntax
public uint Flags { get; }
Public ReadOnly Property Flags As UInteger
public:
property unsigned int Flags {
unsigned int get ();
}

NModbus GetHashCode Method
Namespaces ► FtdAdapter ► FtdDeviceInfo ► GetHashCode() C#
Returns the hash code for this instance.
Declaration Syntax
public override int GetHashCode()
Public Overrides Function GetHashCode As Integer
public:
virtual int GetHashCode() override
Return Value
A 32-bit signed integer that is the hash code for this instance.

NModbus Id Property
Namespaces ► FtdAdapter ► FtdDeviceInfo ► Id C#
Complete device ID, comprising Vendor ID and Product ID.
Declaration Syntax
public uint Id { get; }
Public ReadOnly Property Id As UInteger
public:
property unsigned int Id {
}

NModbus Inequality Operator
Namespaces ► FtdAdapter ► FtdDeviceInfo ► Inequality(FtdDeviceInfo,
FtdDeviceInfo)
C#
Implements the operator !=.
Declaration Syntax
public static bool operator !=(
FtdDeviceInfo left,
FtdDeviceInfo right
)
Public Shared Operator <> ( _

left As FtdDeviceInfo, _
right As FtdDeviceInfo _
) As Boolean
public:
static bool operator !=(
FtdDeviceInfo left,
FtdDeviceInfo right
)
Parameters
left (FtdDeviceInfo)
The left.
right (FtdDeviceInfo)
The right.
Return Value
The result of the operator.

NModbus IsOpen Property
Namespaces ► FtdAdapter ► FtdDeviceInfo ► IsOpen C#
Gets a value indicating if the device is already open.
Declaration Syntax
public bool IsOpen { get; }
Public ReadOnly Property IsOpen As Boolean
public:
property bool IsOpen {
bool get ();
}

NModbus LocationId Property
Namespaces ► FtdAdapter ► FtdDeviceInfo ► LocationId C#
LocID
Declaration Syntax
public uint LocationId { get; }
Public ReadOnly Property LocationId As UInteger
public:
property unsigned int LocationId {
}

NModbus ProductId Property
Namespaces ► FtdAdapter ► FtdDeviceInfo ► ProductId C#
Product ID
Declaration Syntax
public uint ProductId { get; }
Public ReadOnly Property ProductId As UInteger
public:
property unsigned int ProductId {
}

NModbus SerialNumber Property
Namespaces ► FtdAdapter ► FtdDeviceInfo ► SerialNumber C#
Serial number of device.
Declaration Syntax
public string SerialNumber { get; }
Public ReadOnly Property SerialNumber As String
public:
property String^ SerialNumber {
String^ get ();
}

NModbus Type Property
Namespaces ► FtdAdapter ► FtdDeviceInfo ► Type C#
Device type.
Declaration Syntax
public uint Type { get; }
Public ReadOnly Property Type As UInteger
public:
property unsigned int Type {
}

NModbus VendorId Property
Namespaces ► FtdAdapter ► FtdDeviceInfo ► VendorId C#
Vendor ID.
Declaration Syntax
public uint VendorId { get; }
Public ReadOnly Property VendorId As UInteger
public:
property unsigned int VendorId {
}

NModbus FtdFlowControl Enumeration
Namespaces ► FtdAdapter ► FtdFlowControl C#
Specifies the flow control used on the UsbPort object.
Declaration Syntax
public enum FtdFlowControl
Public Enumeration FtdFlowControl
public enum class FtdFlowControl
Members
Member Description
None No flow control is used
RtsCts RTS CTS are used for flow control
DtrDsr DTR DSR are used for flow control
XonXoff XON XOFF are used for flow control

NModbus FtdParity Enumeration
Namespaces ► FtdAdapter ► FtdParity C#
Specifies the parity used on the UsbPort object.
Declaration Syntax
public enum FtdParity
Public Enumeration FtdParity
public enum class FtdParity
Members
Member Description
None No parity check occurs.
Odd Sets the parity bit so that the count of bits set
is an odd number.
Even Sets the parity bit so that the count of bits set
is an even number.
Mark Leaves the parity bit set to 1.
Space Leaves the parity bit set to 0.

NModbus FtdStopBits Enumeration
Namespaces ► FtdAdapter ► FtdStopBits C#
Specifies the number of stop bits used on the UsbPort object.
Declaration Syntax
public enum FtdStopBits
Public Enumeration FtdStopBits
public enum class FtdStopBits
Members
Member Description
One One stop bit is used.
OnePointFive 1.5 stop bits are used.
Two Two stop bits are used.

NModbus FtdUsbPort Class
Namespaces ► FtdAdapter ► FtdUsbPort C#
Wrapper class for the FTD2XX USB resource.
Declaration Syntax
public class FtdUsbPort : IStreamResource, IDisposable
Public Class FtdUsbPort _

Implements IStreamResource, IDisposable
public ref class FtdUsbPort : IStreamResource,

IDisposable
Members
All Members Constructors Methods Properties

Protected Static
Inherited
FtdUsbPort() Initializes a new instance of the
FtdUsbPort class.
BaudRate Gets or sets the serial baud rate.
Close() Closes the port connection.
DataBits Gets or sets the standard length of

data bits per byte.
DiscardInBuffer() Purges the receive buffer.

Dispose() Performs application-defined tasks
associated with freeing, releasing, or
resetting unmanaged resources.
Dispose(Boolean) Releases unmanaged and - optionally -

managed resources
Equals(Object) Determines whether the specified

Object is equal to the current Object.

operations before the Object is
reclaimed by garbage collection.

GetDeviceCount() Returns the number of D2XX devices
connected to the system.
GetDeviceInfo(UInt32) Gets the device info at the specified

device index.
GetDeviceInfos() Gets an array of the currently

connected device's device info.
GetHashCode() Serves as a hash function for a

particular type.


InfiniteTimeout Indicates that no time-out should
occur.
IsOpen Gets a value indicating the open or

closed status of the UsbPort object.

Object.

OpenByDescription(String) Opens the device by description.
OpenByIndex(UInt32) Opens the device by index.
OpenByLocationId(UInt32) Opens the device by location id.
OpenBySerialNumber(String) Opens the device by serial number.
Parity Gets or sets the parity-checking

protocol.
Read(Byte[], Int32, Int32) Reads a number of bytes from the

UsbPort input buffer and writes those
bytes into a byte array at the specified
offset.
ReadTimeout Gets or sets the number of

milliseconds before a time-out occurs
when a read operation does not finish.
SetFlowControl(FtdFlowControl, Set flow control.
Byte, Byte)
StopBits Gets or sets the standard number of

stopbits per byte.
ToString() Returns a String that represents the

current Object.

Write(Byte[], Int32, Int32) Writes a specified number of bytes to
the port from an output buffer, starting
at the specified offset.
WriteTimeout Gets or sets the number of

milliseconds before a time-out occurs
when a write operation does not finish.
Inheritance Hierarchy
Object
FtdUsbPort

NModbus FtdUsbPort Constructor
Namespaces ► FtdAdapter ► FtdUsbPort ► FtdUsbPort() C#
Initializes a new instance of the FtdUsbPort class.
Declaration Syntax
public FtdUsbPort()
Public Sub New
public:
FtdUsbPort()

NModbus BaudRate Property
Namespaces ► FtdAdapter ► FtdUsbPort ► BaudRate C#
Gets or sets the serial baud rate.
Declaration Syntax
public int BaudRate { get; set; }
Public Property BaudRate As Integer
public:
property int BaudRate {
int get ();
void set (int value);
}

NModbus Close Method
Namespaces ► FtdAdapter ► FtdUsbPort ► Close() C#
Closes the port connection.
Declaration Syntax
public void Close()
Public Sub Close
public:
void Close()

NModbus DataBits Property
Namespaces ► FtdAdapter ► FtdUsbPort ► DataBits C#
Gets or sets the standard length of data bits per byte.
Declaration Syntax
public int DataBits { get; set; }
Public Property DataBits As Integer
public:
property int DataBits {
int get ();
}

NModbus DiscardInBuffer Method
Namespaces ► FtdAdapter ► FtdUsbPort ► DiscardInBuffer() C#
Purges the receive buffer.
Declaration Syntax
public void DiscardInBuffer()
Public Sub DiscardInBuffer
public:
virtual void DiscardInBuffer() sealed

NModbus Dispose Method
Namespaces ► FtdAdapter ► FtdUsbPort ► Dispose() C#
Members

managed resources

Namespaces ► FtdAdapter ► FtdUsbPort ► Dispose() C#
Performs application-defined tasks associated with freeing, releasing, or

Declaration Syntax
public void Dispose()
Public Sub Dispose
public:
virtual void Dispose() sealed

NModbus Dispose Method (disposing)
Namespaces ► FtdAdapter ► FtdUsbPort ► Dispose(Boolean) C#
Releases unmanaged and - optionally - managed resources
Declaration Syntax
protected virtual void Dispose(
bool disposing
)
Protected Overridable Sub Dispose ( _

disposing As Boolean _
)
protected:
virtual void Dispose(
bool disposing
)
Parameters
disposing (Boolean)
true to release both managed and unmanaged resources; false to
release only unmanaged resources.

NModbus GetDeviceCount Method
Namespaces ► FtdAdapter ► FtdUsbPort ► GetDeviceCount() C#
Returns the number of D2XX devices connected to the system.
Declaration Syntax
public static int GetDeviceCount()
Public Shared Function GetDeviceCount As Integer
public:
static int GetDeviceCount()

NModbus GetDeviceInfo Method (index)
Namespaces ► FtdAdapter ► FtdUsbPort ► GetDeviceInfo(UInt32)
C#
Gets the device info at the specified device index.
Declaration Syntax
public static FtdDeviceInfo GetDeviceInfo(
uint index
)
Public Shared Function GetDeviceInfo ( _

index As UInteger _
) As FtdDeviceInfo
public:
static FtdDeviceInfo GetDeviceInfo(
unsigned int index
)
Parameters
index (UInt32)
Index of the device.
Return Value
An FtdDeviceInfo instance.

NModbus GetDeviceInfos Method
Namespaces ► FtdAdapter ► FtdUsbPort ► GetDeviceInfos() C#
Gets an array of the currently connected device's device info.
Declaration Syntax
public static FtdDeviceInfo[] GetDeviceInfos()
Public Shared Function GetDeviceInfos As FtdDeviceInfo()
public:
static array<FtdDeviceInfo>^ GetDeviceInfos()
Return Value
An array of FtdDeviceInfo objects.
Exceptions
Exception Condition
IOException

NModbus InfiniteTimeout Property
Namespaces ► FtdAdapter ► FtdUsbPort ► InfiniteTimeout C#
Indicates that no time-out should occur.
Declaration Syntax
public int InfiniteTimeout { get; }
Public ReadOnly Property InfiniteTimeout As Integer
public:
virtual property int InfiniteTimeout {
int get () sealed;
}

NModbus IsOpen Property
Namespaces ► FtdAdapter ► FtdUsbPort ► IsOpen C#
Gets a value indicating the open or closed status of the UsbPort object.
Declaration Syntax
public bool IsOpen { get; }
Public ReadOnly Property IsOpen As Boolean
public:
property bool IsOpen {
bool get ();
}

NModbus OpenByDescription Method (description)
Namespaces ► FtdAdapter ► FtdUsbPort ► OpenByDescription(String)
C#
Opens the device by description.
Declaration Syntax
public void OpenByDescription(
string description
)
Public Sub OpenByDescription ( _

description As String _
)
public:
void OpenByDescription(
String^ description
)
Parameters
description (String)
The description.

NModbus OpenByIndex Method (index)
Namespaces ► FtdAdapter ► FtdUsbPort ► OpenByIndex(UInt32)
C#
Opens the device by index.
Declaration Syntax
public void OpenByIndex(
uint index
)
Public Sub OpenByIndex ( _

index As UInteger _
)
public:
void OpenByIndex(
unsigned int index
)
Parameters
index (UInt32)
Must be 0 if only one device is attached. For multiple devices 1, 2 etc.

NModbus OpenByLocationId Method (locationId)
Namespaces ► FtdAdapter ► FtdUsbPort ► OpenByLocationId(UInt32)
C#
Opens the device by location id.
Declaration Syntax
public void OpenByLocationId(
uint locationId
)
Public Sub OpenByLocationId ( _

locationId As UInteger _
)
public:
void OpenByLocationId(
unsigned int locationId
)
Parameters
locationId (UInt32)
The location id.

NModbus OpenBySerialNumber Method (serialNumber)
Namespaces ► FtdAdapter ► FtdUsbPort ► OpenBySerialNumber(String)
C#
Opens the device by serial number.
Declaration Syntax
public void OpenBySerialNumber(
string serialNumber
)
Public Sub OpenBySerialNumber ( _

serialNumber As String _
)
public:
void OpenBySerialNumber(
String^ serialNumber
)
Parameters
serialNumber (String)
The serial number.

NModbus Parity Property
Namespaces ► FtdAdapter ► FtdUsbPort ► Parity C#
Gets or sets the parity-checking protocol.
Declaration Syntax
public FtdParity Parity { get; set; }
Public Property Parity As FtdParity
public:
property FtdParity Parity {
FtdParity get ();
void set (FtdParity value);
}

NModbus Read Method (buffer, offset, count)
Namespaces ► FtdAdapter ► FtdUsbPort ► Read(Byte[], Int32, Int32)
C#
Reads a number of bytes from the UsbPort input buffer and writes those bytes
into a byte array at the specified offset.
Declaration Syntax
public int Read(
byte[] buffer,
int offset,
int count
)
Public Function Read ( _

buffer As Byte(), _
offset As Integer, _
count As Integer _
) As Integer
public:
virtual int Read(
array<unsigned char>^ buffer,
int offset,
int count
) sealed
Parameters
buffer ( Byte [])
The byte array to write the input to.
offset (Int32)
The offset in the buffer array to begin writing.
count (Int32)
The number of bytes to read.
Return Value
The number of bytes read.

NModbus ReadTimeout Property
Namespaces ► FtdAdapter ► FtdUsbPort ► ReadTimeout C#
Gets or sets the number of milliseconds before a time-out occurs when a read
operation does not finish.
Declaration Syntax
public int ReadTimeout { get; set; }
Public Property ReadTimeout As Integer
public:
virtual property int ReadTimeout {
int get () sealed;
void set (int value) sealed;
}

SetFlowControl Method (flowControl, xOn,
NModbus
xOff)
Namespaces ► FtdAdapter ► FtdUsbPort ►
SetFlowControl(FtdFlowControl, Byte, Byte)
C#
Set flow control.
Declaration Syntax
public void SetFlowControl(
FtdFlowControl flowControl,
byte xOn,
byte xOff
)
Public Sub SetFlowControl ( _

flowControl As FtdFlowControl, _
xOn As Byte, _
xOff As Byte _
)
public:
void SetFlowControl(
FtdFlowControl flowControl,
unsigned char xOn,
unsigned char xOff
)
Parameters
flowControl (FtdFlowControl)
Type of flow control
xOn (Byte)
XON symbol
xOff (Byte)
XOFF symbol

NModbus StopBits Property
Namespaces ► FtdAdapter ► FtdUsbPort ► StopBits C#
Gets or sets the standard number of stopbits per byte.
Declaration Syntax
public FtdStopBits StopBits { get; set; }
Public Property StopBits As FtdStopBits
public:
property FtdStopBits StopBits {
FtdStopBits get ();
void set (FtdStopBits value);
}

NModbus Write Method (buffer, offset, count)
Namespaces ► FtdAdapter ► FtdUsbPort ► Write(Byte[], Int32, Int32)
C#
Writes a specified number of bytes to the port from an output buffer, starting
Declaration Syntax
public void Write(
byte[] buffer,
int offset,
int count
)
Public Sub Write ( _

buffer As Byte(), _
count As Integer _
)
public:
virtual void Write(
int offset,
int count
) sealed
Parameters
buffer ( Byte [])
The byte array that contains the data to write to the port.
offset (Int32)
count (Int32)
The number of bytes to write.

NModbus WriteTimeout Property
Namespaces ► FtdAdapter ► FtdUsbPort ► WriteTimeout C#
Gets or sets the number of milliseconds before a time-out occurs when a write
Declaration Syntax
public int WriteTimeout { get; set; }
Public Property WriteTimeout As Integer
public:
virtual property int WriteTimeout {
int get () sealed;
void set (int value) sealed;
}

NModbus Modbus Namespace
Namespaces ► Modbus C#
Modbus.
Declaration Syntax
namespace Modbus
Namespace Modbus
namespace Modbus
Types
All Types Classes
SlaveException Represents slave errors that occur during
communication.
NModbus SlaveException Class
Namespaces ► Modbus ► SlaveException C#
Represents slave errors that occur during communication.
Declaration Syntax
[SerializableAttribute]
public class SlaveException : Exception
<SerializableAttribute> _
Public Class SlaveException _
Inherits Exception
[SerializableAttribute]
public ref class SlaveException : public Exception
Members

Protected Static
Inherited
SlaveException() Initializes a new instance of the
SlaveException class.
SlaveException(String) Initializes a new instance of the

SlaveException(String, Initializes a new instance of the

Exception) SlaveException class.
SlaveException(SerializationInfo, Initializes a new instance of the

StreamingContext) SlaveException class.
Data Gets a collection of key/value pairs th
provide additional user-defined
information about the exception.
(Inherited from Exception.)

Equals(Object) Determines whether the specified Obj
equal to the current Object.

operations before the Object is reclaim

FunctionCode Gets the response function code that
caused the exception to occur, or 0.
GetBaseException() When overridden in a derived class,

returns the Exception that is the root
cause of one or more subsequent
exceptions.

GetHashCode() Serves as a hash function for a partic
type.

GetObjectData(SerializationInfo, When overridden in a derived class, s
StreamingContext) the SerializationInfo with information
about the exception.
(Overrides
Exception.GetObjectData(Serializatio
StreamingContext).)
GetType() Gets the runtime type of the current
instance.
HelpLink Gets or sets a link to the help file

associated with this exception.

HResult Gets or sets HRESULT, a coded numer
value that is assigned to a specific
exception.

InnerException Gets the Exception instance that caus
the current exception.

Object.

Message Gets a message that describes the cu
exception.
(Overrides Exception.Message.)
SlaveAddress Gets the slave address, or 0.
SlaveExceptionCode Gets the slave exception code, or 0.
Source Gets or sets the name of the applicati

the object that causes the error.

StackTrace Gets a string representation of the fra
on the call stack at the time the curre
exception was thrown.

TargetSite Gets the method that throws the curr
exception.

ToString() Creates and returns a string
representation of the current exceptio
Object
Exception
SlaveException
Assembly: Modbus (Module: Modbus) Version: 1.11.0.0 (1.11.0.0)

NModbus SlaveException Constructor
Namespaces ► Modbus ► SlaveException ► SlaveException() C#
Members
SlaveException() Initializes a new instance of the
SlaveException(String) Initializes a new instance of the

SlaveException(String, Initializes a new instance of the

Exception) SlaveException class.
SlaveException(SerializationInfo, Initializes a new instance of the

StreamingContext) SlaveException class.

NModbus SlaveException Constructor
Namespaces ► Modbus ► SlaveException ► SlaveException() C#
Initializes a new instance of the SlaveException class.
Declaration Syntax
public SlaveException()
Public Sub New
public:
SlaveException()

NModbus SlaveException Constructor (info, context)
Namespaces ► Modbus ► SlaveException ►
SlaveException(SerializationInfo, StreamingContext)
C#
Declaration Syntax
protected SlaveException(
SerializationInfo info,
StreamingContext context
)
Protected Sub New ( _

info As SerializationInfo, _
context As StreamingContext _
)
protected:
SlaveException(
SerializationInfo^ info,
)
Parameters
info (SerializationInfo)
The SerializationInfo that holds the serialized object data about the
exception being thrown.
context (StreamingContext)
The StreamingContext that contains contextual information about the
source or destination.
Exceptions
Exception Condition
SerializationException The class name is null or HResult is zero (0).
ArgumentNullException The info parameter is null.

NModbus SlaveException Constructor (message)
Namespaces ► Modbus ► SlaveException ► SlaveException(String)
C#
Declaration Syntax
public SlaveException(
string message
)
Public Sub New ( _

message As String _
)
public:
SlaveException(
String^ message
)
Parameters
message (String)
The message.

SlaveException Constructor (message,
NModbus
innerException)
Namespaces ► Modbus ► SlaveException ► SlaveException(String,
Exception)
C#
Declaration Syntax
public SlaveException(
string message,
Exception innerException
)
Public Sub New ( _

message As String, _
innerException As Exception _
)
public:
SlaveException(
String^ message,
Exception^ innerException
)
Parameters
message (String)
The message.
innerException (Exception)
The inner exception.

NModbus FunctionCode Property
Namespaces ► Modbus ► SlaveException ► FunctionCode C#
Gets the response function code that caused the exception to occur, or 0.
Declaration Syntax
public byte FunctionCode { get; }
Public ReadOnly Property FunctionCode As Byte
public:
property unsigned char FunctionCode {
unsigned char get ();
}
Value
The function code.

NModbus GetObjectData Method (info, context)
Namespaces ► Modbus ► SlaveException ►
GetObjectData(SerializationInfo, StreamingContext)
C#
When overridden in a derived class, sets the SerializationInfo with information
about the exception.
Declaration Syntax
public override void GetObjectData(
SerializationInfo info,
)
Public Overrides Sub GetObjectData ( _

info As SerializationInfo, _
context As StreamingContext _
)
public:
virtual void GetObjectData(
SerializationInfo^ info,
) override
Parameters
info (SerializationInfo)
The SerializationInfo that holds the serialized object data about the
exception being thrown.
context (StreamingContext)
The StreamingContext that contains contextual information about the
source or destination.
Exceptions
Exception Condition
ArgumentNullException The info parameter is a null reference
(Nothing in Visual Basic).
NModbus Message Property
Namespaces ► Modbus ► SlaveException ► Message C#
Gets a message that describes the current exception.
Declaration Syntax
public override string Message { get; }
Public Overrides ReadOnly Property Message As String
public:
virtual property String^ Message {
String^ get () override;
}
Value
Return Value
The error message that explains the reason for the exception, or an empty
string("").

NModbus SlaveAddress Property
Namespaces ► Modbus ► SlaveException ► SlaveAddress C#
Gets the slave address, or 0.
Declaration Syntax
public byte SlaveAddress { get; }
Public ReadOnly Property SlaveAddress As Byte
public:
property unsigned char SlaveAddress {
}
Value
The slave address.

NModbus SlaveExceptionCode Property
Namespaces ► Modbus ► SlaveException ► SlaveExceptionCode
C#
Gets the slave exception code, or 0.
Declaration Syntax
public byte SlaveExceptionCode { get; }
Public ReadOnly Property SlaveExceptionCode As Byte
public:
property unsigned char SlaveExceptionCode {
}
Value
The slave exception code.

NModbus Modbus.Data Namespace
Namespaces ► Modbus.Data C#
Modbus data.
Declaration Syntax
namespace Modbus.Data
Namespace Modbus.Data
namespace Modbus.Data
Types
All Types Classes Interfaces Enumerations
DataStore Object simulation of device
memory map. The underlying
collections are thread safe when
using the ModbusMaster API to
read/write values. You can use the
SyncRoot property to synchronize
direct access to the DataStore
collections.
DataStoreEventArgs Event args for read write actions

performed on the DataStore.
DataStoreFactory Data story factory.
DiscreteCollection Collection of discrete values.
IModbusMessageDataCollection Modbus message containing data.

ModbusDataCollection<TData> A 1 origin collection represetative
of the Modbus Data Model.
ModbusDataType Types of data supported by the

Modbus protocol.
RegisterCollection Collection of 16 bit registers.

NModbus DataStore Class
Namespaces ► Modbus.Data ► DataStore C#
Object simulation of device memory map. The underlying collections are

thread safe when using the ModbusMaster API to read/write values. You can
use the SyncRoot property to synchronize direct access to the DataStore
collections.
Declaration Syntax
public class DataStore
Public Class DataStore
public ref class DataStore
Members
All Members Constructors Methods Properties Events
DataStore() Initializes a new instance of the
DataStore class.
CoilDiscretes Gets the coil discretes.
DataStoreReadFrom Occurs when the DataStore is read from

via a Modbus command.
DataStoreWrittenTo Occurs when the DataStore is written to

via a Modbus command.
Equals(Object) Determines whether the specified Object

is equal to the current Object.


GetHashCode() Serves as a hash function for a particular
type.


HoldingRegisters Gets the holding registers.
InputDiscretes Gets the input discretes.
InputRegisters Gets the input registers.

Object.

SyncRoot An object that can be used to synchronize
direct access to the DataStore collections.

current Object.
Object
DataStore

NModbus DataStore Constructor
Namespaces ► Modbus.Data ► DataStore ► DataStore() C#
Initializes a new instance of the DataStore class.
Declaration Syntax
public DataStore()
Public Sub New
public:
DataStore()

NModbus CoilDiscretes Property
Namespaces ► Modbus.Data ► DataStore ► CoilDiscretes C#
Gets the coil discretes.
Declaration Syntax
public ModbusDataCollection<bool> CoilDiscretes { get; private set
Public Property CoilDiscretes As ModbusDataCollection(Of Boolean)
public:
property ModbusDataCollection<bool>^ CoilDiscretes {
ModbusDataCollection<bool>^ get ();
void set (ModbusDataCollection<bool>^ value);
}

NModbus DataStoreReadFrom Event
Namespaces ► Modbus.Data ► DataStore ► DataStoreReadFrom
C#
Occurs when the DataStore is read from via a Modbus command.
Declaration Syntax
public event EventHandler<DataStoreEventArgs> DataStoreReadFrom
Public Event DataStoreReadFrom As EventHandler(Of DataStoreEventAr
public:
event EventHandler<DataStoreEventArgs^>^ DataStoreReadFrom {
void add (EventHandler<DataStoreEventArgs^>^ value);
void remove (EventHandler<DataStoreEventArgs^>^ value);
}

NModbus DataStoreWrittenTo Event
Namespaces ► Modbus.Data ► DataStore ► DataStoreWrittenTo
C#
Occurs when the DataStore is written to via a Modbus command.
Declaration Syntax
public event EventHandler<DataStoreEventArgs> DataStoreWrittenTo
Public Event DataStoreWrittenTo As EventHandler(Of DataStoreEventA
public:
event EventHandler<DataStoreEventArgs^>^ DataStoreWrittenTo {
void add (EventHandler<DataStoreEventArgs^>^ value);
void remove (EventHandler<DataStoreEventArgs^>^ value);
}

NModbus HoldingRegisters Property
Namespaces ► Modbus.Data ► DataStore ► HoldingRegisters C#
Gets the holding registers.
Declaration Syntax
public ModbusDataCollection<ushort> HoldingRegisters { get; privat
Public Property HoldingRegisters As ModbusDataCollection(Of UShort
public:
property ModbusDataCollection<unsigned short>^ HoldingRegisters {
ModbusDataCollection<unsigned short>^ get ();
void set (ModbusDataCollection<unsigned short>^ value);
}

NModbus InputDiscretes Property
Namespaces ► Modbus.Data ► DataStore ► InputDiscretes C#
Gets the input discretes.
Declaration Syntax
public ModbusDataCollection<bool> InputDiscretes { get; private se
Public Property InputDiscretes As ModbusDataCollection(Of Boolean
public:
property ModbusDataCollection<bool>^ InputDiscretes {
ModbusDataCollection<bool>^ get ();
void set (ModbusDataCollection<bool>^ value);
}

NModbus InputRegisters Property
Namespaces ► Modbus.Data ► DataStore ► InputRegisters C#
Gets the input registers.
Declaration Syntax
public ModbusDataCollection<ushort> InputRegisters { get; private
Public Property InputRegisters As ModbusDataCollection(Of UShort)
public:
property ModbusDataCollection<unsigned short>^ InputRegisters {
ModbusDataCollection<unsigned short>^ get ();
void set (ModbusDataCollection<unsigned short>^ value);
}

NModbus SyncRoot Property
Namespaces ► Modbus.Data ► DataStore ► SyncRoot C#
An object that can be used to synchronize direct access to the DataStore

collections.
Declaration Syntax
public Object SyncRoot { get; }
Public ReadOnly Property SyncRoot As Object
public:
property Object^ SyncRoot {
Object^ get ();
}

NModbus DataStoreEventArgs Class
Namespaces ► Modbus.Data ► DataStoreEventArgs C#
Event args for read write actions performed on the DataStore.
Declaration Syntax
public class DataStoreEventArgs : EventArgs
Public Class DataStoreEventArgs _

Inherits EventArgs
public ref class DataStoreEventArgs : public EventArgs
Members
Data Data that was read or written.



type.

Object.

ModbusDataType Type of Modbus data (e.g. Holding
register).
StartAddress Start address of data.

current Object.
Object
EventArgs
DataStoreEventArgs

NModbus Data Property
Namespaces ► Modbus.Data ► DataStoreEventArgs ► Data C#
Data that was read or written.
Declaration Syntax
public DiscriminatedUnion<ReadOnlyCollection<bool>, ReadOnlyCollec
Public Property Data As DiscriminatedUnion(Of ReadOnlyCollection(
public:
property DiscriminatedUnion<ReadOnlyCollection<bool>^, ReadOnlyCol
DiscriminatedUnion<ReadOnlyCollection<bool>^, ReadOnlyColl
void set (DiscriminatedUnion<ReadOnlyCollection<bool>^, Re
}

NModbus ModbusDataType Property
Namespaces ► Modbus.Data ► DataStoreEventArgs ► ModbusDataType
C#
Type of Modbus data (e.g. Holding register).
Declaration Syntax
public ModbusDataType ModbusDataType { get; private set; }
Public Property ModbusDataType As ModbusDataType
public:
property ModbusDataType ModbusDataType {
ModbusDataType get ();
void set (ModbusDataType value);
}

NModbus StartAddress Property
Namespaces ► Modbus.Data ► DataStoreEventArgs ► StartAddress
C#
Start address of data.
Declaration Syntax
public ushort StartAddress { get; private set; }
Public Property StartAddress As UShort
public:
property unsigned short StartAddress {
unsigned short get ();
void set (unsigned short value);
}

NModbus DataStoreFactory Class
Namespaces ► Modbus.Data ► DataStoreFactory C#
Data story factory.
Declaration Syntax
public static class DataStoreFactory
Public NotInheritable Class DataStoreFactory
public ref class DataStoreFactory abstract sealed
Members
All Members Methods
CreateDefaultDataStore() Factory method for default data store
- register values set to 0 and discrete
values set to false.
CreateDefaultDataStore(UInt16, Factory method for default data store

UInt16, UInt16, UInt16) - register values set to 0 and discrete
CreateTestDataStore() Factory method for test data store.
Object
DataStoreFactory

NModbus CreateDefaultDataStore Method
Namespaces ► Modbus.Data ► DataStoreFactory ►
CreateDefaultDataStore()
C#
Members
CreateDefaultDataStore() Factory method for default data store
- register values set to 0 and discrete
CreateDefaultDataStore(UInt16, Factory method for default data store

UInt16, UInt16, UInt16) - register values set to 0 and discrete

NModbus CreateDefaultDataStore Method
CreateDefaultDataStore()
C#
Factory method for default data store - register values set to 0 and discrete
Declaration Syntax
public static DataStore CreateDefaultDataStore()
Public Shared Function CreateDefaultDataStore As DataStore
public:
static DataStore^ CreateDefaultDataStore()

CreateDefaultDataStore Method (coilsCount,
NModbus
inputsCount, holdingRegistersCount,
inputRegistersCount)
CreateDefaultDataStore(UInt16, UInt16, UInt16, UInt16)
C#
Factory method for default data store - register values set to 0 and discrete
Declaration Syntax
public static DataStore CreateDefaultDataStore(
ushort coilsCount,
ushort inputsCount,
ushort holdingRegistersCount,
ushort inputRegistersCount
)
Public Shared Function CreateDefaultDataStore ( _

coilsCount As UShort, _
inputsCount As UShort, _
holdingRegistersCount As UShort, _
inputRegistersCount As UShort _
) As DataStore
public:
static DataStore^ CreateDefaultDataStore(
unsigned short coilsCount,
unsigned short inputsCount,
unsigned short holdingRegistersCount,
unsigned short inputRegistersCount
)
Parameters
coilsCount (UInt16)
inputsCount (UInt16)
holdingRegistersCount (UInt16)
inputRegistersCount (UInt16)
NModbus CreateTestDataStore Method
Namespaces ► Modbus.Data ► DataStoreFactory ► CreateTestDataStore()
C#
Factory method for test data store.
Declaration Syntax
public static DataStore CreateTestDataStore()
Public Shared Function CreateTestDataStore As DataStore
public:
static DataStore^ CreateTestDataStore()

NModbus DiscreteCollection Class
Namespaces ► Modbus.Data ► DiscreteCollection C#
Collection of discrete values.
Declaration Syntax
public class DiscreteCollection : Collection<bool>,
IModbusMessageDataCollection
Public Class DiscreteCollection _

Inherits Collection(Of Boolean) _
Implements IModbusMessageDataCollection
public ref class DiscreteCollection : public Collection<bool>,

Members

Protected Static
Inherited
DiscreteCollection() Initializes a new instance of the
DiscreteCollection class.
DiscreteCollection(Boolean[]) Initializes a new instance of the

DiscreteCollection(Byte[]) Initializes a new instance of the

DiscreteCollection(IList<Boolean>) Initializes a new instance of the

Add(T) Adds an object to the end of the
Collection<T>.
(Inherited from
Collection<Boolean>.)
ByteCount Gets the byte count.
Clear() Removes all elements from the

Collection<T>.
(Inherited from
ClearItems() Removes all elements from the
Collection<T>.
(Inherited from
Contains(T) Determines whether an element is
in the Collection<T>.
(Inherited from
CopyTo(T[], Int32) Copies the entire Collection<T> to
a compatible one-dimensional
Array, starting at the specified
index of the target array.
(Inherited from
Count Gets the number of elements
actually contained in the
Collection<T>.
(Inherited from
Object is equal to the current
Object.

resources and perform other
cleanup operations before the
Object is reclaimed by garbage
collection.

GetEnumerator() Returns an enumerator that
iterates through the Collection<T>
(Inherited from
particular type.

GetType() Gets the Type of the current
instance.

IndexOf(T) Searches for the specified object
and returns the zero-based index of
the first occurrence within the
entire Collection<T>.
(Inherited from
Insert(Int32, T) Inserts an element into the
Collection<T> at the specified
index.
(Inherited from
InsertItem(Int32, T) Inserts an element into the
Collection<T> at the specified
index.
(Inherited from
Item[Int32] Gets or sets the element at the
specified index.
(Inherited from
Items Gets a IList<T> wrapper around
the Collection<T>.
(Inherited from
MemberwiseClone() Creates a shallow copy of the
current Object.

NetworkBytes Gets the network bytes.
Remove(T) Removes the first occurrence of a

specific object from the
Collection<T>.
(Inherited from
RemoveAt(Int32) Removes the element at the
specified index of the
Collection<T>.
(Inherited from
RemoveItem(Int32) Removes the element at the
specified index of the
Collection<T>.
(Inherited from
SetItem(Int32, T) Replaces the element at the
specified index.
(Inherited from
ToString() Returns a String that represents
the current Object.
(Overrides Object.ToString().)
Object
Collection<Boolean>
DiscreteCollection

NModbus DiscreteCollection Constructor
Namespaces ► Modbus.Data ► DiscreteCollection ► DiscreteCollection()
C#
Members
DiscreteCollection() Initializes a new instance of the
DiscreteCollection(Boolean[]) Initializes a new instance of the

DiscreteCollection(Byte[]) Initializes a new instance of the

DiscreteCollection(IList<Boolean>) Initializes a new instance of the


NModbus DiscreteCollection Constructor
Namespaces ► Modbus.Data ► DiscreteCollection ► DiscreteCollection()
C#
Initializes a new instance of the DiscreteCollection class.
Declaration Syntax
public DiscreteCollection()
Public Sub New
public:
DiscreteCollection()

NModbus DiscreteCollection Constructor (bits)
Namespaces ► Modbus.Data ► DiscreteCollection ►
DiscreteCollection(Boolean[])
C#
Declaration Syntax
public DiscreteCollection(
params bool[] bits
)
Public Sub New ( _

ParamArray bits As Boolean() _
)
public:
DiscreteCollection(
... array<bool>^ bits
)
Parameters
bits ( Boolean [])

NModbus DiscreteCollection Constructor (bytes)
DiscreteCollection(Byte[])
C#
Declaration Syntax
params byte[] bytes
)
Public Sub New ( _

ParamArray bytes As Byte() _
)
public:
DiscreteCollection(
... array<unsigned char>^ bytes
)
Parameters
bytes ( Byte [])

NModbus DiscreteCollection Constructor (bits)
DiscreteCollection(IList<Boolean>)
C#
Declaration Syntax
IList<bool> bits
)
Public Sub New ( _

bits As IList(Of Boolean) _
)
public:
DiscreteCollection(
IList<bool>^ bits
)
Parameters
bits (IList<Boolean>)

NModbus ByteCount Property
Namespaces ► Modbus.Data ► DiscreteCollection ► ByteCount
C#
Gets the byte count.
Declaration Syntax
public byte ByteCount { get; }
Public ReadOnly Property ByteCount As Byte
public:
virtual property unsigned char ByteCount {
unsigned char get () sealed;
}

NModbus NetworkBytes Property
Namespaces ► Modbus.Data ► DiscreteCollection ► NetworkBytes
C#
Gets the network bytes.
Declaration Syntax
public byte[] NetworkBytes { get; }
Public ReadOnly Property NetworkBytes As Byte()
public:
virtual property array<unsigned char>^ NetworkBytes {
array<unsigned char>^ get () sealed;
}

NModbus ToString Method
Namespaces ► Modbus.Data ► DiscreteCollection ► ToString()
C#
Returns a String that represents the current Object.
Declaration Syntax
public override string ToString()
Public Overrides Function ToString As String
public:
virtual String^ ToString() override
Return Value
A String that represents the current Object.

NModbus IModbusMessageDataCollection Interface
Namespaces ► Modbus.Data ► IModbusMessageDataCollection
C#
Modbus message containing data.
Declaration Syntax
public interface IModbusMessageDataCollection
Public Interface IModbusMessageDataCollection
public interface class IModbusMessageDataCollection
Members
All Members Properties

Namespaces ► Modbus.Data ► IModbusMessageDataCollection ► ByteCount
C#
Declaration Syntax
byte ByteCount { get; }
ReadOnly Property ByteCount As Byte
property unsigned char ByteCount {

}

Namespaces ► Modbus.Data ► IModbusMessageDataCollection ►
NetworkBytes
C#
Declaration Syntax
byte[] NetworkBytes { get; }
ReadOnly Property NetworkBytes As Byte()
property array<unsigned char>^ NetworkBytes {

array<unsigned char>^ get ();
}

NModbus ModbusDataCollection<TData> Class
Namespaces ► Modbus.Data ► ModbusDataCollection<TData>
C#
A 1 origin collection represetative of the Modbus Data Model.
Declaration Syntax
public class ModbusDataCollection<TData> : Collection<TData>
Public Class ModbusDataCollection(Of TData) _

Inherits Collection(Of TData)
generic<typename TData>
public ref class ModbusDataCollection : public Collection<TData>
Generic Template Parameters

TData
[Missing <typeparam name="TData"/> documentation for

"T:Modbus.Data.ModbusDataCollection`1"]
Members

Protected Static
Inherited
ModbusDataCollection<TData>() Initializes a new instance
ModbusDataCollection
ModbusDataCollection<TData>(TData[]) Initializes a new instance

ModbusDataCollection<TData>(IList<TData>) Initializes a new instance

Add(T) Adds an object to the end
Collection<T>.
(Inherited from Collectio

Clear() Removes all elements fro
Collection<T>.

ClearItems() Removes all elements fro
Collection<T>.
(Overrides
Collection<TData>.Clea
Contains(T) Determines whether an e
Collection<T>.

CopyTo(T[], Int32) Copies the entire Collect
compatible one-dimensio
starting at the specified i
target array.

Count Gets the number of elem
contained in the Collectio

Equals(Object) Determines whether the
is equal to the current O

Finalize() Allows an Object to attem
resources and perform ot
operations before the Ob

GetEnumerator() Returns an enumerator t
through the Collection<

GetHashCode() Serves as a hash functio
type.

GetType() Gets the Type of the curr

IndexOf(T) Searches for the specifie
returns the zero-based in
occurrence within the en
Collection<T>.

Insert(Int32, T) Inserts an element into t
Collection<T> at the spe

InsertItem(Int32, TData) Inserts an element into t
Collection<T> at the spe
(Overrides
Collection<TData>.Inser
T).)
Item[Int32] Gets or sets the element
index.

Items Gets a IList<T> wrapper
Collection<T>.

MemberwiseClone() Creates a shallow copy o
Object.

Remove(T) Removes the first occurre
object from the Collectio

RemoveAt(Int32) Removes the element at
index of the Collection<

RemoveItem(Int32) Removes the element at
index of the Collection<
(Overrides
Collection<TData>.Rem
SetItem(Int32, TData) Replaces the element at
index.
(Overrides
Collection<TData>.SetIt
ToString() Returns a String that rep
current Object.
Object
Collection<TData>
ModbusDataCollection<TData>

NModbus ModbusDataCollection<TData> Constructor
Namespaces ► Modbus.Data ► ModbusDataCollection<TData> ►
ModbusDataCollection<TData>()
C#
Members
ModbusDataCollection<TData>() Initializes a new instance
the
ModbusDataCollection<T
class.
ModbusDataCollection<TData>(TData[]) Initializes a new instance

the
class.
ModbusDataCollection<TData>(IList<TData>) Initializes a new instance

the
class.

NModbus ModbusDataCollection<TData> Constructor
ModbusDataCollection<TData>()
C#
Initializes a new instance of the ModbusDataCollection<TData> class.
Declaration Syntax
public ModbusDataCollection()
Public Sub New
public:
ModbusDataCollection()

ModbusDataCollection<TData> Constructor
NModbus
(data)
ModbusDataCollection<TData>(IList<TData>)
C#
Declaration Syntax
public ModbusDataCollection(
IList<TData> data
)
Public Sub New ( _

data As IList(Of TData) _
)
public:
ModbusDataCollection(
IList<TData>^ data
)
Parameters
data (IList<TData>)
The data.

ModbusDataCollection<TData> Constructor
NModbus
(data)
ModbusDataCollection<TData>(TData[])
C#
Declaration Syntax
public ModbusDataCollection(
params TData[] data
)
Public Sub New ( _

ParamArray data As TData() _
)
public:
ModbusDataCollection(
... array<TData>^ data
)
Parameters
data ( TData [])
The data.

NModbus ClearItems Method
ClearItems()
C#
Removes all elements from the Collection<T>.
Declaration Syntax
protected override void ClearItems()
Protected Overrides Sub ClearItems
protected:
virtual void ClearItems() override

NModbus InsertItem Method (index, item)
InsertItem(Int32, TData)
C#
Inserts an element into the Collection<T> at the specified index.
Declaration Syntax
protected override void InsertItem(
int index,
TData item
)
Protected Overrides Sub InsertItem ( _

index As Integer, _
item As TData _
)
protected:
virtual void InsertItem(
int index,
TData item
) override
Parameters
index (Int32)
The zero-based index at which item should be inserted.
item (TData)
The object to insert. The value can be null for reference types.
Exceptions
Exception Condition
ArgumentOutOfRangeExceptionindex is less than zero.-or-index is greater
than Count.

NModbus RemoveItem Method (index)
RemoveItem(Int32)
C#
Removes the element at the specified index of the Collection<T>.
Declaration Syntax
protected override void RemoveItem(
int index
)
Protected Overrides Sub RemoveItem ( _

index As Integer _
)
protected:
virtual void RemoveItem(
int index
) override
Parameters
index (Int32)
The zero-based index of the element to remove.
Exceptions
Exception Condition
ArgumentOutOfRangeExceptionindex is less than zero.-or-index is equal to or
greater than Count.

NModbus SetItem Method (index, item)
SetItem(Int32, TData)
C#
Replaces the element at the specified index.
Declaration Syntax
protected override void SetItem(
int index,
TData item
)
Protected Overrides Sub SetItem ( _

index As Integer, _
item As TData _
)
protected:
virtual void SetItem(
int index,
TData item
) override
Parameters
index (Int32)
The zero-based index of the element to replace.
item (TData)
The new value for the element at the specified index. The value can be
null for reference types.
Exceptions
Exception Condition
ArgumentOutOfRangeExceptionindex is less than zero.-or-index is greater
than Count.

NModbus ModbusDataType Enumeration
Namespaces ► Modbus.Data ► ModbusDataType C#
Types of data supported by the Modbus protocol.
Declaration Syntax
public enum ModbusDataType
Public Enumeration ModbusDataType
public enum class ModbusDataType
Members
Member Description
HoldingRegister read/write register
InputRegister readonly register
Coil read/write discrete
Input readonly discrete

NModbus RegisterCollection Class
Namespaces ► Modbus.Data ► RegisterCollection C#
Collection of 16 bit registers.
Declaration Syntax
public class RegisterCollection : Collection<ushort>,
Public Class RegisterCollection _

Inherits Collection(Of UShort) _
Implements IModbusMessageDataCollection
public ref class RegisterCollection : public Collection<unsigned s

Members

Protected Static
Inherited
RegisterCollection() Initializes a new instance of the
RegisterCollection class.
RegisterCollection(Byte[]) Initializes a new instance of the

RegisterCollection(UInt16[]) Initializes a new instance of the

RegisterCollection(IList<UInt16>) Initializes a new instance of the

Add(T) Adds an object to the end of the
Collection<T>.
(Inherited from
Collection<UInt16>.)
Clear() Removes all elements from the

Collection<T>.
(Inherited from
ClearItems() Removes all elements from the
Collection<T>.
(Inherited from
Contains(T) Determines whether an element is in
the Collection<T>.
(Inherited from
CopyTo(T[], Int32) Copies the entire Collection<T> to a
compatible one-dimensional Array,
starting at the specified index of the
target array.
(Inherited from
Count Gets the number of elements
actually contained in the
Collection<T>.
(Inherited from
Object is equal to the current
Object.


GetEnumerator() Returns an enumerator that iterates
through the Collection<T>.
(Inherited from
particular type.

GetType() Gets the Type of the current
instance.

IndexOf(T) Searches for the specified object and
returns the zero-based index of the
first occurrence within the entire
Collection<T>.
(Inherited from
Insert(Int32, T) Inserts an element into the
Collection<T> at the specified index.
(Inherited from
InsertItem(Int32, T) Inserts an element into the
Collection<T> at the specified index.
(Inherited from
Item[Int32] Gets or sets the element at the
specified index.
(Inherited from
Items Gets a IList<T> wrapper around the
Collection<T>.
(Inherited from
MemberwiseClone() Creates a shallow copy of the
current Object.

Remove(T) Removes the first occurrence of a

specific object from the
Collection<T>.
(Inherited from
RemoveAt(Int32) Removes the element at the
specified index of the Collection<T>
(Inherited from
RemoveItem(Int32) Removes the element at the
specified index of the Collection<T>
(Inherited from
SetItem(Int32, T) Replaces the element at the
specified index.
(Inherited from

current Object.
Object
Collection<UInt16>
RegisterCollection

NModbus RegisterCollection Constructor
Namespaces ► Modbus.Data ► RegisterCollection ► RegisterCollection()
C#
Members
RegisterCollection() Initializes a new instance of the
RegisterCollection(Byte[]) Initializes a new instance of the

RegisterCollection(UInt16[]) Initializes a new instance of the

RegisterCollection(IList<UInt16>) Initializes a new instance of the


NModbus RegisterCollection Constructor
Namespaces ► Modbus.Data ► RegisterCollection ► RegisterCollection()
C#
Initializes a new instance of the RegisterCollection class.
Declaration Syntax
public RegisterCollection()
Public Sub New
public:
RegisterCollection()

NModbus RegisterCollection Constructor (bytes)
Namespaces ► Modbus.Data ► RegisterCollection ►
RegisterCollection(Byte[])
C#
Declaration Syntax
public RegisterCollection(
byte[] bytes
)
Public Sub New ( _

bytes As Byte() _
)
public:
RegisterCollection(
array<unsigned char>^ bytes
)
Parameters
bytes ( Byte [])

NModbus RegisterCollection Constructor (registers)
RegisterCollection(IList<UInt16>)
C#
Declaration Syntax
IList<ushort> registers
)
Public Sub New ( _

registers As IList(Of UShort) _
)
public:
RegisterCollection(
IList<unsigned short>^ registers
)
Parameters
registers (IList<UInt16>)

NModbus RegisterCollection Constructor (registers)
RegisterCollection(UInt16[])
C#
Declaration Syntax
params ushort[] registers
)
Public Sub New ( _

ParamArray registers As UShort() _
)
public:
RegisterCollection(
... array<unsigned short>^ registers
)
Parameters
registers ( UInt16 [])

Namespaces ► Modbus.Data ► RegisterCollection ► ByteCount
C#
Declaration Syntax
public byte ByteCount { get; }
Public ReadOnly Property ByteCount As Byte
public:
virtual property unsigned char ByteCount {
unsigned char get () sealed;
}

Namespaces ► Modbus.Data ► RegisterCollection ► NetworkBytes
C#
Declaration Syntax
public byte[] NetworkBytes { get; }
Public ReadOnly Property NetworkBytes As Byte()
public:
virtual property array<unsigned char>^ NetworkBytes {
array<unsigned char>^ get () sealed;
}

Namespaces ► Modbus.Data ► RegisterCollection ► ToString()
C#
Declaration Syntax
public:
Return Value

NModbus Modbus.Device Namespace
Namespaces ► Modbus.Device C#
Modbus device.
Declaration Syntax
namespace Modbus.Device
Namespace Modbus.Device
namespace Modbus.Device
Types
All Types Classes Interfaces
IModbusMaster Modbus master device.
IModbusSerialMaster Modbus Serial Master device.
ModbusDevice Modbus device.
ModbusIpMaster Modbus IP master device.
ModbusMaster Modbus master device.
ModbusSerialMaster Modbus serial master device.
ModbusSerialSlave Modbus serial slave device.

ModbusSlave Modbus slave device.
ModbusSlaveRequestEventArgs Modbus Slave request event args

containing information on the
message.
ModbusTcpSlave Modbus TCP slave device.
ModbusUdpSlave Modbus UDP slave device.

NModbus IModbusMaster Interface
Namespaces ► Modbus.Device ► IModbusMaster C#
Modbus master device.
Declaration Syntax
public interface IModbusMaster : IDisposable
Public Interface IModbusMaster _

Implements IDisposable
public interface class IModbusMaster : IDisposable
Members
(Inherited from IDisposable.)

ReadCoils(Byte, UInt16, UInt16) Read from 1 to 2000 contiguous coils
status.
ReadHoldingRegisters(Byte, Read contiguous block of holding

UInt16, UInt16) registers.
ReadInputRegisters(Byte, Read contiguous block of input

ReadInputs(Byte, UInt16, Read from 1 to 2000 contiguous

UInt16) discrete input status.
ReadWriteMultipleRegisters(Byte, Performs a combination of one read

UInt16, UInt16, UInt16, operation and one write operation in
UInt16[]) a single Modbus transaction. The
write operation is performed before
the read.
Transport Transport for used by this master.
WriteMultipleCoils(Byte, UInt16, Force each coil in a sequence of coils

Boolean[]) to a provided value.
WriteMultipleRegisters(Byte, Write a block of 1 to 123 contiguous

UInt16, UInt16[]) registers.
WriteSingleCoil(Byte, UInt16, Write a single coil value.

Boolean)
WriteSingleRegister(Byte, Write a single holding register.

UInt16, UInt16)

ReadCoils Method (slaveAddress,
NModbus
startAddress, numberOfPoints)
Namespaces ► Modbus.Device ► IModbusMaster ► ReadCoils(Byte,
UInt16, UInt16)
C#
Read from 1 to 2000 contiguous coils status.
Declaration Syntax
bool[] ReadCoils(
byte slaveAddress,
ushort startAddress,
ushort numberOfPoints
)
Function ReadCoils ( _
slaveAddress As Byte, _
startAddress As UShort, _
numberOfPoints As UShort _
) As Boolean()
array<bool>^ ReadCoils(
unsigned char slaveAddress,
unsigned short startAddress,
unsigned short numberOfPoints
)
Parameters
slaveAddress (Byte)
Address of device to read values from.
startAddress (UInt16)
Address to begin reading.
numberOfPoints (UInt16)
Number of coils to read.
Return Value
Coils status

ReadHoldingRegisters Method (slaveAddress,
NModbus
Namespaces ► Modbus.Device ► IModbusMaster ►
ReadHoldingRegisters(Byte, UInt16, UInt16)
C#
Read contiguous block of holding registers.
Declaration Syntax
ushort[] ReadHoldingRegisters(
byte slaveAddress,
)
Function ReadHoldingRegisters ( _
) As UShort()
array<unsigned short>^ ReadHoldingRegisters(

)
Parameters
slaveAddress (Byte)
Number of holding registers to read.
Return Value
Holding registers status

ReadInputRegisters Method (slaveAddress,
NModbus
ReadInputRegisters(Byte, UInt16, UInt16)
C#
Read contiguous block of input registers.
Declaration Syntax
ushort[] ReadInputRegisters(
byte slaveAddress,
)
Function ReadInputRegisters ( _
) As UShort()
array<unsigned short>^ ReadInputRegisters(

)
Parameters
slaveAddress (Byte)
Return Value
Input registers status

ReadInputs Method (slaveAddress,
NModbus
Namespaces ► Modbus.Device ► IModbusMaster ► ReadInputs(Byte,
UInt16, UInt16)
C#
Read from 1 to 2000 contiguous discrete input status.
Declaration Syntax
bool[] ReadInputs(
byte slaveAddress,
)
Function ReadInputs ( _
) As Boolean()
array<bool>^ ReadInputs(
)
Parameters
slaveAddress (Byte)
Number of discrete inputs to read.
Return Value
Discrete inputs status

ReadWriteMultipleRegisters Method
NModbus
(slaveAddress, startReadAddress,
numberOfPointsToRead, startWriteAddress,
writeData)
ReadWriteMultipleRegisters(Byte, UInt16, UInt16, UInt16, UInt16[])
C#
Performs a combination of one read operation and one write operation in a
single Modbus transaction. The write operation is performed before the read.
Declaration Syntax
ushort[] ReadWriteMultipleRegisters(
byte slaveAddress,
ushort startReadAddress,
ushort numberOfPointsToRead,
ushort startWriteAddress,
ushort[] writeData
)
Function ReadWriteMultipleRegisters ( _
startReadAddress As UShort, _
numberOfPointsToRead As UShort, _
startWriteAddress As UShort, _
writeData As UShort() _
) As UShort()
array<unsigned short>^ ReadWriteMultipleRegisters(

unsigned short startReadAddress,
unsigned short numberOfPointsToRead,
unsigned short startWriteAddress,
array<unsigned short>^ writeData
)
Parameters
slaveAddress (Byte)
startReadAddress (UInt16)
Address to begin reading (Holding registers are addressed starting at 0).
numberOfPointsToRead (UInt16)
Number of registers to read.
startWriteAddress (UInt16)
Address to begin writing (Holding registers are addressed starting at 0).
writeData ( UInt16 [])
Register values to write.

NModbus Transport Property
Namespaces ► Modbus.Device ► IModbusMaster ► Transport C#
Transport for used by this master.
Declaration Syntax
ModbusTransport Transport { get; }
ReadOnly Property Transport As ModbusTransport
property ModbusTransport^ Transport {

ModbusTransport^ get ();
}

WriteMultipleCoils Method (slaveAddress,
NModbus
startAddress, data)
WriteMultipleCoils(Byte, UInt16, Boolean[])
C#
Force each coil in a sequence of coils to a provided value.
Declaration Syntax
void WriteMultipleCoils(
byte slaveAddress,
bool[] data
)
Sub WriteMultipleCoils ( _
data As Boolean() _
)
array<bool>^ data
)
Parameters
slaveAddress (Byte)
Address of the device to write to.
Address to begin writing values.
data ( Boolean [])
Values to write.

WriteMultipleRegisters Method
NModbus
(slaveAddress, startAddress, data)

WriteMultipleRegisters(Byte, UInt16, UInt16[])
C#
Write a block of 1 to 123 contiguous registers.
Declaration Syntax
void WriteMultipleRegisters(
byte slaveAddress,
ushort[] data
)
Sub WriteMultipleRegisters ( _
data As UShort() _
)
array<unsigned short>^ data
)
Parameters
slaveAddress (Byte)
data ( UInt16 [])
Values to write.

WriteSingleCoil Method (slaveAddress,
NModbus
coilAddress, value)
Namespaces ► Modbus.Device ► IModbusMaster ► WriteSingleCoil(Byte,
UInt16, Boolean)
C#
Write a single coil value.
Declaration Syntax
void WriteSingleCoil(
byte slaveAddress,
ushort coilAddress,
bool value
)
Sub WriteSingleCoil ( _
coilAddress As UShort, _
value As Boolean _
)
unsigned short coilAddress,
bool value
)
Parameters
slaveAddress (Byte)
coilAddress (UInt16)
Address to write value to.
value (Boolean)
Value to write.

WriteSingleRegister Method (slaveAddress,
NModbus
registerAddress, value)
WriteSingleRegister(Byte, UInt16, UInt16)
C#
Write a single holding register.
Declaration Syntax
void WriteSingleRegister(
byte slaveAddress,
ushort registerAddress,
ushort value
)
Sub WriteSingleRegister ( _
registerAddress As UShort, _
value As UShort _
)
unsigned short registerAddress,
unsigned short value
)
Parameters
slaveAddress (Byte)
registerAddress (UInt16)
Address to write.
value (UInt16)
Value to write.

NModbus IModbusSerialMaster Interface
Namespaces ► Modbus.Device ► IModbusSerialMaster C#
Modbus Serial Master device.
Declaration Syntax
public interface IModbusSerialMaster : IModbusMaster,
IDisposable
Public Interface IModbusSerialMaster _

Implements IModbusMaster, IDisposable
public interface class IModbusSerialMaster : IModbusMaster,

IDisposable
Members

ReadCoils(Byte, UInt16, UInt16) Read from 1 to 2000 contiguous coils
status.
(Inherited from IModbusMaster.)

ReadHoldingRegisters(Byte, Read contiguous block of holding

ReadInputRegisters(Byte, Read contiguous block of input

ReadInputs(Byte, UInt16, Read from 1 to 2000 contiguous
UInt16) discrete input status.

ReadWriteMultipleRegisters(Byte, Performs a combination of one read
UInt16, UInt16, UInt16, operation and one write operation in
UInt16[]) a single Modbus transaction. The
write operation is performed before
the read.

ReturnQueryData(Byte, UInt16) Serial Line only. Diagnostic function
which loops back the original data.
NModbus only supports looping back
one ushort value, this is a limitation
of the "Best Effort" implementation of
the RTU protocol.

WriteMultipleCoils(Byte, UInt16, Force each coil in a sequence of coils
Boolean[]) to a provided value.

WriteMultipleRegisters(Byte, Write a block of 1 to 123 contiguous
UInt16, UInt16[]) registers.

WriteSingleCoil(Byte, UInt16, Write a single coil value.
Boolean)
WriteSingleRegister(Byte, Write a single holding register.
UInt16, UInt16)
ReturnQueryData Method (slaveAddress,
NModbus
data)
Namespaces ► Modbus.Device ► IModbusSerialMaster ►
ReturnQueryData(Byte, UInt16)
C#
Serial Line only. Diagnostic function which loops back the original data.
NModbus only supports looping back one ushort value, this is a limitation of
the "Best Effort" implementation of the RTU protocol.
Declaration Syntax
bool ReturnQueryData(
byte slaveAddress,
ushort data
)
Function ReturnQueryData ( _
data As UShort _
) As Boolean
bool ReturnQueryData(
unsigned short data
)
Parameters
slaveAddress (Byte)
Address of device to test.
data (UInt16)
Data to return.
Return Value
Return true if slave device echoed data.

Namespaces ► Modbus.Device ► IModbusSerialMaster ► Transport
C#
Transport for used by this master.
Declaration Syntax
ModbusSerialTransport Transport { get; }
ReadOnly Property Transport As ModbusSerialTransport
property ModbusSerialTransport^ Transport {

ModbusSerialTransport^ get ();
}

NModbus ModbusDevice Class
Namespaces ► Modbus.Device ► ModbusDevice C#
Modbus device.
Declaration Syntax
public abstract class ModbusDevice : IDisposable
Public MustInherit Class ModbusDevice _

public ref class ModbusDevice abstract : IDisposable
Members
Dispose() Releases unmanaged and - optionally -
managed resources

managed resources



type.


Object.

current Object.

Transport Gets the Modbus Transport.
Object
ModbusDevice
ModbusMaster
ModbusSlave

Namespaces ► Modbus.Device ► ModbusDevice ► Dispose() C#
Members
managed resources

managed resources

Namespaces ► Modbus.Device ► ModbusDevice ► Dispose() C#
Declaration Syntax
Public Sub Dispose
public:

Namespaces ► Modbus.Device ► ModbusDevice ► Dispose(Boolean)
C#
Declaration Syntax
bool disposing
)

)
protected:
bool disposing
)
Parameters
disposing (Boolean)

Namespaces ► Modbus.Device ► ModbusDevice ► Transport C#
Gets the Modbus Transport.
Declaration Syntax
public ModbusTransport Transport { get; }
Public ReadOnly Property Transport As ModbusTransport
public:
virtual property ModbusTransport^ Transport {
ModbusTransport^ get () sealed;
}
Value
The transport.

NModbus ModbusIpMaster Class
Namespaces ► Modbus.Device ► ModbusIpMaster C#
Modbus IP master device.
Declaration Syntax
public class ModbusIpMaster : ModbusMaster
Public Class ModbusIpMaster _

Inherits ModbusMaster
public ref class ModbusIpMaster : public ModbusMaster
Members
CreateIp(TcpClient) Modbus IP
master factory
method.
CreateIp(UdpClient) Modbus IP
master factory
method.
CreateIp(SerialPort) Modbus IP
master factory
method.
CreateIp(IStreamResource) Modbus IP
master factory
method.
Dispose() Releases
unmanaged
and - optionall
- managed
resources
(Inherited from
ModbusDevice
Dispose(Boolean) Releases
unmanaged
and - optionall
- managed
resources
(Inherited from
ModbusDevice
Equals(Object) Determines
whether the
specified Objec
is equal to the
current Object
(Inherited from
Object.)
ExecuteCustomMessage<TResponse>(IModbusMessage) Executes the
custom
message.
(Inherited from
ModbusMaster
Finalize() Allows an
Object to
attempt to free
resources and
perform other
cleanup
operations
before the
Object is
reclaimed by
garbage
collection.
(Inherited from
Object.)
GetHashCode() Serves as a
hash function
for a particular
type.
(Inherited from
Object.)
GetType() Gets the Type
of the current
instance.
(Inherited from
Object.)
MemberwiseClone() Creates a
shallow copy o
the current
Object.
(Inherited from
Object.)
ReadCoils(UInt16, UInt16) Read from 1 to
2000
contiguous coil
status.
ReadCoils(Byte, UInt16, UInt16) Read from 1 to

2000
contiguous coil
status.
(Inherited from
ModbusMaster
ReadHoldingRegisters(UInt16, UInt16) Read
contiguous
block of holdin
registers.
ReadHoldingRegisters(Byte, UInt16, UInt16) Read

contiguous
block of 16 bit
holding
registers.
(Inherited from
ModbusMaster
ReadInputRegisters(UInt16, UInt16) Read
contiguous
block of input
registers.
ReadInputRegisters(Byte, UInt16, UInt16) Read

contiguous
block of 16 bit
input registers
(Inherited from
ModbusMaster
ReadInputs(UInt16, UInt16) Read from 1 to
2000
contiguous
discrete input
status.
ReadInputs(Byte, UInt16, UInt16) Read from 1 to

2000
contiguous
discrete input
status.
(Inherited from
ModbusMaster
ReadWriteMultipleRegisters(UInt16, UInt16, UInt16, Performs a
UInt16[]) combination of
one read
operation and
one write
operation in a
single MODBUS
transaction.
The write
operation is
performed
before the
read. Message
uses default
TCP slave id of
0.
ReadWriteMultipleRegisters(Byte, UInt16, UInt16, Performs a

UInt16, UInt16[]) combination of
one read
operation and
one write
operation in a
single Modbus
transaction.
The write
operation is
performed
before the
read.
(Inherited from
ModbusMaster
ToString() Returns a
String that
represents the
current Object
(Inherited from
Object.)
Transport Gets the
Modbus
Transport.
(Inherited from
ModbusDevice
WriteMultipleCoils(UInt16, Boolean[]) Force each coil
in a sequence
of coils to a
provided value
WriteMultipleCoils(Byte, UInt16, Boolean[]) Force each coil

in a sequence
of coils to a
provided value
(Inherited from
ModbusMaster
WriteMultipleRegisters(UInt16, UInt16[]) Write a block o
1 to 123
contiguous
registers.
WriteMultipleRegisters(Byte, UInt16, UInt16[]) Write a block o

1 to 123
contiguous 16
bit holding
registers.
(Inherited from
ModbusMaster
WriteSingleCoil(UInt16, Boolean) Write a single
coil value.
WriteSingleCoil(Byte, UInt16, Boolean) Write a single

coil value.
(Inherited from
ModbusMaster
WriteSingleRegister(UInt16, UInt16) Write a single
holding
register.
WriteSingleRegister(Byte, UInt16, UInt16) Write a single

holding
register.
(Inherited from
ModbusMaster
Object
ModbusDevice
ModbusMaster
ModbusIpMaster

NModbus CreateIp Method
Namespaces ► Modbus.Device ► ModbusIpMaster ► CreateIp()
C#
Members
CreateIp(TcpClient) Modbus IP master factory method.
CreateIp(UdpClient) Modbus IP master factory method.
CreateIp(SerialPort) Modbus IP master factory method.
CreateIp(IStreamResource) Modbus IP master factory method.

NModbus CreateIp Method (streamResource)
Namespaces ► Modbus.Device ► ModbusIpMaster ►
CreateIp(IStreamResource)
C#
Modbus IP master factory method.
Declaration Syntax
public static ModbusIpMaster CreateIp(
IStreamResource streamResource
)
Public Shared Function CreateIp ( _

streamResource As IStreamResource _
) As ModbusIpMaster
public:
static ModbusIpMaster^ CreateIp(
IStreamResource^ streamResource
)
Parameters
streamResource (IStreamResource)

NModbus CreateIp Method (serialPort)
Namespaces ► Modbus.Device ► ModbusIpMaster ► CreateIp(SerialPort)
C#
Declaration Syntax
SerialPort serialPort
)

serialPort As SerialPort _
) As ModbusIpMaster
public:
SerialPort^ serialPort
)
Parameters
serialPort (SerialPort)

NModbus CreateIp Method (tcpClient)
Namespaces ► Modbus.Device ► ModbusIpMaster ► CreateIp(TcpClient)
C#
Declaration Syntax
TcpClient tcpClient
)

tcpClient As TcpClient _
) As ModbusIpMaster
public:
TcpClient^ tcpClient
)
Parameters
tcpClient (TcpClient)

NModbus CreateIp Method (udpClient)
Namespaces ► Modbus.Device ► ModbusIpMaster ► CreateIp(UdpClient)
C#
Declaration Syntax
UdpClient udpClient
)

udpClient As UdpClient _
) As ModbusIpMaster
public:
UdpClient^ udpClient
)
Parameters
udpClient (UdpClient)

ReadCoils Method (startAddress,
NModbus
numberOfPoints)
Namespaces ► Modbus.Device ► ModbusIpMaster ► ReadCoils(UInt16,
UInt16)
C#
Declaration Syntax
public bool[] ReadCoils(
)
Public Function ReadCoils ( _

) As Boolean()
public:
array<bool>^ ReadCoils(
)
Parameters
Return Value
Coils status

ReadHoldingRegisters Method (startAddress,
NModbus
numberOfPoints)
ReadHoldingRegisters(UInt16, UInt16)
C#
Read contiguous block of holding registers.
Declaration Syntax
public ushort[] ReadHoldingRegisters(
)
Public Function ReadHoldingRegisters ( _

) As UShort()
public:
array<unsigned short>^ ReadHoldingRegisters(
)
Parameters
Return Value

ReadInputRegisters Method (startAddress,
NModbus
numberOfPoints)
ReadInputRegisters(UInt16, UInt16)
C#
Read contiguous block of input registers.
Declaration Syntax
public ushort[] ReadInputRegisters(
)
Public Function ReadInputRegisters ( _

) As UShort()
public:
array<unsigned short>^ ReadInputRegisters(
)
Parameters
Return Value

ReadInputs Method (startAddress,
NModbus
numberOfPoints)
Namespaces ► Modbus.Device ► ModbusIpMaster ► ReadInputs(UInt16,
UInt16)
C#
Declaration Syntax
public bool[] ReadInputs(
)
Public Function ReadInputs ( _

) As Boolean()
public:
array<bool>^ ReadInputs(
)
Parameters
Return Value

NModbus
(startReadAddress, numberOfPointsToRead,
startWriteAddress, writeData)
ReadWriteMultipleRegisters(UInt16, UInt16, UInt16, UInt16[])
C#
single MODBUS transaction. The write operation is performed before the read.
Message uses default TCP slave id of 0.
Declaration Syntax
public ushort[] ReadWriteMultipleRegisters(
ushort[] writeData
)
Public Function ReadWriteMultipleRegisters ( _

) As UShort()
public:
array<unsigned short>^ ReadWriteMultipleRegisters(
)
Parameters

WriteMultipleCoils Method (startAddress,
NModbus
data)
WriteMultipleCoils(UInt16, Boolean[])
C#
Declaration Syntax
public void WriteMultipleCoils(
bool[] data
)
Public Sub WriteMultipleCoils ( _

data As Boolean() _
)
public:
array<bool>^ data
)
Parameters
data ( Boolean [])
Values to write.

NModbus
(startAddress, data)
WriteMultipleRegisters(UInt16, UInt16[])
C#
Write a block of 1 to 123 contiguous registers.
Declaration Syntax
public void WriteMultipleRegisters(
ushort[] data
)
Public Sub WriteMultipleRegisters ( _

data As UShort() _
)
public:
)
Parameters
data ( UInt16 [])
Values to write.

NModbus WriteSingleCoil Method (coilAddress, value)
WriteSingleCoil(UInt16, Boolean)
C#
Declaration Syntax
public void WriteSingleCoil(
ushort coilAddress,
bool value
)
Public Sub WriteSingleCoil ( _

value As Boolean _
)
public:
bool value
)
Parameters
value (Boolean)
Value to write.

WriteSingleRegister Method
NModbus
(registerAddress, value)
WriteSingleRegister(UInt16, UInt16)
C#
Declaration Syntax
public void WriteSingleRegister(
ushort value
)
Public Sub WriteSingleRegister ( _

value As UShort _
)
public:
)
Parameters
Address to write.
value (UInt16)
Value to write.

NModbus ModbusMaster Class
Namespaces ► Modbus.Device ► ModbusMaster C#
Modbus master device.
Declaration Syntax
public abstract class ModbusMaster : ModbusDevice,
IModbusMaster, IDisposable
Public MustInherit Class ModbusMaster _

Inherits ModbusDevice _
Implements IModbusMaster, IDisposable
public ref class ModbusMaster abstract : public ModbusDevice,

IModbusMaster, IDisposable
Members
Dispose() Releases
unmanaged
and - optionall
- managed
resources
(Inherited from
ModbusDevice
unmanaged
and - optionall
- managed
resources
(Inherited from
ModbusDevice
whether the
specified Objec
is equal to the
current Object
(Inherited from
Object.)
custom
message.
Object to
attempt to free
resources and
perform other
cleanup
operations
before the
Object is
reclaimed by
garbage
collection.
(Inherited from
Object.)
hash function
for a particular
type.
(Inherited from
Object.)
of the current
instance.
(Inherited from
Object.)
shallow copy o
the current
Object.
(Inherited from
Object.)
2000
contiguous
coils status.

contiguous
block of 16 bit
holding
registers.

contiguous
block of 16 bit
input registers

2000
contiguous
discrete input
status.

one read
operation and
one write
operation in a
single Modbus
transaction.
The write
operation is
performed
before the
read.
String that
represents the
current Object
(Inherited from
Object.)
Transport Gets the
Modbus
Transport.
(Inherited from
ModbusDevice
in a sequence
of coils to a
provided value

1 to 123
contiguous 16
bit holding
registers.

coil value.

holding
register.
Object
ModbusDevice
ModbusMaster
ModbusIpMaster
ModbusSerialMaster

ExecuteCustomMessage<TResponse> Method
NModbus
(request)
Namespaces ► Modbus.Device ► ModbusMaster ►
ExecuteCustomMessage<TResponse>(IModbusMessage)
C#
Executes the custom message.
Declaration Syntax
public TResponse ExecuteCustomMessage<TResponse>(
IModbusMessage request
)
where TResponse : new(), IModbusMessage
Public Function ExecuteCustomMessage(Of TResponse As {New, IModbus

request As IModbusMessage _
) As TResponse
public:
generic<typename TResponse>
where TResponse : gcnew(), IModbusMessage
TResponse ExecuteCustomMessage(
IModbusMessage^ request
)

TResponse
The type of the response.
Parameters
request (IModbusMessage)
The request.

ReadCoils Method (slaveAddress,
NModbus
Namespaces ► Modbus.Device ► ModbusMaster ► ReadCoils(Byte,
UInt16, UInt16)
C#
Declaration Syntax
public bool[] ReadCoils(
byte slaveAddress,
)
Public Function ReadCoils ( _

) As Boolean()
public:
virtual array<bool>^ ReadCoils(
) sealed
Parameters
slaveAddress (Byte)
Return Value
Coils status
ReadHoldingRegisters Method (slaveAddress,
NModbus
ReadHoldingRegisters(Byte, UInt16, UInt16)
C#
Read contiguous block of 16 bit holding registers.
Declaration Syntax
public ushort[] ReadHoldingRegisters(
byte slaveAddress,
)
Public Function ReadHoldingRegisters ( _

) As UShort()
public:
virtual array<unsigned short>^ ReadHoldingRegisters(
) sealed
Parameters
slaveAddress (Byte)
Return Value
ReadInputRegisters Method (slaveAddress,
NModbus
ReadInputRegisters(Byte, UInt16, UInt16)
C#
Read contiguous block of 16 bit input registers.
Declaration Syntax
public ushort[] ReadInputRegisters(
byte slaveAddress,
)
Public Function ReadInputRegisters ( _

) As UShort()
public:
virtual array<unsigned short>^ ReadInputRegisters(
) sealed
Parameters
slaveAddress (Byte)
Return Value
ReadInputs Method (slaveAddress,
NModbus
Namespaces ► Modbus.Device ► ModbusMaster ► ReadInputs(Byte,
UInt16, UInt16)
C#
Declaration Syntax
public bool[] ReadInputs(
byte slaveAddress,
)
Public Function ReadInputs ( _

) As Boolean()
public:
virtual array<bool>^ ReadInputs(
) sealed
Parameters
slaveAddress (Byte)
Return Value
NModbus
(slaveAddress, startReadAddress,
numberOfPointsToRead, startWriteAddress,
writeData)
ReadWriteMultipleRegisters(Byte, UInt16, UInt16, UInt16, UInt16[])
C#
single Modbus transaction. The write operation is performed before the read.
Declaration Syntax
public ushort[] ReadWriteMultipleRegisters(
byte slaveAddress,
ushort[] writeData
)
Public Function ReadWriteMultipleRegisters ( _

) As UShort()
public:
virtual array<unsigned short>^ ReadWriteMultipleRegisters(
) sealed
Parameters
slaveAddress (Byte)

WriteMultipleCoils Method (slaveAddress,
NModbus
startAddress, data)
WriteMultipleCoils(Byte, UInt16, Boolean[])
C#
Declaration Syntax
public void WriteMultipleCoils(
byte slaveAddress,
bool[] data
)
Public Sub WriteMultipleCoils ( _

data As Boolean() _
)
public:
virtual void WriteMultipleCoils(
array<bool>^ data
) sealed
Parameters
slaveAddress (Byte)
data ( Boolean [])
Values to write.

NModbus
(slaveAddress, startAddress, data)

WriteMultipleRegisters(Byte, UInt16, UInt16[])
C#
Write a block of 1 to 123 contiguous 16 bit holding registers.
Declaration Syntax
public void WriteMultipleRegisters(
byte slaveAddress,
ushort[] data
)
Public Sub WriteMultipleRegisters ( _

data As UShort() _
)
public:
virtual void WriteMultipleRegisters(
) sealed
Parameters
slaveAddress (Byte)
data ( UInt16 [])
Values to write.

WriteSingleCoil Method (slaveAddress,
NModbus
coilAddress, value)
Namespaces ► Modbus.Device ► ModbusMaster ► WriteSingleCoil(Byte,
UInt16, Boolean)
C#
Declaration Syntax
public void WriteSingleCoil(
byte slaveAddress,
ushort coilAddress,
bool value
)
Public Sub WriteSingleCoil ( _

value As Boolean _
)
public:
virtual void WriteSingleCoil(
bool value
) sealed
Parameters
slaveAddress (Byte)
value (Boolean)
Value to write.

WriteSingleRegister Method (slaveAddress,
NModbus
registerAddress, value)
WriteSingleRegister(Byte, UInt16, UInt16)
C#
Declaration Syntax
public void WriteSingleRegister(
byte slaveAddress,
ushort value
)
Public Sub WriteSingleRegister ( _

value As UShort _
)
public:
virtual void WriteSingleRegister(
) sealed
Parameters
slaveAddress (Byte)
Address to write.
value (UInt16)
Value to write.

NModbus ModbusSerialMaster Class
Namespaces ► Modbus.Device ► ModbusSerialMaster C#
Modbus serial master device.
Declaration Syntax
public class ModbusSerialMaster : ModbusMaster,
IModbusSerialMaster, IModbusMaster, IDisposable
Public Class ModbusSerialMaster _

Inherits ModbusMaster _
Implements IModbusSerialMaster, IModbusMaster, IDisposable
public ref class ModbusSerialMaster : public ModbusMaster,

IModbusSerialMaster, IModbusMaster, IDisposable
Members
CreateAscii(SerialPort) Modbus ASCII
master factory
method.
CreateAscii(TcpClient) Modbus ASCII

master factory
method.
CreateAscii(UdpClient) Modbus ASCII

master factory
method.
CreateAscii(IStreamResource) Modbus ASCII
master factory
method.
CreateRtu(SerialPort) Modbus RTU

master factory
method.
CreateRtu(TcpClient) Modbus RTU

master factory
method.
CreateRtu(UdpClient) Modbus RTU

master factory
method.
CreateRtu(IStreamResource) Modbus RTU

master factory
method.
Dispose() Releases
unmanaged
and - optionall
- managed
resources
(Inherited from
ModbusDevice
unmanaged
and - optionall
- managed
resources
(Inherited from
ModbusDevice
whether the
specified Objec
is equal to the
current Object
(Inherited from
Object.)
custom
message.
(Inherited from
ModbusMaster
Object to
attempt to free
resources and
perform other
cleanup
operations
before the
Object is
reclaimed by
garbage
collection.
(Inherited from
Object.)
hash function
for a particular
type.
(Inherited from
Object.)
of the current
instance.
(Inherited from
Object.)
shallow copy o
the current
Object.
(Inherited from
Object.)
2000
contiguous coil
status.
(Inherited from
ModbusMaster
contiguous
block of 16 bit
holding
registers.
(Inherited from
ModbusMaster
contiguous
block of 16 bit
input registers
(Inherited from
ModbusMaster
2000
contiguous
discrete input
status.
(Inherited from
ModbusMaster
one read
operation and
one write
operation in a
single Modbus
transaction.
The write
operation is
performed
before the
read.
(Inherited from
ModbusMaster
ReturnQueryData(Byte, UInt16) Serial Line
only. Diagnosti
function which
loops back the
original data.
NModbus only
supports
looping back
one ushort
value, this is a
limitation of
the "Best
Effort"
implementation
of the RTU
protocol.
String that
represents the
current Object
(Inherited from
Object.)
Transport Gets the
Modbus
Transport.
(Inherited from
ModbusDevice
in a sequence
of coils to a
provided value
(Inherited from
ModbusMaster
1 to 123
contiguous 16
bit holding
registers.
(Inherited from
ModbusMaster
coil value.
(Inherited from
ModbusMaster
holding
register.
(Inherited from
ModbusMaster
Object
ModbusDevice
ModbusMaster
ModbusSerialMaster
NModbus CreateAscii Method
Namespaces ► Modbus.Device ► ModbusSerialMaster ► CreateAscii()
C#
Members
CreateAscii(SerialPort) Modbus ASCII master factory method.
CreateAscii(TcpClient) Modbus ASCII master factory method.
CreateAscii(UdpClient) Modbus ASCII master factory method.
CreateAscii(IStreamResource) Modbus ASCII master factory method.

NModbus CreateAscii Method (streamResource)
Namespaces ► Modbus.Device ► ModbusSerialMaster ►
CreateAscii(IStreamResource)
C#
Modbus ASCII master factory method.
Declaration Syntax
public static ModbusSerialMaster CreateAscii(
)
Public Shared Function CreateAscii ( _

) As ModbusSerialMaster
public:
static ModbusSerialMaster^ CreateAscii(
)
Parameters

NModbus CreateAscii Method (serialPort)
CreateAscii(SerialPort)
C#
Declaration Syntax
)

public:
)
Parameters

NModbus CreateAscii Method (tcpClient)
CreateAscii(TcpClient)
C#
Declaration Syntax
TcpClient tcpClient
)

public:
)
Parameters

NModbus CreateAscii Method (udpClient)
CreateAscii(UdpClient)
C#
Declaration Syntax
UdpClient udpClient
)

public:
)
Parameters

NModbus CreateRtu Method
Namespaces ► Modbus.Device ► ModbusSerialMaster ► CreateRtu()
C#
Members
CreateRtu(SerialPort) Modbus RTU master factory method.
CreateRtu(TcpClient) Modbus RTU master factory method.
CreateRtu(UdpClient) Modbus RTU master factory method.
CreateRtu(IStreamResource) Modbus RTU master factory method.

NModbus CreateRtu Method (streamResource)
CreateRtu(IStreamResource)
C#
Modbus RTU master factory method.
Declaration Syntax
public static ModbusSerialMaster CreateRtu(
)
Public Shared Function CreateRtu ( _

public:
static ModbusSerialMaster^ CreateRtu(
)
Parameters

NModbus CreateRtu Method (serialPort)
CreateRtu(SerialPort)
C#
Declaration Syntax
)

public:
)
Parameters

NModbus CreateRtu Method (tcpClient)
CreateRtu(TcpClient)
C#
Declaration Syntax
TcpClient tcpClient
)

public:
)
Parameters

NModbus CreateRtu Method (udpClient)
CreateRtu(UdpClient)
C#
Declaration Syntax
UdpClient udpClient
)

public:
)
Parameters

ReturnQueryData Method (slaveAddress,
NModbus
data)
ReturnQueryData(Byte, UInt16)
C#
Serial Line only. Diagnostic function which loops back the original data.
NModbus only supports looping back one ushort value, this is a limitation of
the "Best Effort" implementation of the RTU protocol.
Declaration Syntax
public bool ReturnQueryData(
byte slaveAddress,
ushort data
)
Public Function ReturnQueryData ( _

data As UShort _
) As Boolean
public:
virtual bool ReturnQueryData(
unsigned short data
) sealed
Parameters
slaveAddress (Byte)
Address of device to test.
data (UInt16)
Data to return.
Return Value
Return true if slave device echoed data.

NModbus ModbusSerialSlave Class
Namespaces ► Modbus.Device ► ModbusSerialSlave C#
Modbus serial slave device.
Declaration Syntax
public class ModbusSerialSlave : ModbusSlave
Public Class ModbusSerialSlave _

Inherits ModbusSlave
public ref class ModbusSerialSlave : public ModbusSlave
Members
All Members Methods Properties Events

Protected Static
Inherited
CreateAscii(Byte, SerialPort) Modbus ASCII slave factory method.
CreateAscii(Byte, Modbus ASCII slave factory method.

IStreamResource)
CreateRtu(Byte, SerialPort) Modbus RTU slave factory method.
CreateRtu(Byte, Modbus RTU slave factory method.

IStreamResource)
DataStore Gets or sets the data store.
(Inherited from ModbusSlave.)

managed resources
(Inherited from ModbusDevice.)

managed resources



particular type.


Listen() Start slave listening for requests.
(Overrides ModbusSlave.Listen().)
Object.

ModbusSlaveRequestReceived Occurs when a modbus slave receives a
request.

current Object.


UnitId Gets or sets the unit ID.
Object
ModbusDevice
ModbusSlave
ModbusSerialSlave

NModbus CreateAscii Method
Namespaces ► Modbus.Device ► ModbusSerialSlave ► CreateAscii()
C#
Members
CreateAscii(Byte, SerialPort) Modbus ASCII slave factory method.
CreateAscii(Byte, Modbus ASCII slave factory method.

IStreamResource)

NModbus CreateAscii Method (unitId, streamResource)
Namespaces ► Modbus.Device ► ModbusSerialSlave ► CreateAscii(Byte,
IStreamResource)
C#
Modbus ASCII slave factory method.
Declaration Syntax
public static ModbusSerialSlave CreateAscii(
byte unitId,
)

unitId As Byte, _
) As ModbusSerialSlave
public:
static ModbusSerialSlave^ CreateAscii(
unsigned char unitId,
)
Parameters
unitId (Byte)

NModbus CreateAscii Method (unitId, serialPort)
Namespaces ► Modbus.Device ► ModbusSerialSlave ► CreateAscii(Byte,
SerialPort)
C#
Modbus ASCII slave factory method.
Declaration Syntax
public static ModbusSerialSlave CreateAscii(
byte unitId,
)

unitId As Byte, _
public:
static ModbusSerialSlave^ CreateAscii(
)
Parameters
unitId (Byte)

NModbus CreateRtu Method
Namespaces ► Modbus.Device ► ModbusSerialSlave ► CreateRtu()
C#
Members
CreateRtu(Byte, SerialPort) Modbus RTU slave factory method.
CreateRtu(Byte, Modbus RTU slave factory method.

IStreamResource)

NModbus CreateRtu Method (unitId, streamResource)
Namespaces ► Modbus.Device ► ModbusSerialSlave ► CreateRtu(Byte,
IStreamResource)
C#
Modbus RTU slave factory method.
Declaration Syntax
public static ModbusSerialSlave CreateRtu(
byte unitId,
)

unitId As Byte, _
public:
static ModbusSerialSlave^ CreateRtu(
)
Parameters
unitId (Byte)

NModbus CreateRtu Method (unitId, serialPort)
Namespaces ► Modbus.Device ► ModbusSerialSlave ► CreateRtu(Byte,
SerialPort)
C#
Modbus RTU slave factory method.
Declaration Syntax
public static ModbusSerialSlave CreateRtu(
byte unitId,
)

unitId As Byte, _
public:
static ModbusSerialSlave^ CreateRtu(
)
Parameters
unitId (Byte)

NModbus Listen Method
Namespaces ► Modbus.Device ► ModbusSerialSlave ► Listen()
C#
Start slave listening for requests.
Declaration Syntax
public override void Listen()
Public Overrides Sub Listen
public:
virtual void Listen() override

NModbus ModbusSlave Class
Namespaces ► Modbus.Device ► ModbusSlave C#
Modbus slave device.
Declaration Syntax
public abstract class ModbusSlave : ModbusDevice
Public MustInherit Class ModbusSlave _

Inherits ModbusDevice
public ref class ModbusSlave abstract : public ModbusDevice
Members

Protected Static
Inherited

managed resources

managed resources



particular type.



Object.

request.

current Object.


Object
ModbusDevice
ModbusSlave
ModbusSerialSlave
ModbusTcpSlave
ModbusUdpSlave

NModbus DataStore Property
Namespaces ► Modbus.Device ► ModbusSlave ► DataStore C#
Gets or sets the data store.
Declaration Syntax
public DataStore DataStore { get; set; }
Public Property DataStore As DataStore
public:
property DataStore^ DataStore {
DataStore^ get ();
void set (DataStore^ value);
}

Namespaces ► Modbus.Device ► ModbusSlave ► Listen() C#
Declaration Syntax
public abstract void Listen()
Public MustOverride Sub Listen
public:
virtual void Listen() abstract

NModbus ModbusSlaveRequestReceived Event
Namespaces ► Modbus.Device ► ModbusSlave ►
ModbusSlaveRequestReceived
C#
Occurs when a modbus slave receives a request.
Declaration Syntax
public event EventHandler<ModbusSlaveRequestEventArgs> ModbusSlave
Public Event ModbusSlaveRequestReceived As EventHandler(Of ModbusS
public:
event EventHandler<ModbusSlaveRequestEventArgs^>^ ModbusSlaveRequ
void add (EventHandler<ModbusSlaveRequestEventArgs^>^ valu
void remove (EventHandler<ModbusSlaveRequestEventArgs^>^
}

NModbus UnitId Property
Namespaces ► Modbus.Device ► ModbusSlave ► UnitId C#
Gets or sets the unit ID.
Declaration Syntax
public byte UnitId { get; set; }
Public Property UnitId As Byte
public:
property unsigned char UnitId {
void set (unsigned char value);
}

NModbus ModbusSlaveRequestEventArgs Class
Namespaces ► Modbus.Device ► ModbusSlaveRequestEventArgs
C#
Modbus Slave request event args containing information on the message.
Declaration Syntax
public class ModbusSlaveRequestEventArgs : EventArgs
Public Class ModbusSlaveRequestEventArgs _

Inherits EventArgs
public ref class ModbusSlaveRequestEventArgs : public EventArgs
Members


type.


Object.

Message Gets the message.

current Object.
Object
EventArgs
ModbusSlaveRequestEventArgs

NModbus Message Property
Namespaces ► Modbus.Device ► ModbusSlaveRequestEventArgs ► Message
C#
Gets the message.
Declaration Syntax
public IModbusMessage Message { get; }
Public ReadOnly Property Message As IModbusMessage
public:
property IModbusMessage^ Message {
IModbusMessage^ get ();
}
Value
The message.

NModbus ModbusTcpSlave Class
Namespaces ► Modbus.Device ► ModbusTcpSlave C#
Modbus TCP slave device.
Declaration Syntax
public class ModbusTcpSlave : ModbusSlave
Public Class ModbusTcpSlave _

public ref class ModbusTcpSlave : public ModbusSlave
Members

Protected Static
Inherited
CreateTcp(Byte, TcpListener) Modbus TCP slave factory method.

managed resources
(Overrides
ModbusDevice.Dispose(Boolean).)
managed resources



particular type.


Masters Gets the Modbus TCP Masters connected
to this Modbus TCP Slave.

Object.

request.

current Object.


Object
ModbusDevice
ModbusSlave
ModbusTcpSlave

NModbus CreateTcp Method (unitId, tcpListener)
Namespaces ► Modbus.Device ► ModbusTcpSlave ► CreateTcp(Byte,
TcpListener)
C#
Modbus TCP slave factory method.
Declaration Syntax
public static ModbusTcpSlave CreateTcp(
byte unitId,
TcpListener tcpListener
)
Public Shared Function CreateTcp ( _

unitId As Byte, _
tcpListener As TcpListener _
) As ModbusTcpSlave
public:
static ModbusTcpSlave^ CreateTcp(
TcpListener^ tcpListener
)
Parameters
unitId (Byte)
tcpListener (TcpListener)

Namespaces ► Modbus.Device ► ModbusTcpSlave ► Dispose(Boolean)
C#
Declaration Syntax
protected override void Dispose(
bool disposing
)
Protected Overrides Sub Dispose ( _

)
protected:
bool disposing
) override
Parameters
disposing (Boolean)
Remarks
Dispose is thread-safe.

Namespaces ► Modbus.Device ► ModbusTcpSlave ► Listen() C#
Declaration Syntax
public:

NModbus Masters Property
Namespaces ► Modbus.Device ► ModbusTcpSlave ► Masters C#
Gets the Modbus TCP Masters connected to this Modbus TCP Slave.
Declaration Syntax
public ReadOnlyCollection<TcpClient> Masters { get; }
Public ReadOnly Property Masters As ReadOnlyCollection(Of TcpClien
public:
property ReadOnlyCollection<TcpClient^>^ Masters {
ReadOnlyCollection<TcpClient^>^ get ();
}

NModbus ModbusUdpSlave Class
Namespaces ► Modbus.Device ► ModbusUdpSlave C#
Modbus UDP slave device.
Declaration Syntax
public class ModbusUdpSlave : ModbusSlave
Public Class ModbusUdpSlave _

public ref class ModbusUdpSlave : public ModbusSlave
Members

Protected Static
Inherited
CreateUdp(UdpClient) Modbus UDP slave factory method.
Creates NModbus UDP slave with default
CreateUdp(Byte, UdpClient) Modbus UDP slave factory method.

managed resources

managed resources



particular type.


Object.

request.

current Object.


Object
ModbusDevice
ModbusSlave
ModbusUdpSlave

NModbus CreateUdp Method
Namespaces ► Modbus.Device ► ModbusUdpSlave ► CreateUdp()
C#
Members
CreateUdp(UdpClient) Modbus UDP slave factory method.
Creates NModbus UDP slave with default
CreateUdp(Byte, UdpClient) Modbus UDP slave factory method.

NModbus CreateUdp Method (unitId, client)
Namespaces ► Modbus.Device ► ModbusUdpSlave ► CreateUdp(Byte,
UdpClient)
C#
Modbus UDP slave factory method.
Declaration Syntax
public static ModbusUdpSlave CreateUdp(
byte unitId,
UdpClient client
)
Public Shared Function CreateUdp ( _

unitId As Byte, _
client As UdpClient _
) As ModbusUdpSlave
public:
static ModbusUdpSlave^ CreateUdp(
UdpClient^ client
)
Parameters
unitId (Byte)
client (UdpClient)

NModbus CreateUdp Method (client)
Namespaces ► Modbus.Device ► ModbusUdpSlave ►
CreateUdp(UdpClient)
C#
Modbus UDP slave factory method. Creates NModbus UDP slave with default
Declaration Syntax
public static ModbusUdpSlave CreateUdp(
UdpClient client
)
Public Shared Function CreateUdp ( _

client As UdpClient _
) As ModbusUdpSlave
public:
static ModbusUdpSlave^ CreateUdp(
UdpClient^ client
)
Parameters
client (UdpClient)

Namespaces ► Modbus.Device ► ModbusUdpSlave ► Listen() C#
Declaration Syntax
public:

NModbus Modbus.IO Namespace
Namespaces ► Modbus.IO C#
Modbus transport IO.
Declaration Syntax
namespace Modbus.IO
Namespace Modbus.IO
namespace Modbus.IO
Types
All Types Classes Interfaces
EmptyTransport Empty placeholder.
IStreamResource Represents a serial resource. Implementor -

http://en.wikipedia.org/wiki/Bridge_Pattern
ModbusSerialTransport Transport for Serial protocols. Refined

Abstraction -
ModbusTransport Modbus transport. Abstraction -

NModbus EmptyTransport Class
Namespaces ► Modbus.IO ► EmptyTransport C#
Empty placeholder.
Declaration Syntax
public class EmptyTransport : ModbusTransport
Public Class EmptyTransport _

Inherits ModbusTransport
public ref class EmptyTransport : public ModbusTransport
Members

Protected Static
Inherited
EmptyTransport() Initializes a new instance of the
EmptyTransport class

(Inherited from ModbusTransport.)

managed resources



type.


Object.

ReadTimeout Gets or sets the number of milliseconds
before a timeout occurs when a read

Retries Number of times to retry sending
message after encountering a failure
such as an IOException,
TimeoutException, or a corrupt message.

current Object.

WaitToRetryMilliseconds Gets or sets the number of milliseconds
the tranport will wait before retrying a
message after receiving an
ACKNOWLEGE or SLAVE DEVICE BUSY
slave exception response.

WriteTimeout Gets or sets the number of milliseconds
before a timeout occurs when a write
Object
ModbusTransport
EmptyTransport

NModbus EmptyTransport Constructor
Namespaces ► Modbus.IO ► EmptyTransport ► EmptyTransport()
C#
Initializes a new instance of the EmptyTransport class
Declaration Syntax
public EmptyTransport()
Public Sub New
public:
EmptyTransport()

NModbus IStreamResource Interface
Namespaces ► Modbus.IO ► IStreamResource C#
Represents a serial resource. Implementor -

Declaration Syntax
public interface IStreamResource : IDisposable
Public Interface IStreamResource _

public interface class IStreamResource : IDisposable
Members
DiscardInBuffer() Purges the receive buffer.


InfiniteTimeout Indicates that no timeout should occur.
Read(Byte[], Int32, Int32) Reads a number of bytes from the input

buffer and writes those bytes into a byte
array at the specified offset.

Write(Byte[], Int32, Int32) Writes a specified number of bytes to the

port from an output buffer, starting at the
specified offset.


NModbus DiscardInBuffer Method
Namespaces ► Modbus.IO ► IStreamResource ► DiscardInBuffer()
C#
Purges the receive buffer.
Declaration Syntax
void DiscardInBuffer()
Sub DiscardInBuffer
void DiscardInBuffer()

NModbus InfiniteTimeout Property
Namespaces ► Modbus.IO ► IStreamResource ► InfiniteTimeout
C#
Indicates that no timeout should occur.
Declaration Syntax
int InfiniteTimeout { get; }
ReadOnly Property InfiniteTimeout As Integer
property int InfiniteTimeout {

int get ();
}

NModbus Read Method (buffer, offset, count)
Namespaces ► Modbus.IO ► IStreamResource ► Read(Byte[], Int32,
Int32)
C#
Reads a number of bytes from the input buffer and writes those bytes into a
byte array at the specified offset.
Declaration Syntax
int Read(
byte[] buffer,
int offset,
int count
)
Function Read ( _
buffer As Byte(), _
count As Integer _
) As Integer
int Read(
int offset,
int count
)
Parameters
buffer ( Byte [])
The byte array to write the input to.
offset (Int32)
count (Int32)
The number of bytes to read.
Return Value
The number of bytes read.

Namespaces ► Modbus.IO ► IStreamResource ► ReadTimeout
C#
Gets or sets the number of milliseconds before a timeout occurs when a read
Declaration Syntax
int ReadTimeout { get; set; }
Property ReadTimeout As Integer
property int ReadTimeout {

int get ();
}

NModbus Write Method (buffer, offset, count)
Namespaces ► Modbus.IO ► IStreamResource ► Write(Byte[], Int32,
Int32)
C#
Writes a specified number of bytes to the port from an output buffer, starting
Declaration Syntax
void Write(
byte[] buffer,
int offset,
int count
)
Sub Write ( _
buffer As Byte(), _
count As Integer _
)
void Write(
int offset,
int count
)
Parameters
buffer ( Byte [])
The byte array that contains the data to write to the port.
offset (Int32)
count (Int32)
The number of bytes to write.

Namespaces ► Modbus.IO ► IStreamResource ► WriteTimeout
C#
Gets or sets the number of milliseconds before a timeout occurs when a write
Declaration Syntax
int WriteTimeout { get; set; }
Property WriteTimeout As Integer
property int WriteTimeout {

int get ();
}

NModbus ModbusSerialTransport Class
Namespaces ► Modbus.IO ► ModbusSerialTransport C#
Transport for Serial protocols. Refined Abstraction -

Declaration Syntax
public abstract class ModbusSerialTransport : ModbusTransport
Public MustInherit Class ModbusSerialTransport _

Inherits ModbusTransport
public ref class ModbusSerialTransport abstract : public ModbusTra
Members
CheckFrame Gets or sets a value indicating whether
LRC/CRC frame checking is performed on
messages.


managed resources


type.


Object.



current Object.

Object
ModbusTransport
ModbusSerialTransport

NModbus CheckFrame Property
Namespaces ► Modbus.IO ► ModbusSerialTransport ► CheckFrame
C#
Gets or sets a value indicating whether LRC/CRC frame checking is performed
on messages.
Declaration Syntax
public bool CheckFrame { get; set; }
Public Property CheckFrame As Boolean
public:
property bool CheckFrame {
bool get ();
void set (bool value);
}

NModbus ModbusTransport Class
Namespaces ► Modbus.IO ► ModbusTransport C#
Modbus transport. Abstraction - http://en.wikipedia.org/wiki/Bridge_Pattern
Declaration Syntax
public abstract class ModbusTransport : IDisposable
Public MustInherit Class ModbusTransport _

public ref class ModbusTransport abstract : IDisposable
Members

managed resources


type.


Object.



current Object.


Object
ModbusTransport
EmptyTransport
ModbusSerialTransport

Namespaces ► Modbus.IO ► ModbusTransport ► Dispose() C#
Members

managed resources

Namespaces ► Modbus.IO ► ModbusTransport ► Dispose() C#
Performs application-defined tasks associated with freeing, releasing, or

Declaration Syntax
Public Sub Dispose
public:

Namespaces ► Modbus.IO ► ModbusTransport ► Dispose(Boolean)
C#
Declaration Syntax
bool disposing
)

)
protected:
bool disposing
)
Parameters
disposing (Boolean)

Namespaces ► Modbus.IO ► ModbusTransport ► ReadTimeout
C#
Gets or sets the number of milliseconds before a timeout occurs when a read
Declaration Syntax
public int ReadTimeout { get; set; }
Public Property ReadTimeout As Integer
public:
property int ReadTimeout {
int get ();
}

NModbus Retries Property
Namespaces ► Modbus.IO ► ModbusTransport ► Retries C#
Number of times to retry sending message after encountering a failure such as

an IOException, TimeoutException, or a corrupt message.
Declaration Syntax
public int Retries { get; set; }
Public Property Retries As Integer
public:
property int Retries {
int get ();
}

NModbus WaitToRetryMilliseconds Property
Namespaces ► Modbus.IO ► ModbusTransport ► WaitToRetryMilliseconds
C#
Gets or sets the number of milliseconds the tranport will wait before retrying a
message after receiving an ACKNOWLEGE or SLAVE DEVICE BUSY slave
exception response.
Declaration Syntax
public int WaitToRetryMilliseconds { get; set; }
Public Property WaitToRetryMilliseconds As Integer
public:
property int WaitToRetryMilliseconds {
int get ();
}

Namespaces ► Modbus.IO ► ModbusTransport ► WriteTimeout
C#
Gets or sets the number of milliseconds before a timeout occurs when a write
Declaration Syntax
public int WriteTimeout { get; set; }
Public Property WriteTimeout As Integer
public:
property int WriteTimeout {
int get ();
}

NModbus Modbus.Message Namespace
Namespaces ► Modbus.Message C#
Modbus messages.
Declaration Syntax
namespace Modbus.Message
Namespace Modbus.Message
namespace Modbus.Message
Types
All Types Interfaces
IModbusMessage A message built by the master (client)
that initiates a Modbus transaction.
IModbusRequest Methods specific to a modbus request

message.
NModbus IModbusMessage Interface
Namespaces ► Modbus.Message ► IModbusMessage C#
A message built by the master (client) that initiates a Modbus transaction.
Declaration Syntax
public interface IModbusMessage
Public Interface IModbusMessage
public interface class IModbusMessage
Members
FunctionCode The function code tells the server what
kind of action to perform.
Initialize(Byte[]) Initializes a modbus message from the

specified message frame.
MessageFrame Composition of the slave address and

protocol data unit.
ProtocolDataUnit Composition of the function code and

message data.
SlaveAddress Address of the slave (server).

TransactionId A unique identifier assigned to a message
when using the IP protocol.

NModbus FunctionCode Property
Namespaces ► Modbus.Message ► IModbusMessage ► FunctionCode
C#
The function code tells the server what kind of action to perform.
Declaration Syntax
byte FunctionCode { get; set; }
Property FunctionCode As Byte
property unsigned char FunctionCode {

}

NModbus Initialize Method (frame)
Namespaces ► Modbus.Message ► IModbusMessage ► Initialize(Byte[])
C#
Initializes a modbus message from the specified message frame.
Declaration Syntax
void Initialize(
byte[] frame
)
Sub Initialize ( _
frame As Byte() _
)
void Initialize(
array<unsigned char>^ frame
)
Parameters
frame ( Byte [])
The frame.

NModbus MessageFrame Property
Namespaces ► Modbus.Message ► IModbusMessage ► MessageFrame
C#
Composition of the slave address and protocol data unit.
Declaration Syntax
byte[] MessageFrame { get; }
ReadOnly Property MessageFrame As Byte()
property array<unsigned char>^ MessageFrame {

}

NModbus ProtocolDataUnit Property
Namespaces ► Modbus.Message ► IModbusMessage ► ProtocolDataUnit
C#
Composition of the function code and message data.
Declaration Syntax
byte[] ProtocolDataUnit { get; }
ReadOnly Property ProtocolDataUnit As Byte()
property array<unsigned char>^ ProtocolDataUnit {

}

NModbus SlaveAddress Property
Namespaces ► Modbus.Message ► IModbusMessage ► SlaveAddress
C#
Address of the slave (server).
Declaration Syntax
byte SlaveAddress { get; set; }
Property SlaveAddress As Byte
property unsigned char SlaveAddress {

}

NModbus TransactionId Property
Namespaces ► Modbus.Message ► IModbusMessage ► TransactionId
C#
A unique identifier assigned to a message when using the IP protocol.
Declaration Syntax
ushort TransactionId { get; set; }
Property TransactionId As UShort
property unsigned short TransactionId {

unsigned short get ();
void set (unsigned short value);
}

NModbus IModbusRequest Interface
Namespaces ► Modbus.Message ► IModbusRequest C#
Methods specific to a modbus request message.
Declaration Syntax
public interface IModbusRequest : IModbusMessage
Public Interface IModbusRequest _

Implements IModbusMessage
public interface class IModbusRequest : IModbusMessage
Members
FunctionCode The function code tells the server
what kind of action to perform.
(Inherited from IModbusMessage.)

Initialize(Byte[]) Initializes a modbus message from
the specified message frame.

MessageFrame Composition of the slave address
and protocol data unit.

ProtocolDataUnit Composition of the function code
and message data.

SlaveAddress Address of the slave (server).
TransactionId A unique identifier assigned to a
message when using the IP
protocol.

ValidateResponse(IModbusMessage) Validate the specified response
against the current request.

NModbus ValidateResponse Method (response)
Namespaces ► Modbus.Message ► IModbusRequest ►
ValidateResponse(IModbusMessage)
C#
Validate the specified response against the current request.
Declaration Syntax
void ValidateResponse(
IModbusMessage response
)
Sub ValidateResponse ( _
response As IModbusMessage _
)
void ValidateResponse(
IModbusMessage^ response
)
Parameters
response (IModbusMessage)

NModbus Modbus.Utility Namespace
Namespaces ► Modbus.Utility C#
Modbus utility methods.
Declaration Syntax
namespace Modbus.Utility
Namespace Modbus.Utility
namespace Modbus.Utility
Types
All Types Classes Enumerations
DiscriminatedUnion<TA, A data type that can store one of two
TB> possible strongly typed options.
DiscriminatedUnionOption Possible options for DiscriminatedUnion

type
ModbusUtility Modbus utility methods.

NModbus DiscriminatedUnion<TA, TB> Class
Namespaces ► Modbus.Utility ► DiscriminatedUnion<TA, TB>
C#
A data type that can store one of two possible strongly typed options.
Declaration Syntax
public class DiscriminatedUnion<TA, TB>
Public Class DiscriminatedUnion(Of TA, TB)
generic<typename TA, typename TB>

public ref class DiscriminatedUnion

TA
The type of option A.
TB
The type of option B.
Members

Protected Static
Inherited
DiscriminatedUnion<TA, TB> Initializes a new instance of the
() DiscriminatedUnion<TA, TB> class
A Gets the value of option A.
B Gets the value of option B.

CreateA(TA) Factory method for creating
DiscriminatedUnion with option A set.
CreateB(TB) Factory method for creating

DiscriminatedUnion with option B set.



type.


Object.

Option Gets the discriminated value option set
for this instance.

current Object.
Object
DiscriminatedUnion<TA, TB>

NModbus DiscriminatedUnion<TA, TB> Constructor
Namespaces ► Modbus.Utility ► DiscriminatedUnion<TA, TB> ►
DiscriminatedUnion<TA, TB>()
C#
Initializes a new instance of the DiscriminatedUnion<TA, TB> class
Declaration Syntax
public DiscriminatedUnion()
Public Sub New
public:
DiscriminatedUnion()

NModbus A Property
Namespaces ► Modbus.Utility ► DiscriminatedUnion<TA, TB> ► A
C#
Gets the value of option A.
Declaration Syntax
public TA A { get; }
Public ReadOnly Property A As TA
public:
property TA A {
TA get ();
}

NModbus B Property
Namespaces ► Modbus.Utility ► DiscriminatedUnion<TA, TB> ► B
C#
Gets the value of option B.
Declaration Syntax
public TB B { get; }
Public ReadOnly Property B As TB
public:
property TB B {
TB get ();
}

NModbus CreateA Method (a)
CreateA(TA)
C#
Factory method for creating DiscriminatedUnion with option A set.
Declaration Syntax
public static DiscriminatedUnion<TA, TB> CreateA(
TA a
)
Public Shared Function CreateA ( _

a As TA _
) As DiscriminatedUnion(Of TA, TB)
public:
static DiscriminatedUnion<TA, TB>^ CreateA(
TA a
)
Parameters
a (TA)

NModbus CreateB Method (b)
CreateB(TB)
C#
Factory method for creating DiscriminatedUnion with option B set.
Declaration Syntax
public static DiscriminatedUnion<TA, TB> CreateB(
TB b
)
Public Shared Function CreateB ( _

b As TB _
) As DiscriminatedUnion(Of TA, TB)
public:
static DiscriminatedUnion<TA, TB>^ CreateB(
TB b
)
Parameters
b (TB)

NModbus Option Property
Namespaces ► Modbus.Utility ► DiscriminatedUnion<TA, TB> ► Option
C#
Gets the discriminated value option set for this instance.
Declaration Syntax
public DiscriminatedUnionOption Option { get; }
Public ReadOnly Property Option As DiscriminatedUnionOption
public:
property DiscriminatedUnionOption Option {
DiscriminatedUnionOption get ();
}

Namespaces ► Modbus.Utility ► DiscriminatedUnion<TA, TB> ► ToString()
C#
Declaration Syntax
public:
Return Value

NModbus DiscriminatedUnionOption Enumeration
Namespaces ► Modbus.Utility ► DiscriminatedUnionOption C#
Possible options for DiscriminatedUnion type
Declaration Syntax
public enum DiscriminatedUnionOption
Public Enumeration DiscriminatedUnionOption
public enum class DiscriminatedUnionOption
Members
Member Description
A Option A
B Option B

NModbus ModbusUtility Class
Namespaces ► Modbus.Utility ► ModbusUtility C#
Modbus utility methods.
Declaration Syntax
public static class ModbusUtility
Public NotInheritable Class ModbusUtility
public ref class ModbusUtility abstract sealed
Members
All Members Methods
CalculateCrc(Byte[]) Calculate Cyclical Redundancy
Check
CalculateLrc(Byte[]) Calculate Longitudinal Redundancy

Check.
GetAsciiBytes(Byte[]) Converts an array of bytes to an

ASCII byte array
GetAsciiBytes(UInt16[]) Converts an array of UInt16 to an

ASCII byte array
GetSingle(UInt16, UInt16) Converts two UInt16 values into a

IEEE 32 floating point format
GetUInt32(UInt16, UInt16) Converts two UInt16 values into a
UInt32
HexToBytes(String) Converts a hex string to a byte

array.
NetworkBytesToHostUInt16(Byte[]) Converts a network order byte

array to an array of UInt16 values
in host order
Object
ModbusUtility

NModbus CalculateCrc Method (data)
Namespaces ► Modbus.Utility ► ModbusUtility ► CalculateCrc(Byte[])
C#
Calculate Cyclical Redundancy Check
Declaration Syntax
public static byte[] CalculateCrc(
byte[] data
)
Public Shared Function CalculateCrc ( _

data As Byte() _
) As Byte()
public:
static array<unsigned char>^ CalculateCrc(
array<unsigned char>^ data
)
Parameters
data ( Byte [])
The data used in CRC
Return Value
CRC value

NModbus CalculateLrc Method (data)
Namespaces ► Modbus.Utility ► ModbusUtility ► CalculateLrc(Byte[])
C#
Calculate Longitudinal Redundancy Check.
Declaration Syntax
public static byte CalculateLrc(
byte[] data
)
Public Shared Function CalculateLrc ( _

data As Byte() _
) As Byte
public:
static unsigned char CalculateLrc(
array<unsigned char>^ data
)
Parameters
data ( Byte [])
The data used in LRC
Return Value
LRC value

NModbus GetAsciiBytes Method
Namespaces ► Modbus.Utility ► ModbusUtility ► GetAsciiBytes()
C#
Members
GetAsciiBytes(Byte[]) Converts an array of bytes to an ASCII
byte array
GetAsciiBytes(UInt16[]) Converts an array of UInt16 to an ASCII

byte array

NModbus GetAsciiBytes Method (numbers)
Namespaces ► Modbus.Utility ► ModbusUtility ► GetAsciiBytes(Byte[])
C#
Converts an array of bytes to an ASCII byte array
Declaration Syntax
public static byte[] GetAsciiBytes(
params byte[] numbers
)
Public Shared Function GetAsciiBytes ( _

ParamArray numbers As Byte() _
) As Byte()
public:
static array<unsigned char>^ GetAsciiBytes(
... array<unsigned char>^ numbers
)
Parameters
numbers ( Byte [])
The byte array
Return Value
An array of ASCII byte values

NModbus GetAsciiBytes Method (numbers)
Namespaces ► Modbus.Utility ► ModbusUtility ► GetAsciiBytes(UInt16[])
C#
Converts an array of UInt16 to an ASCII byte array
Declaration Syntax
public static byte[] GetAsciiBytes(
params ushort[] numbers
)
Public Shared Function GetAsciiBytes ( _

ParamArray numbers As UShort() _
) As Byte()
public:
static array<unsigned char>^ GetAsciiBytes(
... array<unsigned short>^ numbers
)
Parameters
numbers ( UInt16 [])
The ushort array
Return Value
An array of ASCII byte values

GetSingle Method (highOrderValue,
NModbus
lowOrderValue)
Namespaces ► Modbus.Utility ► ModbusUtility ► GetSingle(UInt16,
UInt16)
C#
Converts two UInt16 values into a IEEE 32 floating point format
Declaration Syntax
public static float GetSingle(
ushort highOrderValue,
ushort lowOrderValue
)
Public Shared Function GetSingle ( _

highOrderValue As UShort, _
lowOrderValue As UShort _
) As Single
public:
static float GetSingle(
unsigned short highOrderValue,
unsigned short lowOrderValue
)
Parameters
highOrderValue (UInt16)
High order ushort value
lowOrderValue (UInt16)
Low order ushort value
Return Value
IEEE 32 floating point value

GetUInt32 Method (highOrderValue,
NModbus
lowOrderValue)
Namespaces ► Modbus.Utility ► ModbusUtility ► GetUInt32(UInt16,
UInt16)
C#
Converts two UInt16 values into a UInt32
Declaration Syntax
public static uint GetUInt32(
ushort highOrderValue,
ushort lowOrderValue
)
Public Shared Function GetUInt32 ( _

highOrderValue As UShort, _
lowOrderValue As UShort _
) As UInteger
public:
static unsigned int GetUInt32(
unsigned short highOrderValue,
unsigned short lowOrderValue
)
Parameters
highOrderValue (UInt16)
lowOrderValue (UInt16)

NModbus HexToBytes Method (hex)
Namespaces ► Modbus.Utility ► ModbusUtility ► HexToBytes(String)
C#
Converts a hex string to a byte array.
Declaration Syntax
public static byte[] HexToBytes(
string hex
)
Public Shared Function HexToBytes ( _

hex As String _
) As Byte()
public:
static array<unsigned char>^ HexToBytes(
String^ hex
)
Parameters
hex (String)
The hex string
Return Value
Array of bytes

NetworkBytesToHostUInt16 Method
NModbus
(networkBytes)
Namespaces ► Modbus.Utility ► ModbusUtility ►
NetworkBytesToHostUInt16(Byte[])
C#
Converts a network order byte array to an array of UInt16 values in host orde
Declaration Syntax
public static ushort[] NetworkBytesToHostUInt16(
byte[] networkBytes
)
Public Shared Function NetworkBytesToHostUInt16 ( _

networkBytes As Byte() _
) As UShort()
public:
static array<unsigned short>^ NetworkBytesToHostUInt16(
array<unsigned char>^ networkBytes
)
Parameters
networkBytes ( Byte [])
The network order byte array
Return Value
The host order ushort array

NModbus
Namespaces C#
NModbus is a C# 3.0 implementation of the Modbus protocol.
Namespaces
Namespace Description
FtdAdapter .NET wrapper for Future Device Technologies
USB driver. This assembly contains unsafe
code and must be run with full trust.
Modbus Modbus.
Modbus.Data Modbus data.
Modbus.Device Modbus device.
Modbus.IO Modbus transport IO.
Modbus.Message Modbus messages.
Modbus.Utility Modbus utility methods.

FtdDeviceInfo Class for USB Device Info

Uploaded by

Document Information

Original Description:

Original Title

Copyright

Available Formats

Share this document

Share or Embed Document

Sharing Options

Did you find this document useful?

Is this content inappropriate?

Copyright:

Available Formats

FtdDeviceInfo Class for USB Device Info

Uploaded by

Copyright:

Available Formats

NModbus FtdAdapter Namespace

FtdFlowControl Specifies the flow control used on the

FtdParity Specifies the parity used on the UsbPort

FtdStopBits Specifies the number of stop bits used on

FtdUsbPort Wrapper class for the FTD2XX USB

Provides information about an attached FTDI USB device.

Public Structure FtdDeviceInfo

public value class FtdDeviceInfo

Equality(FtdDeviceInfo, Implements the operator ==.

Equals(Object) Indicates whether this instance and a

(Inherited from Object.)

(Inherited from Object.)

Inequality(FtdDeviceInfo, Implements the operator !=.

IsOpen Gets a value indicating if the device is

MemberwiseClone() Creates a shallow copy of the current

(Inherited from Object.)

SerialNumber Serial number of device.

ToString() Returns the fully qualified type name of

(Inherited from ValueType.)

VendorId Vendor ID.

Public ReadOnly Property Description As String

Assembly: FtdAdapter (Module: FtdAdapter) Version: 1.11.0.0 (1.11.0.0)

Public Shared Operator = ( _

Assembly: FtdAdapter (Module: FtdAdapter) Version: 1.11.0.0 (1.11.0.0)

Indicates whether this instance and a specified object are equal.

Public Overrides Function Equals ( _

Assembly: FtdAdapter (Module: FtdAdapter) Version: 1.11.0.0 (1.11.0.0)

Public ReadOnly Property Flags As UInteger

Assembly: FtdAdapter (Module: FtdAdapter) Version: 1.11.0.0 (1.11.0.0)

Returns the hash code for this instance.

Public Overrides Function GetHashCode As Integer

Assembly: FtdAdapter (Module: FtdAdapter) Version: 1.11.0.0 (1.11.0.0)

Complete device ID, comprising Vendor ID and Product ID.

Public ReadOnly Property Id As UInteger

Assembly: FtdAdapter (Module: FtdAdapter) Version: 1.11.0.0 (1.11.0.0)

Public Shared Operator <> ( _

Assembly: FtdAdapter (Module: FtdAdapter) Version: 1.11.0.0 (1.11.0.0)

Gets a value indicating if the device is already open.

Public ReadOnly Property IsOpen As Boolean

Assembly: FtdAdapter (Module: FtdAdapter) Version: 1.11.0.0 (1.11.0.0)

Public ReadOnly Property LocationId As UInteger

Assembly: FtdAdapter (Module: FtdAdapter) Version: 1.11.0.0 (1.11.0.0)

Public ReadOnly Property ProductId As UInteger

Assembly: FtdAdapter (Module: FtdAdapter) Version: 1.11.0.0 (1.11.0.0)

Serial number of device.

Public ReadOnly Property SerialNumber As String

Assembly: FtdAdapter (Module: FtdAdapter) Version: 1.11.0.0 (1.11.0.0)

Public ReadOnly Property Type As UInteger

Assembly: FtdAdapter (Module: FtdAdapter) Version: 1.11.0.0 (1.11.0.0)

Public ReadOnly Property VendorId As UInteger

Assembly: FtdAdapter (Module: FtdAdapter) Version: 1.11.0.0 (1.11.0.0)

Specifies the flow control used on the UsbPort object.

Public Enumeration FtdFlowControl

public enum class FtdFlowControl

RtsCts RTS CTS are used for flow control

DtrDsr DTR DSR are used for flow control

XonXoff XON XOFF are used for flow control

Assembly: FtdAdapter (Module: FtdAdapter) Version: 1.11.0.0 (1.11.0.0)

Specifies the parity used on the UsbPort object.

Public Enumeration FtdParity

public enum class FtdParity

Mark Leaves the parity bit set to 1.