Merge pull request #22 from budulinek/dev

Dev

Author: budulinek

README.md

@@ -30,7 +30,8 @@ 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
+  - counters ("RTU Data", "Ethernet Data", "Modbus Statistics") are periodically saved to EEPROM (every 6 hours)
+  - unsigned longs are used, rollover of counters is synchronized
   - 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
@@ -45,10 +46,11 @@ Change settings of your Arduino-based Modbus RTU to Modbus TCP/UDP gateway via w
   - stored in EEPROM
   - retained during firmware upgrade (only in case of major version change, Arduino loads factory defaults)
   - all web interface inputs have proper validation
+  - factory defaults for user settings can be specified in advanced_settings.h
   - settings marked \* are only available if ENABLE_DHCP is defined in the sketch
   - settings marked \*\* are only available if ENABLE_EXTRA_DIAG is defined in the sketch
 * advanced settings:
-  - can be changed in sketch (see the initial section of arduino-modbus-rtu-tcp-gateway.ino)
+  - can be changed in sketch (advanced_settings.h)
   - stored in flash memory
 
 <img src="/pics/modbus1.png" alt="01" style="zoom:100%;" />
@@ -57,6 +59,10 @@ Change settings of your Arduino-based Modbus RTU to Modbus TCP/UDP gateway via w
 
 **Reboot**.
 
+**EEPROM Health**. Keeps track of EEPROM write cycles (this counter is persistent, never cleared during factory resets). Replace your Arduino once you reach 100 000 write cycles (with 6 hours EEPROM_INTERVAL you have more than 50 years lifespan).
+
+**Ethernet Sockets**. Max number of usable sockets. See Limitations bellow. One socket is reserved for Modbus UDP, remaining sockets are shared between Modbus TCP and WebUI.
+
 **Generate New MAC**. Generate new MAC address. First 3 bytes are fixed 90:A2:DA, remaining 3 bytes are true random.
 
 <img src="/pics/modbus2.png" alt="02" style="zoom:100%;" />
@@ -73,7 +79,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**.
 * **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.
@@ -148,21 +154,27 @@ Get the hardware (cheap clones from China are sufficient) and connect together:
 * **Arduino Nano, Uno or Mega** (and possibly other). On Mega you have to configure Serial in advanced settings in the sketch.
 * **W5100, W5200 or W5500 based Ethernet shield**. The ubiquitous W5100 shield for Uno/Mega is sufficient. If available, I recommend W5500 Ethernet Shield. !!! ENC28J60 will not work !!!
 * **TTL to RS485 module**:
-  - with hardware automatic flow control (recommended, available on Aliexpress)<br>
-      Arduino <-> Module<br>
-      Tx1 <-> Tx<br>
-      Rx0 <-> Rx
-  - with flow controlled by pin (such as MAX485 module)<br>
-      Arduino <-> MAX485<br>
-      Tx1 <-> DI<br>
-      Rx0 <-> RO<br>
+  - recommended: TTL to RS485 module with hardware automatic flow control (available on Aliexpress)<br>
+      Arduino <-> Module
+      Tx1 <-> Tx
+      Rx0 <-> Rx<br>
+      
+  - not recommended: MAX485 module with flow controlled by pin (works but is vulnerable to burn outs)<br>
+      Arduino <-> MAX485
+      Tx1 <-> DI
+      Rx0 <-> RO
       Pin 6 <-> DE,RE
 
-Here is my setup:
+Here is my HW setup:
 Terminal shield + Arduino Nano + W5500 ethernet shield (RobotDyn) + TTL to RS485 module (HW automatic flow control)
 <img src="/pics/HW.jpg" alt="01" style="zoom:100%;" />
 
-Download this repository (all *.ino files) and open arduino-modbus-rtu-tcp-gateway.ino in Arduino IDE. Download all required libraries (they are available in "library manager"). If you want, you can check the default factory settings (can be later changed via web interface) and advanced settings (can only be changed in the sketch). Compile and upload your program to Arduino. Connect your Arduino to ethernet, connect your Modbus RTU slaves to MAX485 module. Use your web browser to access the web interface on default IP  http://192.168.1.254   Enjoy :-)
+You can either:
+- ** Download and flash my pre-compiled firmware** from "Releases".
+- **Compile your own firmware**. Download this repository (all *.ino files) and open arduino-modbus-rtu-tcp-gateway.ino in Arduino IDE. Download all required libraries (they are available in "library manager"). If you want, you can check the default factory settings (can be later changed via web interface) and advanced settings (can only be changed in the sketch). Compile and upload your program to Arduino.
+
+Connect your Arduino to ethernet and use your web browser to access the web interface on default IP:  http://192.168.1.254
+Enjoy :-)
 
 ## Where can I learn more about Modbus protocols?
 
@@ -199,7 +211,7 @@ The number of used sockets is determined (by the Ethernet.h library) based on mi
 
 #### Memory
 
