Version 1.1

Added stop() function.

README.md

@@ -116,6 +116,12 @@ myNet.setApSetting("SSID", "PASSWORD");
 myNet.begin();
 ```
 
+### ESP-NOW Mesh network deinitialization
+
+```cpp
+myNet.stop();
+```
+
 ### Sends broadcast message to all nodes
 
 ```cpp

library.properties

@@ -1,5 +1,5 @@
 name=ZHNetwork
-version=1.0
+version=1.1
 author=Alexey Zholtikov
 maintainer=Alexey Zholtikov
 sentence=ESP-NOW based Mesh network for ESP8266/ESP32

src/ZHNetwork.cpp

@@ -5,7 +5,7 @@ incoming_queue_t queueForIncomingData;
 outgoing_queue_t queueForOutgoingData;
 waiting_queue_t queueForRoutingVectorWaiting;
 
-const String firmware{"1.0"};
+const char *firmware PROGMEM{"1.1"};
 const uint8_t broadcastMAC[6]{0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF};
 
 bool criticalProcessSemaphore{false};
@@ -62,23 +62,20 @@ error_code_t ZHNetwork::setNetName(const char *netName)
 {
     if (strlen(netName) < 1 || strlen(netName) > 20)
         return ERROR;
-    memset(&netName_, 0, strlen(netName));
     strcpy(netName_, netName);
     return SUCCESS;
 }
 
 String ZHNetwork::getNetName()
 {
-    return String(netName_);
+    return netName_;
 }
 
 error_code_t ZHNetwork::setStaSetting(const char *ssid, const char *password)
 {
     if (strlen(ssid) < 1 || strlen(ssid) > 32 || strlen(password) > 64)
         return ERROR;
-    memset(&staSsid_, 0, strlen(ssid));
     strcpy(staSsid_, ssid);
-    memset(&staPassword_, 0, strlen(password));
     strcpy(staPassword_, password);
     return SUCCESS;
 }
@@ -87,9 +84,7 @@ error_code_t ZHNetwork::setApSetting(const char *ssid, const char *password)
 {
     if (strlen(ssid) < 1 || strlen(ssid) > 32 || strlen(password) < 8 || strlen(password) > 64)
         return ERROR;
-    memset(&apSsid_, 0, strlen(ssid));
     strcpy(apSsid_, ssid);
-    memset(&apPassword_, 0, strlen(password));
     strcpy(apPassword_, password);
     return SUCCESS;
 }
@@ -135,6 +130,15 @@ error_code_t ZHNetwork::begin()
     return SUCCESS;
 }
 
