Improve error reporting

Author: budulinek

arduino-modbus-rtu-tcp-gateway/02-modbus-tcp.ino

@@ -21,13 +21,14 @@
    deleteRequest
    - deletes requests from queue
 
-   getSlaveResponding, setSlaveResponding
+   getSlaveStatus, setSlaveStatus
    - read from and write to bool array
 
    ***************************************************************** */
 
-// bool array for storing Modbus RTU status (responging or not responding). Array index corresponds to slave address.
-uint8_t slavesResponding[(maxSlaves + 1 + 7) / 8];
+// bool arrays for storing Modbus RTU status (responging or not responding). Array index corresponds to slave address.
+uint8_t responding[(maxSlaves + 1 + 7) / 8];
+uint8_t error[(maxSlaves + 1 + 7) / 8];
 uint8_t masks[8] = { 1, 2, 4, 8, 16, 32, 64, 128 };
 
 typedef struct {
@@ -45,6 +46,7 @@ CircularBuffer<byte, reqQueueSize> queuePDUs;        // queue of PDU data (funct
 CircularBuffer<byte, reqQueueCount> queueRetries;    // queue of retry counters
 byte pduStart;  // first byte of Protocol Data Unit (i.e. Function code)
 
+
 void recvUdp() {
   unsigned int packetSize = Udp.parsePacket();
   if (packetSize) {
@@ -146,7 +148,7 @@ void processRequests() {
     if (!queueHeaders.isEmpty()) {
       boolean queueHasRespondingSlaves;  // true if  queue holds at least one request to responding slaves
       for (byte i = 0; i < queueHeaders.size(); i++) {
-        if (getSlaveResponding(queueHeaders[i].uid) == true) {
+        if (getSlaveStatus(queueHeaders[i].uid, responding) == true) {
           queueHasRespondingSlaves = true;
           break;
         } else {
@@ -194,15 +196,13 @@ void deleteRequest()  // delete request from queue
   queueRetries.shift();
 }
 
-
-bool getSlaveResponding(const uint8_t index) {
+bool getSlaveStatus(const uint8_t index, const uint8_t status[]) {
   if (index >= maxSlaves) return false;  // error
-  return (slavesResponding[index / 8] & masks[index & 7]) > 0;
+  return (status[index / 8] & masks[index & 7]) > 0;
 }
 
-
-void setSlaveResponding(const uint8_t index, const bool value) {
+void setSlaveStatus(const uint8_t index, uint8_t status[], const bool value) {
   if (index >= maxSlaves) return;  // error
-  if (value == 0) slavesResponding[index / 8] &= ~masks[index & 7];
-  else slavesResponding[index / 8] |= masks[index & 7];
+  if (value == 0) status[index / 8] &= ~masks[index & 7];
+  else status[index / 8] |= masks[index & 7];
 }

arduino-modbus-rtu-tcp-gateway/03-modbus-rtu.ino

@@ -96,8 +96,8 @@ void recvSerial() {
     // Checks: 1) RTU frame is without errors; 2) CRC; 3) address of incoming packet against first request in queue; 4) only expected responses are forwarded to TCP/UDP
     header myHeader = queueHeaders.first();
     if (!rxErr && checkCRC(serialIn, rxNdx) == true && serialIn[0] == myHeader.uid && serialState == WAITING) {
-      setSlaveResponding(serialIn[0], true);  // flag slave as responding
-
+      setSlaveStatus(serialIn[0], responding, true);  // flag slave as responding
+      setSlaveStatus(serialIn[0], error, false);      // flag slave as without error
       byte MBAP[] = { myHeader.tid[0], myHeader.tid[1], 0x00, 0x00, highByte(rxNdx - 2), lowByte(rxNdx - 2) };
       if (myHeader.clientNum == UDP_REQUEST) {
         Udp.beginPacket(myHeader.remIP, myHeader.remPort);
@@ -113,8 +113,7 @@ void recvSerial() {
 #endif /* ENABLE_EXTRA_DIAG */
       } else if (myHeader.clientNum != SCAN_REQUEST) {
         EthernetClient client = EthernetClient(myHeader.clientNum);
-        // make sure that this is really our socket
-        if (client.localPort() == localConfig.tcpPort && (client.status() == SnSR::ESTABLISHED || client.status() == SnSR::CLOSE_WAIT)) {
+        if (client.connected()) {
           if (localConfig.enableRtuOverTcp) client.write(serialIn, rxNdx);
           else {
             client.write(MBAP, 6);
@@ -137,7 +136,8 @@ void recvSerial() {
   // Deal with Serial timeouts (i.e. Modbus RTU timeouts)
   if (serialState == WAITING && requestTimeout.isOver()) {
     header myHeader = queueHeaders.first();
-    setSlaveResponding(myHeader.uid, false);                                    // flag slave as nonresponding
+    setSlaveStatus(myHeader.uid, responding, false);                                    // flag slave as nonresponding
+    if (myHeader.clientNum != SCAN_REQUEST) setSlaveStatus(myHeader.uid, error, true);  // flag slave as error
     if (queueRetries.first() >= localConfig.serialAttempts) {
       // send modbus error 11 (Gateway Target Device Failed to Respond) - usually means that target device (address) is not present
       byte MBAP[] = { myHeader.tid[0], myHeader.tid[1], 0x00, 0x00, 0x00, 0x03 };
@@ -168,8 +168,7 @@ void recvSerial() {
         default:  // Ethernet client
           {
         EthernetClient client = EthernetClient(myHeader.clientNum);
-        // make sure that this is really our socket
-        if (client.localPort() == localConfig.tcpPort && (client.status() == SnSR::ESTABLISHED || client.status() == SnSR::CLOSE_WAIT)) {
+        if (client.connected()) {
           if (!localConfig.enableRtuOverTcp) {
             client.write(MBAP, 6);
           }

arduino-modbus-rtu-tcp-gateway/04-webserver.ino

@@ -332,6 +332,8 @@ void processPost(char postParameter[]) {
       break;
     case SCAN:
       scanCounter = 1;
+      memset(responding, 0, sizeof(responding));   // clear status flags
+      memset(error, 0, sizeof(error));
       break;
     default:
       break;

arduino-modbus-rtu-tcp-gateway/05-pages.ino

@@ -38,7 +38,7 @@ void sendPage(EthernetClient &client, byte reqPage) {
   chunked.print(F("<!DOCTYPE html>"
                   "<html>"
                   "<head>"
-                  "<meta charset=utf-8"));
+                  "<meta"));
   if (reqPage == PAGE_STATUS || reqPage == PAGE_WAIT) chunked.print(F(" http-equiv=refresh content=5"));
   if (reqPage == PAGE_WAIT) {  // redirect to new IP and web port
     chunked.print(F(";url=http://"));
@@ -82,7 +82,7 @@ void sendPage(EthernetClient &client, byte reqPage) {
     menuItem(chunked, i);
     chunked.print(F("</a>"));
   }
-  chunked.print(F("</table><td valign=top style=padding:0px>"));
+  chunked.print(F("</table><td style=padding:0>"));
 
   // Main Page
   chunked.print(F("<form action=/"));
@@ -334,11 +334,11 @@ void contentStatus(ChunkedPrint &chunked) {
     if (ipTemp != 0 && ipTemp != 0xFFFFFFFF) {
       if (clientDiag.status() == SnSR::UDP && clientDiag.localPort() == localConfig.udpPort) {
         chunked.print(F("<td><tr><td>UDP:<td>"));
-        chunked.print(ipTemp);
+        chunked.print((IPAddress)ipTemp);
         countMasters++;
       } else if (clientDiag.localPort() == localConfig.tcpPort) {
         chunked.print(F("<td><tr><td>TCP:<td>"));
-        chunked.print(ipTemp);
+        chunked.print((IPAddress)ipTemp);
         countMasters++;
       }
     }
@@ -352,13 +352,16 @@ void contentStatus(ChunkedPrint &chunked) {
   chunked.print(F(">Scan</button>"));
   byte countSlaves = 0;
   for (int k = 1; k < maxSlaves; k++) {
-    if (getSlaveResponding(k) == true || k == scanCounter) {
+    if (getSlaveStatus(k, responding) == true || getSlaveStatus(k, error) == true || k == scanCounter) {
       chunked.print(F("<tr><td><td>0x"));
       if (k < 16) chunked.print(F("0"));
       chunked.print(k, HEX);
-      if (getSlaveResponding(k) == true) {
+      if (getSlaveStatus(k, responding) == true) {
         chunked.print(F(" OK"));
         countSlaves++;
+      } else if (getSlaveStatus(k, error) == true) {
+        chunked.print(F(" Failed to respond"));
+        countSlaves++;
       } else chunked.print(F(" scanning..."));
     }
   }