Allow Client types to set default id, bump TCP client response timeout

sandeepmistry · sandeepmistry · commit bd1217a9798d · 2018-07-18T11:42:17.000-04:00
diff --git a/src/ModbusClient.cpp b/src/ModbusClient.cpp
@@ -22,7 +22,8 @@
 #include "ModbusClient.h"
 
 ModbusClient::ModbusClient() :
-  _mb(NULL)
+  _mb(NULL),
+  _defaultId(0x00)
 {
 }
 
@@ -33,11 +34,12 @@ ModbusClient::~ModbusClient()
   }
 }
 
-int ModbusClient::begin(modbus_t* mb)
+int ModbusClient::begin(modbus_t* mb, int defaultId)
 {
   end();
 
   _mb = mb;
+  _defaultId = defaultId;
   if (_mb == NULL) {
     return 0;
   }
@@ -49,6 +51,8 @@ int ModbusClient::begin(modbus_t* mb)
     return 0;
   }
 
+  modbus_set_error_recovery(_mb, MODBUS_ERROR_RECOVERY_PROTOCOL);
+
   return 1;
 }
 
@@ -64,7 +68,7 @@ void ModbusClient::end()
 
 int ModbusClient::readCoil(int address)
 {
-  return readCoil(0x00, address);
+  return readCoil(_defaultId, address);
 }
 
 int ModbusClient::readCoil(int id, int address)
@@ -80,7 +84,7 @@ int ModbusClient::readCoil(int id, int address)
 
 int ModbusClient::readCoils(int address, uint8_t values[], int nb)
 {
-  return readCoils(0x00, address, values, nb);
+  return readCoils(_defaultId, address, values, nb);
 }
 
 int ModbusClient::readCoils(int id, int address, uint8_t values[], int nb)
@@ -96,7 +100,7 @@ int ModbusClient::readCoils(int id, int address, uint8_t values[], int nb)
 
 int ModbusClient::readDiscreteInput(int address)
 {
-  return readDiscreteInput(0x00, address);
+  return readDiscreteInput(_defaultId, address);
 }
 
 int ModbusClient::readDiscreteInput(int id, int address)
@@ -112,7 +116,7 @@ int ModbusClient::readDiscreteInput(int id, int address)
 
 int ModbusClient::readDiscreteInputs(int address, uint8_t values[], int nb)
 {
-  return readDiscreteInputs(0x00, address, values, nb);
+  return readDiscreteInputs(_defaultId, address, values, nb);
 }
 
 int ModbusClient::readDiscreteInputs(int id, int address, uint8_t values[], int nb)
