prbt_hardware_support::ModbusClient Class Reference

#include <modbus_client.h>

Inheritance diagram for prbt_hardware_support::ModbusClient:

Public Member Functions
virtual unsigned long	getResponseTimeoutInMs ()=0
	Get the response timeout. More...
virtual bool	init (const char *ip, unsigned int port)=0
	Initialize the modbus client by connecting to the server. More...
virtual RegCont	readHoldingRegister (int addr, int nb)=0
	Read the holding registers. More...
virtual void	setResponseTimeoutInMs (unsigned long timeout_ms)=0
	Set the response timeout. More...
virtual RegCont	writeReadHoldingRegister (const int write_addr, const RegCont &write_reg, const int read_addr, const int read_nb)=0
virtual	~ModbusClient ()=default

Detailed Description

Definition at line 28 of file modbus_client.h.

Constructor & Destructor Documentation

~ModbusClient()

virtual prbt_hardware_support::ModbusClient::~ModbusClient ( )

virtualdefault

Member Function Documentation

getResponseTimeoutInMs()

virtual unsigned long prbt_hardware_support::ModbusClient::getResponseTimeoutInMs ( )

pure virtual

Get the response timeout.

Returns

response timeout

Implemented in prbt_hardware_support::LibModbusClient.

init()

virtual bool prbt_hardware_support::ModbusClient::init ( const char *  ip, unsigned int  port  )

pure virtual

Initialize the modbus client by connecting to the server.

Parameters

ip	of the server
port	to use

Returns

true if the connection to the server succeeded

false if the connection to the server failed

Implemented in prbt_hardware_support::LibModbusClient.

readHoldingRegister()

virtual RegCont prbt_hardware_support::ModbusClient::readHoldingRegister ( int  addr, int  nb  )

pure virtual

Read the holding registers.

Parameters

addr	starting address to read from
nb	number of registers to read

Exceptions

ModbusExceptionDisconnect

if a disconnect from the server happens

Returns

the registers content.

Implemented in prbt_hardware_support::LibModbusClient.

setResponseTimeoutInMs()

virtual void prbt_hardware_support::ModbusClient::setResponseTimeoutInMs ( unsigned long  timeout_ms )

pure virtual

Set the response timeout.

Interval to wait for a response from the server if within this timespan no answer is received readHoldingRegisters will throw a ModbusExceptionDisconnect

Parameters

timeout_ms

in ms

Implemented in prbt_hardware_support::LibModbusClient.

writeReadHoldingRegister()

virtual RegCont prbt_hardware_support::ModbusClient::writeReadHoldingRegister ( const int  write_addr, const RegCont &  write_reg, const int  read_addr, const int  read_nb  )

pure virtual

Implemented in prbt_hardware_support::LibModbusClient.

---

The documentation for this class was generated from the following file:

• modbus_client.h