IModbusAdapter.h
3.58 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
/****************************************************************************
* Copyright (c) 2022 Priva b.v.
****************************************************************************/
#pragma once
// std
#include <string>
#include <variant>
#include <vector>
using modbusData = std::vector<std::variant<uint8_t, uint16_t>>;
// Forward Declaration
class ConnectionConfig;
/*!
* \brief The IModbusAdapter class provides an abstract way of using
* the modbus stack. Implemented as a pure virtual, it cannot be instantiated.
* This represents a unique connection to either a serial bus or a TCP connection.
*/
class IModbusAdapter
{
public:
/// Default DTor.
virtual ~IModbusAdapter() = default;
/// Create a modbus connection, accepting a configuration object.
virtual bool ModbusConnect( const ConnectionConfig &conncfg ) = 0;
/*!
* \brief ModbusDisconnect
* Disconnect from the serial bus or the TCP connection, freeing its resources
*/
virtual bool ModbusDisconnect() = 0;
/*!
* \brief Read data from a modbus device given by its parameters.
* \param slaveId - The Id of the ModbusDevice.
* \param functionCode - The code describing the action we want to perform on the device.
* Given by an enum, provided by the modbus-stack.
* \param startAddress - Startaddres of the register we want to read.
* \param noOfItems - The number of items we expect back.
* \returns modbusData - A vector holding each register in an entry in the same order as they are received.
* Empty if no data was received.
*/
virtual modbusData ModbusReadData( int slaveId, int functionCode, int startAddress, int noOfItems ) = 0;
/*!
* \brief Read data from the holdregisters ( or keep-registers ) of a modbus device.
* \param slaveId - The Id of the ModbusDevice.
* \param startAddress - Startaddres of the register we want to read.
* \param noOfItems - The number of items we expect back.
* \returns modbusData - A vector holding each register in an entry in the same order as they are received.
* Empty if no data was received.
*/
virtual modbusData ModbusReadHoldReg( int slaveId, int startAddress, int noOfItems ) = 0;
/*!
* \brief Write data to the device.
* \param slaveId - The Id of the Modbus device
* \param funtionCode - The code describing the action we want to perform on the device
* given by an enum, provided by the modbus-stack.
* \param startAddress - Startaddres of the register we want to read.
* \param noOfItems - The number of items we expect to be written
* \param values - The values we want to write to the given device. Each vector-entry represents a single byte
* and they will be sent in sequence.
*/
virtual void ModBusWriteData( int slaveId, int functionCode, int startAddress, int noOfItems, std::vector<int>values ) = 0;
/*!
* \brief Indicates if this connection is alive.
* \return True if alive, false if not.
*/
virtual bool isConnected() const = 0;
/*!
* \brief returns the translated error code coming from the modbus stack.
* \param errnum - error Number coming from the stack.
* \return The translated error as a string. Empty if not resolvable.
*/
virtual std::string ErrorString( int errnum ) const = 0;
};