Screenshot, Readme

Author: budulinek

README.md

@@ -59,7 +59,7 @@ Change settings of your Arduino-based Modbus RTU to Modbus TCP/UDP gateway via w
 
 **Reboot**.
 
-**EEPROM Health**. Keeps track of EEPROM write cycles (persistent, never cleared during factory resets)
+**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.
 
@@ -165,11 +165,16 @@ Get the hardware (cheap clones from China are sufficient) and connect together:
       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?
 
@@ -206,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/04-webserver.ino

@@ -24,16 +24,16 @@ const byte POST_SIZE = 24;  // a smaller buffer for single post parameter + key
 
 // Actions that need to be taken after saving configuration.
 enum action_type : byte {
-  NONE,
-  FACTORY,        // Load default factory settings (but keep MAC address)
-  MAC,            // Generate new random MAC
-  REBOOT,         // Reboot the microcontroller
-  RESET_ETH,      // Ethernet reset
-  RESET_SERIAL,   // Serial reset
-  SCAN,           // Initialize RTU scan
-  RESET_STATS,    // Reset Modbus Statistics
-  CLEAR_REQUEST,  // Clear Modbus Request form
-  WEB             // Restart webserver
+  ACT_NONE,
+  ACT_FACTORY,        // Load default factory settings (but keep MAC address)
+  ACT_MAC,            // Generate new random MAC
+  ACT_REBOOT,         // Reboot the microcontroller
+  ACT_RESET_ETH,      // Ethernet reset
+  ACT_RESET_SERIAL,   // Serial reset
+  ACT_SCAN,           // Initialize RTU scan
+  ACT_RESET_STATS,    // Reset Modbus Statistics
+  ACT_CLEAR_REQUEST,  // Clear Modbus Request form
+  ACT_WEB             // Restart webserver
 };
 enum action_type action;
 
@@ -151,7 +151,7 @@ void recvWeb(EthernetClient &client) {
     }
   }
   // Actions that require "please wait" page
