Simplify EEPROM read / write

Author: budulinek

README.md

@@ -11,6 +11,7 @@ Arduino-based Modbus RTU to Modbus TCP/UDP gateway with web interface. Allows yo
   - [IP Settings](#ip-settings)
   - [TCP/UDP Settings](#tcpudp-settings)
   - [RTU Settings](#rtu-settings)
+  - [Tools](#tools)
 * [Integration](#integration)
   - [Loxone](#loxone)
   - [Home Assistant](#home-assistant)
@@ -73,22 +74,25 @@ Allows you to connect your Modbus devices (such as sensors, energy meters, HVAC
 # Hardware
 Get the hardware (cheap clones from China are sufficient) and connect together:
 
-* **Arduino Nano, Uno or Mega** (and possibly other boards with Atmel chips).<br>On Mega you have to configure Serial in advanced settings in the sketch.
+* **Arduino Nano, Uno or Mega** (and possibly other boards with ATmega chips).<br>On Mega you have to configure Serial in advanced settings in the sketch.
 * **Ethernet shield with WIZnet chip (W5100, W5200 or W5500)**.<br>The ubiquitous W5100 shield for Uno/Mega is sufficient. If available, I recommend W5500 Ethernet Shield. You can also use combo board MCU + ethernet (such as ATmega328 + W5500 board from Keyestudio).<br>ATTENTION: Ethernet shields with ENC28J60 chip will not work !!!
-* **TTL to RS485 module with an automatic flow direction control**.<br>You can buy cheap modules with MAX3485, MAX13487, SP485 or SP3485 chips (some of these modules are branded as "XY-017", "XY-485", "XY-G485", etc.) from Aliexpress and other marketplaces. Use stabilized external power supply 5V for both Arduino (incl. ethernet shield) and the RS485 module.<br>ATTENTION: Modules with MAX485 chip will work (use pin 6 for DE,RE), but are NOT recommended (no auto-direction, no ESD protection, no hot-swap protection)!!!
+* **TTL to RS485 module with an automatic flow direction control**.<br>You can buy cheap modules with MAX3485, MAX13487, SP485 or SP3485 chips (some of these modules are branded as "XY-017", "XY-485", "XY-G485", etc.) from Aliexpress and other marketplaces.<br>ATTENTION: Modules with MAX485 chip will work (use pin 6 for DE+RE), but are NOT recommended (no auto-direction, no ESD protection, no hot-swap protection) !!!
+* **External power supply**.<br>Use regulated 5V external power supply for both the Arduino (+ the ethernet shield) and the RS485 module.<br>ATTENTION: By using the 5V pin, you are bypassing Arduino's built-in voltage regulator and reverse-polarity protection curcuit. Make sure your external power supply does not exceed 5,5V !!!
 
 <img src="pics/fritzing.png" alt="fritzing" />
 
 
 Here is my HW setup:
-Terminal shield + Arduino Nano + W5500 ethernet shield (RobotDyn, no longer available) + XY-017 TTL to RS485 module (automatic flow control)
+Terminal shield + Arduino Nano + W5500 ethernet shield (from RobotDyn, no longer available) + TTL to RS485 module (automatic flow control)
 <img src="pics/HW.jpg" alt="HW" style="zoom:100%;" />
 
 # Firmware
 
 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.
+- **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. If you want, you can check advanced_settings.h for advanced settings (can only be changed in the sketch) and for default factory settings (can be later changed via web interface). Download all required libraries, compile and upload your program to Arduino. The program uses the following external libraries (all are available in Arduino IDE's "library manager"):
+ - CircularBuffer (https://github.com/rlogiacco/CircularBuffer)
+ - StreamLib (https://github.com/jandrassy/StreamLib)
 
 Connect your Arduino to ethernet and use your web browser to access the web interface on default IP:  http://192.168.1.254
 Enjoy :-)
@@ -99,14 +103,12 @@ Enjoy :-)
 ## System Info
 <img src="pics/modbus1.png" alt="modbus1" style="zoom:100%;" />
 
-**Load Default Settings**. Loads default settings (see DEFAULT_CONFIG in advanced settings). MAC address is retained.
-
-**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.
 
+**Ethernet Chip**. Wiznet chip on the ethernet shield.
+
 **MAC Address**. First 3 bytes are fixed 90:A2:DA, remaining 3 bytes are random. You can also set manual MAC in IP Settings.
 
 ## Modbus Status
@@ -197,6 +199,13 @@ Enjoy :-)
 
 **Attempts**. Number of attempts before error (Code 11) is sent back to the Modbus TCP/UDP master.
 
+## Tools
+<img src="pics/modbus6.png" alt="modbus6" style="zoom:100%;" />
+
+**Load Default Settings**. Loads default settings (see DEFAULT_CONFIG in advanced settings). MAC address is retained.
+
+**Reboot**.
+
 # Integration
 
 This gateway adheres to the Modbus protocol specifications, so you can use it to connect any compliant Modbus RTU slave (Modbus device) with any compliant Modbus  TCP/UDP master (such as home automation system). Here is a quick overview how you can integrate the gateway into the most popular home automation systems:

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

@@ -47,7 +47,7 @@
 
 
 void startSerial() {
-  mySerial.begin((localConfig.baud * 100UL), localConfig.serialConfig);
+  mySerial.begin((data.config.baud * 100UL), data.config.serialConfig);
 #ifdef RS485_CONTROL_PIN
   pinMode(RS485_CONTROL_PIN, OUTPUT);
   digitalWrite(RS485_CONTROL_PIN, RS485_RECEIVE);  // Init Transceiver
@@ -58,25 +58,25 @@ void startSerial() {
 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)
+    (((data.config.serialConfig & 0x06) >> 1) + 5) +            // data bits
+    (((data.config.serialConfig & 0x08) >> 3) + 1);             // stop bits
+  if (((data.config.serialConfig & 0x30) >> 4) > 1) bits += 1;  // parity bit (if present)
   return bits;
 }
 
 // character timeout in micros
 uint32_t charTimeOut() {
-  if (localConfig.baud <= 192) {
-    return (15000UL * bitsPerChar()) / localConfig.baud;  // inter-character time-out should be 1,5T
+  if (data.config.baud <= 192) {
+    return (15000UL * bitsPerChar()) / data.config.baud;  // inter-character time-out should be 1,5T
   } else {
     return 750;
   }
 }
 
 // minimum frame delay in micros
 uint32_t frameDelay() {
-  if (localConfig.baud <= 192) {
-    return (35000UL * bitsPerChar()) / localConfig.baud;  // inter-frame delay should be 3,5T
+  if (data.config.baud <= 192) {
+    return (35000UL * bitsPerChar()) / data.config.baud;  // inter-frame delay should be 3,5T
   } else {
     return 1750;  // 1750 μs
   }
@@ -91,20 +91,20 @@ void startEthernet() {
     delay(ETH_RESET_DELAY);
   }
 #ifdef ENABLE_DHCP
-  if (localConfig.enableDhcp) {
-    dhcpSuccess = Ethernet.begin(mac);
+  if (data.config.enableDhcp) {
+    dhcpSuccess = Ethernet.begin(data.mac);
   }
-  if (!localConfig.enableDhcp || dhcpSuccess == false) {
-    Ethernet.begin(mac, localConfig.ip, localConfig.dns, localConfig.gateway, localConfig.subnet);
+  if (!data.config.enableDhcp || dhcpSuccess == false) {
+    Ethernet.begin(data.mac, data.config.ip, data.config.dns, data.config.gateway, data.config.subnet);
   }
 #else  /* ENABLE_DHCP */
-  Ethernet.begin(mac, localConfig.ip, {}, localConfig.gateway, localConfig.subnet);  // No DNS
+  Ethernet.begin(data.mac, data.config.ip, {}, data.config.gateway, data.config.subnet);  // No DNS
 #endif /* ENABLE_DHCP */
   W5100.setRetransmissionTime(TCP_RETRANSMISSION_TIMEOUT);
   W5100.setRetransmissionCount(TCP_RETRANSMISSION_COUNT);
-  modbusServer = EthernetServer(localConfig.tcpPort);
-  webServer = EthernetServer(localConfig.webPort);
-  Udp.begin(localConfig.udpPort);
+  modbusServer = EthernetServer(data.config.tcpPort);
+  webServer = EthernetServer(data.config.webPort);
+  Udp.begin(data.config.udpPort);
   modbusServer.begin();
   webServer.begin();
 #if MAX_SOCK_NUM > 4
@@ -116,7 +116,7 @@ void (*resetFunc)(void) = 0;  //declare reset function at address 0
 
 #ifdef ENABLE_DHCP
 void maintainDhcp() {
-  if (localConfig.enableDhcp && dhcpSuccess == true) {  // only call maintain if initial DHCP request by startEthernet was successfull
+  if (data.config.enableDhcp && dhcpSuccess == true) {  // only call maintain if initial DHCP request by startEthernet was successfull
     byte maintainResult = Ethernet.maintain();
     if (maintainResult == 1 || maintainResult == 3) {  // renew failed or rebind failed
       dhcpSuccess = false;
@@ -146,7 +146,7 @@ bool rollover() {
   // synchronize roll-over of run time, data counters and modbus stats to zero, at 0xFFFFFF00
   const uint32_t ROLLOVER = 0xFFFFFF00;
   for (byte i = 0; i < ERROR_LAST; i++) {
-    if (errorCount[i] > ROLLOVER) {
+    if (data.errorCnt[i] > ROLLOVER) {
       return true;
     }
   }
@@ -155,56 +155,41 @@ bool rollover() {
     return true;
   }
   for (byte i = 0; i < DATA_LAST; i++) {
-    if (rtuCount[i] > ROLLOVER || ethCount[i] > ROLLOVER) {
+    if (data.rtuCnt[i] > ROLLOVER || data.ethCnt[i] > ROLLOVER) {
       return true;
     }
   }
 #endif /* ENABLE_EXTRA_DIAG */
   return false;
 }
 
+// resets counters to 0: data.errorCnt, data.rtuCnt, data.ethCnt
 void resetStats() {
-  memset(errorCount, 0, sizeof(errorCount));
+  memset(data.errorCnt, 0, sizeof(data.errorCnt));
 #ifdef ENABLE_EXTRA_DIAG
+  memset(data.rtuCnt, 0, sizeof(data.rtuCnt));
+  memset(data.ethCnt, 0, sizeof(data.ethCnt));
   remaining_seconds = -(millis() / 1000);
-  memset(rtuCount, 0, sizeof(rtuCount));
-  memset(ethCount, 0, sizeof(ethCount));
 #endif /* ENABLE_EXTRA_DIAG */
-  updateEeprom();
 }
 
+// generate new MAC (bytes 0, 1 and 2 are static, bytes 3, 4 and 5 are generated randomly)
 void generateMac() {
   // Marsaglia algorithm from https://github.com/RobTillaart/randomHelpers
   seed1 = 36969L * (seed1 & 65535L) + (seed1 >> 16);
   seed2 = 18000L * (seed2 & 65535L) + (seed2 >> 16);
   uint32_t randomBuffer = (seed1 << 16) + seed2; /* 32-bit random */
-  memcpy(mac, MAC_START, 3);                     // set first 3 bytes
+  memcpy(data.mac, MAC_START, 3);                // set first 3 bytes
   for (byte i = 0; i < 3; i++) {
-    mac[i + 3] = randomBuffer & 0xFF;  // random last 3 bytes
+    data.mac[i + 3] = randomBuffer & 0xFF;  // random last 3 bytes
     randomBuffer >>= 8;
   }
 }
 
 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
-  uint16_t address = CONFIG_START;
-  EEPROM.put(address, eepromWrites);
-  address += sizeof(eepromWrites);
-  EEPROM.put(address, VERSION[0]);
-  address += 1;
-  EEPROM.put(address, mac);
-  address += 6;
-  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 */
+  data.eepromWrites++;                                        // we assume that at least some bytes are written to EEPROM during EEPROM.update or EEPROM.put
+  EEPROM.put(DATA_START, data);
 }
 
 #if MAX_SOCK_NUM == 8
@@ -243,7 +228,7 @@ void manageSockets() {
       case SnSR::SYNRECV:
         {
           lastSocketUse[s] = millis();
-          if (W5100.readSnPORT(s) == localConfig.webPort) {
+          if (W5100.readSnPORT(s) == data.config.webPort) {
             webListening = s;
           } else {
             modbusListening = s;
@@ -275,8 +260,8 @@ void manageSockets() {
               W5100.execCmdSn(s, Sock_DISCON);  //  send DISCON command...
               lastSocketUse[s] = millis();      //   record time at which it was sent...
                                                 // status becomes LAST_ACK for short time
-            } else if (((W5100.readSnPORT(s) == localConfig.webPort && sockAge > WEB_IDLE_TIMEOUT)
-                        || (W5100.readSnPORT(s) == localConfig.tcpPort && sockAge > (localConfig.tcpTimeout * 1000UL)))
+            } else if (((W5100.readSnPORT(s) == data.config.webPort && sockAge > WEB_IDLE_TIMEOUT)
+                        || (W5100.readSnPORT(s) == data.config.tcpPort && sockAge > (data.config.tcpTimeout * 1000UL)))
                        && sockAge > maxAge) {
               oldest = s;        //     record the socket number...
               maxAge = sockAge;  //      and make its age the new max age.
@@ -291,7 +276,7 @@ void manageSockets() {
 
   if (dataAvailable != MAX_SOCK_NUM) {
     EthernetClient client = EthernetClient(dataAvailable);
-    if (W5100.readSnPORT(dataAvailable) == localConfig.webPort) {
+    if (W5100.readSnPORT(dataAvailable) == data.config.webPort) {
       recvWeb(client);
     } else {
       recvTcp(client);