Save error counters to EEPROM

Author: budulinek

README.md

@@ -30,7 +30,7 @@ Change settings of your Arduino-based Modbus RTU to Modbus TCP/UDP gateway via w
   - send Modbus request and recieve Modbus response
   - scan Modbus slaves on RS485 interface
   - queue (buffer) status
-  - error counts
+  - error counters (stored in EEPROM)
   - content of the Modbus Status page is updated in the background (fetch API), javascript alert is shown if connection is lost
 * optimized TCP socket management (web interface and Modbus TCP):
   - gateway always listens for new web and Modbus TCP connections
@@ -73,7 +73,7 @@ Change settings of your Arduino-based Modbus RTU to Modbus TCP/UDP gateway via w
 
 **Requests Queue**. Monitors internal request queue (buffer). The limits for bytes and for the number of requests stored in the queue can be configured in advanced settings.
 
-**Modbus Statistics**. Counters for various errors. Insigned longs are used, rollover of counters is synchronized:
+**Modbus Statistics**. Counters for various errors. Counters are periodically saved to EEPROM. Insigned longs are used, rollover of counters is synchronized:
 * **Slave Responded**. Slave responded with a valid Modbus RTU response within response timeout.
 * **Slave Responded with Error (Codes 1~8)**. Slave responded, but with an error. For the list of error codes see https://en.wikipedia.org/wiki/Modbus#Exception_responses.
 * **Gateway Overloaded (Code 10)**. Request queue is full (either the number of bytes stored or the number of requests stored). Request was dropped and the gateway responded with an error code 10.

arduino-modbus-rtu-tcp-gateway/01-interfaces.ino

@@ -88,7 +88,7 @@ void startEthernet() {
     digitalWrite(ETH_RESET_PIN, LOW);
     delay(25);
     digitalWrite(ETH_RESET_PIN, HIGH);
-    delay(500);
+    delay(ETH_RESET_DELAY);
   }
   byte mac[6];
   memcpy(mac, MAC_START, 3);               // set first 3 bytes
