Extended Lufkin Automation Modbus Master Protocol. More...

Public Types
enum	{ SER_DATABITS_7 = 7, SER_DATABITS_8 = 8 }

enum	{ SER_STOPBITS_1 = 1, SER_STOPBITS_2 = 2 }

enum	{ SER_PARITY_NONE = 0, SER_PARITY_EVEN = 2, SER_PARITY_ODD = 1 }

Public Member Functions
	MbusElamMasterProtocol ()
	Constructs a MbusElamMasterProtocol object and initialises its data.

virtual int	openProtocol (const char *const portName, long baudRate, int dataBits, int stopBits, int parity)
	Opens a Modbus RTU protocol and the associated serial port with specific port parameters. More...

virtual void	closeProtocol ()
	Closes an open protocol including any associated communication resources (com ports or sockets).

virtual int	isOpen ()

virtual int	enableRs485Mode (int rtsDelay)
	Enables RS485 mode. More...

Bit Access
Table 0:00000 (Coils) and Table 1:0000 (Input Status)
int	readCoils (int slaveAddr, int startRef, int bitArr[], int refCnt)
	Modbus function 1, Read Coil Status/Read Coils. More...

int	readInputDiscretes (int slaveAddr, int startRef, int bitArr[], int refCnt)
	Modbus function 2, Read Inputs Status/Read Input Discretes. More...

int	writeCoil (int slaveAddr, int bitAddr, int bitVal)
	Modbus function 5, Force Single Coil/Write Coil. More...

int	forceMultipleCoils (int slaveAddr, int startRef, const int bitArr[], int refCnt)
	Modbus function 15 (0F Hex), Force Multiple Coils. More...

16-bit Access
Table 4:00000 (Holding Registers) and Table 3:00000 (Input Registers)
int	readMultipleRegisters (int slaveAddr, int startRef, short regArr[], int refCnt)
	Modbus function 3, Read Holding Registers/Read Multiple Registers. More...

int	readInputRegisters (int slaveAddr, int startRef, short regArr[], int refCnt)
	Modbus function 4, Read Input Registers. More...

int	writeSingleRegister (int slaveAddr, int regAddr, short regVal)
	Modbus function 6, Preset Single Register/Write Single Register. More...

int	writeMultipleRegisters (int slaveAddr, int startRef, const short regArr[], int refCnt)
	Modbus function 16 (10 Hex), Preset Multiple Registers/Write Multiple Registers. More...

int	maskWriteRegister (int slaveAddr, int regAddr, short andMask, short orMask)
	Modbus function 22 (16 Hex), Mask Write Register. More...

int	readWriteRegisters (int slaveAddr, int readRef, short readArr[], int readCnt, int writeRef, const short writeArr[], int writeCnt)
	Modbus function 23 (17 Hex), Read/Write Registers. More...

32-bit Access
Table 4:00000 (Holding Registers) and Table 3:00000 (Input Registers)
int	readMultipleLongInts (int slaveAddr, int startRef, int int32Arr[], int refCnt)
	Modbus function 3 for 32-bit long int data types, Read Holding Registers/Read Multiple Registers as long int data. More...

int	readInputLongInts (int slaveAddr, int startRef, int int32Arr[], int refCnt)
	Modbus function 4 for 32-bit long int data types, Read Input Registers as long int data. More...

int	writeMultipleLongInts (int slaveAddr, int startRef, const int int32Arr[], int refCnt)
	Modbus function 16 (10 Hex) for 32-bit long int data types, Preset Multiple Registers/Write Multiple Registers with long int data. More...

int	readMultipleFloats (int slaveAddr, int startRef, float float32Arr[], int refCnt)
	Modbus function 3 for 32-bit float data types, Read Holding Registers/Read Multiple Registers as float data. More...

int	readInputFloats (int slaveAddr, int startRef, float float32Arr[], int refCnt)
	Modbus function 4 for 32-bit float data types, Read Input Registers as float data. More...

int	writeMultipleFloats (int slaveAddr, int startRef, const float float32Arr[], int refCnt)
	Modbus function 16 (10 Hex) for 32-bit float data types, Preset Multiple Registers/Write Multiple Registers with float data. More...

int	readMultipleMod10000 (int slaveAddr, int startRef, int int32Arr[], int refCnt)
	Modbus function 3 for 32-bit modulo-10000 long int data types, Read Holding Registers/Read Multiple Registers as modulo-10000 long int data. More...

int	readInputMod10000 (int slaveAddr, int startRef, int int32Arr[], int refCnt)
	Modbus function 4 for 32-bit modulo-10000 long int data types, Read Input Registers as modulo-10000 long int data. More...

int	writeMultipleMod10000 (int slaveAddr, int startRef, const int int32Arr[], int refCnt)
	Modbus function 16 (10 Hex) for 32-bit modulo-10000 long int data types, Preset Multiple Registers/Write Multiple Registers with modulo-10000 long int data. More...

64-bit Access
Table 4:00000 (Holding Registers) and Table 3:00000 (Input Registers)
int	readHoldingRegistersI64 (int slaveAddr, int startRef, int64_t int64Arr[], int refCnt)
	Modbus function 3 for 64-bit integer data, Read Holding Registers as int64_t type. More...

int	readInputRegistersI64 (int slaveAddr, int startRef, int64_t int64Arr[], int refCnt)
	Modbus function 4 for 64-bit integer data, Read Holding Registers as int64_t type. More...

int	writeMultipleRegistersI64 (int slaveAddr, int startRef, const int64_t int64Arr[], int refCnt)
	Modbus function 16 (10 Hex) for 64-bit integer data, Write Multiple Registers as int64_t type. More...

int	readHoldingRegistersF64 (int slaveAddr, int startRef, double double64Arr[], int refCnt)
	Modbus function 3 for 64-bit floating point data, Read Input Registers as double type. More...

int	readInputRegistersF64 (int slaveAddr, int startRef, double double64Arr[], int refCnt)
	Modbus function 4 for 64-bit floating point data, Read Input Registers as double type. More...

int	writeMultipleRegistersF64 (int slaveAddr, int startRef, const double double64Arr[], int refCnt)
	Modbus function 16 (10 Hex) for 64-bit floating point data, Write Multiple Registers as double type. More...

File Record Access
int	readFileRecord (int slaveAddr, int refType, int fileNo, int recordNo, short recordArr[], int recordCnt)
	Modbus function 20, Read File Record. More...

int	readFileRecord (int slaveAddr, FileSubRequest subReqArr[], int subReqCnt)
	Modbus function 20, Read File Record. More...

int	writeFileRecord (int slaveAddr, int refType, int fileNo, int recordNo, const short recordArr[], int recordCnt)
	Modbus function 21, Write File Record. More...

int	writeFileRecord (int slaveAddr, const FileSubRequest subReqArr[], int subReqCnt)
	Modbus function 21, Write File Record. More...

Diagnostics
int	readExceptionStatus (int slaveAddr, unsigned char *statusBytePtr)
	Modbus function 7, Read Exception Status. More...

int	returnQueryData (int slaveAddr, const unsigned char queryArr[], unsigned char echoArr[], int len)
	Modbus function code 8, sub-function 00, Return Query Data. More...