-  if (action == WEB || action == MAC || action == RESET_ETH || action == REBOOT || action == FACTORY) {
+  if (action == ACT_WEB || action == ACT_MAC || action == ACT_RESET_ETH || action == ACT_REBOOT || action == ACT_FACTORY) {
     reqPage = PAGE_WAIT;
   }
   // Send page
@@ -160,7 +160,7 @@ void recvWeb(EthernetClient &client) {
   // Do all actions before the "please wait" redirects (5s delay at the moment)
   if (reqPage == PAGE_WAIT) {
     switch (action) {
-      case WEB:
+      case ACT_WEB:
         for (byte s = 0; s < maxSockNum; s++) {
           // close old webserver TCP connections
           if (EthernetClient(s).localPort() != localConfig.tcpPort) {
@@ -169,23 +169,23 @@ void recvWeb(EthernetClient &client) {
         }
         webServer = EthernetServer(localConfig.webPort);
         break;
-      case MAC:
-      case RESET_ETH:
+      case ACT_MAC:
+      case ACT_RESET_ETH:
         for (byte s = 0; s < maxSockNum; s++) {
           // close all TCP and UDP sockets
           disconSocket(s);
         }
         startEthernet();
         break;
-      case REBOOT:
-      case FACTORY:
+      case ACT_REBOOT:
+      case ACT_FACTORY:
         resetFunc();
         break;
       default:
         break;
     }
   }
-  action = NONE;
+  action = ACT_NONE;
 }
 
 // This function stores POST parameter values in localConfig.
@@ -237,7 +237,7 @@ void processPost(EthernetClient &client) {
         break;
       case POST_IP ... POST_IP_3:
         {
-          action = RESET_ETH;  // this RESET_ETH is triggered when the user changes anything on the "IP Settings" page.
+          action = ACT_RESET_ETH;  // this RESET_ETH is triggered when the user changes anything on the "IP Settings" page.
           // No need to trigger RESET_ETH for other cases (POST_SUBNET, POST_GATEWAY etc.)
           localConfig.ip[paramKeyByte - POST_IP] = byte(paramValueUint);
         }
@@ -276,7 +276,7 @@ void processPost(EthernetClient &client) {
         {
           if (paramValueUint != localConfig.webPort && paramValueUint != localConfig.tcpPort) {  // continue only of the value changed and it differs from Modbus TCP port
             localConfig.webPort = paramValueUint;
-            action = WEB;
+            action = ACT_WEB;
           }
         }
         break;
@@ -288,7 +288,7 @@ void processPost(EthernetClient &client) {
         break;
       case POST_BAUD:
         {
-          action = RESET_SERIAL;  // this RESET_SERIAL is triggered when the user changes anything on the "RTU Settings" page.
+          action = ACT_RESET_SERIAL;  // this RESET_SERIAL is triggered when the user changes anything on the "RTU Settings" page.
           // No need to trigger RESET_ETH for other cases (POST_DATA, POST_PARITY etc.)
           localConfig.baud = paramValueUint;
           byte minFrameDelay = byte((frameDelay() / 1000UL) + 1);
@@ -329,7 +329,7 @@ void processPost(EthernetClient &client) {
     }
   }
   switch (action) {
-    case FACTORY:
+    case ACT_FACTORY:
       {
         byte tempMac[3];
         memcpy(tempMac, localConfig.macEnd, 3);  // keep current MAC
@@ -338,21 +338,21 @@ void processPost(EthernetClient &client) {
         resetStats();
         break;
       }
-    case MAC:
+    case ACT_MAC:
       generateMac();
       break;
-    case RESET_STATS:
+    case ACT_RESET_STATS:
       resetStats();
       break;
-    case RESET_SERIAL:
+    case ACT_RESET_SERIAL:
       clearQueue();
       startSerial();
       break;
-    case SCAN:
+    case ACT_SCAN:
       scanCounter = 1;
       memset(&slaveStatus, 0, sizeof(slaveStatus));  // clear all status flags
       break;
-    case CLEAR_REQUEST:
+    case ACT_CLEAR_REQUEST:
       requestLen = 0;
       responseLen = 0;
       break;

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

@@ -195,11 +195,11 @@ void contentInfo(ChunkedPrint &chunked) {
   chunked.print(VERSION[0]);
   chunked.print(F("."));
   chunked.print(VERSION[1]);
-  tagButton(chunked, F("Load Default Settings"), FACTORY);
+  tagButton(chunked, F("Load Default Settings"), ACT_FACTORY);
   tagDivClose(chunked);
   tagLabelDiv(chunked, F("Microcontroller"));
   chunked.print(BOARD);
-  tagButton(chunked, F("Reboot"), REBOOT);
+  tagButton(chunked, F("Reboot"), ACT_REBOOT);
   tagDivClose(chunked);
   tagLabelDiv(chunked, F("EEPROM Health"));
   chunked.print(eepromWrites);
@@ -231,7 +231,7 @@ void contentInfo(ChunkedPrint &chunked) {
     chunked.print(hex(macBuffer[i]));
     if (i < 5) chunked.print(F(":"));
   }
-  tagButton(chunked, F("Generate New MAC"), MAC);
+  tagButton(chunked, F("Generate New MAC"), ACT_MAC);
   tagDivClose(chunked);
 
 #ifdef ENABLE_DHCP
@@ -284,7 +284,7 @@ void contentStatus(ChunkedPrint &chunked) {
     chunked.print(F("'>"));
   }
   chunked.print(F("h (without CRC) <input type=submit value=Send>"));
-  tagButton(chunked, F("Clear"), CLEAR_REQUEST);
+  tagButton(chunked, F("Clear"), ACT_CLEAR_REQUEST);
   tagDivClose(chunked);
   chunked.print(F("</form><form method=post>"));
   tagLabelDiv(chunked, F("Modbus RTU Response"));
@@ -294,14 +294,14 @@ void contentStatus(ChunkedPrint &chunked) {
   tagSpan(chunked, JSON_QUEUE);
   tagDivClose(chunked);
   tagLabelDiv(chunked, F("Modbus Statistics"));
-  tagButton(chunked, F("Reset Stats"), RESET_STATS);
+  tagButton(chunked, F("Reset Stats"), ACT_RESET_STATS);
   tagSpan(chunked, JSON_STATS);
   tagDivClose(chunked);
   tagLabelDiv(chunked, F("Modbus Masters"));
   tagSpan(chunked, JSON_TCP_UDP_MASTERS);
   tagDivClose(chunked);
   tagLabelDiv(chunked, F("Modbus Slaves"));
-  tagButton(chunked, F("Scan Slaves"), SCAN);
+  tagButton(chunked, F("Scan Slaves"), ACT_SCAN);
   tagSpan(chunked, JSON_SLAVES);
   tagDivClose(chunked);
 }