modbus_client.h
Go to the documentation of this file.
1 /*
2  * Copyright (c) 2018 Pilz GmbH & Co. KG
3  *
4  * This program is free software: you can redistribute it and/or modify
5  * it under the terms of the GNU Lesser General Public License as published by
6  * the Free Software Foundation, either version 3 of the License, or
7  * (at your option) any later version.
8 
9  * This program is distributed in the hope that it will be useful,
10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12  * GNU Lesser General Public License for more details.
13 
14  * You should have received a copy of the GNU Lesser General Public License
15  * along with this program. If not, see <http://www.gnu.org/licenses/>.
16  */
17 
18 #ifndef MODBUS_CLIENT_H
19 #define MODBUS_CLIENT_H
20 
21 #include <vector>
22 #include <cstdint>
23 
24 #include "register_container.h"
25 
26 namespace prbt_hardware_support
27 {
29 {
30 public:
31  // LCOV_EXCL_START
32  virtual ~ModbusClient() = default;
33  // LCOV_EXCL_STOP
34 
35 public:
44  virtual bool init(const char* ip, unsigned int port) = 0;
45 
54  virtual void setResponseTimeoutInMs(unsigned long timeout_ms) = 0;
55 
61  virtual unsigned long getResponseTimeoutInMs() = 0;
62 
71  virtual RegCont readHoldingRegister(int addr, int nb) = 0;
72 
73  virtual RegCont writeReadHoldingRegister(const int write_addr, const RegCont& write_reg, const int read_addr,
74  const int read_nb) = 0;
75 };
76 
77 } // namespace prbt_hardware_support
78 
79 #endif // MODBUS_CLIENT_H
virtual bool init(const char *ip, unsigned int port)=0
Initialize the modbus client by connecting to the server.
std::vector< uint16_t > RegCont
Convenience data type defining the data type for a collection of registers.
virtual unsigned long getResponseTimeoutInMs()=0
Get the response timeout.
virtual RegCont readHoldingRegister(int addr, int nb)=0
Read the holding registers.
virtual RegCont writeReadHoldingRegister(const int write_addr, const RegCont &write_reg, const int read_addr, const int read_nb)=0
virtual void setResponseTimeoutInMs(unsigned long timeout_ms)=0
Set the response timeout.


prbt_hardware_support
Author(s):
autogenerated on Sat May 16 2020 03:13:49