int	restartCommunicationsOption (int slaveAddr, int clearEventLog)
	Modbus function code 8, sub-function 01, Restart Communications Option. More...

int	readDeviceIdentification (int slaveAddr, int accessType, int objId, DeviceIdObjectList *objListPtr)
	Modbus function 43 (hex 2B) subfunction 14 (hex 0E), Read Device Identification. More...

Custom Function Codes
int	customFunction (int slaveAddr, int functionCode, void requestData, size_t requestLen, void responseData, size_t *responseLenPtr)
	User Defined Function CodeThis method can be used to implement User Defined Function Codes. More...

Protocol Configuration
int	setTimeout (int timeOut)
	Configures time-out. More...

int	getTimeout ()
	Returns the time-out value. More...

int	setPollDelay (int pollDelay)
	Configures poll delay. More...

int	getPollDelay ()
	Returns the poll delay time. More...

int	setRetryCnt (int retryCnt)
	Configures the automatic retry setting. More...

int	getRetryCnt ()
	Returns the automatic retry count. More...

Transmission Statistic Functions
long	getTotalCounter ()
	Returns how often a message transfer has been executed. More...

void	resetTotalCounter ()
	Resets total message transfer counter.

long	getSuccessCounter ()
	Returns how often a message transfer was successful. More...

void	resetSuccessCounter ()
	Resets successful message transfer counter.

Slave Configuration
void	configureBigEndianInts ()
	Configures 32-bit int data type functions to do a word swap. More...

int	configureBigEndianInts (int slaveAddr)
	Enables int data type functions to do a word swap on a per slave basis. More...

void	configureLittleEndianInts ()
	Configures 32-bit int data type functions not to do a word swap. More...

int	configureLittleEndianInts (int slaveAddr)
	Disables word swapping for int data type functions on a per slave basis. More...

void	configureIeeeFloats ()
	Configures float data type functions not to do a word swap. More...

int	configureIeeeFloats (int slaveAddr)
	Disables float data type functions to do a word swap on a per slave basis. More...

void	configureSwappedFloats ()
	Configures float data type functions to do a word swap. More...

int	configureSwappedFloats (int slaveAddr)
	Enables float data type functions to do a word swap on a per slave basis. More...

void	configureStandard32BitMode ()
	Configures all slaves for Standard 32-bit Mode. More...

int	configureStandard32BitMode (int slaveAddr)
	Configures a slave for Standard 32-bit Register Mode. More...

void	configureEnron32BitMode ()
	Configures all slaves for Daniel/ENRON 32-bit Mode. More...

int	configureEnron32BitMode (int slaveAddr)
	Configures all slaves for Daniel/ENRON 32-bit Mode. More...

void	configureCountFromOne ()
	Configures the reference counting scheme to start with one for all slaves. More...

int	configureCountFromOne (int slaveAddr)
	Configures a slave's reference counting scheme to start with one. More...

void	configureCountFromZero ()
	Configures the reference counting scheme to start with zero for all slaves. More...

int	configureCountFromZero (int slaveAddr)
	Configures a slave's reference counting scheme to start with zero. More...

Utility Functions
static const TCHAR *	getPackageVersion ()
	Returns the library version number. More...

Detailed Description

Extended Lufkin Automation Modbus Master Protocol.

This class realizes the Extended Lufkin Automation (ELAM) Modbus protocol. This proprietary Modbus extension allows adressing of up to 2295 slave units and the retrieval of up to 2500 registers for Modbus functions 3 and 4.

It's implementation is based on the specification "ELAM Extended Lufkin Automation Modbus Version 1.01" published by LUFKIN Automation. The ELAM multiple instruction requests extensions are not implemented.

Tests showed the following size limits with a LUFKIN SAM Well Manager device:

Coils: 1992 for read Registers: 2500 to read, 60 for write

See also: Data and Control Functions for all Modbus Protocol Flavours, Serial Protocols; MbusRtuMasterProtocol

Member Enumeration Documentation

◆ anonymous enum

anonymous enum

inherited

Enumerator
SER_DATABITS_7	7 data bits
SER_DATABITS_8	8 data bits

◆ anonymous enum

anonymous enum

inherited

Enumerator
SER_STOPBITS_1	1 stop bit
SER_STOPBITS_2	2 stop bits

◆ anonymous enum

anonymous enum

inherited

Enumerator
SER_PARITY_NONE	No parity.
SER_PARITY_EVEN	Even parity.
SER_PARITY_ODD	Odd parity.

Member Function Documentation

◆ openProtocol()

int openProtocol	(	const char *const	portName,
		long	baudRate,
		int	dataBits,
		int	stopBits,
		int	parity
	)

virtualinherited

Opens a Modbus RTU protocol and the associated serial port with specific port parameters.

This function opens the serial port. After a port has been opened, data and control functions can be used.

Note: The default time-out for the data transfer is 1000 ms.; The default poll delay is 0 ms.; Automatic retries are switched off (retry count is 0).; The Modbus standard requires two stop bits if no parity is chosen. This library is not enforcing this but it is a recommended configuration.

Parameters

portName	Serial port identifier (e.g. "COM1", "/dev/ser1" or "/dev/ttyS0")
baudRate	The port baudRate in bps (typically 1200 - 115200, maximum value depends on UART hardware)
dataBits	Must be SER_DATABITS_8 for RTU
stopBits	SER_STOPBITS_1: 1 stop bit, SER_STOPBITS_2: 2 stop bits
parity	SER_PARITY_NONE: no parity, SER_PARITY_ODD: odd parity, SER_PARITY_EVEN: even parity

Returns: FTALK_SUCCESS on success or error code. See Error Management for a list of error codes.

Reimplemented from MbusSerialClientBase.

References FTALK_ILLEGAL_ARGUMENT_ERROR, MbusSerialClientBase::openProtocol(), and MbusSerialClientBase::SER_DATABITS_8.

◆ isOpen()

int isOpen ( )

virtualinherited

Deprecated:: Returns whether the protocol is open or not.

This simply returns the state of an internal flag whether openProtocol() has been called or not.

Note: This function does not report the state of the underlaying transport network, in particular it does not report whether the TCP connection is still in 'established' state or in fully 'closed' state.

Return values

true	= open
false	= closed

Implements MbusMasterFunctions.

◆ enableRs485Mode()

int enableRs485Mode ( int rtsDelay )

virtualinherited

Enables RS485 mode.

In RS485 mode the RTS signal can be used to enable and disable the transmitter of a RS232/RS485 converter. The RTS signal is asserted before sending data. It is cleared after the transmit buffer has been emptied and in addition the specified delay time has elapsed. The delay time is necessary because even the transmit buffer is already empty, the UART's FIFO will still contain unsent characters.

Warning: The use of RTS controlled RS232/RS485 converters should be avoided if possible. It is difficult to determine the exact time when to switch off the transmitter with non real-time operating systems like Windows and Linux. If it is switched off to early characters might still sit in the FIFO or the transmit register of the UART and these characters will be lost. Hence the slave will not recognize the message. On the other hand if it is switched off too late then the slave's message is corrupted and the master will not recognize the message.

Remarks: The delay value is indicative only and not guaranteed to be maintained. How precise it is followed depends on the operating system used, it's scheduling priority and it's system timer resolution.