+error_code_t stop()
+{
+    WiFi.mode(WIFI_OFF);
+    esp_now_deinit();
+    esp_now_unregister_recv_cb();
+    esp_now_unregister_send_cb();
+    return SUCCESS;
+}
+
 void ZHNetwork::sendBroadcastMessage(const char *data)
 {
     broadcastMessage(data, broadcastMAC, BROADCAST);
@@ -154,7 +158,7 @@ void ZHNetwork::maintenance()
         if (confirmReceiving)
         {
 #ifdef PRINT_LOG
-            Serial.println("OK.");
+            Serial.println(F("OK."));
 #endif
             outgoing_data_t outgoingData = queueForOutgoingData.front();
             queueForOutgoingData.pop();
@@ -167,7 +171,7 @@ void ZHNetwork::maintenance()
         else
         {
 #ifdef PRINT_LOG
-            Serial.println("FAULT.");
+            Serial.println(F("FAULT."));
 #endif
             if (numberOfAttemptsToSend < maxNumberOfAttempts_)
                 ++numberOfAttemptsToSend;
@@ -186,14 +190,13 @@ void ZHNetwork::maintenance()
                     {
                         routingVector.erase(routingVector.begin() + i);
 #ifdef PRINT_LOG
-                        Serial.print("CHECKING ROUTING TABLE... Routing to MAC ");
+                        Serial.print(F("CHECKING ROUTING TABLE... Routing to MAC "));
                         Serial.print(macToString(outgoingData.transmittedData.originalTargetMAC));
-                        Serial.println(" deleted.");
+                        Serial.println(F(" deleted."));
 #endif
                     }
                 }
                 waiting_data_t waitingData;
-                esp_memset(&waitingData, 0, sizeof(waiting_data_t));
                 waitingData.time = millis();
                 memcpy(&waitingData.intermediateTargetMAC, &outgoingData.intermediateTargetMAC, 6);
                 memcpy(&waitingData.transmittedData, &outgoingData.transmittedData, sizeof(transmitted_data_t));
@@ -220,33 +223,33 @@ void ZHNetwork::maintenance()
         switch (outgoingData.transmittedData.messageType)
         {
         case BROADCAST:
-            Serial.print("BROADCAST");
+            Serial.print(F("BROADCAST"));
             break;
         case UNICAST:
-            Serial.print("UNICAST");
+            Serial.print(F("UNICAST"));
             break;
         case UNICAST_WITH_CONFIRM:
-            Serial.print("UNICAST_WITH_CONFIRM");
+            Serial.print(F("UNICAST_WITH_CONFIRM"));
             break;
         case DELIVERY_CONFIRM_RESPONSE:
-            Serial.print("DELIVERY_CONFIRM_RESPONSE");
+            Serial.print(F("DELIVERY_CONFIRM_RESPONSE"));
             break;
         case SEARCH_REQUEST:
-            Serial.print("SEARCH_REQUEST");
+            Serial.print(F("SEARCH_REQUEST"));
             break;
         case SEARCH_RESPONSE:
-            Serial.print("SEARCH_RESPONSE");
+            Serial.print(F("SEARCH_RESPONSE"));
             break;
         default:
             break;
         }
-        Serial.print(" message from MAC ");
+        Serial.print(F(" message from MAC "));
         Serial.print(macToString(outgoingData.transmittedData.originalSenderMAC));
-        Serial.print(" to MAC ");
+        Serial.print(F(" to MAC "));
         Serial.print(macToString(outgoingData.transmittedData.originalTargetMAC));
-        Serial.print(" via MAC ");
+        Serial.print(F(" via MAC "));
         Serial.print(macToString(outgoingData.intermediateTargetMAC));
-        Serial.print(" sended. Status ");
+        Serial.print(F(" sended. Status "));
 #endif
     }
     if (!queueForIncomingData.empty())
@@ -261,9 +264,9 @@ void ZHNetwork::maintenance()
         {
         case BROADCAST:
 #ifdef PRINT_LOG
-            Serial.print("BROADCAST message from MAC ");
+            Serial.print(F("BROADCAST message from MAC "));
             Serial.print(macToString(incomingData.transmittedData.originalSenderMAC));
-            Serial.println(" received.");
+            Serial.println(F(" received."));
 #endif
             if (onBroadcastReceivingCallback)
                 onBroadcastReceivingCallback(incomingData.transmittedData.message, incomingData.transmittedData.originalSenderMAC);
@@ -271,13 +274,13 @@ void ZHNetwork::maintenance()
             break;
         case UNICAST:
 #ifdef PRINT_LOG
-            Serial.print("UNICAST message from MAC ");
+            Serial.print(F("UNICAST message from MAC "));
             Serial.print(macToString(incomingData.transmittedData.originalSenderMAC));
-            Serial.print(" to MAC ");
+            Serial.print(F(" to MAC "));
             Serial.print(macToString(incomingData.transmittedData.originalTargetMAC));
-            Serial.print(" via MAC ");
+            Serial.print(F(" via MAC "));
             Serial.print(macToString(incomingData.intermediateSenderMAC));
-            Serial.println(" received.");
+            Serial.println(F(" received."));
 #endif
             if (macToString(incomingData.transmittedData.originalTargetMAC) == macToString(localMAC))
             {
@@ -289,13 +292,13 @@ void ZHNetwork::maintenance()
             break;
         case UNICAST_WITH_CONFIRM:
 #ifdef PRINT_LOG
-            Serial.print("UNICAST_WITH_CONFIRM message from MAC ");
+            Serial.print(F("UNICAST_WITH_CONFIRM message from MAC "));
             Serial.print(macToString(incomingData.transmittedData.originalSenderMAC));
-            Serial.print(" to MAC ");
+            Serial.print(F(" to MAC "));
             Serial.print(macToString(incomingData.transmittedData.originalTargetMAC));
-            Serial.print(" via MAC ");
+            Serial.print(F(" via MAC "));
             Serial.print(macToString(incomingData.intermediateSenderMAC));
-            Serial.println(" received.");
+            Serial.println(F(" received."));
 #endif
             if (macToString(incomingData.transmittedData.originalTargetMAC) == macToString(localMAC))
             {
@@ -308,13 +311,13 @@ void ZHNetwork::maintenance()
             break;
         case DELIVERY_CONFIRM_RESPONSE:
 #ifdef PRINT_LOG
-            Serial.print("DELIVERY_CONFIRM_RESPONSE message from MAC ");
+            Serial.print(F("DELIVERY_CONFIRM_RESPONSE message from MAC "));
             Serial.print(macToString(incomingData.transmittedData.originalSenderMAC));
-            Serial.print(" to MAC ");
+            Serial.print(F(" to MAC "));
             Serial.print(macToString(incomingData.transmittedData.originalTargetMAC));
-            Serial.print(" via MAC ");
+            Serial.print(F(" via MAC "));
             Serial.print(macToString(incomingData.intermediateSenderMAC));
-            Serial.println(" received.");
+            Serial.println(F(" received."));
 #endif
             if (macToString(incomingData.transmittedData.originalTargetMAC) == macToString(localMAC))
             {
@@ -326,11 +329,11 @@ void ZHNetwork::maintenance()
             break;
         case SEARCH_REQUEST:
 #ifdef PRINT_LOG
-            Serial.print("SEARCH_REQUEST message from MAC ");
+            Serial.print(F("SEARCH_REQUEST message from MAC "));
             Serial.print(macToString(incomingData.transmittedData.originalSenderMAC));
-            Serial.print(" to MAC ");
+            Serial.print(F(" to MAC "));
             Serial.print(macToString(incomingData.transmittedData.originalTargetMAC));
-            Serial.println(" received.");
+            Serial.println(F(" received."));
 #endif
             if (macToString(incomingData.transmittedData.originalTargetMAC) == macToString(localMAC))
                 broadcastMessage("", incomingData.transmittedData.originalSenderMAC, SEARCH_RESPONSE);
@@ -340,11 +343,11 @@ void ZHNetwork::maintenance()
             break;
         case SEARCH_RESPONSE:
 #ifdef PRINT_LOG
-            Serial.print("SEARCH_RESPONSE message from MAC ");
+            Serial.print(F("SEARCH_RESPONSE message from MAC "));
             Serial.print(macToString(incomingData.transmittedData.originalSenderMAC));
-            Serial.print(" to MAC ");
+            Serial.print(F(" to MAC "));
             Serial.print(macToString(incomingData.transmittedData.originalTargetMAC));
-            Serial.println(" received.");
+            Serial.println(F(" received."));
 #endif
             if (macToString(incomingData.transmittedData.originalTargetMAC) != macToString(localMAC))
                 forward = true;
@@ -375,11 +378,11 @@ void ZHNetwork::maintenance()
                         memcpy(&routingTable.intermediateTargetMAC, &incomingData.intermediateSenderMAC, 6);
                         routingVector.at(i) = routingTable;
 #ifdef PRINT_LOG
-                        Serial.print("CHECKING ROUTING TABLE... Routing to MAC ");
+                        Serial.print(F("CHECKING ROUTING TABLE... Routing to MAC "));
                         Serial.print(macToString(incomingData.transmittedData.originalSenderMAC));
-                        Serial.print(" updated. Target is ");
+                        Serial.print(F(" updated. Target is "));
                         Serial.print(macToString(incomingData.intermediateSenderMAC));
-                        Serial.println(".");
+                        Serial.println(F("."));
 #endif
                     }
                 }
@@ -393,11 +396,11 @@ void ZHNetwork::maintenance()
                     memcpy(&routingTable.intermediateTargetMAC, &incomingData.intermediateSenderMAC, 6);
                     routingVector.push_back(routingTable);
 #ifdef PRINT_LOG
-                    Serial.print("CHECKING ROUTING TABLE... Routing to MAC ");
+                    Serial.print(F("CHECKING ROUTING TABLE... Routing to MAC "));
                     Serial.print(macToString(incomingData.transmittedData.originalSenderMAC));
-                    Serial.print(" added. Target is ");
+                    Serial.print(F(" added. Target is "));
                     Serial.print(macToString(incomingData.intermediateSenderMAC));
-                    Serial.println(".");
+                    Serial.println(F("."));
 #endif
                 }
             }
@@ -413,16 +416,15 @@ void ZHNetwork::maintenance()
             {
                 queueForRoutingVectorWaiting.pop();
                 outgoing_data_t outgoingData;
-                esp_memset(&outgoingData, 0, sizeof(outgoing_data_t));
                 memcpy(&outgoingData.transmittedData, &waitingData.transmittedData, sizeof(transmitted_data_t));
                 memcpy(&outgoingData.intermediateTargetMAC, &routingTable.intermediateTargetMAC, 6);
                 queueForOutgoingData.push(outgoingData);
 #ifdef PRINT_LOG
-                Serial.print("CHECKING ROUTING TABLE... Routing to MAC ");
+                Serial.print(F("CHECKING ROUTING TABLE... Routing to MAC "));
                 Serial.print(macToString(outgoingData.transmittedData.originalTargetMAC));
-                Serial.print(" found. Target is ");
+                Serial.print(F(" found. Target is "));
                 Serial.print(macToString(outgoingData.intermediateTargetMAC));
-                Serial.println(".");
+                Serial.println(F("."));
 #endif
                 return;
             }
@@ -431,30 +433,30 @@ void ZHNetwork::maintenance()
         {
             queueForRoutingVectorWaiting.pop();
 #ifdef PRINT_LOG
-            Serial.print("CHECKING ROUTING TABLE... Routing to MAC ");
+            Serial.print(F("CHECKING ROUTING TABLE... Routing to MAC "));
             Serial.print(macToString(waitingData.transmittedData.originalTargetMAC));
-            Serial.println(" not found.");
+            Serial.println(F(" not found."));
             switch (waitingData.transmittedData.messageType)
             {
             case UNICAST:
-                Serial.print("UNICAST");
+                Serial.print(F("UNICAST"));
                 break;
             case UNICAST_WITH_CONFIRM:
-                Serial.print("UNICAST_WITH_CONFIRM");
+                Serial.print(F("UNICAST_WITH_CONFIRM"));
                 break;
             case DELIVERY_CONFIRM_RESPONSE:
-                Serial.print("DELIVERY_CONFIRM_RESPONSE");
+                Serial.print(F("DELIVERY_CONFIRM_RESPONSE"));
                 break;
             default:
                 break;
             }
-            Serial.print(" message from MAC ");
+            Serial.print(F(" message from MAC "));
             Serial.print(macToString(waitingData.transmittedData.originalSenderMAC));
-            Serial.print(" to MAC ");
+            Serial.print(F(" to MAC "));
             Serial.print(macToString(waitingData.transmittedData.originalTargetMAC));
-            Serial.print(" via MAC ");
+            Serial.print(F(" via MAC "));
             Serial.print(macToString(waitingData.intermediateTargetMAC));
-            Serial.println(" undelivered.");
+            Serial.println(F(" undelivered."));
 #endif
             if (waitingData.transmittedData.messageType == UNICAST_WITH_CONFIRM && macToString(waitingData.transmittedData.originalSenderMAC) == macToString(localMAC))
                 if (onConfirmReceivingCallback)
@@ -601,7 +603,6 @@ void IRAM_ATTR ZHNetwork::onDataReceive(uint8_t *mac, uint8_t *data, uint8_t len
 void ZHNetwork::broadcastMessage(const char *data, const uint8_t *target, message_type_t type)
 {
     outgoing_data_t outgoingData;
-    esp_memset(&outgoingData, 0, sizeof(outgoing_data_t));
     outgoingData.transmittedData.messageType = type;
     outgoingData.transmittedData.messageID = ((uint16_t)random(32767) << 8) | (uint16_t)random(32767);
     memcpy(&outgoingData.transmittedData.netName, &netName_, 20);
@@ -614,29 +615,28 @@ void ZHNetwork::broadcastMessage(const char *data, const uint8_t *target, messag
     switch (outgoingData.transmittedData.messageType)
     {
     case BROADCAST:
-        Serial.print("BROADCAST");
+        Serial.print(F("BROADCAST"));
         break;
     case SEARCH_REQUEST:
-        Serial.print("SEARCH_REQUEST");
+        Serial.print(F("SEARCH_REQUEST"));
         break;
     case SEARCH_RESPONSE:
-        Serial.print("SEARCH_RESPONSE");
+        Serial.print(F("SEARCH_RESPONSE"));
         break;
     default:
         break;
     }
-    Serial.print(" message from MAC ");
+    Serial.print(F(" message from MAC "));
     Serial.print(macToString(outgoingData.transmittedData.originalSenderMAC));
-    Serial.print(" to MAC ");
+    Serial.print(F(" to MAC "));
     Serial.print(macToString(outgoingData.transmittedData.originalTargetMAC));
-    Serial.println(" added to queue.");
+    Serial.println(F(" added to queue."));
 #endif
 }
 
 void ZHNetwork::unicastMessage(const char *data, const uint8_t *target, const uint8_t *sender, message_type_t type)
 {
     outgoing_data_t outgoingData;
-    esp_memset(&outgoingData, 0, sizeof(outgoing_data_t));
     outgoingData.transmittedData.messageType = type;
     outgoingData.transmittedData.messageID = ((uint16_t)random(32767) << 8) | (uint16_t)random(32767);
     memcpy(&outgoingData.transmittedData.netName, &netName_, 20);
@@ -651,32 +651,32 @@ void ZHNetwork::unicastMessage(const char *data, const uint8_t *target, const ui
             memcpy(&outgoingData.intermediateTargetMAC, &routingTable.intermediateTargetMAC, 6);
             queueForOutgoingData.push(outgoingData);
 #ifdef PRINT_LOG
-            Serial.print("CHECKING ROUTING TABLE... Routing to MAC ");
+            Serial.print(F("CHECKING ROUTING TABLE... Routing to MAC "));
             Serial.print(macToString(outgoingData.transmittedData.originalTargetMAC));
-            Serial.print(" found. Target is ");
+            Serial.print(F(" found. Target is "));
             Serial.print(macToString(outgoingData.intermediateTargetMAC));
-            Serial.println(".");
+            Serial.println(F("."));
             switch (outgoingData.transmittedData.messageType)
             {
             case UNICAST:
-                Serial.print("UNICAST");
+                Serial.print(F("UNICAST"));
                 break;
             case UNICAST_WITH_CONFIRM:
-                Serial.print("UNICAST_WITH_CONFIRM");
+                Serial.print(F("UNICAST_WITH_CONFIRM"));
                 break;
             case DELIVERY_CONFIRM_RESPONSE:
-                Serial.print("DELIVERY_CONFIRM_RESPONSE");
+                Serial.print(F("DELIVERY_CONFIRM_RESPONSE"));
                 break;
             default:
                 break;
             }
-            Serial.print(" message from MAC ");
+            Serial.print(F(" message from MAC "));
             Serial.print(macToString(outgoingData.transmittedData.originalSenderMAC));
-            Serial.print(" to MAC ");
+            Serial.print(F(" to MAC "));
             Serial.print(macToString(outgoingData.transmittedData.originalTargetMAC));
-            Serial.print(" via MAC ");
+            Serial.print(F(" via MAC "));
             Serial.print(macToString(outgoingData.intermediateTargetMAC));
-            Serial.println(" added to queue.");
+            Serial.println(F(" added to queue."));
 #endif
             return;
         }
@@ -684,31 +684,31 @@ void ZHNetwork::unicastMessage(const char *data, const uint8_t *target, const ui
     memcpy(&outgoingData.intermediateTargetMAC, target, 6);
     queueForOutgoingData.push(outgoingData);
 #ifdef PRINT_LOG
-    Serial.print("CHECKING ROUTING TABLE... Routing to MAC ");
+    Serial.print(F("CHECKING ROUTING TABLE... Routing to MAC "));
     Serial.print(macToString(outgoingData.transmittedData.originalTargetMAC));
-    Serial.print(" not found. Target is ");
+    Serial.print(F(" not found. Target is "));
     Serial.print(macToString(outgoingData.intermediateTargetMAC));
-    Serial.println(".");
+    Serial.println(F("."));
     switch (outgoingData.transmittedData.messageType)
     {
     case UNICAST:
-        Serial.print("UNICAST");
+        Serial.print(F("UNICAST"));
         break;
     case UNICAST_WITH_CONFIRM:
-        Serial.print("UNICAST_WITH_CONFIRM");
+        Serial.print(F("UNICAST_WITH_CONFIRM"));
         break;
     case DELIVERY_CONFIRM_RESPONSE:
-        Serial.print("DELIVERY_CONFIRM_RESPONSE");
+        Serial.print(F("DELIVERY_CONFIRM_RESPONSE"));
         break;
     default:
         break;
     }
-    Serial.print(" message from MAC ");
+    Serial.print(F(" message from MAC "));
     Serial.print(macToString(outgoingData.transmittedData.originalSenderMAC));
-    Serial.print(" to MAC ");
+    Serial.print(F(" to MAC "));
     Serial.print(macToString(outgoingData.transmittedData.originalTargetMAC));
-    Serial.print(" via MAC ");
+    Serial.print(F(" via MAC "));
     Serial.print(macToString(outgoingData.intermediateTargetMAC));
-    Serial.println(" added to queue.");
+    Serial.println(F(" added to queue."));
 #endif
 }

src/ZHNetwork.h

@@ -15,46 +15,39 @@
 
 // #define PRINT_LOG // Uncomment to display to serial port the full operation log.
 
-#if defined(ESP8266)
-#define esp_memset memset // Just for remove the compiler notice for ESP8266 at "memset". I don't know why this is happening...
-#endif
-#if defined(ESP32)
-#define esp_memset memset
-#endif
-
 typedef struct
 {
-    uint8_t messageType;
+    uint8_t messageType{0};
-    uint16_t messageID;
+    uint16_t messageID{0};
-    char netName[20];
+    char netName[20]{0};
-    uint8_t originalTargetMAC[6];
+    uint8_t originalTargetMAC[6]{0};
-    uint8_t originalSenderMAC[6];
+    uint8_t originalSenderMAC[6]{0};
-    char message[200];
+    char message[200]{0};
 } transmitted_data_t;
 
 typedef struct
 {
-    uint8_t intermediateTargetMAC[6];
+    uint8_t intermediateTargetMAC[6]{0};
     transmitted_data_t transmittedData;
 } outgoing_data_t;
 
 typedef struct
 {
-    uint8_t intermediateSenderMAC[6];
+    uint8_t intermediateSenderMAC[6]{0};
     transmitted_data_t transmittedData;
 } incoming_data_t;
 
 typedef struct
 {
-    uint64_t time;
+    uint64_t time{0};
-    uint8_t intermediateTargetMAC[6];
+    uint8_t intermediateTargetMAC[6]{0};
     transmitted_data_t transmittedData;
 } waiting_data_t;
 
 typedef struct
 {
-    uint8_t originalTargetMAC[6];
+    uint8_t originalTargetMAC[6]{0};
-    uint8_t intermediateTargetMAC[6];
+    uint8_t intermediateTargetMAC[6]{0};
 } routing_table_t;
 
 typedef enum
@@ -104,6 +97,7 @@ public:
     error_code_t setApSetting(const char *ssid, const char *password);
 
     error_code_t begin(void);
+    error_code_t stop(void);
 
     void sendBroadcastMessage(const char *data);
     void sendUnicastMessage(const char *data, const uint8_t *target, const bool confirm = false);