Coding style adjustments

Author: budulinek

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

@@ -57,11 +57,11 @@ void startSerial() {
 }
 
 void startEthernet() {
-  if (ethResetPin != 0) {
-    pinMode(ethResetPin, OUTPUT);
-    digitalWrite(ethResetPin, LOW);
+  if (ETH_RESET_PIN != 0) {
+    pinMode(ETH_RESET_PIN, OUTPUT);
+    digitalWrite(ETH_RESET_PIN, LOW);
     delay(25);
-    digitalWrite(ethResetPin, HIGH);
+    digitalWrite(ETH_RESET_PIN, HIGH);
     delay(500);
   }
   byte mac[6];
@@ -121,9 +121,8 @@ void maintainUptime() {
 #ifdef ENABLE_EXTRA_DIAG
 void maintainCounters() {
   // synchronize roll-over of data counters to zero, at 0xFFFFFF00 or 0xFF00 respectively
-  const unsigned long rollover = 0xFFFFFF00;
-  const unsigned int rollover = 0xFF00;
-  if (serialTxCount > rollover || serialRxCount > rollover || ethTxCount > rollover || ethRxCount > rollover) {
+  const unsigned long ROLLOVER = 0xFFFFFF00;
+  if (serialTxCount > ROLLOVER || serialRxCount > ROLLOVER || ethTxCount > ROLLOVER || ethRxCount > ROLLOVER) {
     ethRxCount = 0;
     ethTxCount = 0;
     serialRxCount = 0;

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

@@ -26,11 +26,11 @@
 
    ***************************************************************** */
 
-// Stored in "header.requestType" 
+// Stored in "header.requestType"
 #define PRIORITY_REQUEST B10000000  // Request to slave which is not "nonresponding"
-#define SCAN_REQUEST B01000000 // Request triggered by slave scanner
-#define UDP_REQUEST B00100000 // UDP request
-#define TCP_REQUEST B00001111 // TCP request, also stores TCP client number
+#define SCAN_REQUEST B01000000      // Request triggered by slave scanner
+#define UDP_REQUEST B00100000       // UDP request
+#define TCP_REQUEST B00001111       // TCP request, also stores TCP client number
 
 enum status : byte {
   STAT_OK,              // Slave Responded
@@ -42,7 +42,7 @@ enum status : byte {
 };
 
 // bool arrays for storing Modbus RTU status of individual slaves
-uint8_t stat[STAT_NUM][(maxSlaves + 1 + 7) / 8];
+uint8_t stat[STAT_NUM][(MAX_SLAVES + 1 + 7) / 8];
 
 // Scan request is in the queue
 bool scanReqInQueue = false;
@@ -63,21 +63,21 @@ typedef struct {
   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 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, maxQueueRequests> queueHeaders;  // queue of requests' headers and metadata (MBAP transaction ID, MBAP unit ID, PDU length, remIP, remPort, TCP client)
-CircularBuffer<byte, maxQueueData> queueData;           // queue of PDU data (function code, data)
+CircularBuffer<header, MAX_QUEUE_REQUESTS> queueHeaders;  // queue of requests' headers and metadata 
+CircularBuffer<byte, MAX_QUEUE_DATA> queueData;           // queue of PDU data
 
 void recvUdp() {
   unsigned int msgLength = Udp.parsePacket();
   if (msgLength) {
 #ifdef ENABLE_EXTRA_DIAG
     ethRxCount += msgLength;
 #endif                              /* ENABLE_EXTRA_DIAG */
-    byte inBuffer[modbusSize + 4];  // Modbus TCP frame is 4 bytes longer than Modbus RTU frame
+    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
     // Modbus RTU frame: [0] address.....[n-1][n] CRC
     Udp.read(inBuffer, sizeof(inBuffer));
@@ -118,7 +118,7 @@ void recvTcp() {
 #ifdef ENABLE_EXTRA_DIAG
     ethRxCount += msgLength;
 #endif                              /* ENABLE_EXTRA_DIAG */
-    byte inBuffer[modbusSize + 4];  // Modbus TCP frame is 4 bytes longer than Modbus RTU frame
+    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).....
     // Modbus RTU frame: [0] address.....
     client.read(inBuffer, sizeof(inBuffer));
@@ -152,23 +152,23 @@ void recvTcp() {
 
 void processRequests() {
   // Insert scan request into queue, allow only one scan request in a queue
-  if (scanCounter != 0 && queueHeaders.available() > 1 && queueData.available() > sizeof(scanCommand) + 1 && scanReqInQueue == false) {
+  if (scanCounter != 0 && queueHeaders.available() > 1 && queueData.available() > sizeof(SCAN_COMMAND) + 1 && scanReqInQueue == false) {
     scanReqInQueue = true;
     // Store scan request in request queue
     queueHeaders.push(header{
-      { 0x00, 0x00 },                  // tid[2]
-      sizeof(scanCommand) + 1,         // msgLen
-      {},                              // remIP
-      0,                               // remPort
-      SCAN_REQUEST,                    // requestType
-      0,  // atts
+      { 0x00, 0x00 },           // tid[2]
+      sizeof(SCAN_COMMAND) + 1,  // msgLen
+      {},                       // remIP
+      0,                        // remPort
+      SCAN_REQUEST,             // requestType
+      0,                        // atts
     });
     queueData.push(scanCounter);  // address of the scanned slave
-    for (byte i = 0; i < sizeof(scanCommand); i++) {
-      queueData.push(scanCommand[i]);
+    for (byte i = 0; i < sizeof(SCAN_COMMAND); i++) {
+      queueData.push(SCAN_COMMAND[i]);
     }
     scanCounter++;
-    if (scanCounter == maxSlaves + 1) scanCounter = 0;
+    if (scanCounter == MAX_SLAVES + 1) scanCounter = 0;
   }
   // Optimize queue (prioritize requests from responding slaves) and trigger sending via serial
   if (serialState == IDLE) {  // send new data over serial only if we are not waiting for response
@@ -206,25 +206,24 @@ byte checkRequest(const byte inBuffer[], unsigned int msgLength, const IPAddress
   }
   // allow only one request to non responding slaves
   if (getSlaveStatus(inBuffer[addressPos], STAT_ERROR_0B_QUEUE)) {
-    setSlaveStatus(inBuffer[addressPos], STAT_ERROR_0B, true);
+    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);
-  }
-
-  // all checkes passed OK, we can store the incoming data in request queue
-  // Add PRIORITY_REQUEST flag to requests for responding slaves
-  if (getSlaveStatus(inBuffer[addressPos], STAT_ERROR_0B_QUEUE) == false) {
+  } else {
+    // Add PRIORITY_REQUEST flag to requests for responding slaves
     requestType = requestType | PRIORITY_REQUEST;
     priorityReqInQueue++;
   }
+
+  // all checkes passed OK, we can store the incoming data in request queue
   // Store in request queue
   queueHeaders.push(header{
     { inBuffer[0], inBuffer[1] },  // tid[2] (ignored in Modbus RTU over TCP/UDP)
     (byte)msgLength,               // msgLen
     (IPAddress)remoteIP,           // remIP
     (unsigned int)remotePort,      // remPort
-    (byte)(requestType),             // requestType
+    (byte)(requestType),           // requestType
     0,                             // atts
   });
   for (byte i = 0; i < msgLength; i++) {
@@ -247,12 +246,12 @@ void deleteRequest()  // delete request from queue
 }
 
 bool getSlaveStatus(const uint8_t slave, const byte status) {
-  if (slave >= maxSlaves) return false;  // error
+  if (slave >= MAX_SLAVES) return false;  // error
   return (stat[status][slave / 8] & masks[slave & 7]) > 0;
 }
 
 void setSlaveStatus(const uint8_t slave, byte status, const bool value) {
-  if (slave >= maxSlaves) return;  // error
+  if (slave >= MAX_SLAVES) return;  // error
   if (value == 0) {
     stat[status][slave / 8] &= ~masks[slave & 7];
   } else {

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

@@ -60,7 +60,7 @@ void sendSerial() {
 #ifdef RS485_CONTROL_PIN
     digitalWrite(RS485_CONTROL_PIN, RS485_RECEIVE);  // Disable RS485 Transmit
 #endif                                               /* RS485_CONTROL_PIN */
-    if (queueData[0] == 0x00) {   // Modbus broadcast - we do not count attempts and delete immediatelly
+    if (queueData[0] == 0x00) {                      // Modbus broadcast - we do not count attempts and delete immediatelly
       serialState = IDLE;
       deleteRequest();
     } else {
@@ -74,12 +74,12 @@ void sendSerial() {
 }
 
 void recvSerial() {
-  static byte serialIn[modbusSize];
+  static byte serialIn[MODBUS_SIZE];
   while (mySerial.available() > 0) {
     if (rxTimeout.isOver() && rxNdx != 0) {
       rxErr = true;  // character timeout
     }
-    if (rxNdx < modbusSize) {
+    if (rxNdx < MODBUS_SIZE) {
       serialIn[rxNdx] = mySerial.read();
       rxNdx++;
     } else {
@@ -93,13 +93,12 @@ void recvSerial() {
     // Process Serial data
     // Checks: 1) RTU frame is without errors; 2) CRC; 3) address of incoming packet against first request in queue; 4) only expected responses are forwarded to TCP/UDP
     header myHeader = queueHeaders.first();
-    if (!rxErr && checkCRC(serialIn, rxNdx) == true) {
-      if (serialIn[1] > 0x80 && (myHeader.requestType & SCAN_REQUEST) == false) {
-        setSlaveStatus(serialIn[0], STAT_ERROR_0X, true);
-      } else {
-        setSlaveStatus(serialIn[0], STAT_OK, true);
-      }
-      if (serialIn[0] == queueData[0] && serialState == WAITING) {
+    if (!rxErr && 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);
+        } else {
+          setSlaveStatus(serialIn[0], STAT_OK, true);
+        }
         byte MBAP[] = { myHeader.tid[0], myHeader.tid[1], 0x00, 0x00, highByte(rxNdx - 2), lowByte(rxNdx - 2) };
         if (myHeader.requestType & UDP_REQUEST) {
           Udp.beginPacket(myHeader.remIP, myHeader.remPort);
@@ -130,7 +129,6 @@ void recvSerial() {
         deleteRequest();
         serialState = IDLE;
       }
-    }
 #ifdef ENABLE_EXTRA_DIAG
     serialRxCount += rxNdx;
 #endif /* ENABLE_EXTRA_DIAG */

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

@@ -16,8 +16,8 @@
 
    ***************************************************************** */
 
-const byte webInBufferSize = 128;  // size of web server read buffer (reads a complete line), 128 bytes necessary for POST data
-const byte smallbuffersize = 32;   // a smaller buffer for uri
+const byte WEB_IN_BUFFER_SIZE = 128;  // size of web server read buffer (reads a complete line), 128 bytes necessary for POST data
+const byte SMALL_BUFFER_SIZE = 32;   // a smaller buffer for uri
 
 // Actions that need to be taken after saving configuration.
 // These actions are also used by buttons on the Tools page.
@@ -84,11 +84,11 @@ enum post_key : byte {
 void recvWeb() {
   EthernetClient client = webServer.available();
   if (client) {
-    char uri[smallbuffersize];  // the requested page
-    // char requestParameter[smallbuffersize];      // parameter appended to the URI after a ?
-    // char postParameter[smallbuffersize] {'\0'};         // parameter transmitted in the body / by POST
+    char uri[SMALL_BUFFER_SIZE];  // the requested page
+    // char requestParameter[SMALL_BUFFER_SIZE];      // parameter appended to the URI after a ?
+    // char postParameter[SMALL_BUFFER_SIZE] {'\0'};         // parameter transmitted in the body / by POST
     if (client.available()) {
-      char webInBuffer[webInBufferSize]{ '\0' };  // buffer for incoming data
+      char webInBuffer[WEB_IN_BUFFER_SIZE]{ '\0' };  // buffer for incoming data
       unsigned int i = 0;                         // index / current read position
       enum status_type : byte {
         REQUEST,
@@ -116,7 +116,7 @@ void recvWeb() {
           i = 0;
           memset(webInBuffer, 0, sizeof(webInBuffer));
         } else {
-          if (i < (webInBufferSize - 1))  // <==== BUG FOUND
+          if (i < (WEB_IN_BUFFER_SIZE - 1))
           {
             webInBuffer[i] = c;
             i++;
@@ -306,7 +306,7 @@ void processPost(char postParameter[]) {
       {
         byte tempMac[3];
         memcpy(tempMac, localConfig.macEnd, 3);  // keep current MAC
-        localConfig = defaultConfig;
+        localConfig = DEFAULT_CONFIG;
         memcpy(localConfig.macEnd, tempMac, 3);
         break;
       }
@@ -329,7 +329,7 @@ void processPost(char postParameter[]) {
       break;
   }
   // new parameter values received, save them to EEPROM
-  EEPROM.put(configStart + 1, localConfig);  // it is safe to call, only changed values are updated
+  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();

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

@@ -24,10 +24,10 @@
 
    ***************************************************************** */
 
-const byte webOutBufferSize = 128;  // size of web server write buffer (used by StreamLib)
+const byte WEB_OUT_BUFFER_SIZE = 128;  // size of web server write buffer (used by StreamLib)
 
 void sendPage(EthernetClient &client, byte reqPage) {
-  char webOutBuffer[webOutBufferSize];
+  char webOutBuffer[WEB_OUT_BUFFER_SIZE];
   ChunkedPrint chunked(client, webOutBuffer, sizeof(webOutBuffer));  // the StreamLib object to replace client print
   chunked.print(F("HTTP/1.1 200 OK\r\n"
                   "Connection: close\r\n"
@@ -156,9 +156,9 @@ void menuItem(ChunkedPrint &chunked, byte item) {
 //        Current Status
 void contentStatus(ChunkedPrint &chunked) {
   chunked.print(F("<tr><td>SW Version:<td>"));
-  chunked.print(version[0], HEX);
+  chunked.print(VERSION[0], HEX);
   chunked.print(F("."));
-  chunked.print(version[1], HEX);
+  chunked.print(VERSION[1], HEX);
   chunked.print(F("<tr><td>Microcontroller:<td>"));
   chunked.print(BOARD);
   // chunked.print(freeMemory());
@@ -327,12 +327,12 @@ void contentStatus(ChunkedPrint &chunked) {
                   "<tr><td>Requests Queue:<td>"));
   chunked.print(queueDataSize);
   chunked.print(F(" / "));
-  chunked.print(maxQueueData);
+  chunked.print(MAX_QUEUE_DATA);
   chunked.print(F(" bytes"
                   "<tr><td><td>"));
   chunked.print(queueHeadersSize);
   chunked.print(F(" / "));
-  chunked.print(maxQueueRequests);
+  chunked.print(MAX_QUEUE_REQUESTS);
   chunked.print(F(" requests"));
   queueDataSize = 0;
   queueHeadersSize = 0;
@@ -368,7 +368,7 @@ void contentStatus(ChunkedPrint &chunked) {
   chunked.print(SCAN);
   chunked.print(F(">Scan & Reset Stats</button>"));
   byte countSlaves = 0;
-  for (int k = 1; k < maxSlaves; k++) {
+  for (int k = 1; k < MAX_SLAVES; k++) {
     for (int s = 0; s < STAT_NUM; s++) {
       if (getSlaveStatus(k, s) == true || k == scanCounter) {
         countSlaves++;
@@ -583,7 +583,7 @@ void contentTools(ChunkedPrint &chunked) {
   chunked.print(F(" value="));
   chunked.print(FACTORY);
   chunked.print(F(">Restore</button> (Static IP: "));
-  chunked.print((IPAddress)defaultConfig.ip);
+  chunked.print((IPAddress)DEFAULT_CONFIG.ip);
   chunked.print(F(")"
                   "<tr><td>MAC Address: <td><button name="));
   chunked.print(POST_ACTION);