Note: A protocol must be closed in order to configure it.

Parameters

rtsDelay Delay time in ms (Range: 0 - 100000) which applies after the transmit buffer is empty. 0 disables this mode.

Return values

FTALK_SUCCESS	Success
FTALK_ILLEGAL_ARGUMENT_ERROR	Argument out of range
FTALK_ILLEGAL_STATE_ERROR	Protocol is already open

References FTALK_ILLEGAL_ARGUMENT_ERROR, FTALK_ILLEGAL_STATE_ERROR, FTALK_SUCCESS, and MbusSerialClientBase::isOpen().

◆ readCoils()

int readCoils	(	int	slaveAddr,
		int	startRef,
		int	bitArr[],
		int	refCnt
	)

inherited

Modbus function 1, Read Coil Status/Read Coils.

Reads the contents of the discrete outputs (coils, 0:00000 table).

Parameters

slaveAddr	Modbus address of slave device or unit identifier (Range: 1 - 255)
startRef	Start reference (Range: 1 - 65536)
bitArr	Buffer which will contain the data read
refCnt	Number of coils to be read (Range: 1-2000)

Returns: FTALK_SUCCESS on success or error code. See Error Management for a list of error codes.

Note: No broadcast supported

◆ readInputDiscretes()

int readInputDiscretes	(	int	slaveAddr,
		int	startRef,
		int	bitArr[],
		int	refCnt
	)

inherited

Modbus function 2, Read Inputs Status/Read Input Discretes.

Reads the contents of the discrete inputs (input status, 1:00000 table).

Parameters

slaveAddr	Modbus address of slave device or unit identifier (Range: 1 - 255)
startRef	Start reference (Range: 1 - 65536)
bitArr	Buffer which will contain the data read
refCnt	Number of coils to be read (Range: 1-2000)

Returns: FTALK_SUCCESS on success or error code. See Error Management for a list of error codes.

Note: No broadcast supported

◆ writeCoil()

int writeCoil	(	int	slaveAddr,
		int	bitAddr,
		int	bitVal
	)

inherited

Modbus function 5, Force Single Coil/Write Coil.

Sets a single discrete output variable (coil, 0:00000 table) to either ON or OFF.

Parameters

slaveAddr	Modbus address of slave device or unit identifier (Range: 0 - 255)
bitAddr	Coil address (Range: 1 - 65536)
bitVal	true sets, false clears discrete output variable

Returns: FTALK_SUCCESS on success or error code. See Error Management for a list of error codes.

Note: Broadcast supported for serial protocols

References FTALK_ILLEGAL_ARGUMENT_ERROR, FTALK_INVALID_REPLY_ERROR, and FTALK_SUCCESS.

◆ forceMultipleCoils()

int forceMultipleCoils	(	int	slaveAddr,
		int	startRef,
		const int	bitArr[],
		int	refCnt
	)

inherited

Modbus function 15 (0F Hex), Force Multiple Coils.

Writes binary values into a sequence of discrete outputs (coils, 0:00000 table).

Parameters

slaveAddr	Modbus address of slave device or unit identifier (Range: 0 - 255)
startRef	Start reference (Range: 1 - 65536)
bitArr	Buffer which contains the data to be sent
refCnt	Number of coils to be written (Range: 1-1968)

Returns: FTALK_SUCCESS on success or error code. See Error Management for a list of error codes.

Note: Broadcast supported for serial protocols

References FTALK_ILLEGAL_ARGUMENT_ERROR, FTALK_INVALID_REPLY_ERROR, and FTALK_SUCCESS.

◆ readMultipleRegisters()

int readMultipleRegisters	(	int	slaveAddr,
		int	startRef,
		short	regArr[],
		int	refCnt
	)

inherited

Modbus function 3, Read Holding Registers/Read Multiple Registers.

Reads the contents of the output registers (holding registers, 4:00000 table).

Parameters

slaveAddr	Modbus address of slave device or unit identifier (Range: 1 - 255)
startRef	Start register (Range: 1 - 65536)
regArr	Buffer which will be filled with the data read
refCnt	Number of registers to be read (Range: 1-125)

Returns: FTALK_SUCCESS on success or error code. See Error Management for a list of error codes.

Note: No broadcast supported

◆ readInputRegisters()

int readInputRegisters	(	int	slaveAddr,
		int	startRef,
		short	regArr[],
		int	refCnt
	)

inherited

Modbus function 4, Read Input Registers.

Read the contents of the input registers (3:00000 table).

Parameters

slaveAddr	Modbus address of slave device or unit identifier (Range: 1 - 255)
startRef	Start register (Range: 1 - 65536)
regArr	Buffer which will be filled with the data read.
refCnt	Number of registers to be read (Range: 1-125)

Returns: FTALK_SUCCESS on success or error code. See Error Management for a list of error codes.

Note: No broadcast supported

◆ writeSingleRegister()

int writeSingleRegister	(	int	slaveAddr,
		int	regAddr,
		short	regVal
	)

inherited

Modbus function 6, Preset Single Register/Write Single Register.

Writes a value into a single output register (holding register, 4:00000 reference).

Parameters

slaveAddr	Modbus address of slave device or unit identifier (Range: 0 - 255)
regAddr	Register address (Range: 1 - 65536)
regVal	Data to be sent

Returns: FTALK_SUCCESS on success or error code. See Error Management for a list of error codes.

Note: Broadcast supported for serial protocols

References FTALK_ILLEGAL_ARGUMENT_ERROR, FTALK_INVALID_REPLY_ERROR, and FTALK_SUCCESS.

◆ writeMultipleRegisters()

int writeMultipleRegisters	(	int	slaveAddr,
		int	startRef,
		const short	regArr[],
		int	refCnt
	)

inherited

Modbus function 16 (10 Hex), Preset Multiple Registers/Write Multiple Registers.

Writes values into a sequence of output registers (holding registers, 4:00000 table).

Parameters

slaveAddr	Modbus address of slave device or unit identifier (Range: 0 - 255)
startRef	Start register (Range: 1 - 65536)
regArr	Buffer with the data to be sent.
refCnt	Number of registers to be written (Range: 1-123)

Returns: FTALK_SUCCESS on success or error code. See Error Management for a list of error codes.

Note: Broadcast supported for serial protocols

◆ maskWriteRegister()

int maskWriteRegister	(	int	slaveAddr,
		int	regAddr,
		short	andMask,
		short	orMask
	)

inherited

Modbus function 22 (16 Hex), Mask Write Register.

Masks bits according to an AND & an OR mask into a single output register (holding register, 4:00000 reference). Masking is done as follows: result = (currentVal AND andMask) OR (orMask AND (NOT andMask))

Parameters

slaveAddr	Modbus address of slave device or unit identifier (Range: 1 - 255 for serial, 0 - 255 for TCP)
regAddr	Register address (Range: 1 - 65536)
andMask	Mask to be applied as a logic AND to the register
orMask	Mask to be applied as a logic OR to the register

Note: No broadcast supported

References FTALK_ILLEGAL_ARGUMENT_ERROR, FTALK_INVALID_REPLY_ERROR, and FTALK_SUCCESS.

◆ readWriteRegisters()

