Documentation

MbusAsciiSlaveProtocol Class

This class realises the server side of the Modbus ASCII slave protocol.
Inheritance Hierarchy
SystemObject
  FieldTalk.Modbus.SlaveMbusSlaveServer
    FieldTalk.Modbus.SlaveMbusSerialServerBase
      FieldTalk.Modbus.SlaveMbusAsciiSlaveProtocol

Namespace:  FieldTalk.Modbus.Slave
Assembly:  FieldTalk.Modbus.Slave (in FieldTalk.Modbus.Slave.dll) Version: 2.11.0-eval+eb1ecbe71c969eff5d7c05d58da16dade0474678
Syntax
public class MbusAsciiSlaveProtocol : MbusSerialServerBase

The MbusAsciiSlaveProtocol type exposes the following members.

Constructors
  NameDescription
Public methodMbusAsciiSlaveProtocol
Instantiates a Modbus ASCII protocol server object.
Top
Properties
  NameDescription
Public propertybaudRate
Baud rate property in bps
(Inherited from MbusSerialServerBase.)
Public propertydataBits
Data bits property
(Inherited from MbusSerialServerBase.)
Public propertyparity
Parity property
(Inherited from MbusSerialServerBase.)
Public propertyportName
Serial port identifier property
(Inherited from MbusSerialServerBase.)
Public propertystopBits
Stop bits property
(Inherited from MbusSerialServerBase.)
Public propertytimeout
Time-out port property
(Inherited from MbusSlaveServer.)
Top
Methods
  NameDescription
Public methodaddDataTable
Associates a protocol object with a Data Provider and a Modbus slave ID.
(Inherited from MbusSlaveServer.)
Public methodDispose
Implement IDisposable.
(Inherited from MbusSlaveServer.)
Public methodenableRs485Mode
Enables RS485 mode.
(Inherited from MbusSerialServerBase.)
Protected methodFinalize
Destructor.
(Inherited from MbusSlaveServer.)
Public methodgetConnectionStatus
Checks if a Modbus master is polling periodically.
(Inherited from MbusSlaveServer.)
Public methodgetSuccessCounter
Returns how often a message transfer was successful.
(Inherited from MbusSlaveServer.)
Public methodgetTimeout
Returns the currently set master time-out supervision value.
(Inherited from MbusSlaveServer.)
Public methodgetTotalCounter
Returns how often a message transfer has been executed.
(Inherited from MbusSlaveServer.)
Public methodisStarted
Returns whether server has been started up.
(Inherited from MbusSlaveServer.)
Public methodresetSuccessCounter
Resets successful message transfer counter.
(Inherited from MbusSlaveServer.)
Public methodresetTotalCounter
Resets total message transfer counter.
(Inherited from MbusSlaveServer.)
Public methodserverLoop
Modbus slave server loop
(Inherited from MbusSlaveServer.)
Public methodsetTimeout
Configures master transmit time-out supervision.
(Inherited from MbusSlaveServer.)
Public methodshutdownServer
Shuts down the Modbus Server.
(Inherited from MbusSlaveServer.)
Public methodstartupServer
Opens a serial Modbus protocol and the associated serial port with the port parameters configured via properties
(Inherited from MbusSerialServerBase.)
Public methodstartupServer(String, Int32, Int32, Int32, Int32)
Opens a serial Modbus protocol and the associated serial port with the port parameters configured via properties
(Inherited from MbusSerialServerBase.)
Top
Remarks
This class provides functions to start-up and to execute the Modbus ASCII server engine which includes opening and closing of the serial port. Upon receipt of a valid master query the server engine calls Data Provider methods to exchange data with the user application.

For a more detailed description which Modbus data and control functions have been implemented in the server engine see section Server Functions common to all Protocol Flavours.

It is possible to instantiate multiple instances for establishing multiple connections on different serial ports, however they must be executed in separate threads.

Thread Safety
Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.
See Also