3 Commits
v1.0 ... v1.02

Author SHA1 Message Date
425e5035c9 Version 1.02
Minor code optimization.
2022-12-11 09:13:25 +03:00
7a1b67102e Minor changes 2022-12-10 15:18:15 +03:00
67dcf3f407 Version 1.01
Optimizing using RAM on PRINT_LOG mode.
2022-12-10 15:11:11 +03:00
3 changed files with 93 additions and 109 deletions

View File

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

View File

@ -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.02"};
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;
}
@ -154,7 +149,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 +162,7 @@ void ZHNetwork::maintenance()
else
{
#ifdef PRINT_LOG
Serial.println("FAULT.");
Serial.println(F("FAULT."));
#endif
if (numberOfAttemptsToSend < maxNumberOfAttempts_)
++numberOfAttemptsToSend;
@ -186,14 +181,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 +214,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 +255,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 +265,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 +283,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 +302,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 +320,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 +334,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 +369,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 +387,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 +407,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 +424,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 +594,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 +606,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 +642,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 +675,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
}

View File

@ -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;
uint16_t messageID;
char netName[20];
uint8_t originalTargetMAC[6];
uint8_t originalSenderMAC[6];
char message[200];
uint8_t messageType{0};
uint16_t messageID{0};
char netName[20]{0};
uint8_t originalTargetMAC[6]{0};
uint8_t originalSenderMAC[6]{0};
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;
uint8_t intermediateTargetMAC[6];
uint64_t time{0};
uint8_t intermediateTargetMAC[6]{0};
transmitted_data_t transmittedData;
} waiting_data_t;
typedef struct
{
uint8_t originalTargetMAC[6];
uint8_t intermediateTargetMAC[6];
uint8_t originalTargetMAC[6]{0};
uint8_t intermediateTargetMAC[6]{0};
} routing_table_t;
typedef enum