int readWriteRegisters	(	int	slaveAddr,
		int	readRef,
		short	readArr[],
		int	readCnt,
		int	writeRef,
		const short	writeArr[],
		int	writeCnt
	)

inherited

Modbus function 23 (17 Hex), Read/Write Registers.

Combines reading and writing of the output registers in one transaction (holding registers, 4:00000 table).

Parameters

slaveAddr	Modbus address of slave device or unit identifier (Range: 1 - 255 for serial, 0 - 255 for TCP)
readRef	Start register for reading (Range: 1 - 65536)
readArr	Buffer which will contain the data read
readCnt	Number of registers to be read (Range: 1-125)
writeRef	Start register for writing (Range: 1 - 65536)
writeArr	Buffer with data to be sent
writeCnt	Number of registers to be written (Range: 1-121)

Returns: FTALK_SUCCESS on success or error code. See Error Management for a list of error codes.

Note: No broadcast supported

References FTALK_ILLEGAL_ARGUMENT_ERROR, FTALK_INVALID_REPLY_ERROR, and FTALK_SUCCESS.

◆ readMultipleLongInts()

int readMultipleLongInts	(	int	slaveAddr,
		int	startRef,
		int	int32Arr[],
		int	refCnt
	)

inherited

Modbus function 3 for 32-bit long int data types, Read Holding Registers/Read Multiple Registers as long int data.

Reads the contents of pairs of consecutive output registers (holding registers, 4:00000 table) into 32-bit long int values.

Remarks: Depending on the 32-bit Mode setting, an int will be transferred as two consecutive 16-bit registers (Standard) or as one 32-bit register (Daniel/Enron).

Parameters

slaveAddr	Modbus address of slave device or unit identifier (Range: 1 - 255)
startRef	Start reference (Range: 1 - 65536)
int32Arr	Buffer which will be filled with the data read
refCnt	Number of values to be read (Range: 1-62)

Returns: FTALK_SUCCESS on success or error code. See Error Management for a list of error codes.

Note: No broadcast supported

◆ readInputLongInts()

int readInputLongInts	(	int	slaveAddr,
		int	startRef,
		int	int32Arr[],
		int	refCnt
	)

inherited

Modbus function 4 for 32-bit long int data types, Read Input Registers as long int data.

Reads the contents of pairs of consecutive input registers (3:00000 table) into 32-bit long int values.

Remarks: Depending on the 32-bit Mode setting, an int will be transferred as two consecutive 16-bit registers (Standard) or as one 32-bit register (Daniel/Enron).

Parameters

slaveAddr	Modbus address of slave device or unit identifier (Range: 1 - 255)
startRef	Start reference (Range: 1 - 65536)
int32Arr	Buffer which will be filled with the data read
refCnt	Number of values to be read (Range: 1-62)

Returns: FTALK_SUCCESS on success or error code. See Error Management for a list of error codes.

Note: No broadcast supported

◆ writeMultipleLongInts()

int writeMultipleLongInts	(	int	slaveAddr,
		int	startRef,
		const int	int32Arr[],
		int	refCnt
	)

inherited

Modbus function 16 (10 Hex) for 32-bit long int data types, Preset Multiple Registers/Write Multiple Registers with long int data.

Writes long int values into pairs of output registers (holding registers, 4:00000 table).

Remarks: Depending on the 32-bit Mode setting, an int will be transferred as two consecutive 16-bit registers (Standard) or as one 32-bit register (Daniel/Enron).

Parameters

slaveAddr	Modbus address of slave device or unit identifier (Range: 0 - 255)
startRef	Start reference (Range: 1 - 65536)
int32Arr	Buffer with the data to be sent
refCnt	Number of values to be sent (Range: 1-61)

Returns: FTALK_SUCCESS on success or error code. See Error Management for a list of error codes.

Note: Broadcast supported for serial protocols

References FTALK_ILLEGAL_ARGUMENT_ERROR.

◆ readMultipleFloats()

int readMultipleFloats	(	int	slaveAddr,
		int	startRef,
		float	float32Arr[],
		int	refCnt
	)

inherited

Modbus function 3 for 32-bit float data types, Read Holding Registers/Read Multiple Registers as float data.

Reads the contents of pairs of consecutive output registers (holding registers, 4:00000 table) into float values.

Remarks: Depending on the 32-bit Mode setting, an int will be transferred as two consecutive 16-bit registers (Standard) or as one 32-bit register (Daniel/Enron).

Parameters

slaveAddr	Modbus address of slave device or unit identifier (Range: 1 - 255)
startRef	Start reference (Range: 1 - 65536)
float32Arr	Buffer which will be filled with the data read
refCnt	Number of values to be read (Range: 1-62)

Returns: FTALK_SUCCESS on success or error code. See Error Management for a list of error codes.

Note: No broadcast supported

◆ readInputFloats()

int readInputFloats	(	int	slaveAddr,
		int	startRef,
		float	float32Arr[],
		int	refCnt
	)

inherited

Modbus function 4 for 32-bit float data types, Read Input Registers as float data.

Reads the contents of pairs of consecutive input registers (3:00000 table) into float values.

Remarks: Depending on the 32-bit Mode setting, an int will be transferred as two consecutive 16-bit registers (Standard) or as one 32-bit register (Daniel/Enron).

Parameters

slaveAddr	Modbus address of slave device or unit identifier (Range: 1 - 255)
startRef	Start reference (Range: 1 - 65536)
float32Arr	Buffer which will be filled with the data read
refCnt	Number of values to be read (Range: 1-62)

Returns: FTALK_SUCCESS on success or error code. See Error Management for a list of error codes.

Note: No broadcast supported

◆ writeMultipleFloats()

int writeMultipleFloats	(	int	slaveAddr,
		int	startRef,
		const float	float32Arr[],
		int	refCnt
	)

inherited

Modbus function 16 (10 Hex) for 32-bit float data types, Preset Multiple Registers/Write Multiple Registers with float data.

Writes float values into pairs of output registers (holding registers, 4:00000 table).

Remarks: Depending on the 32-bit Mode setting, an int will be transferred as two consecutive 16-bit registers (Standard) or as one 32-bit register (Daniel/Enron).

Parameters

slaveAddr	Modbus address of slave device or unit identifier (Range: 0 - 255)
startRef	Start reference (Range: 1 - 65536)
float32Arr	Buffer with the data to be sent
refCnt	Number of values to be sent (Range: 1-61)

Returns: FTALK_SUCCESS on success or error code. See Error Management for a list of error codes.

Note: Broadcast supported for serial protocols

References FTALK_ILLEGAL_ARGUMENT_ERROR.

◆ readMultipleMod10000()

int readMultipleMod10000	(	int	slaveAddr,
		int	startRef,
		int	int32Arr[],
		int	refCnt
	)

inherited

Modbus function 3 for 32-bit modulo-10000 long int data types, Read Holding Registers/Read Multiple Registers as modulo-10000 long int data.

Reads the contents of pairs of consecutive output registers (holding registers, 4:00000 table) representing a modulo-10000 long int value into 32-bit int values and performs number format conversion.

Remarks: Depending on the 32-bit Mode setting, an int will be transferred as two consecutive 16-bit registers (Standard) or as one 32-bit register (Daniel/Enron).