-Not everything could fit into the limited flash memory of Arduino Nano / Uno. If you have a microcontroller with more memory (such as Mega), you can enable extra settings in the main sketch by defining ENABLE_DHCP and/or ENABLE_EXTRA_DIAG in the sketch.
+Not everything could fit into the limited flash memory of Arduino Nano / Uno. If you have a microcontroller with more memory (such as Mega), you can enable extra settings in the main sketch by defining ENABLE_DHCP and/or ENABLE_EXTRA_DIAG in advanced settings.
 
 ## Version history
 

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

@@ -54,29 +54,29 @@ void startSerial() {
 #endif                                             /* RS485_CONTROL_PIN */
 }
 
-// time to send 1 character over serial in microseconds
-unsigned long charTime() {
-  byte bits =                                                   // number of bits per character (11 in default Modbus RTU settings)
+// number of bits per character (11 in default Modbus RTU settings)
+byte bitsPerChar() {
+  byte bits =
     1 +                                                         // start bit
     (((localConfig.serialConfig & 0x06) >> 1) + 5) +            // data bits
     (((localConfig.serialConfig & 0x08) >> 3) + 1);             // stop bits
   if (((localConfig.serialConfig & 0x30) >> 4) > 1) bits += 1;  // parity bit (if present)
-  return (bits * 10000UL) / (unsigned long)localConfig.baud;
+  return bits;
 }
 
-// character timeout
+// character timeout in micros
 unsigned long charTimeOut() {
   if (localConfig.baud <= 192) {
-    return 1.5 * charTime();  // inter-character time-out should be 1,5T
+    return (15000UL * bitsPerChar()) / localConfig.baud;  // inter-character time-out should be 1,5T
   } else {
     return 750;
   }
 }
 
-// minimum frame delay
+// minimum frame delay in micros
 unsigned long frameDelay() {
   if (localConfig.baud <= 192) {
-    return 3.5 * charTime();  // inter-frame delay should be 3,5T
+    return (35000UL * bitsPerChar()) / localConfig.baud;  // inter-frame delay should be 3,5T
   } else {
     return 1750;  // 1750 μs
   }
@@ -88,17 +88,17 @@ 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
   memcpy(mac + 3, localConfig.macEnd, 3);  // set last 3 bytes
 #ifdef ENABLE_DHCP
-  if (extraConfig.enableDhcp) {
+  if (localConfig.enableDhcp) {
     dhcpSuccess = Ethernet.begin(mac);
   }
-  if (!extraConfig.enableDhcp || dhcpSuccess == false) {
-    Ethernet.begin(mac, localConfig.ip, extraConfig.dns, localConfig.gateway, localConfig.subnet);
+  if (!localConfig.enableDhcp || dhcpSuccess == false) {
+    Ethernet.begin(mac, localConfig.ip, localConfig.dns, localConfig.gateway, localConfig.subnet);
   }
 #else  /* ENABLE_DHCP */
   Ethernet.begin(mac, localConfig.ip, {}, localConfig.gateway, localConfig.subnet);  // No DNS
@@ -119,7 +119,7 @@ void (*resetFunc)(void) = 0;  //declare reset function at address 0
 
 #ifdef ENABLE_DHCP
 void maintainDhcp() {
-  if (extraConfig.enableDhcp && dhcpSuccess == true) {  // only call maintain if initial DHCP request by startEthernet was successfull
+  if (localConfig.enableDhcp && dhcpSuccess == true) {  // only call maintain if initial DHCP request by startEthernet was successfull
     uint8_t maintainResult = Ethernet.maintain();
     if (maintainResult == 1 || maintainResult == 3) {  // renew failed or rebind failed
       dhcpSuccess = false;
@@ -148,37 +148,32 @@ 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++) {
     if (errorCount[i] > ROLLOVER) {
       return true;
     }
   }
-  if (errorTcpCount > ROLLOVER || errorRtuCount > ROLLOVER || errorTimeoutCount > ROLLOVER) {
-    return true;
-  }
 #ifdef ENABLE_EXTRA_DIAG
   if (seconds > ROLLOVER) {
     return true;
   }
-  if (serialTxCount > ROLLOVER || serialRxCount > ROLLOVER || ethTxCount > ROLLOVER || ethRxCount > ROLLOVER) {
-    return true;
+  for (byte i = 0; i < DATA_LAST; i++) {
+    if (rtuCount[i] > ROLLOVER || ethCount[i] > ROLLOVER) {
+      return true;
+    }
   }
 #endif /* ENABLE_EXTRA_DIAG */
   return false;
 }
 
 void resetStats() {
   memset(errorCount, 0, sizeof(errorCount));
-  errorTcpCount = 0;
-  errorRtuCount = 0;
-  errorTimeoutCount = 0;
 #ifdef ENABLE_EXTRA_DIAG
   remaining_seconds = -(millis() / 1000);
-  ethRxCount = 0;
-  ethTxCount = 0;
-  serialRxCount = 0;
-  serialTxCount = 0;
+  memset(rtuCount, 0, sizeof(rtuCount));
+  memset(ethCount, 0, sizeof(ethCount));
 #endif /* ENABLE_EXTRA_DIAG */
+  updateEeprom();
 }
 
 void generateMac() {
@@ -192,13 +187,31 @@ void generateMac() {
   }
 }
 
-
+void updateEeprom() {
+  eepromTimer.sleep(EEPROM_INTERVAL * 60UL * 60UL * 1000UL);  // EEPROM_INTERVAL is in hours, sleep is in milliseconds!
+  eepromWrites++;                                             // we assume that at least some bytes are written to EEPROM during EEPROM.update or EEPROM.put
+  int address = CONFIG_START;
+  EEPROM.put(address, eepromWrites);
+  address += sizeof(eepromWrites);
+  EEPROM.put(address, VERSION[0]);
+  address += 1;
+  EEPROM.put(address, localConfig);
+  address += sizeof(localConfig);
+  EEPROM.put(address, errorCount);
+  address += sizeof(errorCount);
+#ifdef ENABLE_EXTRA_DIAG
+  EEPROM.put(address, rtuCount);
+  address += sizeof(rtuCount);
+  EEPROM.put(address, ethCount);
+  address += sizeof(ethCount);
+#endif /* ENABLE_EXTRA_DIAG */
+}
 
 #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 +369,7 @@ ISR(WDT_vect) {
 #elif defined(__MK66FX1M0__)
 #define BOARD F("Teensy 3.6")
 #else
-#define BOARD F("Unknown board")
+#define BOARD F("Unknown Board")
 #endif
 
 #else  // --------------- Arduino ------------------
@@ -412,7 +425,7 @@ ISR(WDT_vect) {
 #elif defined(ARDUINO_ARC32_TOOLS)
 #define BOARD F("Arduino 101")
 #else
-#define BOARD F("Unknown board")
+#define BOARD F("Unknown Board")
 #endif
 
 #endif

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

@@ -43,7 +43,7 @@ void recvUdp() {
   unsigned int msgLength = Udp.parsePacket();
   if (msgLength) {
 #ifdef ENABLE_EXTRA_DIAG
-    ethRxCount += msgLength;
+    ethCount[DATA_RX] += msgLength;
 #endif                               /* ENABLE_EXTRA_DIAG */
     byte inBuffer[MODBUS_SIZE + 4];  // Modbus TCP frame is 4 bytes longer than Modbus RTU frame
                                      // Modbus TCP/UDP frame: [0][1] transaction ID, [2][3] protocol ID, [4][5] length and [6] unit ID (address)..... no CRC
@@ -72,8 +72,8 @@ void recvUdp() {
       }
       Udp.endPacket();
 #ifdef ENABLE_EXTRA_DIAG
-      ethTxCount += 5;
-      if (!localConfig.enableRtuOverTcp) ethTxCount += 4;
+      ethCount[DATA_TX] += 5;
+      if (!localConfig.enableRtuOverTcp) ethCount[DATA_TX] += 4;
 #endif /* ENABLE_EXTRA_DIAG */
     }
   }
@@ -82,7 +82,7 @@ void recvUdp() {
 void recvTcp(EthernetClient &client) {
   unsigned int msgLength = client.available();
 #ifdef ENABLE_EXTRA_DIAG
-  ethRxCount += msgLength;
+  ethCount[DATA_RX] += msgLength;
 #endif                             /* ENABLE_EXTRA_DIAG */
   byte inBuffer[MODBUS_SIZE + 4];  // Modbus TCP frame is 4 bytes longer than Modbus RTU frame
   // Modbus TCP/UDP frame: [0][1] transaction ID, [2][3] protocol ID, [4][5] length and [6] unit ID (address).....
@@ -113,8 +113,8 @@ void recvTcp(EthernetClient &client) {
     }
     client.write(outBuffer, i);
 #ifdef ENABLE_EXTRA_DIAG
-    ethTxCount += 5;
-    if (!localConfig.enableRtuOverTcp) ethTxCount += 4;
+    ethCount[DATA_TX] += 5;
+    if (!localConfig.enableRtuOverTcp) ethCount[DATA_TX] += 4;
 #endif /* ENABLE_EXTRA_DIAG */
   }
 }
@@ -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
     }
   }
@@ -215,29 +215,29 @@ void deleteRequest()  // delete request from queue
 }
 
 void clearQueue() {
-  queueHeaders.clear();  // <- eats memory!
+  queueHeaders.clear();
   queueData.clear();
   scanReqInQueue = false;
   priorityReqInQueue = false;
   memset(socketInQueue, 0, sizeof(socketInQueue));
-  memset(stat[SLAVE_ERROR_0B_QUEUE], 0, sizeof(stat[SLAVE_ERROR_0B_QUEUE]));
-  sendTimer.sleep(0);
+  memset(slaveStatus[SLAVE_ERROR_0B_QUEUE], 0, sizeof(slaveStatus[SLAVE_ERROR_0B_QUEUE]));
+  sendMicroTimer.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
   }
 }