@@ -128,7 +132,7 @@ int ModbusClient::readDiscreteInputs(int id, int address, uint8_t values[], int
 
 long ModbusClient::readHoldingRegister(int address)
 {
-  return readHoldingRegister(0x00, address);
+  return readHoldingRegister(_defaultId, address);
 }
 
 long ModbusClient::readHoldingRegister(int id, int address)
@@ -144,7 +148,7 @@ long ModbusClient::readHoldingRegister(int id, int address)
 
 int ModbusClient::readHoldingRegisters(int address, uint16_t values[], int nb)
 {
-  return readHoldingRegisters(0x00, address, values, nb);
+  return readHoldingRegisters(_defaultId, address, values, nb);
 }
 
 int ModbusClient::readHoldingRegisters(int id, int address, uint16_t values[], int nb)
@@ -160,7 +164,7 @@ int ModbusClient::readHoldingRegisters(int id, int address, uint16_t values[], i
 
 long ModbusClient::readInputRegister(int address)
 {
-  return readInputRegister(0x00, address);
+  return readInputRegister(_defaultId, address);
 }
 
 long ModbusClient::readInputRegister(int id, int address)
@@ -176,7 +180,7 @@ long ModbusClient::readInputRegister(int id, int address)
 
 int ModbusClient::readInputRegisters(int address, uint16_t values[], int nb)
 {
-  return readInputRegisters(0x00, address, values, nb);
+  return readInputRegisters(_defaultId, address, values, nb);
 }
 
 int ModbusClient::readInputRegisters(int id, int address, uint16_t values[], int nb)
@@ -192,7 +196,7 @@ int ModbusClient::readInputRegisters(int id, int address, uint16_t values[], int
 
 int ModbusClient::writeCoil(int address, uint8_t value)
 {
-  return writeCoil(0x00, address, value);
+  return writeCoil(_defaultId, address, value);
 }
 
 int ModbusClient::writeCoil(int id, int address, uint8_t value)
@@ -208,7 +212,7 @@ int ModbusClient::writeCoil(int id, int address, uint8_t value)
 
 int ModbusClient::writeCoils(int address, const uint8_t values[], int nb)
 {
-  return writeCoils(0x00, address, values, nb);
+  return writeCoils(_defaultId, address, values, nb);
 }
 
 int ModbusClient::writeCoils(int id, int address, const uint8_t values[], int nb)
@@ -224,7 +228,7 @@ int ModbusClient::writeCoils(int id, int address, const uint8_t values[], int nb
 
 int ModbusClient::writeHoldingRegister(int address, uint16_t value)
 {
-  return writeHoldingRegister(0x00, address, value);
+  return writeHoldingRegister(_defaultId, address, value);
 }
 
 int ModbusClient::writeHoldingRegister(int id, int address, uint16_t value)
@@ -240,7 +244,7 @@ int ModbusClient::writeHoldingRegister(int id, int address, uint16_t value)
 
 int ModbusClient::writeHoldingRegisters(int address, const uint16_t values[], int nb)
 {
-  return writeHoldingRegisters(0x00, address, values, nb);
+  return writeHoldingRegisters(_defaultId, address, values, nb);
 }
 
 int ModbusClient::writeHoldingRegisters(int id, int address, const uint16_t values[], int nb)
@@ -256,7 +260,7 @@ int ModbusClient::writeHoldingRegisters(int id, int address, const uint16_t valu
 
 int ModbusClient::maskWriteRegister(int address, uint16_t andMask, uint16_t orMask)
 {
-  return maskWriteRegister(0x00, address, andMask, orMask);
+  return maskWriteRegister(_defaultId, address, andMask, orMask);
 }
 
 int ModbusClient::maskWriteRegister(int id, int address, uint16_t andMask, uint16_t orMask)
@@ -272,7 +276,7 @@ int ModbusClient::maskWriteRegister(int id, int address, uint16_t andMask, uint1
 
 int ModbusClient::writeAndReadRegisters(int writeAddress, const uint16_t writeValues[], int writeNb, int readAddress, uint16_t readValues[], int readNb)
 {
-  return writeAndReadRegisters(0x00, writeAddress, writeValues, writeNb, readAddress, readValues, readNb);
+  return writeAndReadRegisters(_defaultId, writeAddress, writeValues, writeNb, readAddress, readValues, readNb);
 }
 
 int ModbusClient::writeAndReadRegisters(int id, int writeAddress, const uint16_t writeValues[], int writeNb, int readAddress, uint16_t readValues[], int readNb)
diff --git a/src/ModbusClient.h b/src/ModbusClient.h
@@ -233,10 +233,11 @@ class ModbusClient {
   ModbusClient();
   virtual ~ModbusClient();
 
-  int begin(modbus_t* _mb);
+  int begin(modbus_t* _mb, int defaultId);
 
 private:
   modbus_t* _mb;
+  int _defaultId;
 };
 
 #endif
diff --git a/src/ModbusRTUClient.cpp b/src/ModbusRTUClient.cpp
@@ -38,7 +38,7 @@ int ModbusRTUClientClass::begin(unsigned long baudrate, uint16_t config)
 {
   modbus_t* mb = modbus_new_rtu(baudrate, config);
 
-  return ModbusClient::begin(mb);
+  return ModbusClient::begin(mb, 0x00);
 }
 
 ModbusRTUClientClass ModbusRTUClient;
diff --git a/src/ModbusTCPClient.cpp b/src/ModbusTCPClient.cpp
@@ -39,5 +39,17 @@ int ModbusTCPClient::begin(IPAddress ip, uint16_t port)
 {
   modbus_t* mb = modbus_new_tcp(_client, ip, port);
 
-  return ModbusClient::begin(mb);
+  modbus_set_response_timeout(mb, 30, 0);
+
+  return ModbusClient::begin(mb, MODBUS_TCP_SLAVE);
+}
+
+int ModbusTCPClient::connected()
+{
+  return _client->connected();
+}
+
+void ModbusTCPClient::stop()
+{
+  end();
 }
diff --git a/src/ModbusTCPClient.h b/src/ModbusTCPClient.h
@@ -41,10 +41,22 @@ class ModbusTCPClient : public ModbusClient {
    * @param ip IP Address of the Modbus server
    * @param port TCP port number of Modbus server, defaults to 502
    *
-   * Return 1 on success, 0 on failure
+   * @return 1 on success, 0 on failure
    */
   int begin(IPAddress ip, uint16_t port = 502);
 
+  /**
+   * Query connection status.
+   *
+   * @return 1 if connected, 0 if not connected
+   */
+  int connected();
+
+  /**
+   * Disconnect the client.
+   */
+  void stop();
+
 private:
   Client* _client;
 };
diff --git a/src/ModbusTCPServer.h b/src/ModbusTCPServer.h
@@ -32,11 +32,11 @@ class ModbusTCPServer : public ModbusServer {
   /**
    * Start the Modbus TCP server with the specified parameters
    *
-   * @param id (slave) id of the server, defaults to 0x00 (broadcast)
+   * @param id (slave) id of the server, defaults to 0xff (TCP)
    *
    * Return 1 on success, 0 on failure
    */
-  int begin(int id = 0x00);
+  int begin(int id = 0xff);
 
   /**
    * Accept client connection

Original file line number	Diff line number	Diff line change
`@@ -22,7 +22,8 @@`
`22`	`22`	`#include "ModbusClient.h"`
`23`	`23`
`24`	`24`	`ModbusClient::ModbusClient() :`
`25`		`- _mb(NULL)`
	`25`	`+ _mb(NULL),`
	`26`	`+ _defaultId(0x00)`
`26`	`27`	`{`
`27`	`28`	`}`
`28`	`29`
`@@ -33,11 +34,12 @@ ModbusClient::~ModbusClient()`
`33`	`34`	`}`
`34`	`35`	`}`
`35`	`36`
`36`		`-int ModbusClient::begin(modbus_t* mb)`
	`37`	`+int ModbusClient::begin(modbus_t* mb, int defaultId)`
`37`	`38`	`{`
`38`	`39`	`end();`
`39`	`40`
`40`	`41`	`_mb = mb;`
	`42`	`+ _defaultId = defaultId;`
`41`	`43`	`if (_mb == NULL) {`
`42`	`44`	`return 0;`
`43`	`45`	`}`
`@@ -49,6 +51,8 @@ int ModbusClient::begin(modbus_t* mb)`
`49`	`51`	`return 0;`
`50`	`52`	`}`
`51`	`53`
	`54`	`+ modbus_set_error_recovery(_mb, MODBUS_ERROR_RECOVERY_PROTOCOL);`
	`55`	`+`
`52`	`56`	`return 1;`
`53`	`57`	`}`
`54`	`58`
`@@ -64,7 +68,7 @@ void ModbusClient::end()`
`64`	`68`
`65`	`69`	`int ModbusClient::readCoil(int address)`
`66`	`70`	`{`
`67`		`- return readCoil(0x00, address);`
	`71`	`+ return readCoil(_defaultId, address);`
`68`	`72`	`}`
`69`	`73`
`70`	`74`	`int ModbusClient::readCoil(int id, int address)`
`@@ -80,7 +84,7 @@ int ModbusClient::readCoil(int id, int address)`
`80`	`84`
`81`	`85`	`int ModbusClient::readCoils(int address, uint8_t values[], int nb)`
`82`	`86`	`{`
`83`		`- return readCoils(0x00, address, values, nb);`
	`87`	`+ return readCoils(_defaultId, address, values, nb);`
`84`	`88`	`}`
`85`	`89`
`86`	`90`	`int ModbusClient::readCoils(int id, int address, uint8_t values[], int nb)`
`@@ -96,7 +100,7 @@ int ModbusClient::readCoils(int id, int address, uint8_t values[], int nb)`
`96`	`100`
`97`	`101`	`int ModbusClient::readDiscreteInput(int address)`
`98`	`102`	`{`
`99`		`- return readDiscreteInput(0x00, address);`
	`103`	`+ return readDiscreteInput(_defaultId, address);`
`100`	`104`	`}`
`101`	`105`
`102`	`106`	`int ModbusClient::readDiscreteInput(int id, int address)`
`@@ -112,7 +116,7 @@ int ModbusClient::readDiscreteInput(int id, int address)`
`112`	`116`
`113`	`117`	`int ModbusClient::readDiscreteInputs(int address, uint8_t values[], int nb)`
`114`	`118`	`{`
`115`		`- return readDiscreteInputs(0x00, address, values, nb);`
	`119`	`+ return readDiscreteInputs(_defaultId, address, values, nb);`
`116`	`120`	`}`
`117`	`121`
`118`	`122`	`int ModbusClient::readDiscreteInputs(int id, int address, uint8_t values[], int nb)`
`@@ -128,7 +132,7 @@ int ModbusClient::readDiscreteInputs(int id, int address, uint8_t values[], int`
`128`	`132`
`129`	`133`	`long ModbusClient::readHoldingRegister(int address)`
`130`	`134`	`{`
`131`		`- return readHoldingRegister(0x00, address);`
	`135`	`+ return readHoldingRegister(_defaultId, address);`
`132`	`136`	`}`
`133`	`137`
`134`	`138`	`long ModbusClient::readHoldingRegister(int id, int address)`
`@@ -144,7 +148,7 @@ long ModbusClient::readHoldingRegister(int id, int address)`
`144`	`148`
`145`	`149`	`int ModbusClient::readHoldingRegisters(int address, uint16_t values[], int nb)`
`146`	`150`	`{`
`147`		`- return readHoldingRegisters(0x00, address, values, nb);`
	`151`	`+ return readHoldingRegisters(_defaultId, address, values, nb);`
`148`	`152`	`}`
`149`	`153`
`150`	`154`	`int ModbusClient::readHoldingRegisters(int id, int address, uint16_t values[], int nb)`
`@@ -160,7 +164,7 @@ int ModbusClient::readHoldingRegisters(int id, int address, uint16_t values[], i`
`160`	`164`
`161`	`165`	`long ModbusClient::readInputRegister(int address)`
`162`	`166`	`{`
`163`		`- return readInputRegister(0x00, address);`
	`167`	`+ return readInputRegister(_defaultId, address);`
`164`	`168`	`}`
`165`	`169`
`166`	`170`	`long ModbusClient::readInputRegister(int id, int address)`
`@@ -176,7 +180,7 @@ long ModbusClient::readInputRegister(int id, int address)`
`176`	`180`
`177`	`181`	`int ModbusClient::readInputRegisters(int address, uint16_t values[], int nb)`
`178`	`182`	`{`
`179`		`- return readInputRegisters(0x00, address, values, nb);`
	`183`	`+ return readInputRegisters(_defaultId, address, values, nb);`
`180`	`184`	`}`
`181`	`185`
`182`	`186`	`int ModbusClient::readInputRegisters(int id, int address, uint16_t values[], int nb)`
`@@ -192,7 +196,7 @@ int ModbusClient::readInputRegisters(int id, int address, uint16_t values[], int`
`192`	`196`
`193`	`197`	`int ModbusClient::writeCoil(int address, uint8_t value)`
`194`	`198`	`{`
`195`		`- return writeCoil(0x00, address, value);`
	`199`	`+ return writeCoil(_defaultId, address, value);`
`196`	`200`	`}`
`197`	`201`
`198`	`202`	`int ModbusClient::writeCoil(int id, int address, uint8_t value)`
`@@ -208,7 +212,7 @@ int ModbusClient::writeCoil(int id, int address, uint8_t value)`
`208`	`212`
`209`	`213`	`int ModbusClient::writeCoils(int address, const uint8_t values[], int nb)`
`210`	`214`	`{`
`211`		`- return writeCoils(0x00, address, values, nb);`
	`215`	`+ return writeCoils(_defaultId, address, values, nb);`
`212`	`216`	`}`
`213`	`217`
`214`	`218`	`int ModbusClient::writeCoils(int id, int address, const uint8_t values[], int nb)`
`@@ -224,7 +228,7 @@ int ModbusClient::writeCoils(int id, int address, const uint8_t values[], int nb`
`224`	`228`
`225`	`229`	`int ModbusClient::writeHoldingRegister(int address, uint16_t value)`
`226`	`230`	`{`
`227`		`- return writeHoldingRegister(0x00, address, value);`
	`231`	`+ return writeHoldingRegister(_defaultId, address, value);`
`228`	`232`	`}`
`229`	`233`
`230`	`234`	`int ModbusClient::writeHoldingRegister(int id, int address, uint16_t value)`
`@@ -240,7 +244,7 @@ int ModbusClient::writeHoldingRegister(int id, int address, uint16_t value)`
`240`	`244`
`241`	`245`	`int ModbusClient::writeHoldingRegisters(int address, const uint16_t values[], int nb)`
`242`	`246`	`{`
`243`		`- return writeHoldingRegisters(0x00, address, values, nb);`
	`247`	`+ return writeHoldingRegisters(_defaultId, address, values, nb);`
`244`	`248`	`}`
`245`	`249`
`246`	`250`	`int ModbusClient::writeHoldingRegisters(int id, int address, const uint16_t values[], int nb)`
`@@ -256,7 +260,7 @@ int ModbusClient::writeHoldingRegisters(int id, int address, const uint16_t valu`
`256`	`260`
`257`	`261`	`int ModbusClient::maskWriteRegister(int address, uint16_t andMask, uint16_t orMask)`
`258`	`262`	`{`
`259`		`- return maskWriteRegister(0x00, address, andMask, orMask);`
	`263`	`+ return maskWriteRegister(_defaultId, address, andMask, orMask);`
`260`	`264`	`}`
`261`	`265`
`262`	`266`	`int ModbusClient::maskWriteRegister(int id, int address, uint16_t andMask, uint16_t orMask)`
`@@ -272,7 +276,7 @@ int ModbusClient::maskWriteRegister(int id, int address, uint16_t andMask, uint1`
`272`	`276`
`273`	`277`	`int ModbusClient::writeAndReadRegisters(int writeAddress, const uint16_t writeValues[], int writeNb, int readAddress, uint16_t readValues[], int readNb)`
`274`	`278`	`{`
`275`		`- return writeAndReadRegisters(0x00, writeAddress, writeValues, writeNb, readAddress, readValues, readNb);`
	`279`	`+ return writeAndReadRegisters(_defaultId, writeAddress, writeValues, writeNb, readAddress, readValues, readNb);`
`276`	`280`	`}`
`277`	`281`
`278`	`282`	`int ModbusClient::writeAndReadRegisters(int id, int writeAddress, const uint16_t writeValues[], int writeNb, int readAddress, uint16_t readValues[], int readNb)`
Original file line number	Diff line number	Diff line change
`@@ -38,7 +38,7 @@ int ModbusRTUClientClass::begin(unsigned long baudrate, uint16_t config)`
`38`	`38`	`{`
`39`	`39`	`modbus_t* mb = modbus_new_rtu(baudrate, config);`
`40`	`40`
`41`		`- return ModbusClient::begin(mb);`
	`41`	`+ return ModbusClient::begin(mb, 0x00);`
`42`	`42`	`}`
`43`	`43`
`44`	`44`	`ModbusRTUClientClass ModbusRTUClient;`
Original file line number	Diff line number	Diff line change
`@@ -32,11 +32,11 @@ class ModbusTCPServer : public ModbusServer {`
`32`	`32`	`/**`
`33`	`33`	`* Start the Modbus TCP server with the specified parameters`
`34`	`34`	`*`
`35`		`- * @param id (slave) id of the server, defaults to 0x00 (broadcast)`
	`35`	`+ * @param id (slave) id of the server, defaults to 0xff (TCP)`
`36`	`36`	`*`
`37`	`37`	`* Return 1 on success, 0 on failure`
`38`	`38`	`*/`
`39`		`- int begin(int id = 0x00);`
	`39`	`+ int begin(int id = 0xff);`
`40`	`40`
`41`	`41`	`/**`
`42`	`42`	`* Accept client connection`