Parameters

slaveAddr	Modbus address of slave device or unit identifier (Range: 1 - 255)
startRef	Start reference (Range: 1 - 65536)
int32Arr	Buffer which will be filled with the data read
refCnt	Number of M10K integers to be read (Range: 1-62)

Returns: FTALK_SUCCESS on success or error code. See Error Management for a list of error codes.

Note: No broadcast supported

◆ readInputMod10000()

int readInputMod10000	(	int	slaveAddr,
		int	startRef,
		int	int32Arr[],
		int	refCnt
	)

inherited

Modbus function 4 for 32-bit modulo-10000 long int data types, Read Input Registers as modulo-10000 long int data.

Reads the contents of pairs of consecutive input registers (3:00000 table) representing a modulo-10000 long int value into 32-bit long int values and performs number format conversion.

Remarks: Depending on the 32-bit Mode setting, an int will be transferred as two consecutive 16-bit registers (Standard) or as one 32-bit register (Daniel/Enron).

Parameters

slaveAddr	Modbus address of slave device or unit identifier (Range: 1 - 255)
startRef	Start reference (Range: 1 - 65536)
int32Arr	Buffer which will be filled with the data read
refCnt	Number of M10K integers to be read (Range: 1-62)

Returns: FTALK_SUCCESS on success or error code. See Error Management for a list of error codes.

Note: No broadcast supported

◆ writeMultipleMod10000()

int writeMultipleMod10000	(	int	slaveAddr,
		int	startRef,
		const int	int32Arr[],
		int	refCnt
	)

inherited

Modbus function 16 (10 Hex) for 32-bit modulo-10000 long int data types, Preset Multiple Registers/Write Multiple Registers with modulo-10000 long int data.

Writes long int values into pairs of output registers (holding registers, 4:00000 table) representing a modulo-10000 long int value and performs number format conversion.

Remarks: Depending on the 32-bit Mode setting, an int will be transferred as two consecutive 16-bit registers (Standard) or as one 32-bit register (Daniel/Enron).

Parameters

slaveAddr	Modbus address of slave device or unit identifier (Range: 0 - 255)
startRef	Start reference (Range: 1 - 65536)
int32Arr	Buffer with the data to be sent
refCnt	Number of values values to be sent (Range: 1-61)

Returns: FTALK_SUCCESS on success or error code. See Error Management for a list of error codes.

Note: Broadcast supported for serial protocols

References FTALK_ILLEGAL_ARGUMENT_ERROR.

◆ readHoldingRegistersI64()

int readHoldingRegistersI64	(	int	slaveAddr,
		int	startRef,
		int64_t	int64Arr[],
		int	refCnt
	)

inherited

Modbus function 3 for 64-bit integer data, Read Holding Registers as int64_t type.

Reads the contents of quartets of consecutive holding registers (4:00000 table) into 64-bit integer values.

Remarks: Depending on the 32-bit Mode setting, an int64_t will be transferred as four consecutive 16-bit registers (Standard) or as two 32-bit registers (Daniel/Enron).

Parameters

slaveAddr	Modbus address of slave device or unit identifier (Range: 1 - 255)
startRef	Start reference (Range: 1 - 65536)
int64Arr	Buffer which will be filled with the data read
refCnt	Number of values to be read (Range: 1-31)

Returns: FTALK_SUCCESS on success or error code. See Error Management for a list of error codes.

Note: No broadcast supported

◆ readInputRegistersI64()

int readInputRegistersI64	(	int	slaveAddr,
		int	startRef,
		int64_t	int64Arr[],
		int	refCnt
	)

inherited

Modbus function 4 for 64-bit integer data, Read Holding Registers as int64_t type.

Reads the contents of quartets of consecutive input registers (3:00000 table) into 64-bit integer values.

Remarks: Depending on the 32-bit Mode setting, an int64_t will be transferred as four consecutive 16-bit registers (Standard) or as two 32-bit registers (Daniel/Enron).

Parameters

slaveAddr	Modbus address of slave device or unit identifier (Range: 1 - 255)
startRef	Start reference (Range: 1 - 65536)
int64Arr	Buffer which will be filled with the data read
refCnt	Number of values to be read (Range: 1-31)

Returns: FTALK_SUCCESS on success or error code. See Error Management for a list of error codes.

Note: No broadcast supported

◆ writeMultipleRegistersI64()

int writeMultipleRegistersI64	(	int	slaveAddr,
		int	startRef,
		const int64_t	int64Arr[],
		int	refCnt
	)

inherited

Modbus function 16 (10 Hex) for 64-bit integer data, Write Multiple Registers as int64_t type.

Writes for 64-bit integer values into quartets of holding registers (4:00000 table).

Remarks: Depending on the 32-bit Mode setting, an int will be transferred as four consecutive 16-bit registers (Standard) or as two 32-bit registers (Daniel/Enron).

Parameters

slaveAddr	Modbus address of slave device or unit identifier (Range: 0 - 255)
startRef	Start reference (Range: 1 - 65536)
int64Arr	Buffer with the data to be sent
refCnt	Number of values to be sent (Range: 1-30)

Returns: FTALK_SUCCESS on success or error code. See Error Management for a list of error codes.

Note: Broadcast supported for serial protocols

References FTALK_ILLEGAL_ARGUMENT_ERROR.

◆ readHoldingRegistersF64()

int readHoldingRegistersF64	(	int	slaveAddr,
		int	startRef,
		double	double64Arr[],
		int	refCnt
	)

inherited

Modbus function 3 for 64-bit floating point data, Read Input Registers as double type.

Reads the contents of quartets of consecutive input registers (4:00000 table) into 64-bit floating point values.

Remarks: Depending on the 32-bit Mode setting, a double will be transferred as four consecutive 16-bit registers (Standard) or as two 32-bit registers (Daniel/Enron).

Parameters

slaveAddr	Modbus address of slave device or unit identifier (Range: 1 - 255)
startRef	Start reference (Range: 1 - 65536)
double64Arr	Buffer which will be filled with the data read
refCnt	Number of values to be read (Range: 1-31)

Returns: FTALK_SUCCESS on success or error code. See Error Management for a list of error codes.

Note: No broadcast supported

◆ readInputRegistersF64()

int readInputRegistersF64	(	int	slaveAddr,
		int	startRef,
		double	double64Arr[],
		int	refCnt
	)

inherited

Modbus function 4 for 64-bit floating point data, Read Input Registers as double type.

Reads the contents of quartets of consecutive input registers (3:00000 table) into 64-bit floating point values.

Remarks: Depending on the 32-bit Mode setting, a double will be transferred as four consecutive 16-bit registers (Standard) or as two 32-bit registers (Daniel/Enron).

Parameters

slaveAddr	Modbus address of slave device or unit identifier (Range: 1 - 255)
startRef	Start reference (Range: 1 - 65536)
double64Arr	Buffer which will be filled with the data read
refCnt	Number of values to be read (Range: 1-31)

Returns: FTALK_SUCCESS on success or error code. See Error Management for a list of error codes.

Note: No broadcast supported

◆ writeMultipleRegistersF64()

int writeMultipleRegistersF64	(	int	slaveAddr,
		int	startRef,
		const double	double64Arr[],
		int	refCnt
	)