@@ -148,14 +148,11 @@ void maintainUptime() {
 bool rollover() {
   // synchronize roll-over of run time, data counters and modbus stats to zero, at 0xFFFFFF00
   const unsigned long ROLLOVER = 0xFFFFFF00;
-  for (byte i = 0; i < SLAVE_ERROR_0B_QUEUE; i++) {  // there is no counter for SLAVE_ERROR_0B_QUEUE
+  for (byte i = 0; i < ERROR_LAST; i++) {  // there is no counter for SLAVE_ERROR_0B_QUEUE
     if (errorCount[i] > ROLLOVER) {
       return true;
     }
   }
-  if (errorTcpCount > ROLLOVER || errorRtuCount > ROLLOVER || errorTimeoutCount > ROLLOVER) {
-    return true;
-  }
 #ifdef ENABLE_EXTRA_DIAG
   if (seconds > ROLLOVER) {
     return true;
@@ -169,9 +166,7 @@ bool rollover() {
 
 void resetStats() {
   memset(errorCount, 0, sizeof(errorCount));
-  errorTcpCount = 0;
-  errorRtuCount = 0;
-  errorTimeoutCount = 0;
+  statsEepromTimer.sleep(0);
 #ifdef ENABLE_EXTRA_DIAG
   remaining_seconds = -(millis() / 1000);
   ethRxCount = 0;
@@ -195,10 +190,10 @@ void generateMac() {
 
 
 #if MAX_SOCK_NUM == 8
-unsigned long lastSocketUse[MAX_SOCK_NUM] = { 0, 0, 0, 0, 0, 0, 0, 0 };  // +rs 03Feb2019 - records last interaction involving each socket to enable detecting sockets unused for longest time period
+unsigned long lastSocketUse[MAX_SOCK_NUM] = { 0, 0, 0, 0, 0, 0, 0, 0 };
 byte socketInQueue[MAX_SOCK_NUM] = { 0, 0, 0, 0, 0, 0, 0, 0 };
 #elif MAX_SOCK_NUM == 4
-unsigned long lastSocketUse[MAX_SOCK_NUM] = { 0, 0, 0, 0 };                          // +rs 03Feb2019 - records last interaction involving each socket to enable detecting sockets unused for longest time period
+unsigned long lastSocketUse[MAX_SOCK_NUM] = { 0, 0, 0, 0 };
 byte socketInQueue[MAX_SOCK_NUM] = { 0, 0, 0, 0 };
 #endif
 
@@ -356,7 +351,7 @@ ISR(WDT_vect) {
 #elif defined(__MK66FX1M0__)
 #define BOARD F("Teensy 3.6")
 #else
-#error "Unknown board"
+#define BOARD F("Unknown Board")
 #endif
 
 #else  // --------------- Arduino ------------------
@@ -412,7 +407,7 @@ ISR(WDT_vect) {
 #elif defined(ARDUINO_ARC32_TOOLS)
 #define BOARD F("Arduino 101")
 #else
-#error "Unknown board"
+#define BOARD F("Unknown Board")
 #endif
 
 #endif

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

@@ -152,12 +152,12 @@ byte checkRequest(byte inBuffer[], unsigned int msgLength, const uint32_t remote
   byte addressPos = 6 * !localConfig.enableRtuOverTcp;  // position of slave address in the incoming TCP/UDP message (0 for Modbus RTU over TCP/UDP and 6 for Modbus RTU over TCP/UDP)
   if (localConfig.enableRtuOverTcp) {                   // check CRC for Modbus RTU over TCP/UDP
     if (checkCRC(inBuffer, msgLength) == false) {
-      errorTcpCount++;
+      errorCount[ERROR_TCP]++;
       return 0;  // drop request and do not return any error code
     }
   } else {  // check MBAP header structure for Modbus TCP/UDP
     if (inBuffer[2] != 0x00 || inBuffer[3] != 0x00 || inBuffer[4] != 0x00 || inBuffer[5] != msgLength - 6) {
-      errorTcpCount++;
+      errorCount[ERROR_TCP]++;
       return 0;  // drop request and do not return any error code
     }
   }
@@ -220,24 +220,24 @@ void clearQueue() {
   scanReqInQueue = false;
   priorityReqInQueue = false;
   memset(socketInQueue, 0, sizeof(socketInQueue));
-  memset(stat[SLAVE_ERROR_0B_QUEUE], 0, sizeof(stat[SLAVE_ERROR_0B_QUEUE]));
+  memset(slaveStatus[SLAVE_ERROR_0B_QUEUE], 0, sizeof(slaveStatus[SLAVE_ERROR_0B_QUEUE]));
   sendTimer.sleep(0);
 }
 
 bool getSlaveStatus(const uint8_t slave, const byte status) {
   if (slave >= MAX_SLAVES) return false;  // error
-  return (stat[status][slave / 8] & masks[slave & 7]) > 0;
+  return (slaveStatus[status][slave / 8] & masks[slave & 7]) > 0;
 }
 
 void setSlaveStatus(const uint8_t slave, byte status, const bool value, const bool isScan) {
-  if (slave >= MAX_SLAVES) return;  // error
+  if (slave >= MAX_SLAVES || status > SLAVE_ERROR_0B_QUEUE) return;  // error
   if (value == 0) {
-    stat[status][slave / 8] &= ~masks[slave & 7];
+    slaveStatus[status][slave / 8] &= ~masks[slave & 7];
   } else {
-    for (byte i = 0; i < SLAVE_ERROR_LAST; i++) {
-      stat[i][slave / 8] &= ~masks[slave & 7];  // set all other flags to false
+    for (byte i = 0; i <= SLAVE_ERROR_0B_QUEUE; i++) {
+      slaveStatus[i][slave / 8] &= ~masks[slave & 7];  // set all other flags to false, SLAVE_ERROR_0B_QUEUE is the last slave status
     }
-    stat[status][slave / 8] |= masks[slave & 7];
+    slaveStatus[status][slave / 8] |= masks[slave & 7];
     if (status != SLAVE_ERROR_0B_QUEUE && isScan == false) errorCount[status]++;  // there is no counter for SLAVE_ERROR_0B_QUEUE, ignor scans in statistics
   }
 }

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

@@ -109,10 +109,10 @@ void sendSerial() {
           PDU[3] = lowByte(crc);  // send CRC, low byte first
           PDU[4] = highByte(crc);
           sendResponse(MBAP, PDU, 5);
-          errorTimeoutCount++;
+          errorCount[ERROR_TIMEOUT]++;
         } else {
           setSlaveStatus(queueData[0], SLAVE_ERROR_0B_QUEUE, true, false);
-          errorTimeoutCount++;
+          errorCount[ERROR_TIMEOUT]++;
         }                 // if (myHeader.atts >= MAX_RETRY)
         serialState = 0;  // IDLE
       }
@@ -130,7 +130,7 @@ void recvSerial() {
     if (rxNdx < MODBUS_SIZE) {
       serialIn[rxNdx] = b;
       rxNdx++;
-    }  // if frame longer than maximum allowed, CRC will fail and errorRtuCount will be recorded down the road
+    }  // if frame longer than maximum allowed, CRC will fail and errorCount[ERROR_RTU] will be recorded down the road
     recvTimer.sleep(charTimeOut());
     sendTimer.sleep(localConfig.frameDelay * 1000UL);  // delay next serial write
   }
@@ -155,7 +155,7 @@ void recvSerial() {
       sendResponse(MBAP, serialIn, rxNdx);
       serialState = IDLE;
     } else {
-      errorRtuCount++;
+      errorCount[ERROR_RTU]++;
     }
 #ifdef ENABLE_EXTRA_DIAG
     serialRxCount += rxNdx;

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

@@ -102,26 +102,14 @@ byte requestLen = 0;                         // Length of the Modbus request sen
 
 // Keys for JSON elements, used in: 1) JSON documents, 2) ID of span tags, 3) Javascript.
 enum JSON_type : byte {
-  JSON_SECS,   // Runtime seconds
-  JSON_MINS,   // Runtime minutes
-  JSON_HOURS,  // Runtime hours
-  JSON_DAYS,   // Runtime days
-  JSON_ERROR,  // Modbus status from array errorCount[STAT_ERROR_0B_QUEUE]
-  JSON_ERROR_1,
-  JSON_ERROR_2,
-  JSON_ERROR_3,
-  JSON_ERROR_TCP,
-  JSON_ERROR_RTU,
-  JSON_ERROR_TIMEOUT,
-  JSON_QUEUE_DATA,
-  JSON_QUEUE_REQUESTS,
+  JSON_TIME,   // Runtime seconds
+  JSON_RTU_DATA,
+  JSON_ETH_DATA,
+  JSON_RESPONSE,
+  JSON_STATS,  // Modbus statistics from array errorCount[]
+  JSON_QUEUE,
   JSON_TCP_UDP_MASTERS,  // list of Modbus TCP/UDP masters separated by <br>
   JSON_SLAVES,           // list of Modbus RTU slaves separated by <br>
-  JSON_RTU_TX,
-  JSON_RTU_RX,
-  JSON_ETH_TX,
-  JSON_ETH_RX,
-  JSON_RESPONSE,
   JSON_SOCKETS,
   JSON_LAST,  // Must be the very last element in this array
 };
@@ -362,7 +350,7 @@ void processPost(EthernetClient &client) {
       break;
     case SCAN:
       scanCounter = 1;
-      memset(&stat, 0, sizeof(stat));  // clear all status flags
+      memset(&slaveStatus, 0, sizeof(slaveStatus));  // clear all status flags
       break;
     case CLEAR_REQUEST:
       requestLen = 0;
@@ -390,7 +378,7 @@ void processPost(EthernetClient &client) {
   // new parameter values received, save them to EEPROM
   EEPROM.put(CONFIG_START + 1, localConfig);  // it is safe to call, only changed values are updated
 #ifdef ENABLE_DHCP
-  EEPROM.put(CONFIG_START + 1 + sizeof(localConfig), extraConfig);
+  EEPROM.put(CONFIG_START + 1 + sizeof(localConfig) + sizeof(errorCount), extraConfig);
 #endif
 }