Fetch API

Author: budulinek

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

@@ -35,6 +35,14 @@
 
 
 void startSerial() {
+  mySerial.flush();
+  mySerial.end();
+  queueHeaders.clear();            // <- eats memory!
+  queueData.clear();
+  scanReqInQueue = false;
+  priorityReqInQueue= false;
+  memset(stat[STAT_ERROR_0B_QUEUE], 0, sizeof(stat[STAT_ERROR_0B_QUEUE]));  
+  sendTimer.sleep(0);
   mySerial.begin(localConfig.baud, localConfig.serialConfig);
 #ifdef RS485_CONTROL_PIN
   pinMode(RS485_CONTROL_PIN, OUTPUT);

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

@@ -31,29 +31,8 @@
 #define UDP_REQUEST B00100000       // UDP request
 #define TCP_REQUEST B00001111       // TCP request, also stores TCP client number
 
-// bool arrays for storing Modbus RTU status of individual slaves
-uint8_t stat[STAT_NUM][(MAX_SLAVES + 1 + 7) / 8];
-
-// Scan request is in the queue
-bool scanReqInQueue = false;
-// Counter for priority requests in the queue
-byte priorityReqInQueue;
-
 uint8_t masks[8] = { 1, 2, 4, 8, 16, 32, 64, 128 };
 
-typedef struct {
-  byte tid[2];           // MBAP Transaction ID
-  byte msgLen;           // lenght of Modbus message stored in queueData
-  IPAddress remIP;       // remote IP for UDP client (UDP response is sent back to remote IP)
-  unsigned int remPort;  // remote port for UDP client (UDP response is sent back to remote port)
-  byte requestType;      // TCP client who sent the request
-  byte atts;             // attempts counter
-} header;
-
-// each request is stored in 3 queues (all queues are written to, read and deleted in sync)
-CircularBuffer<header, MAX_QUEUE_REQUESTS> queueHeaders;  // queue of requests' headers and metadata
-CircularBuffer<byte, MAX_QUEUE_DATA> queueData;           // queue of PDU data
-
 byte addressPos;
 
 void recvUdp() {
@@ -173,15 +152,15 @@ byte checkRequest(const byte inBuffer[], unsigned int msgLength, const IPAddress
   msgLength = msgLength - addressPos - (2 * localConfig.enableRtuOverTcp);  // in Modbus RTU over TCP/UDP do not store CRC
   // check if we have space in request queue
   if (queueHeaders.available() < 1 || queueData.available() < msgLength) {
-    setSlaveStatus(inBuffer[addressPos], STAT_ERROR_0A, true);
+    setSlaveStatus(inBuffer[addressPos], STAT_ERROR_0A, true, false);
     return 0x0A;  // return modbus error 0x0A (Gateway Overloaded)
   }
   // allow only one request to non responding slaves
   if (getSlaveStatus(inBuffer[addressPos], STAT_ERROR_0B_QUEUE)) {
     errorCount[STAT_ERROR_0B]++;
     return 0x0B;  // return modbus error 11 (Gateway Target Device Failed to Respond) - usually means that target device (address) is not present
   } else if (getSlaveStatus(inBuffer[addressPos], STAT_ERROR_0B)) {
-    setSlaveStatus(inBuffer[addressPos], STAT_ERROR_0B_QUEUE, true);
+    setSlaveStatus(inBuffer[addressPos], STAT_ERROR_0B_QUEUE, true, false);
   } else {
     // Add PRIORITY_REQUEST flag to requests for responding slaves
     requestType = requestType | PRIORITY_REQUEST;
@@ -224,7 +203,7 @@ bool getSlaveStatus(const uint8_t slave, const byte status) {
   return (stat[status][slave / 8] & masks[slave & 7]) > 0;
 }
 
-void setSlaveStatus(const uint8_t slave, byte status, const bool value) {
+void setSlaveStatus(const uint8_t slave, byte status, const bool value, const bool isScan) {
   if (slave >= MAX_SLAVES) return;  // error
   if (value == 0) {
     stat[status][slave / 8] &= ~masks[slave & 7];
@@ -233,6 +212,6 @@ void setSlaveStatus(const uint8_t slave, byte status, const bool value) {
       stat[i][slave / 8] &= ~masks[slave & 7];  // set all other flags to false
     }
     stat[status][slave / 8] |= masks[slave & 7];
-    if (status != STAT_ERROR_0B_QUEUE) errorCount[status]++; // there is no counter for STAT_ERROR_0B_QUEUE
+    if (status != STAT_ERROR_0B_QUEUE && isScan == false) errorCount[status]++; // there is no counter for STAT_ERROR_0B_QUEUE, ignor scans in statistics
   }
 }

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

@@ -19,9 +19,6 @@
 int rxNdx = 0;
 int txNdx = 0;
 
-MicroTimer recvTimer;
-MicroTimer sendTimer;
-
 void sendSerial() {
   if (!sendTimer.isOver()) {
     return;
@@ -64,9 +61,10 @@ void sendSerial() {
           // this if statement is not very reliable (too fast)
           // Serial.isFlushed() method is needed....see https://github.com/arduino/Arduino/pull/3737
           txNdx = 0;
+          mySerial.flush();
 #ifdef RS485_CONTROL_PIN
-          sendTimer.sleep(charTimeOut());  // very short delay before we toggle the RS485_CONTROL_PIN and disable RS485 transmit
-#endif                                     /* RS485_CONTROL_PIN */
+          // sendTimer.sleep(frameDelay());  // Short delay before we toggle the RS485_CONTROL_PIN and disable RS485 transmit. Not needed if we use flush()
+#endif /* RS485_CONTROL_PIN */
           serialState++;
         }
       }
@@ -95,7 +93,7 @@ void sendSerial() {
           deleteRequest();
         } else if (myHeader.atts >= localConfig.serialAttempts) {
           // send modbus error 0x0B (Gateway Target Device Failed to Respond) - usually means that target device (address) is not present
-          setSlaveStatus(queueData[0], STAT_ERROR_0B, true);
+          setSlaveStatus(queueData[0], STAT_ERROR_0B, true, false);
           byte MBAP[] = { myHeader.tid[0], myHeader.tid[1], 0x00, 0x00, 0x00, 0x03 };
           byte PDU[5] = { queueData[0], (byte)(queueData[1] + 0x80), 0x0B };
           crc = 0xFFFF;
@@ -107,7 +105,7 @@ void sendSerial() {
           sendResponse(MBAP, PDU, 5);
           errorTimeoutCount++;
         } else {
-          setSlaveStatus(queueData[0], STAT_ERROR_0B_QUEUE, true);
+          setSlaveStatus(queueData[0], STAT_ERROR_0B_QUEUE, true, false);
           errorTimeoutCount++;
         }                 // if (myHeader.atts >= MAX_RETRY)
         serialState = 0;  // IDLE
@@ -136,9 +134,9 @@ void recvSerial() {
     header myHeader = queueHeaders.first();
     if (checkCRC(serialIn, rxNdx) == true && serialIn[0] == queueData[0] && serialState == WAITING) {
       if (serialIn[1] > 0x80 && (myHeader.requestType & SCAN_REQUEST) == false) {
-        setSlaveStatus(serialIn[0], STAT_ERROR_0X, true);
+        setSlaveStatus(serialIn[0], STAT_ERROR_0X, true, false);
       } else {
-        setSlaveStatus(serialIn[0], STAT_OK, true);
+        setSlaveStatus(serialIn[0], STAT_OK, true, myHeader.requestType & SCAN_REQUEST);
       }
       byte MBAP[] = { myHeader.tid[0], myHeader.tid[1], 0x00, 0x00, highByte(rxNdx - 2), lowByte(rxNdx - 2) };
       sendResponse(MBAP, serialIn, rxNdx);

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

@@ -28,7 +28,7 @@ enum action_type : byte {
   ETH_SOFT,     // Ethernet software reset
   SERIAL_SOFT,  // Serial software reset
   SCAN,         // Initialize RS485 scan
-  RST_STATS,         // Reset Modbus Statistics
+  RST_STATS,    // Reset Modbus Statistics
   WEB           // Restart webserver
 };
 enum action_type action;
@@ -43,7 +43,7 @@ enum page : byte {
   PAGE_IP,
   PAGE_TCP,
   PAGE_RTU,
-  PAGE_WAIT  // page with "Reloading. Please wait..." message. Must be the last element within this enum!!
+  PAGE_WAIT,  // page with "Reloading. Please wait..." message.
 };
 
 // Keys for POST parameters, used in web forms and processed by processPost() function.
@@ -79,9 +79,36 @@ enum post_key : byte {
   POST_FRAMEDELAY,  //frame delay
   POST_TIMEOUT,     // response timeout
   POST_ATTEMPTS,    // number of request attempts
-  POST_ACTION       // actions on Tools page
+  POST_ACTION,      // actions on Tools page
 };
 
+// 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_MASTERS,  // list of Modbus TCP/UDP masters separated by <br>
+  JSON_SLAVES,   // list of Modbus RTU slaves separated by <br>
+#ifdef ENABLE_EXTRA_DIAG
+  JSON_RS485_TX,
+  JSON_RS485_RX,
+  JSON_ETH_TX,
+  JSON_ETH_RX,
+#endif        /* ENABLE_EXTRA_DIAG */
+  JSON_LAST,  // Must be the very last element in this array
+};
+
+
 void recvWeb() {
   EthernetClient client = webServer.available();
   if (client) {
@@ -139,6 +166,7 @@ void recvWeb() {
     else if ((uri[0] == '/') && !strcmp(uri + 2, ".htm")) {
       reqPage = (byte)(uri[1] - 48);  // Convert single ASCII char to byte
     }
+
     // Actions that require "please wait" page
     if (action == WEB || action == REBOOT || action == ETH_SOFT || action == FACTORY || action == MAC) {
       reqPage = PAGE_WAIT;
@@ -147,6 +175,8 @@ void recvWeb() {
     // Send page
     if ((reqPage > 0) && (reqPage <= PAGE_WAIT))
       sendPage(client, reqPage);
+    else if (!strcmp(uri, "/data.json"))
+      sendJson(client);
     else if (!strcmp(uri, "/favicon.ico"))  // a favicon
       send204(client);                      // if you don't have a favicon, send 204
     else                                    // if the page is unknown, HTTP response code 404
@@ -156,22 +186,21 @@ void recvWeb() {
     if (reqPage == PAGE_WAIT) {
       for (byte n = 0; n < maxSockNum; n++) {
         // in case of webserver restart, stop only clients from old webserver (clients with port different from current settings)
-        // EthernetClient clientTemp = EthernetClient(n);
-        unsigned int port = W5100.readSnPORT(n);
+        EthernetClient client = EthernetClient(n);
+        unsigned int port = client.localPort();
         // for WEB, stop only clients from old webserver (those that do not match modbus ports or current web port); for other actions stop all clients
         if (action != WEB || (port && port != localConfig.webPort && port != localConfig.udpPort && port != localConfig.tcpPort)) {
-          W5100.execCmdSn(n, Sock_CLOSE);  // close it forcefully
-                                           // clientTemp.flush();
-                                           //       clientTemp.stop();
+          client.flush();
+          client.stop();
         }
       }
       switch (action) {
         case WEB:
           webServer = EthernetServer(localConfig.webPort);
           break;
         case REBOOT:
-          Serial.flush();
-          Serial.end();
+          mySerial.flush();
+          mySerial.end();
           resetFunc();
           break;
         default:  // ETH_SOFT, FACTORY, MAC
@@ -218,7 +247,7 @@ void processPost(char postParameter[]) {
 #endif /* ENABLE_DHCP */
       case POST_IP ... POST_IP_3:
         {
-          action = ETH_SOFT; // this ETH_SOFT is triggered when the user changes anything on the "IP Settings" page.
+          action = ETH_SOFT;  // this ETH_SOFT is triggered when the user changes anything on the "IP Settings" page.
           // No need to trigger ETH_SOFT for other cases (POST_SUBNET, POST_GATEWAY etc.)
           localConfig.ip[paramKeyByte - POST_IP] = (byte)paramValueUlong;
         }
@@ -236,10 +265,10 @@ void processPost(char postParameter[]) {
       case POST_TCP:
         {
           for (byte i = 0; i < maxSockNum; i++) {
-            EthernetClient clientTemp = EthernetClient(i);
-            if (clientTemp.status() != SnSR::UDP && clientTemp.localPort() == localConfig.tcpPort) {
-              clientTemp.flush();
-              clientTemp.stop();
+            EthernetClient client = EthernetClient(i);
+            if (client.localPort() == localConfig.tcpPort) {
+              client.flush();
+              client.stop();
             }
           }
           localConfig.tcpPort = (unsigned int)paramValueUlong;
@@ -266,7 +295,7 @@ void processPost(char postParameter[]) {
         break;
       case POST_BAUD:
         {
-          action = SERIAL_SOFT; // this SERIAL_SOFT is triggered when the user changes anything on the "RS485 Settings" page.
+          action = SERIAL_SOFT;  // this SERIAL_SOFT is triggered when the user changes anything on the "RS485 Settings" page.
           // No need to trigger ETH_SOFT for other cases (POST_DATA, POST_PARITY etc.)
           localConfig.baud = paramValueUlong;
           byte minFrameDelay = (byte)(frameDelay() / 1000UL) + 1;
@@ -313,6 +342,7 @@ void processPost(char postParameter[]) {
         memcpy(tempMac, localConfig.macEnd, 3);  // keep current MAC
         localConfig = DEFAULT_CONFIG;
         memcpy(localConfig.macEnd, tempMac, 3);
+        startSerial();
         break;
       }
     case MAC:
@@ -330,10 +360,11 @@ void processPost(char postParameter[]) {
   }
   // new parameter values received, save them to EEPROM
   EEPROM.put(CONFIG_START + 1, localConfig);  // it is safe to call, only changed values are updated
-  if (action == SERIAL_SOFT) {                // can do it without "please wait" page
-    Serial.flush();
-    Serial.end();
-    startSerial(); // TODO clear queue?
+#ifdef ENABLE_DHCP
+  EEPROM.put(CONFIG_START + 1 + sizeof(localConfig), extraConfig);
+#endif                          /* ENABLE_DHCP */
+  if (action == SERIAL_SOFT) {  // can do it without "please wait" page
+    startSerial();
     action = NONE;
   }
 }