inherited

Modbus function 16 (10 Hex) for 64-bit floating point data, Write Multiple Registers as double type.

Writes for 64-bit floating point values into quartets of holding registers (4:00000 table).

Remarks: Depending on the 32-bit Mode setting, a double will be transferred as four consecutive 16-bit registers (Standard) or as two 32-bit registers (Daniel/Enron).

Parameters

slaveAddr	Modbus address of slave device or unit identifier (Range: 0 - 255)
startRef	Start reference (Range: 1 - 65536)
double64Arr	Buffer with the data to be sent
refCnt	Number of values to be sent (Range: 1-30)

Returns: FTALK_SUCCESS on success or error code. See Error Management for a list of error codes.

Note: Broadcast supported for serial protocols

References FTALK_ILLEGAL_ARGUMENT_ERROR.

◆ readFileRecord() [1/2]

int readFileRecord	(	int	slaveAddr,
		int	refType,
		int	fileNo,
		int	recordNo,
		short	recordArr[],
		int	recordCnt
	)

inherited

Modbus function 20, Read File Record.

Performs a file record read for a single subrequest.

Parameters

slaveAddr	Modbus address of slave device or unit identifier (Range: 1 - 255)
refType	Reference type (Must be specified as 6).
fileNo	File number (Range 1-65535). 3 is the input registers file, 4 is the holding registers file.
recordNo	Record Number (Range: 0 - 65535). The first record to read from, 0-based numbering.
recordArr	Buffer which will be filled with the data read
recordCnt	Number of records to read (Range 1-125)

Returns: FTALK_SUCCESS on success or error code. See Error Management for a list of error codes.

Note: No broadcast supported

◆ readFileRecord() [2/2]

int readFileRecord	(	int	slaveAddr,
		FileSubRequest	subReqArr[],
		int	subReqCnt
	)

inherited

Modbus function 20, Read File Record.

Performs a file record read for a list of subrequests.

Parameters

slaveAddr	Modbus address of slave device or unit identifier (Range: 1 - 255)
subReqArr	Array with list of subrequests
subReqCnt	Number of subrequests to read (Range 1-35)

Returns: FTALK_SUCCESS on success or error code. See Error Management for a list of error codes.

Note: No broadcast supported

References FTALK_ILLEGAL_ARGUMENT_ERROR, FTALK_INVALID_REPLY_ERROR, FTALK_SUCCESS, and MbusMasterFunctions::FileSubRequest::recordCnt.

◆ writeFileRecord() [1/2]

int writeFileRecord	(	int	slaveAddr,
		int	refType,
		int	fileNo,
		int	recordNo,
		const short	recordArr[],
		int	recordCnt
	)

inherited

Modbus function 21, Write File Record.

Performs a file record write for a single subrequest.

Parameters

slaveAddr	Modbus address of slave device or unit identifier (Range: 1 - 255)
refType	Reference type (Must be specified as 6).
fileNo	File number (Range 1-65535). 3 is the input registers file, 4 is the holding registers file.
recordNo	Record Number (Range: 0 - 65535). The first record to write to, 0-based numbering.
recordArr	Buffer with the data to be sent.
recordCnt	Number of records to write (Range 1-122)

Returns: FTALK_SUCCESS on success or error code. See Error Management for a list of error codes.

Note: No broadcast supported

◆ writeFileRecord() [2/2]

int writeFileRecord	(	int	slaveAddr,
		const FileSubRequest	subReqArr[],
		int	subReqCnt
	)

inherited

Modbus function 21, Write File Record.

Performs a file record write for a list of subrequests.

Parameters

slaveAddr	Modbus address of slave device or unit identifier (Range: 1 - 255)
subReqArr	Array with list of subrequests
subReqCnt	Number of subrequests to write (Range 1-27)

Returns: FTALK_SUCCESS on success or error code. See Error Management for a list of error codes.

Note: No broadcast supported

References FTALK_ILLEGAL_ARGUMENT_ERROR, FTALK_INVALID_REPLY_ERROR, FTALK_SUCCESS, and MbusMasterFunctions::FileSubRequest::recordCnt.

◆ readExceptionStatus()

int readExceptionStatus	(	int	slaveAddr,
		unsigned char *	statusBytePtr
	)

inherited

Modbus function 7, Read Exception Status.

Reads the eight exception status coils within the slave device.

Parameters

slaveAddr	Modbus address of slave device or unit identifier (Range: 1 - 255 for serial, 0 - 255 for TCP)
statusBytePtr	Slave status byte. The meaning of this status byte is slave specific and varies from device to device.

Returns: FTALK_SUCCESS on success or error code. See Error Management for a list of error codes.

Note: No broadcast supported

References FTALK_ILLEGAL_ARGUMENT_ERROR, and FTALK_SUCCESS.

◆ returnQueryData()

int returnQueryData	(	int	slaveAddr,
		const unsigned char	queryArr[],
		unsigned char	echoArr[],
		int	len
	)

inherited

Modbus function code 8, sub-function 00, Return Query Data.

Parameters

slaveAddr	Modbus address of slave device or unit identifier (Range: 1 - 255 for serial, 0 - 255 for TCP)
queryArr	Buffer with data to be sent
echoArr	Buffer which will contain the data read
len	Number of bytes send sent and read back

Returns: FTALK_SUCCESS on success, FTALK_INVALID_REPLY_ERROR if reply does not match query data or error code. See Error Management for a list of error codes.

Note: No broadcast supported

References FTALK_ILLEGAL_ARGUMENT_ERROR, FTALK_INVALID_REPLY_ERROR, and FTALK_SUCCESS.

◆ restartCommunicationsOption()

int restartCommunicationsOption	(	int	slaveAddr,
		int	clearEventLog
	)

inherited

Modbus function code 8, sub-function 01, Restart Communications Option.

Parameters

slaveAddr	Modbus address of slave device or unit identifier (Range: 1 - 255 for serial, 0 - 255 for TCP)
clearEventLog	Flag when set to one clears in addition the slave's communication even log.

Returns: FTALK_SUCCESS on success. See Error Management for a list of error codes.

Note: No broadcast supported

References FTALK_ILLEGAL_ARGUMENT_ERROR.

◆ readDeviceIdentification()

int readDeviceIdentification	(	int	slaveAddr,
		int	accessType,
		int	objId,
		DeviceIdObjectList *	objListPtr
	)

inherited

Modbus function 43 (hex 2B) subfunction 14 (hex 0E), Read Device Identification.

This function allows a master to retrieve various objects with meta information about a slave device. The data type of the objects returned is a 0-terminated ASCII string.

Object Id	Object Name / Description
0x00	VendorName
0x01	ProductCode
0x02	MajorMinorRevision
0x03	VendorUrl
0x04	ProductName
0x05	ModelName
0x06	UserApplicationName
0x07 - 0x7F	Reserved
0x80 - 0xFF	Vendor specific private objects

Parameters

slaveAddr	Modbus address of slave device or unit identifier (Range: 1 - 255 for serial, 0 - 255 for TCP)
accessType	Category type (1=only mandatory basic objects, 2=all regular objects, 3=include vendor specfic objects, 4=single object)
objId	An object ID from above table
objListPtr	A pointer to a object list container which will receive the retrieved objects.

Returns: FTALK_SUCCESS on success. See Error Management for a list of error codes.

Note: No broadcast supported

Example retrieving all Device ID strings of basic device identification level (level 1):

DeviceIdObjectList objs;
int objId = 0; // Start with object 0
do
{
    result = mbusProtocol.readDeviceIdentification(1, 1, objId, &objs);
    if (result != FTALK_SUCCESS)
    {
        fprintf(stderr, "Error: %s!\n", getBusProtocolErrorText(result));
        exit(EXIT_FAILURE);
    }
    else
    {
        size_t objLen;
        char* objData;
        while (objs.getNext(&objId, &objData, &objLen))
        {
            printf("obj[%d] = '%s', len = %u\n", objId, objData, objLen);
        }
    }
}
while (objs.moreToFollow());

References FTALK_ILLEGAL_ARGUMENT_ERROR, FTALK_INVALID_FRAME_ERROR, FTALK_INVALID_REPLY_ERROR, and FTALK_SUCCESS.

◆ setTimeout()

int setTimeout ( int msTime )

inherited

Configures time-out.

This function sets the operation or socket time-out to the specified value.

Remarks: The time-out value is indicative only and not guaranteed to be maintained. How precise it is followed depends on the operating system used, it's scheduling priority and it's system timer resolution.

Note: A protocol must be closed in order to configure it.

Parameters

msTime Timeout value in ms (Range: 1 - 100000)

Return values

FTALK_SUCCESS	Success
FTALK_ILLEGAL_ARGUMENT_ERROR	Argument out of range
FTALK_ILLEGAL_STATE_ERROR	Protocol is already open

References FTALK_ILLEGAL_ARGUMENT_ERROR, FTALK_ILLEGAL_STATE_ERROR, FTALK_SUCCESS, and MbusMasterFunctions::isOpen().

◆ getTimeout()

int getTimeout ( )

inlineinherited

Returns the time-out value.

Remarks: The time-out value is indicative only and not guaranteed to be maintained. How precise it is followed depends on the operating system used, it's scheduling priority and it's system timer resolution.

Returns: Timeout value in ms

◆ setPollDelay()

int setPollDelay ( int msTime )

inherited

Configures poll delay.

This function sets the delay time which applies between two consecutive Modbus read/write. A value of 0 disables the poll delay.

Remarks: The delay value is indicative only and not guaranteed to be maintained. How precise it is followed depends on the operating system used, it's scheduling priority and it's system timer resolution.

Note: A protocol must be closed in order to configure it.

Parameters

msTime Delay time in ms (Range: 0 - 100000), 0 disables poll delay

Return values

FTALK_SUCCESS	Success
FTALK_ILLEGAL_ARGUMENT_ERROR	Argument out of range
FTALK_ILLEGAL_STATE_ERROR	Protocol is already open

References FTALK_ILLEGAL_ARGUMENT_ERROR, FTALK_ILLEGAL_STATE_ERROR, FTALK_SUCCESS, and MbusMasterFunctions::isOpen().

◆ getPollDelay()

int getPollDelay ( )

inlineinherited

Returns the poll delay time.

Returns: Delay time in ms, 0 if poll delay is switched off

◆ setRetryCnt()

int setRetryCnt ( int retries )

inherited

Configures the automatic retry setting.

A value of 0 disables any automatic retries.

Note: A protocol must be closed in order to configure it.

Parameters

retries Retry count (Range: 0 - 10), 0 disables retries

Return values

FTALK_SUCCESS	Success
FTALK_ILLEGAL_ARGUMENT_ERROR	Argument out of range
FTALK_ILLEGAL_STATE_ERROR	Protocol is already open

References FTALK_ILLEGAL_ARGUMENT_ERROR, FTALK_ILLEGAL_STATE_ERROR, FTALK_SUCCESS, and MbusMasterFunctions::isOpen().

◆ getRetryCnt()

int getRetryCnt ( )

inlineinherited

Returns the automatic retry count.

Returns: Retry count

◆ getTotalCounter()

long getTotalCounter ( )

inlineinherited

Returns how often a message transfer has been executed.

Returns: Counter value

◆ getSuccessCounter()

long getSuccessCounter ( )

inlineinherited

Returns how often a message transfer was successful.

Returns: Counter value

◆ configureBigEndianInts() [1/2]

void configureBigEndianInts ( )

inherited

Configures 32-bit int data type functions to do a word swap.

Modbus is using little-endian word order for 32-bit values. The data transfer functions operating upon 32-bit int data types can be configured to do a word swap which enables them to read 32-bit data correctly from a big-endian slave.

◆ configureBigEndianInts() [2/2]

int configureBigEndianInts ( int slaveAddr )

inherited

Enables int data type functions to do a word swap on a per slave basis.

Modbus is using little-endian word order for 32-bit values. The data transfer functions operating upon 32-bit int data types can be configured to do a word swap which enables them to read 32-bit data correctly from a big-endian machine.

Parameters

slaveAddr Modbus address of slave device or unit identifier (Range: 1 - 255). A value of zero configures the behaviour for broadcasting.

References FTALK_ILLEGAL_ARGUMENT_ERROR, and FTALK_SUCCESS.

◆ configureLittleEndianInts() [1/2]

void configureLittleEndianInts ( )

inherited

Configures 32-bit int data type functions not to do a word swap.

This is the default.

◆ configureLittleEndianInts() [2/2]

int configureLittleEndianInts ( int slaveAddr )

inherited

Disables word swapping for int data type functions on a per slave basis.

Modbus is using little-endian word order for 32-bit values. This setting assumes that the slave also serves 32-bit data in little little-endian word order.

Remarks: This is the default mode

Parameters

slaveAddr Modbus address of slave device or unit identifier (Range: 1 - 255). A value of zero configures the behaviour for broadcasting.

References FTALK_ILLEGAL_ARGUMENT_ERROR, and FTALK_SUCCESS.

◆ configureIeeeFloats() [1/2]

void configureIeeeFloats ( )

inherited

Configures float data type functions not to do a word swap.

This is the default.

◆ configureIeeeFloats() [2/2]

int configureIeeeFloats ( int slaveAddr )

inherited

Disables float data type functions to do a word swap on a per slave basis.

Modbus is using little-endian word order for 32-bit values. This setting assumes that the slave also serves 32-bit floats in little little-endian word order which is the most common case.

Remarks: This is the default mode

Parameters

slaveAddr Modbus address of slave device or unit identifier (Range: 1 - 255). A value of zero configures the behaviour for broadcasting.

References FTALK_ILLEGAL_ARGUMENT_ERROR, and FTALK_SUCCESS.

◆ configureSwappedFloats() [1/2]

void configureSwappedFloats ( )

inherited

Configures float data type functions to do a word swap.

The data functions operating upon 32-bit float data types can be configured to do a word swap.

Note: Most platforms store floats in IEEE 754 little-endian order which does not need a word swap.

◆ configureSwappedFloats() [2/2]

int configureSwappedFloats ( int slaveAddr )

inherited

Enables float data type functions to do a word swap on a per slave basis.

The data functions operating upon 32-bit float data types can be configured to do a word swap.

Note: Most platforms store floats in IEEE 754 little-endian order which does not need a word swap.

Parameters

slaveAddr Modbus address of slave device or unit identifier (Range: 1 - 255). A value of zero configures the behaviour for broadcasting.

References FTALK_ILLEGAL_ARGUMENT_ERROR, and FTALK_SUCCESS.

◆ configureStandard32BitMode() [1/2]

void configureStandard32BitMode ( )

inherited

Configures all slaves for Standard 32-bit Mode.

In Standard 32-bit Register Mode a 32-bit value is transmitted as two consecutive 16-bit Modbus registers.

Note: This function call also re-configures the endianess to default little-endian for 32-bit values!

Remarks: This is the default mode

◆ configureStandard32BitMode() [2/2]

int configureStandard32BitMode ( int slaveAddr )

inherited

Configures a slave for Standard 32-bit Register Mode.

In Standard 32-bit Register Mode a 32-bit value is transmitted as two consecutive 16-bit Modbus registers.

Parameters

slaveAddr Modbus address of slave device or unit identifier (Range: 1 - 255). A value of zero configures the behaviour for broadcasting.

Return values

FTALK_SUCCESS	Success
FTALK_ILLEGAL_ARGUMENT_ERROR	Argument out of range

Remarks: This is the default mode

Note: This function call also re-configures the endianess to default little-endian for 32-bit values!

References MbusMasterFunctions::configureIeeeFloats(), MbusMasterFunctions::configureLittleEndianInts(), FTALK_ILLEGAL_ARGUMENT_ERROR, and FTALK_SUCCESS.

◆ configureEnron32BitMode() [1/2]

void configureEnron32BitMode ( )

inherited

Configures all slaves for Daniel/ENRON 32-bit Mode.

Some Modbus flavours like the Daniel/Enron protocol represent a 32-bit value using one 32-bit Modbus register instead of two 16-bit registers.

Note: This function call also re-configures the endianess to big-endian for 32-bit values as defined by the Daniel/ENRON protocol!

◆ configureEnron32BitMode() [2/2]

int configureEnron32BitMode ( int slaveAddr )

inherited

Configures all slaves for Daniel/ENRON 32-bit Mode.

Some Modbus flavours like the Daniel/Enron protocol represent a 32-bit value using one 32-bit Modbus register instead of two 16-bit registers.

Parameters

slaveAddr Modbus address of slave device or unit identifier (Range: 1 - 255). A value of zero configures the behaviour for broadcasting.

Return values

FTALK_SUCCESS	Success
FTALK_ILLEGAL_ARGUMENT_ERROR	Argument out of range

Note: This function call also re-configures the endianess to big-endian for 32-bit values as defined by the Daniel/ENRON protocol!

References MbusMasterFunctions::configureBigEndianInts(), MbusMasterFunctions::configureSwappedFloats(), FTALK_ILLEGAL_ARGUMENT_ERROR, and FTALK_SUCCESS.

◆ configureCountFromOne() [1/2]

void configureCountFromOne ( )

inherited

Configures the reference counting scheme to start with one for all slaves.

This renders the reference range to be 1 to 65536 (0x10000) and register #0 is an illegal register.

Remarks: This is the default mode

◆ configureCountFromOne() [2/2]

int configureCountFromOne ( int slaveAddr )

inherited

Configures a slave's reference counting scheme to start with one.

This renders the reference range to be 1 to 65536 (0x10000) and register #0 is an illegal register.

Parameters

slaveAddr Modbus address of slave device or unit identifier (Range: 1 - 255). A value of zero configures the behaviour for broadcasting.

Remarks: This is the default mode

References FTALK_ILLEGAL_ARGUMENT_ERROR, and FTALK_SUCCESS.

◆ configureCountFromZero() [1/2]

void configureCountFromZero ( )

inherited

Configures the reference counting scheme to start with zero for all slaves.

This renders the valid reference range to be 0 to 65535 (0xFFFF).

This renders the first register to be #0 for all slaves.

◆ configureCountFromZero() [2/2]

int configureCountFromZero ( int slaveAddr )

inherited

Configures a slave's reference counting scheme to start with zero.

This is also known as PDU addressing.

This renders the valid reference range to be 0 to 65535 (0xFFFF).

Parameters

slaveAddr Modbus address of slave device or unit identifier (Range: 1 - 255). A value of zero configures the behaviour for broadcasting.

References FTALK_ILLEGAL_ARGUMENT_ERROR, and FTALK_SUCCESS.

◆ getPackageVersion()

const TCHAR * getPackageVersion ( )

staticinherited

Returns the library version number.

Returns: Library version string

Public Types

Public Member Functions

Bit Access

16-bit Access

32-bit Access

64-bit Access

File Record Access

Diagnostics

Custom Function Codes

Protocol Configuration

Transmission Statistic Functions

Slave Configuration

Utility Functions

Detailed Description

Member Enumeration Documentation

◆ anonymous enum

◆ anonymous enum

◆ anonymous enum

Member Function Documentation

◆ openProtocol()

◆ isOpen()

◆ enableRs485Mode()

◆ readCoils()

◆ readInputDiscretes()

◆ writeCoil()

◆ forceMultipleCoils()

◆ readMultipleRegisters()

◆ readInputRegisters()

◆ writeSingleRegister()

◆ writeMultipleRegisters()

◆ maskWriteRegister()

◆ readWriteRegisters()

◆ readMultipleLongInts()

◆ readInputLongInts()

◆ writeMultipleLongInts()

◆ readMultipleFloats()

◆ readInputFloats()

◆ writeMultipleFloats()

◆ readMultipleMod10000()

◆ readInputMod10000()

◆ writeMultipleMod10000()

◆ readHoldingRegistersI64()

◆ readInputRegistersI64()

◆ writeMultipleRegistersI64()

◆ readHoldingRegistersF64()

◆ readInputRegistersF64()

◆ writeMultipleRegistersF64()

◆ readFileRecord() [1/2]

◆ readFileRecord() [2/2]

◆ writeFileRecord() [1/2]

◆ writeFileRecord() [2/2]

◆ readExceptionStatus()

◆ returnQueryData()

◆ restartCommunicationsOption()

◆ readDeviceIdentification()

◆ setTimeout()

◆ getTimeout()

◆ setPollDelay()

◆ getPollDelay()

◆ setRetryCnt()

◆ getRetryCnt()

◆ getTotalCounter()

◆ getSuccessCounter()

◆ configureBigEndianInts() [1/2]

◆ configureBigEndianInts() [2/2]

◆ configureLittleEndianInts() [1/2]

◆ configureLittleEndianInts() [2/2]

◆ configureIeeeFloats() [1/2]

◆ configureIeeeFloats() [2/2]

◆ configureSwappedFloats() [1/2]

◆ configureSwappedFloats() [2/2]

◆ configureStandard32BitMode() [1/2]

◆ configureStandard32BitMode() [2/2]

◆ configureEnron32BitMode() [1/2]

◆ configureEnron32BitMode() [2/2]

◆ configureCountFromOne() [1/2]

◆ configureCountFromOne() [2/2]

◆ configureCountFromZero() [1/2]

◆ configureCountFromZero() [2/2]

◆ getPackageVersion()