added allow reboot define and clear node from node queue after successfully ota process

components/mesh_ota/CMakeLists.txt

@@ -1,4 +1,4 @@
-idf_component_register(SRCS "HTTPS_client.c" "Mesh_network_handler.c" "Mesh_network.c" "Mesh_OTA.c"
+idf_component_register(SRCS "Mesh_OTA_Util.c" "Mesh_Network.c" "Mesh_Network_Handler.c" "HTTPS_Client.c" "Mesh_OTA_Partition_Access.c" "Mesh_OTA_Globals.c" "Mesh_OTA.c"
                     INCLUDE_DIRS "include" 
                     REQUIRES nvs_flash
                     esp_http_client

components/mesh_ota/HTTPS_Client.c

@@ -1,7 +1,8 @@
-#include "HTTPS_client.h"
+#include "HTTPS_Client.h"
 
 static const char *TAG = "https_client";
 
+//HTTP GET data
 static const char *REQUEST = "GET " CONFIG_OTA_HTTPS_URL " HTTP/1.1\r\n"
                              "Host: "CONFIG_OTA_HTTPS_SERVER_COMMON_NAME"\r\n"
                              "User-Agent: esp-idf/1.0 esp32\r\n"
@@ -11,12 +12,12 @@ static const char *REQUEST = "GET " CONFIG_OTA_HTTPS_URL " HTTP/1.1\r\n"
 
 static HTTPS_Client_t sHTTPS_ClientConfig;
 
-https_client_ret_t https_clientInitEmbedTLS();
-https_client_ret_t errHTTPSClientConnectToServer();
-https_client_ret_t errHTTPSClientValidateServer();
-https_client_ret_t errHTTPSClientSendRequest();
+https_client_ret_t https_clientInitEmbedTLS(void);
+https_client_ret_t errHTTPSClientConnectToServer(void);
+https_client_ret_t errHTTPSClientValidateServer(void);
+https_client_ret_t errHTTPSClientSendRequest(void);
 
-https_client_ret_t errHTTPSClientInitialize()
+https_client_ret_t errHTTPSClientInitialize(void)
 {
     https_client_ret_t i32RetHTTPClient = HTTPS_CLIENT_OK;
 
@@ -30,27 +31,27 @@ https_client_ret_t errHTTPSClientInitialize()
     return i32RetHTTPClient;
 }
 
-https_client_ret_t errHTTPSClientRetrieveData(char* pu8Data, uint32_t* pu32DataLenght, uint32_t* pu32BytesRead)
+https_client_ret_t errHTTPSClientRetrieveData(char* const cpu8Data, const uint32_t* const cpcu32DataLenght, uint32_t* pu32BytesRead)
 {
     https_client_ret_t i32RetHTTPClient = HTTPS_CLIENT_OK;
     int32_t i32RetRetrieveData = ESP_OK;
     bool bRetriveData = true;
 
-    bzero(pu8Data, *pu32DataLenght);
-    *pu32BytesRead = 0U;
+    bzero(cpu8Data, *cpcu32DataLenght);
+    (*pu32BytesRead) = 0U;
 
     while (bRetriveData)
         {
             mbedtls_ssl_conf_read_timeout(&sHTTPS_ClientConfig.conf, HTTPS_READ_TIMEOUT); //set timeout
             //Reading HTTP response
-            i32RetRetrieveData = mbedtls_ssl_read(&sHTTPS_ClientConfig.ssl, (unsigned char *)(pu8Data+(*pu32BytesRead)), ((*pu32DataLenght)-(*pu32BytesRead)));
+            i32RetRetrieveData = mbedtls_ssl_read(&sHTTPS_ClientConfig.ssl, (unsigned char *)(cpu8Data+(*pu32BytesRead)), ((*cpcu32DataLenght)-(*pu32BytesRead)));
 
             if(i32RetRetrieveData > 0)
                 {
                     //Data received
                     *pu32BytesRead = *pu32BytesRead + i32RetRetrieveData;
 
-                    if(*pu32DataLenght > 0)
+                    if(*cpcu32DataLenght > 0)
                         {
                             //buffer not full yet --> read some more
                             bRetriveData = true;
@@ -85,7 +86,7 @@ https_client_ret_t errHTTPSClientRetrieveData(char* pu8Data, uint32_t* pu32DataL
     return i32RetHTTPClient;
 }
 
-https_client_ret_t errHTTPSClientReset()
+https_client_ret_t errHTTPSClientReset(void)
 {
     https_client_ret_t i32RetHTTPClient = HTTPS_CLIENT_OK;
 
@@ -102,7 +103,7 @@ https_client_ret_t errHTTPSClientReset()
     return i32RetHTTPClient;
 }
 
-https_client_ret_t https_clientInitEmbedTLS()
+https_client_ret_t https_clientInitEmbedTLS(void)
 {
 
     https_client_ret_t i32RetHTTPClient = HTTPS_CLIENT_OK;
@@ -196,7 +197,7 @@ https_client_ret_t https_clientInitEmbedTLS()
     return i32RetHTTPClient;
 }
 
-https_client_ret_t errHTTPSClientConnectToServer()
+https_client_ret_t errHTTPSClientConnectToServer(void)
 {
     https_client_ret_t i32RetHTTPClient = HTTPS_CLIENT_OK;
     int32_t i32RetServerConnect = ESP_OK;
@@ -229,7 +230,7 @@ https_client_ret_t errHTTPSClientConnectToServer()
     return i32RetHTTPClient;
 }
 
-https_client_ret_t errHTTPSClientValidateServer()
+https_client_ret_t errHTTPSClientValidateServer(void)
 {
     https_client_ret_t i32RetHTTPClient = HTTPS_CLIENT_OK;
     int32_t i32RetValidateServer = ESP_OK;
@@ -247,7 +248,7 @@ https_client_ret_t errHTTPSClientValidateServer()
     return i32RetHTTPClient;
 }
 
-https_client_ret_t errHTTPSClientSendRequest()
+https_client_ret_t errHTTPSClientSendRequest(void)
 {
     https_client_ret_t i32RetHTTPClient = HTTPS_CLIENT_OK;
     int32_t i32RetSendRequest = ESP_OK;

components/mesh_ota/Mesh_Network.c

@@ -1,18 +1,34 @@
 
-#include "Mesh_OTA.h"
+#include "Mesh_Network.h"
 
 static const char *LOG_TAG = "mesh_network";
-static uint8_t tx_buf[CONFIG_MESH_MESSAGE_SIZE] = { 0, };
-static uint8_t rx_buf[CONFIG_MESH_MESSAGE_SIZE] = { 0, };
+
+
+//w: errMeshNetworkInitialize
+//r: errMeshNetworkInitialize;vMeshNetworkGetOwnAddr;errMeshNetworkGetChildren
 uint8_t u8ownMAC[6];
-esp_netif_t* netif_sta;
+
+//w: errMeshNetworkInitialize; vMeshNetworkMeshEventHandler
+//r: vMeshNetworkMeshEventHandler
+esp_netif_t* pNetifSta;
+
+//w: errMeshNetworkInitialize; vMeshNetworkMeshEventHandler
+//r: errMeshNetworkInitialize;
 bool bIsMeshConnected;
+
+//w: errMeshNetworkInitialize; vMeshNetworkMeshEventHandler
+//r: vMeshNetworkMeshEventHandler
 int32_t i32MeshLayer;
+
+//w: errMeshNetworkInitialize; vMeshNetworkMeshEventHandler
+//r: vMeshNetworkMeshEventHandler
 mesh_addr_t meshParentAddr;
-void (*pAppRxHandle)(uint8_t*, uint8_t* );
-void (*pOTAChildConnectHandle)(uint8_t* );
-void (*pOTAMessageHandle)(MESH_PACKET_t* );
-void (*pChangeStateOfServerWorkerHandle)(bool );
+
+//function pointer for callbacks
+void (*pAppRxHandle)(const uint8_t* const, const uint8_t* const);
+void (*pOTAChildConnectHandle)(const uint8_t* const);
+void (*pOTAMessageHandle)(const MESH_PACKET_t* const);
+void (*pChangeStateOfServerWorkerHandle)(const bool );
 
 esp_err_t errMeshNetworkInitialize()
 {
@@ -20,7 +36,7 @@ esp_err_t errMeshNetworkInitialize()
     esp_err_t err;
     bIsMeshConnected = false;
     i32MeshLayer = -1;
-    netif_sta = NULL;
+    pNetifSta = NULL;
 
     err = nvs_flash_init(); //init non-volatile storage
 
@@ -38,7 +54,7 @@ esp_err_t errMeshNetworkInitialize()
     ERROR_CHECK(esp_event_loop_create_default());
 
     //create network interfaces for mesh (only station instance saved for further manipulation, soft AP instance ignored
-    ERROR_CHECK(esp_netif_create_default_wifi_mesh_netifs(&netif_sta, NULL));
+    ERROR_CHECK(esp_netif_create_default_wifi_mesh_netifs(&pNetifSta, NULL));
 
     //wifi initialization
     ERROR_CHECK(errMeshNetworkInitializeWiFi());
@@ -47,7 +63,7 @@ esp_err_t errMeshNetworkInitialize()
     ERROR_CHECK(esp_mesh_init());
 
     //mesh initialization
-    ERROR_CHECK(esp_event_handler_register(MESH_EVENT, ESP_EVENT_ANY_ID, &vMeshEventHandler, NULL));
+    ERROR_CHECK(esp_event_handler_register(MESH_EVENT, ESP_EVENT_ANY_ID, &vMeshNetworkMeshEventHandler, NULL));
 
     //set mesh topology
     ERROR_CHECK(esp_mesh_set_topology(CONFIG_MESH_TOPOLOGY));
@@ -97,7 +113,7 @@ esp_err_t errMeshNetworkInitializeWiFi()
     esp_err_t err = ESP_OK;
     wifi_init_config_t config = WIFI_INIT_CONFIG_DEFAULT();
     ERROR_CHECK(esp_wifi_init(&config));
-    ERROR_CHECK(esp_event_handler_register(IP_EVENT, IP_EVENT_STA_GOT_IP, &vIPEventHandler, NULL));
+    ERROR_CHECK(esp_event_handler_register(IP_EVENT, IP_EVENT_STA_GOT_IP, &vMeshNetworkIpEventHandler, NULL));
     ERROR_CHECK(esp_wifi_set_storage(WIFI_STORAGE_FLASH));
     ERROR_CHECK(esp_wifi_start());
     return err;
@@ -115,84 +131,52 @@ esp_err_t errMeshNetworkInitializeRouter(mesh_cfg_t* cfg)
     return err;
 }
 
-//returns true if MAC address is equal
-bool bCheckMACEquality(uint8_t* pu8aMAC,  uint8_t* pu8bMAC)
+esp_err_t errMeshNetworkSetChildConnectedHandle(void (*pChildConnectHandleTmp)(const uint8_t* const cpcu8Data))
 {
-    bool bRet = true;
-    uint8_t index = 0;
-
-    while ((index < 6) && (bRet == true))
-        {
-            if(pu8aMAC[index] != pu8bMAC[index])
-                {
-                    bRet = false;
-                }
-
-            if(index == 5)
-                {
-                    //last byte of mac
-                    if(abs((pu8aMAC[index] - pu8bMAC[index])) <= 1)
-                        {
-                            bRet = true; //last byte differs 1 ore less
-                        }
-                }
-            index++;
-        }
-    return bRet;
+    pOTAChildConnectHandle = pChildConnectHandleTmp;
+    return ESP_OK;
 }
 
-esp_err_t errGetChildren(mesh_addr_t* pChildren, uint16_t* pu16ChildrenSize)
+esp_err_t errMeshNetworkSetAppReceiveHandle(void (*pAppRxHandleTmp)(const uint8_t* const cpcu8Data, const uint8_t* const pu8Sender))
 {
-    esp_err_t err = ESP_OK;
-    int route_table_size = 0;
-    *pu16ChildrenSize = 0;
-    mesh_addr_t route_table[CONFIG_MESH_ROUTE_TABLE_SIZE];
-    ERROR_CHECK(esp_mesh_get_routing_table((mesh_addr_t *) &route_table, (CONFIG_MESH_ROUTE_TABLE_SIZE * 6), &route_table_size));
+    pAppRxHandle = pAppRxHandleTmp; //set handle from app as receive handle if an app packet is received
+    return ESP_OK;
+}
+
+esp_err_t errMeshNetworkSetOTAMessageHandleHandle(void (*pOTAMessageHandleTmp)(const MESH_PACKET_t* const cpcuMeshPacket))
+{
+    pOTAMessageHandle = pOTAMessageHandleTmp;
+    return ESP_OK;
+}
+
+esp_err_t errMeshNetworkSetChangeStateOfServerWorkerHandle(void (*pChangeStateOfServerWorkerHandleTmp)(const bool cbState))
+{
+    pChangeStateOfServerWorkerHandle = pChangeStateOfServerWorkerHandleTmp;
+    return ESP_OK;
+}
+
+esp_err_t errMeshNetworkSendMeshPacket(const mesh_addr_t* const cpcAddrDest, const MESH_PACKET_t* const cpcPacket)
+{
+    esp_err_t err;
+    mesh_data_t data;
+    uint8_t tx_buf[CONFIG_MESH_MESSAGE_SIZE] = { 0, };
+    data.data = tx_buf;
+    data.size = sizeof(tx_buf);
+    data.proto = MESH_PROTO_BIN;
+    data.tos = MESH_TOS_P2P;
+    memcpy(tx_buf, (uint8_t *)cpcPacket, sizeof(MESH_PACKET_t));
+
+    err = esp_mesh_send(cpcAddrDest, &data, MESH_DATA_P2P, NULL, 0);
 
-    if (err == ESP_OK)
-        {
-            for(uint16_t index = 0; index < esp_mesh_get_routing_table_size(); index++)
-                {
-                    if(! (bCheckMACEquality(u8ownMAC, route_table[index].addr))  )
-                        {
-                            //child node
-                            //ESP_LOGI(LOG_TAG, "adding Node: \"0x%x, 0x%x, 0x%x, 0x%x, 0x%x, 0x%x\" ", route_table[index].addr[0], route_table[index].addr[1], route_table[index].addr[2], route_table[index].addr[3], route_table[index].addr[4], route_table[index].addr[5]);
-                            pChildren[*pu16ChildrenSize] = route_table[index];
-                            *pu16ChildrenSize = (*pu16ChildrenSize)+1;
-                        }
-                }
-        }
     return err;
 }
 
-esp_err_t errGetParentNode(mesh_addr_t* pMeshParentAddr)
-{
-    esp_err_t err = ESP_OK;
-
-    if((bIsMeshConnected == false) || (esp_mesh_is_root()))
-        {
-            //this node is not connected or is the root --> this node has no parent
-            err = ESP_FAIL;
-        }
-    else
-        {
-            //node has parent
-            memcpy(pMeshParentAddr, &meshParentAddr, sizeof(mesh_addr_t));
-        }
-    return err;
-}
-
-void vGetOwnAddr(mesh_addr_t* pMeshOwnAddr)
-{
-    memcpy(pMeshOwnAddr->addr, u8ownMAC, 6);
-}
-
-bool bIsRootNode()
+bool bMeshNetworkIsRootNode()
 {
     return esp_mesh_is_root();
 }
 
-bool bIsNodeNeighbour(mesh_addr_t* pNode)
+bool bMeshNetworkIsNodeNeighbour(const mesh_addr_t* const cpcNode)
 {
     esp_err_t err = ESP_OK;
     bool bReturn = false;
@@ -200,11 +184,11 @@ bool bIsNodeNeighbour(mesh_addr_t* pNode)
     mesh_addr_t childrenAddr[CONFIG_MESH_ROUTE_TABLE_SIZE]; //array of children attached to this node
     uint16_t u16ChildrenSize = 0U; //number of children attached to this node
 
-    err = errGetParentNode(&addrParent);
+    err = errMeshNetworkGetParentNode(&addrParent);
 
     if(err == ESP_OK)
         {
-            if(bCheckMACEquality(pNode->addr,  addrParent.addr) == true)
+            if(bMeshNetworkCheckMACEquality(cpcNode->addr,  addrParent.addr) == true)
                 {
                     bReturn = true; //node was found
                 }
@@ -214,11 +198,11 @@ bool bIsNodeNeighbour(mesh_addr_t* pNode)
         {
             err = ESP_OK; //reset error code
 
-            ERROR_CHECK(errGetChildren(childrenAddr, &u16ChildrenSize)); //get all children
+            ERROR_CHECK(errMeshNetworkGetChildren(childrenAddr, &u16ChildrenSize)); //get all children
 
             for (uint16_t u16Index = 0; ((u16Index < u16ChildrenSize) && (err == ESP_OK) && (bReturn == false)); u16Index++)
                 {
-                    if(bCheckMACEquality(pNode->addr,  childrenAddr[u16Index].addr) == true)
+                    if(bMeshNetworkCheckMACEquality(cpcNode->addr,  childrenAddr[u16Index].addr) == true)
                         {
                             bReturn = true; //node was found
                         }
@@ -227,51 +211,38 @@ bool bIsNodeNeighbour(mesh_addr_t* pNode)
     return bReturn;
 }
 
-esp_err_t errMeshNetworkSetAppReceiveHandle(void (*pAppRxHandleTmp)(uint8_t * pu8Data, uint8_t* pu8Sender))
+//returns true if MAC address is equal
+bool bMeshNetworkCheckMACEquality(const uint8_t* const cpcu8aMAC, const uint8_t* const cpcu8bMAC)
 {
-    pAppRxHandle = pAppRxHandleTmp; //set handle from app as receive handle if an app packet is received
-    return ESP_OK;
+    bool bRet = true;
+    uint8_t index = 0;
+
+    while ((index < 6) && (bRet == true))
+        {
+            if(cpcu8aMAC[index] != cpcu8bMAC[index])
+                {
+                    bRet = false;
+                }
+
+            if(index == 5)
+                {
+                    //last byte of mac
+                    if(abs((cpcu8aMAC[index] - cpcu8bMAC[index])) <= 1)
+                        {
+                            bRet = true; //last byte differs 1 ore less
+                        }
+                }
+            index++;
+        }
+    return bRet;
 }
 
-esp_err_t errMeshNetworkSetChildConnectedHandle(void (*pChildConnectHandleTmp)(uint8_t * pu8Data))
-{
-    pOTAChildConnectHandle = pChildConnectHandleTmp;
-    return ESP_OK;
-}
-
-esp_err_t errMeshNetworkSetOTAMessageHandleHandle(void (*pOTAMessageHandleTmp)(MESH_PACKET_t* puMeshPacket))
-{
-    pOTAMessageHandle = pOTAMessageHandleTmp;
-    return ESP_OK;
-}
-
-esp_err_t errMeshNetworkSetChangeStateOfServerWorkerHandle(void (*pChangeStateOfServerWorkerHandleTmp)(bool bState))
-{
-    pChangeStateOfServerWorkerHandle = pChangeStateOfServerWorkerHandleTmp;
-    return ESP_OK;
-}
-
-esp_err_t errSendMeshPacket(mesh_addr_t* pAddrDest, MESH_PACKET_t* pPacket)
-{
-    esp_err_t err;
-    mesh_data_t data;
-    data.data = tx_buf;
-    data.size = sizeof(tx_buf);
-    data.proto = MESH_PROTO_BIN;
-    data.tos = MESH_TOS_P2P;
-    memcpy(tx_buf, (uint8_t *)pPacket, sizeof(MESH_PACKET_t));
-
-    err = esp_mesh_send(pAddrDest, &data, MESH_DATA_P2P, NULL, 0);
-
-    return err;
-}
-
-esp_err_t errStartReceiveTask()
+esp_err_t errMeshNetworkStartReceiveTask()
 {
     esp_err_t err = ESP_OK;
     BaseType_t xReturned;
 
-    xReturned = xTaskCreate(vTaskReceiveMeshData, "ReceiveMeshData", 7000, NULL, 5, NULL);
+    xReturned = xTaskCreate(vMeshNetworkTaskReceiveMeshData, "ReceiveMeshData", 7000, NULL, 5, NULL);
 
     if(xReturned != pdPASS)
         {
@@ -280,11 +251,41 @@ esp_err_t errStartReceiveTask()
     return err;
 }
 
-void vTaskReceiveMeshData(void *arg)
+void vMeshNetworkGetOwnAddr(mesh_addr_t* const cpMeshOwnAddr)
+{
+    memcpy(cpMeshOwnAddr->addr, u8ownMAC, 6);
+}
+
+esp_err_t errMeshNetworkGetChildren(mesh_addr_t* const cpChildren, uint16_t* const cpu16ChildrenSize)
+{
+    esp_err_t err = ESP_OK;
+    int route_table_size = 0;
+    *cpu16ChildrenSize = 0;
+    mesh_addr_t route_table[CONFIG_MESH_ROUTE_TABLE_SIZE];
+    ERROR_CHECK(esp_mesh_get_routing_table((mesh_addr_t *) &route_table, (CONFIG_MESH_ROUTE_TABLE_SIZE * 6), &route_table_size));
+
+    if (err == ESP_OK)
+        {
+            for(uint16_t index = 0; index < esp_mesh_get_routing_table_size(); index++)
+                {
+                    if(! (bMeshNetworkCheckMACEquality(u8ownMAC, route_table[index].addr))  )
+                        {
+                            //child node
+                            //ESP_LOGI(LOG_TAG, "adding Node: \"0x%x, 0x%x, 0x%x, 0x%x, 0x%x, 0x%x\" ", route_table[index].addr[0], route_table[index].addr[1], route_table[index].addr[2], route_table[index].addr[3], route_table[index].addr[4], route_table[index].addr[5]);
+                            cpChildren[*cpu16ChildrenSize] = route_table[index];
+                            (*cpu16ChildrenSize) =  (*cpu16ChildrenSize)+1;
+                        }
+                }
+        }
+    return err;
+}
+
+void vMeshNetworkTaskReceiveMeshData(void *arg)
 {
     esp_err_t err;
     mesh_addr_t from;
     mesh_data_t data;
+    uint8_t rx_buf[CONFIG_MESH_MESSAGE_SIZE] = { 0, };
     int flag = 0;
     data.data = rx_buf;
     data.size = CONFIG_MESH_MESSAGE_SIZE;
@@ -328,6 +329,22 @@ void vTaskReceiveMeshData(void *arg)
         } //end while
 }
 
+esp_err_t errMeshNetworkGetParentNode(mesh_addr_t* const cpMeshParentAddr)
+{
+    esp_err_t err = ESP_OK;
+
+    if((bIsMeshConnected == false) || (esp_mesh_is_root()))
+        {
+            //this node is not connected or is the root --> this node has no parent
+            err = ESP_FAIL;
+        }
+    else
+        {
+            //node has parent
+            memcpy(cpMeshParentAddr, &meshParentAddr, sizeof(mesh_addr_t));
+        }
+    return err;
+}
 
 
 

components/mesh_ota/Mesh_Network_Handler.c

@@ -1,9 +1,9 @@
 
-#include "Mesh_OTA.h"
+#include "Mesh_Network.h"
 
 static const char *LOG_TAG = "mesh_network_handler";
 
-void vIPEventHandler(void *arg, esp_event_base_t event_base, int32_t i32EventID, void *vpEventData)
+void vMeshNetworkIpEventHandler(void *arg, esp_event_base_t event_base, int32_t i32EventID, void *vpEventData)
 {
     ip_event_got_ip_t *event = (ip_event_got_ip_t *) vpEventData;
     ESP_LOGI(LOG_TAG, "<IP_EVENT_STA_GOT_IP>IP:" IPSTR, IP2STR(&event->ip_info.ip));
@@ -13,7 +13,7 @@ void vIPEventHandler(void *arg, esp_event_base_t event_base, int32_t i32EventID,
         }
 }
 
-void vMeshEventHandler(void *arg, esp_event_base_t event_base, int32_t i32EventID, void* vpEventData)
+void vMeshNetworkMeshEventHandler(void *arg, esp_event_base_t event_base, int32_t i32EventID, void* vpEventData)
 {
     mesh_addr_t id = {0,};
     static uint16_t last_layer = 0;
@@ -90,12 +90,12 @@ last_layer = i32MeshLayer;
 bIsMeshConnected = true;
 if (esp_mesh_is_root()) 
 {
-if(esp_netif_dhcpc_start(netif_sta) == ESP_ERR_ESP_NETIF_DHCP_ALREADY_STARTED) //get a IP from router
+if(esp_netif_dhcpc_start(pNetifSta) == ESP_ERR_ESP_NETIF_DHCP_ALREADY_STARTED) //get a IP from router
 {
 if(pChangeStateOfServerWorkerHandle){pChangeStateOfServerWorkerHandle(true);}// signal reconnect
 } 
 }
-errStartReceiveTask();//start receiving
+errMeshNetworkStartReceiveTask();//start receiving
 }
 break;
         case MESH_EVENT_PARENT_DISCONNECTED: 

components/mesh_ota/Mesh_OTA.c

@@ -1,16 +1,10 @@
 #include "Mesh_OTA.h"
+#include "Mesh_OTA_Util.h"
+#include "Mesh_OTA_Globals.h"
+#include "Mesh_OTA_Partition_Access.h"
 
 static const char *LOG_TAG = "mesh_ota";
 
-xQueueHandle queueNodes; //nodes that should be checked for ota update (contains children and parent)
-xQueueHandle queueMessageOTA; //mesh ota controll messages like "OTA_Version_Response" "OTA_ACK"
-
-SemaphoreHandle_t bsStartStopServerWorker; //binary semaphore
-SemaphoreHandle_t bsOTAProcess; //binary semaphore
-
-const esp_partition_t* pOTAPartition; //pointer to ota partition
-bool bWantReboot; //flag to signal pending reboot
-
 esp_err_t errMeshOTAInitialize()
 {
     esp_err_t err = ESP_OK;
@@ -66,9 +60,9 @@ esp_err_t errMeshOTAInitialize()
                 }
         }
 
-    ERROR_CHECK(errMeshNetworkSetChildConnectedHandle(vAddNodeToPossibleUpdatableQueue));
-    ERROR_CHECK(errMeshNetworkSetOTAMessageHandleHandle(vAddOtaMessageToQueue));
-    ERROR_CHECK(errMeshNetworkSetChangeStateOfServerWorkerHandle(vChangeStateOfServerWorker));
+    ERROR_CHECK(errMeshNetworkSetChildConnectedHandle(vMeshOtaUtilAddNodeToPossibleUpdatableQueue));
+    ERROR_CHECK(errMeshNetworkSetOTAMessageHandleHandle(vMeshOtaUtilAddOtaMessageToQueue));
+    ERROR_CHECK(errMeshNetworkSetChangeStateOfServerWorkerHandle(vMeshOtaUtilChangeStateOfServerWorker));
 
     if(err == ESP_OK)
         {
@@ -83,7 +77,7 @@ esp_err_t errMeshOTAInitialize()
 
     if(err == ESP_OK)
         {
-            xReturned = xTaskCreate(vTaskServerWorker, "vTaskServerWorker", 8192, NULL, 5, NULL);
+            xReturned = xTaskCreate(vMeshOtaTaskServerWorker, "vMeshOtaTaskServerWorker", 8192, NULL, 5, NULL);
             if(xReturned != pdPASS)
                 {
                     ESP_LOGE(LOG_TAG, "Unable to create the server worker task");
@@ -94,7 +88,7 @@ esp_err_t errMeshOTAInitialize()
 
     if(err == ESP_OK)
         {
-            xReturned = xTaskCreate(vTaskOTAWorker, "vTaskOTAWorker", 8192, NULL, 5, NULL);
+            xReturned = xTaskCreate(vMeshOtaTaskOTAWorker, "vMeshOtaTaskOTAWorker", 8192, NULL, 5, NULL);
             if(xReturned != pdPASS)
                 {
                     ESP_LOGE(LOG_TAG, "Unable to create the OTA worker task");
@@ -105,76 +99,7 @@ esp_err_t errMeshOTAInitialize()
     return err;
 }
 
-void vAddNodeToPossibleUpdatableQueue(uint8_t* pu8MAC)
-{
-    //send payload to node queues
-    mesh_addr_t addrNode;
-    memcpy(&addrNode.addr, (uint8_t *)pu8MAC, 6); //copy MAC
-
-    if (xQueueSend(queueNodes, &addrNode, portMAX_DELAY) != pdPASS)
-        {
-            ESP_LOGE(LOG_TAG, "Unable to push node into node queue");
-        }
-    else
-        {
-            ESP_LOGI(LOG_TAG, "added node \"%x:%x:%x:%x:%x:%x\" to possible updatable queue", addrNode.addr[0], addrNode.addr[1], addrNode.addr[2], addrNode.addr[3], addrNode.addr[4], addrNode.addr[5]);
-        }
-}
-
-void vAddOtaMessageToQueue(MESH_PACKET_t* puMeshPacket)
-{
-    //send ota packet to packet queue
-    if (xQueueSend(queueMessageOTA, puMeshPacket, portMAX_DELAY) != pdPASS)
-        {
-            ESP_LOGE(LOG_TAG, "Unable to push ota packet into packet queue");
-        }
-    else
-        {
-            switch (puMeshPacket->type)
-                {
-                case OTA_Abort:
-                    ESP_LOGI(LOG_TAG, "added ota message to queue: OTA_Abort from 0x%x", puMeshPacket->meshSenderAddr.addr[5]);
-                    break;
-                case OTA_Version_Request:
-                    ESP_LOGI(LOG_TAG, "added ota message to queue: OTA_Version_Request from 0x%x", puMeshPacket->meshSenderAddr.addr[5]);
-                    break;
-
-                case OTA_Version_Response:
-                    ESP_LOGI(LOG_TAG, "added ota message to queue: OTA_Version Response from 0x%x", puMeshPacket->meshSenderAddr.addr[5]);
-                    break;
-                default:
-                    break;
-                }
-        }
-}
-
-void vChangeStateOfServerWorker(bool bState) //allow access via function ptn to networl_handler
-{
-    static bool bLastState = false;
-
-    if(bState != bLastState) //change only if necessary
-        {
-            ESP_LOGI(LOG_TAG, "server worker change handler");
-
-            if(bState == true)
-                {
-                    if (xSemaphoreGive(bsStartStopServerWorker)  != pdTRUE)
-                        {
-                            ESP_LOGE(LOG_TAG, "Unable to give mutex to activate the server worker");
-                        }
-                }
-            else
-                {
-                    if (xSemaphoreTake(bsStartStopServerWorker,( TickType_t ) 10 )  != pdTRUE)
-                        {
-                            ESP_LOGE(LOG_TAG, "Unable to obtain mutex to deactivate the server worker");
-                        }
-                }
-            bLastState = bState;
-        }
-}
-
-void vTaskServerWorker(void *arg)
+void vMeshOtaTaskServerWorker(void *arg)
 {
     esp_err_t err;
     bool bNewOTAImage; //true if a new ota image was downloaded and validated
@@ -201,7 +126,7 @@ void vTaskServerWorker(void *arg)
                     ERROR_CHECK(errHTTPSClientValidateServer());
                     ERROR_CHECK(errHTTPSClientSendRequest());
 
-                    ERROR_CHECK(errOTAHTTPS(&bNewOTAImage));
+                    ERROR_CHECK(errMeshOtaPartitionAccessHttps(&bNewOTAImage));
                     errHTTPSClientReset();
 
                     if(bNewOTAImage == true)
@@ -209,14 +134,14 @@ void vTaskServerWorker(void *arg)
                             //set want reboot
                             ESP_LOGI(LOG_TAG, "Updated successfully via HTTPS, set pending reboot");
                             bWantReboot = true;
-                            vAddAllNeighboursToQueue(); //add all existing neighbours to queue (aparent will not be added because this node is the root)
+                            vMeshOtaUtilAddAllNeighboursToQueue(); //add all existing neighbours to queue (aparent will not be added because this node is the root)
                         }
                     vTaskDelay( (SERVER_CHECK_INTERVAL*1000) / portTICK_PERIOD_MS); //sleep till next server checks
                 }
         }
 }
 
-void vTaskOTAWorker(void *arg)
+void vMeshOtaTaskOTAWorker(void *arg)
 {
     esp_err_t err = ESP_OK;
     bool bNewOTAImage; //true if a new ota image was downloaded and validated
@@ -232,14 +157,14 @@ void vTaskOTAWorker(void *arg)
                     //nodes queue is empty
                     ESP_LOGI(LOG_TAG, "nodes queue is empty");
 
-                    if(bWantReboot == true)
+                    if((bWantReboot == true) && (OTA_ALLOW_REBOOT == 1))
                         {
-                            //ESP_LOGI(LOG_TAG, "ESP32 Reboot ...");
-                            //vTaskDelay( (1000) / portTICK_PERIOD_MS);
-                            //esp_restart();
+                            ESP_LOGE(LOG_TAG, "ESP32 Reboot ...");
+                            vTaskDelay( (1000) / portTICK_PERIOD_MS);
+                            esp_restart();
                         }
 
-                    ERROR_CHECK(errOTAMeshSlave(&bNewOTAImage));
+                    ERROR_CHECK(errMeshOtaSlaveEndpoint(&bNewOTAImage));
                 }
             else
                 {
@@ -252,13 +177,18 @@ void vTaskOTAWorker(void *arg)
                             err = ESP_FAIL;
                         }
 
-                    ERROR_CHECK(errOTAMeshMaster(&bNewOTAImage, &meshNodeAddr));
+                    ERROR_CHECK(errMeshOtaMasterEndpoint(&bNewOTAImage, &meshNodeAddr));
 
                     if (err != ESP_OK)
                         {
                             //OTA process faild --> add back to queue
-                            vAddNodeToPossibleUpdatableQueue(meshNodeAddr.addr);
+                            vMeshOtaUtilAddNodeToPossibleUpdatableQueue(meshNodeAddr.addr);
                         }
+                    else
+                        {
+                            vMeshOtaUtilClearNeighboursQueue(&meshNodeAddr); //remove this node from queue
+                        }
+
                 }
 
             if(bNewOTAImage == true)
@@ -266,98 +196,20 @@ void vTaskOTAWorker(void *arg)
                     //set want reboot
                     ESP_LOGI(LOG_TAG, "Updated successfully via Mesh, set pending reboot");
                     bWantReboot = true;
-                    vAddAllNeighboursToQueue(); //add all existing neighbours to queue
+
+                    vMeshOtaUtilAddAllNeighboursToQueue(); //add all existing neighbours to queue
                 }
             vTaskDelay( (1000) / portTICK_PERIOD_MS);
         }
 }
 
-esp_err_t errOTAHTTPS(bool* pbNewOTAImage)
-{
-    esp_err_t err = ESP_OK;
-    char u8OTABuffer[OTA_HTTPS_SEGMENT_SIZE]; //store image segment from server before ota write
-    uint32_t u32BufferLenght = OTA_HTTPS_SEGMENT_SIZE; //size of buffer
-    uint32_t u32BytesRead = 0; //number of bytes that are read from server, <= u32BufferLenght
-    char pcRemoteVersionNumber[12]; //string for version number in server image
-    const esp_partition_t* pBootPartition; //pointer to boot partition (that will booted after reset)
-    static esp_ota_handle_t otaHandle; //OTA process handle
-    uint32_t u32StartOffset = 0U; //start offset for image (exclude the http response data)
-    esp_app_desc_t bootPartitionDesc; //Metadate from boot partition
-    uint32_t u32OTABytesWritten = 0U; //counter unsed for progress log
-
-    ERROR_CHECK(errHTTPSClientRetrieveData(u8OTABuffer, &u32BufferLenght, &u32BytesRead)); //read first bytes if image, including the version
-
-    ERROR_CHECK(errExtractVersionNumber(u8OTABuffer, &u32BytesRead, pcRemoteVersionNumber)); //extract version numbers
-
-    if(err == ESP_OK) //check if version number is found
-        {
-            xSemaphoreTake(bsOTAProcess, portMAX_DELAY); //wait for binary semaphore that allows to start the OTA process
-
-            pBootPartition = esp_ota_get_boot_partition(); //get boot partition (that will booted after reset), not the running partition
-            ERROR_CHECK(esp_ota_get_partition_description(pBootPartition, &bootPartitionDesc)); //get metadata of partition
-
-            if(bNewerVersion((bootPartitionDesc).version, pcRemoteVersionNumber)) //compare local and remote version
-                {
-                    // server image is newer --> OTA update required
-                    ESP_LOGI(LOG_TAG, "Server: image is newer --> OTA update required");
-
-                    ERROR_CHECK(errFindImageStart(u8OTABuffer, &u32BufferLenght, &u32StartOffset)); //get image start offset
-
-                    ERROR_CHECK(esp_ota_begin(pOTAPartition, OTA_SIZE_UNKNOWN, &otaHandle)); //start ota update process
-                    if(err == ESP_OK)
-                        {
-                            //image download and ota partition write
-                            ESP_LOGI(LOG_TAG, "start OTA download via HTTPS");
-                            do
-                                {
-                                    vPrintOTAProgress(&(pOTAPartition->size), &u32OTABytesWritten, Receiver);
-                                    ERROR_CHECK(esp_ota_write(otaHandle, (const void*) u8OTABuffer+u32StartOffset, (u32BytesRead-u32StartOffset)));
-
-                                    if(err == ESP_OK)
-                                        {
-                                            //write was succsesfull
-                                            u32StartOffset = 0U; //reset the offset for next download
-                                            ERROR_CHECK(errHTTPSClientRetrieveData(u8OTABuffer, &u32BufferLenght, &u32BytesRead)); //download next data segment
-                                            u32OTABytesWritten = u32OTABytesWritten + u32BytesRead; //update counter
-                                        }
-                                }
-                            while ((u32BytesRead > 0) && (err == ESP_OK) && (u32OTABytesWritten <= pOTAPartition->size)); //loop until error or complete image downloaded
-                        }
-
-                    if(err == ESP_OK)
-                        {
-                            //no error occurred --> finish ota update process
-                            ERROR_CHECK(esp_ota_end(otaHandle)); //finish process
-                            ERROR_CHECK(esp_ota_set_boot_partition(pOTAPartition)); //set new image as boot
-                            if(err == ESP_OK)
-                                {
-                                    *pbNewOTAImage = true; //image validated
-                                }
-                        }
-                    else
-                        {
-                            //error occurred --> abort ota update process
-                            ESP_LOGE(LOG_TAG, "abort ota process due to error 0x%x -> %s", err, esp_err_to_name(err));
-                            ERROR_CHECK(esp_ota_abort(otaHandle));
-                            *pbNewOTAImage = false; //ota update failed
-                        }
-                }
-            else
-                {
-                    ESP_LOGI(LOG_TAG, "server image is NOT newer --> OTA update NOT required");
-                }
-            xSemaphoreGive(bsOTAProcess); //free binary semaphore, this allows other tasks to start the OTA process
-        } //end version number extracted
-    return err;
-}
-
-esp_err_t errOTAMeshSlave(bool* pbNewOTAImage)
+esp_err_t errMeshOtaSlaveEndpoint(bool* const cpbNewOTAImage)
 {
     esp_err_t err = ESP_OK;
     MESH_PACKET_t sOTAMessage;
     const esp_partition_t* pBootPartition; //pointer to boot partition (that will booted after reset)
     esp_app_desc_t bootPartitionDesc; //Metadate from boot partition
-    *pbNewOTAImage = false; //set default false
+    *cpbNewOTAImage = false; //set default false
 
     //read OTAMessages queue
     if(uxQueueSpacesAvailable(queueMessageOTA) < QUEUE_MESSAGE_OTA_SIZE)
@@ -377,22 +229,22 @@ esp_err_t errOTAMeshSlave(bool* pbNewOTAImage)
                     ERROR_CHECK(esp_ota_get_partition_description(pBootPartition, &bootPartitionDesc)); //get metadata of partition
 
                     //send OTA_Version_Response to sender of OTA_Version_Request packet wirh version in payload
-                    ERROR_CHECK(errSendOTAVersionResponse(&sOTAMessage.meshSenderAddr));
+                    ERROR_CHECK(errMeshOtaUtilSendOTAVersionResponse(&sOTAMessage.meshSenderAddr));
 
-                    if((bNewerVersion((bootPartitionDesc).version, (char*) sOTAMessage.au8Payload)) && (err == ESP_OK)) //compare local and remote version
+                    if((bMeshOtaUtilNewerVersion((bootPartitionDesc).version, (char*) sOTAMessage.au8Payload)) && (err == ESP_OK)) //compare local and remote version
                         {
                             //remote newer as local
                             ESP_LOGI(LOG_TAG, "remote image on node is newer --> OTA update required");
-                            //  --> this version older --> start OTA_Rx --> set pbNewOTAImage true
-                            ERROR_CHECK(errOTAMeshReceive(pbNewOTAImage, &sOTAMessage.meshSenderAddr));
+                            //  --> this version older --> start OTA_Rx --> set cpbNewOTAImage true
+                            ERROR_CHECK(errMeshOtaPartitionAccessMeshReceive(cpbNewOTAImage, &sOTAMessage.meshSenderAddr));
                         }
 
-                    if((bNewerVersion((char*) sOTAMessage.au8Payload, (bootPartitionDesc).version)) && (err == ESP_OK)) //compare remote and local version
+                    if((bMeshOtaUtilNewerVersion((char*) sOTAMessage.au8Payload, (bootPartitionDesc).version)) && (err == ESP_OK)) //compare remote and local version
                         {
                             //local newer as remote
                             ESP_LOGI(LOG_TAG, "remote image on node is older --> OTA send required");
                             //  --> this version newer --> start OTA_Tx
-                            ERROR_CHECK(errOTAMeshTransmit(&sOTAMessage.meshSenderAddr));
+                            ERROR_CHECK(errMeshOtaPartitionAccessMeshTransmit(&sOTAMessage.meshSenderAddr));
                         }
                     xSemaphoreGive(bsOTAProcess); //free binary semaphore, this allows other tasks to start the OTA process
                 }
@@ -400,7 +252,7 @@ esp_err_t errOTAMeshSlave(bool* pbNewOTAImage)
     return err;
 }
 
-esp_err_t errOTAMeshMaster(bool* pbNewOTAImage, mesh_addr_t* pMeshNodeAddr)
+esp_err_t errMeshOtaMasterEndpoint(bool* const cpbNewOTAImage, const mesh_addr_t* const cpcMeshNodeAddr)
 {
     esp_err_t err = ESP_OK;
     MESH_PACKET_t sOTAMessage;
@@ -409,15 +261,15 @@ esp_err_t errOTAMeshMaster(bool* pbNewOTAImage, mesh_addr_t* pMeshNodeAddr)
     bool bNodeIsConnected = false;
     bool bNodeIsResponding = false;
 
-    *pbNewOTAImage = false; //set default false
+    *cpbNewOTAImage = false; //set default false
 
-    if(bIsNodeNeighbour(pMeshNodeAddr) == true) //check if node is still connected
+    if(bMeshNetworkIsNodeNeighbour(cpcMeshNodeAddr) == true) //check if node is still connected
         {
             bNodeIsConnected = true; //node is one of the neighbours
             xSemaphoreTake(bsOTAProcess, portMAX_DELAY); //wait for binary semaphore that allows to start the OTA process
 
-            ESP_LOGI(LOG_TAG, "Mesh-Master: send Version_Request to 0x%x", pMeshNodeAddr->addr[5]);
-            ERROR_CHECK(errSendOTAVersionRequest(pMeshNodeAddr)); //send OTA_VERSION_REQUEST with local version in payload
+            ESP_LOGI(LOG_TAG, "Mesh-Master: send Version_Request to 0x%x", cpcMeshNodeAddr->addr[5]);
+            ERROR_CHECK(errMeshOtaUtilSendOTAVersionRequest(cpcMeshNodeAddr)); //send OTA_VERSION_REQUEST with local version in payload
 
             for (uint32_t u32Index = 0; u32Index < QUEUE_MESSAGE_OTA_SIZE; u32Index++) //loop through all OTA messages
                 {
@@ -430,32 +282,32 @@ esp_err_t errOTAMeshMaster(bool* pbNewOTAImage, mesh_addr_t* pMeshNodeAddr)
                                     err = ESP_FAIL;
                                 }
 
-                            if((err == ESP_OK) && (sOTAMessage.type == OTA_Version_Response) && (bCheckMACEquality(sOTAMessage.meshSenderAddr.addr, pMeshNodeAddr->addr))) //if OTA_Version_Request
+                            if((err == ESP_OK) && (sOTAMessage.type == OTA_Version_Response) && (bMeshNetworkCheckMACEquality(sOTAMessage.meshSenderAddr.addr, cpcMeshNodeAddr->addr))) //if OTA_Version_Request
                                 {
                                     bNodeIsResponding = true;
                                     pBootPartition = esp_ota_get_boot_partition(); //get boot partition (that will booted after reset), not the running partition
                                     ERROR_CHECK(esp_ota_get_partition_description(pBootPartition, &bootPartitionDesc)); //get metadata of partition
 
-                                    if((bNewerVersion((bootPartitionDesc).version, (char*) sOTAMessage.au8Payload)) && (err == ESP_OK)) //compare local and remote version
+                                    if((bMeshOtaUtilNewerVersion((bootPartitionDesc).version, (char*) sOTAMessage.au8Payload)) && (err == ESP_OK)) //compare local and remote version
                                         {
                                             //remote newer as local
                                             ESP_LOGI(LOG_TAG, "Mesh: remote image on node is newer --> OTA update required");
-                                            //  --> this version older --> start OTA_Rx --> set pbNewOTAImage true
-                                            ERROR_CHECK(errOTAMeshReceive(pbNewOTAImage, &sOTAMessage.meshSenderAddr));
+                                            //  --> this version older --> start OTA_Rx --> set cpbNewOTAImage true
+                                            ERROR_CHECK(errMeshOtaPartitionAccessMeshReceive(cpbNewOTAImage, &sOTAMessage.meshSenderAddr));
                                         }
 
-                                    if((bNewerVersion((char*) sOTAMessage.au8Payload, (bootPartitionDesc).version)) && (err == ESP_OK)) //compare remote and local version
+                                    if((bMeshOtaUtilNewerVersion((char*) sOTAMessage.au8Payload, (bootPartitionDesc).version)) && (err == ESP_OK)) //compare remote and local version
                                         {
                                             //local newer as remote
                                             ESP_LOGI(LOG_TAG, "Mesh: remote image on node is older --> OTA send required");
                                             //  --> this version newer --> start OTA_Tx
-                                            ERROR_CHECK(errOTAMeshTransmit(&sOTAMessage.meshSenderAddr));
+                                            ERROR_CHECK(errMeshOtaPartitionAccessMeshTransmit(&sOTAMessage.meshSenderAddr));
                                         }
                                 }
                             else if (err == ESP_OK)
                                 {
                                     //received from wrong node or type --> back to queue
-                                    vAddOtaMessageToQueue(&sOTAMessage);
+                                    vMeshOtaUtilAddOtaMessageToQueue(&sOTAMessage);
                                 }
                         }
                     else
@@ -472,485 +324,7 @@ esp_err_t errOTAMeshMaster(bool* pbNewOTAImage, mesh_addr_t* pMeshNodeAddr)
         {
             //add node back to queue if connected and NOT responding
             ESP_LOGI(LOG_TAG, "OTA-Master: connected and NOT responding --> add node back to queue ");
-            vAddNodeToPossibleUpdatableQueue(pMeshNodeAddr->addr);
+            vMeshOtaUtilAddNodeToPossibleUpdatableQueue(cpcMeshNodeAddr->addr);
         }
     return err;
 }
-
-bool bNewerVersion(const char* pu8Local, const  char* pu8Remote)
-{
-    /*
-     * Return true if remote version is newer (higher) than local version
-    */
-    char u8LocalTmp[12]; //local version
-    char u8RemoteTmp[12]; //remote version
-    char* pu8saveptrLocal; //context for strok_r
-    char* pu8saveptrRemote; //context for strok_r
-    bool bReturn = false; //flag to stop loop
-    uint8_t u8Index = 0; //numbers counter in version string
-
-    strncpy(u8LocalTmp, pu8Local, 12); //copy in tmp
-    strncpy(u8RemoteTmp, pu8Remote, 12); //copy in tmp
-
-    char* pu8TokenLocal = strtok_r(u8LocalTmp, ".", &pu8saveptrLocal); //split tokens
-    char* pu8TokenRemote = strtok_r(u8RemoteTmp, ".", &pu8saveptrRemote); //split tokens
-
-    while( (u8Index <= 2) && (bReturn == false)) //loop through tokens
-        {
-            u8Index++;
-            if(atoi(pu8TokenLocal) < atoi(pu8TokenRemote))
-                {
-                    bReturn = true; //version number difference --> stop loop
-                }
-            pu8TokenLocal = strtok_r(NULL, ".", &pu8saveptrLocal); //split tokens
-            pu8TokenRemote = strtok_r(NULL, ".", &pu8saveptrRemote); //split tokens
-        }
-    return bReturn;
-}
-
-esp_err_t errFindImageStart(const char* pu8Data, uint32_t* pu32DataLenght, uint32_t* pu32StartOffset)
-{
-    /*
-    Offset  value
-    0      = 0xE9 (first byte in image --> magic byte)
-    48     = first digit of version number
-    */
-
-    esp_err_t errReturn = ESP_OK;
-    bool bImageStartOffsetFound = false;
-    uint32_t u32DataIndex = 0;
-    uint32_t u32FirstDotOffset = 0;
-    uint32_t u32SecondDotOffset = 0;
-    uint8_t u8FirstDotIndex = 0;
-    uint8_t u8SecondDotIndex = 0;
-
-    *pu32StartOffset = 0U; //reset offset to zero
-
-    while((u32DataIndex < *pu32DataLenght) &&  (bImageStartOffsetFound == false))
-        {
-            //search for magic byte
-            if(pu8Data[u32DataIndex] == 0xe9)
-                {
-                    //magic byte found
-                    while ((u8FirstDotIndex < 3) && (u32FirstDotOffset == 0))
-                        {
-                            //search first dot in version number
-                            if((u32DataIndex+49+u8FirstDotIndex) < *pu32DataLenght)
-                                {
-                                    if((pu8Data[(u32DataIndex+49+u8FirstDotIndex)] == 0x2e))
-                                        {
-                                            //first dot found
-                                            u32FirstDotOffset = (u32DataIndex+49+u8FirstDotIndex);
-                                        }
-                                }
-                            u8FirstDotIndex++;
-                        }
-
-                    while ((u8SecondDotIndex < 3) && (u32SecondDotOffset == 0) && (u32FirstDotOffset != 0))
-                        {
-                            //search first dot in version number
-                            if((u32FirstDotOffset+(u8SecondDotIndex+2)) < *pu32DataLenght)
-                                {
-                                    if((pu8Data[(u32FirstDotOffset+(u8SecondDotIndex+2))] == 0x2e))
-                                        {
-                                            //second dot found
-                                            u32SecondDotOffset = (u32FirstDotOffset+(u8SecondDotIndex+2));
-                                        }
-                                }
-                            u8SecondDotIndex++;
-                        }
-
-                    if((u32FirstDotOffset != 0) && (u32SecondDotOffset != 0))
-                        {
-                            //image start found based on magic byte and version number systax
-                            *pu32StartOffset = u32DataIndex; //store image start offset
-                            bImageStartOffsetFound = true;
-                        }
-                    else
-                        {
-                            // this is propably not the magic byte --> reset
-                            u32FirstDotOffset = 0;
-                            u32SecondDotOffset = 0;
-                            u8FirstDotIndex = 0;
-                            u8SecondDotIndex = 0;
-                        }
-                }
-            u32DataIndex++;
-        }
-
-    if(bImageStartOffsetFound == false)
-        {
-            errReturn = ESP_ERR_NOT_FOUND;
-        }
-
-    return errReturn;
-}
-
-esp_err_t errExtractVersionNumber(const char* pu8Data, uint32_t* pu32DataLenght, char* pc8RemoteVersionNumber)
-{
-    uint32_t u32StartOffset;
-    esp_err_t err = ESP_OK;
-
-    strcpy(pc8RemoteVersionNumber, "999.999.999"); //init value
-    err = errFindImageStart(pu8Data, pu32DataLenght, &u32StartOffset); //get image start offset
-
-    if(err == ESP_OK)
-        {
-            //image found
-            strncpy(pc8RemoteVersionNumber, pu8Data+(u32StartOffset+48), 11); //copy version number
-            pc8RemoteVersionNumber[12] = '\0';
-        }
-    return err;
-}
-
-void vPrintOTAProgress(const uint32_t* const pu32TotalImageSize, const uint32_t* const pu32BytesWritten, OTA_MESH_ROLE_t eRole)
-{
-    uint32_t u32Percentage = 0U;
-    static uint32_t u32LastPercentage = 0U;
-
-    if((*pu32BytesWritten) >= (*pu32TotalImageSize))
-        {
-            u32Percentage = 100;
-        }
-    else
-        {
-            u32Percentage = (uint32_t) (((float) (*pu32BytesWritten)/(float) (*pu32TotalImageSize)) * 100.0);
-        }
-
-    if((u32Percentage-u32LastPercentage) >= OTA_PROGRESS_LOG_INTERVAL)
-        {
-            if(eRole == Transmitter)
-                {
-                    ESP_LOGI(LOG_TAG, "Transmitting OTA update: %i %%", u32Percentage);
-                }
-
-            if(eRole == Receiver)
-                {
-                    ESP_LOGI(LOG_TAG, "Receiving OTA update: %i %%", u32Percentage);
-                }
-
-
-
-            u32LastPercentage = u32Percentage;
-        }
-}
-
-void vAddAllNeighboursToQueue(void)
-{
-    esp_err_t err = ESP_OK;
-
-    mesh_addr_t addrParent;  //addr of parent node
-    mesh_addr_t childrenAddr[CONFIG_MESH_ROUTE_TABLE_SIZE]; //array of children attached to this node
-    uint16_t u16ChildrenSize = 0U; //number of children attached to this node
-
-    err = errGetParentNode(&addrParent);
-
-    if(err == ESP_OK)
-        {
-            vAddNodeToPossibleUpdatableQueue(addrParent.addr);
-            ESP_LOGI(LOG_TAG, "added parent");
-        }
-
-    err = ESP_OK; //reset error code
-
-    ERROR_CHECK(errGetChildren(childrenAddr, &u16ChildrenSize)); //get all children
-
-    for (uint16_t u16Index = 0; ((u16Index < u16ChildrenSize) && (err == ESP_OK)); u16Index++)
-        {
-            vAddNodeToPossibleUpdatableQueue(childrenAddr[u16Index].addr);
-            ESP_LOGI(LOG_TAG, "added child");
-        }
-}
-
-esp_err_t errSendOTAVersionResponse(mesh_addr_t* pMeshReceiverAddr)
-{
-    esp_err_t err = ESP_OK;
-    MESH_PACKET_t packet;
-    packet.type = OTA_Version_Response;
-
-    const esp_partition_t* pBootPartition; //pointer to boot partition (that will booted after reset)
-    esp_app_desc_t bootPartitionDesc; //Metadata from boot partition
-
-    pBootPartition = esp_ota_get_boot_partition(); //get boot partition (that will booted after reset), not the running partition
-    ERROR_CHECK(esp_ota_get_partition_description(pBootPartition, &bootPartitionDesc)); //get metadate of partition
-    memcpy(&packet.au8Payload, &bootPartitionDesc.version, 12); //copy local version to OTA_Version_Response packet
-
-    ESP_LOGI(LOG_TAG, "Send OTA_Version_Response to 0x%x", pMeshReceiverAddr->addr[5]);
-
-    err = errSendMeshPacket(pMeshReceiverAddr, &packet);
-    return err;
-}
-
-void vClearOtaMessageQueue(mesh_addr_t* pMeshNodeAddr)
-{
-    MESH_PACKET_t sMeshPacket; //packet for sending and receiving
-    for (uint32_t u32Index = 0; (u32Index < QUEUE_MESSAGE_OTA_SIZE); u32Index++) //loop through all OTA messages
-        {
-            if (xQueueReceive(queueMessageOTA, &sMeshPacket, 0) == pdTRUE)
-                {
-                    if(!(bCheckMACEquality(sMeshPacket.meshSenderAddr.addr, pMeshNodeAddr->addr)))
-                        {
-                            //received OTA message is NOT from pMeshNodeAddr --> keep it in queue
-                            vAddOtaMessageToQueue(&sMeshPacket);
-                        }
-                    else
-                        {
-                            ESP_LOGI(LOG_TAG, "Removed type %i from node 0x%x", sMeshPacket.type, pMeshNodeAddr->addr[5]);
-                        }
-                }
-        }//end OTA message loop
-}
-
-esp_err_t errSendOTAVersionRequest(mesh_addr_t* pMeshReceiverAddr)
-{
-    esp_err_t err = ESP_OK;
-    MESH_PACKET_t packet;
-    packet.type = OTA_Version_Request;
-
-    const esp_partition_t* pBootPartition; //pointer to boot partition (that will booted after reset)
-    esp_app_desc_t bootPartitionDesc; //Metadata from boot partition
-
-    pBootPartition = esp_ota_get_boot_partition(); //get boot partition (that will booted after reset), not the running partition
-    ERROR_CHECK(esp_ota_get_partition_description(pBootPartition, &bootPartitionDesc)); //get metadate of partition
-    memcpy(&packet.au8Payload, &bootPartitionDesc.version, 12); //copy local version to OTA_Version_Request packet
-    err = errSendMeshPacket(pMeshReceiverAddr, &packet);
-    return err;
-}
-
-esp_err_t errOTAMeshTransmit(mesh_addr_t* pMeshNodeAddr)
-{
-    esp_err_t err = ESP_OK;
-    const esp_partition_t* pBootPartition; //pointer to boot partition (that will booted after reset)
-    MESH_PACKET_t sMeshPacket; //packet for sending and receiving
-    // uint32_t u32Index = 0U; //index for partition read offset
-    bool bAbort = false; //abort the OTA process
-    bool bNodeIsResponding = false; //remote node is still active
-    uint32_t u32OTABytesWritten = 0U;
-    uint32_t u32SegmentCounter = 0U;
-
-    pBootPartition = esp_ota_get_boot_partition(); //get boot partition (that will booted after reset), not the running partition
-
-    //loop through partition to read in segmensts until end or error or abort called
-    while( ((OTA_MESH_SEGMENT_SIZE * u32SegmentCounter) < pBootPartition->size) && (err == ESP_OK) && (bAbort == false))
-        {
-            bNodeIsResponding = false; //reset to default
-
-            // read partition with offset based in index
-            ERROR_CHECK(esp_partition_read(pBootPartition, (OTA_MESH_SEGMENT_SIZE * u32SegmentCounter), sMeshPacket.au8Payload, OTA_MESH_SEGMENT_SIZE));
-            u32OTABytesWritten = ((u32SegmentCounter+1) * OTA_MESH_SEGMENT_SIZE);
-            vPrintOTAProgress(&(pBootPartition->size), &u32OTABytesWritten, Transmitter);
-
-            if(err == ESP_OK)
-                {
-                    //no error while read --> send OTA_DATA packet
-                    sMeshPacket.type = OTA_Data;
-
-                    if((OTA_MESH_SEGMENT_SIZE * (u32SegmentCounter+1)) >= pBootPartition->size) //check if last segment
-                        {
-                            //last partition image segment --> send OTA_Complete
-                            ESP_LOGI(LOG_TAG, "OTA-TX: last segment--> send Complete");
-                            sMeshPacket.type = OTA_Complete;
-                        }
-                    //ESP_LOGI(LOG_TAG, "OTA-TX: send packet");
-                    err = errSendMeshPacket(pMeshNodeAddr, &sMeshPacket);
-                }
-            else
-                {
-                    // error while read --> send OTA_ABORT and abort this OTA process
-                    sMeshPacket.type = OTA_Abort;
-                    bAbort = true;
-                    ESP_LOGI(LOG_TAG, "OTA-TX: error while read --> send ABORT");
-                    errSendMeshPacket(pMeshNodeAddr, &sMeshPacket);
-                }
-
-            // loop through all OTA messages or until abort is called or error
-            for (uint32_t u32Index = 0; ((u32Index < QUEUE_MESSAGE_OTA_SIZE) && (bAbort == false) && (err == ESP_OK)); u32Index++) //loop through all OTA messages
-                {
-                    // if(uxQueueSpacesAvailable(queueMessageOTA) < QUEUE_MESSAGE_OTA_SIZE)
-                    //   {
-                    //queue not empty
-                    if (xQueueReceive(queueMessageOTA, &sMeshPacket, ((OTA_MESH_TIMEOUT) / portTICK_PERIOD_MS)) != pdTRUE)
-                        {
-                            ESP_LOGE(LOG_TAG, "Unable to receive OTA Messages from queue");
-                            err = ESP_FAIL;
-                        }
-
-                    if((err == ESP_OK) && (bCheckMACEquality(sMeshPacket.meshSenderAddr.addr, pMeshNodeAddr->addr))) //if OTA_Version_Request
-                        {
-                            //packet from node received
-                            switch (sMeshPacket.type)
-                                {
-                                case OTA_ACK: //increase index for next round
-                                    u32Index++;
-                                    bNodeIsResponding = true;
-                                    u32Index = QUEUE_MESSAGE_OTA_SIZE;//this will end the loop through all OTA messages
-                                    break;
-                                case OTA_Abort: //abort this OTA process
-                                    bAbort = true;
-                                    bNodeIsResponding = true;
-                                    break;
-                                default:
-                                    //receives wrong OTA message type from node --> back to queue
-                                    //vAddOtaMessageToQueue(&sMeshPacket);
-                                    break;
-                                }
-                        }
-                    else if (err == ESP_OK)
-                        {
-                            //received from wrong node --> back to queue
-                            vAddOtaMessageToQueue(&sMeshPacket);
-                        }
-                    /*
-                    }
-                    else
-                    {
-                        // OTA Message queue is empty --> wait some time
-                        ESP_LOGI(LOG_TAG, "OTA-TX: ota message queue empty --> wait");
-                        vTaskDelay( (OTA_MESH_TIMEOUT) / portTICK_PERIOD_MS);
-                    }
-                    */
-
-                }//end OTA message loop
-
-            if(bNodeIsResponding == false)
-                {
-                    //no abort was called but node didn’t responded
-                    ESP_LOGE(LOG_TAG, "OTA-TX: no abort was called but node didn’t responded --> error");
-                    bAbort = true;
-                    err = ESP_FAIL; //this OTA process failed with error
-                }
-            u32SegmentCounter++;
-        }//end of partition segment loop
-        vClearOtaMessageQueue(pMeshNodeAddr);
-    return err;
-}
-
-esp_err_t errOTAMeshReceive(bool* pbNewOTAImage, mesh_addr_t* pMeshNodeAddr)
-{
-    esp_err_t err = ESP_OK;
-    MESH_PACKET_t sMeshPacket; //packet for sending and receiving
-    bool bComplete = false; //complete the OTA process
-    bool bAbort = false; //abort the OTA process
-    bool bNodeIsResponding = false; //remote node is still active
-    uint32_t u32OTABytesWritten = 0U; //counter unsed for progress log
-    static esp_ota_handle_t otaHandle; //OTA process handle
-    *pbNewOTAImage = false;
-    uint32_t u32SegmentCounter = 0U;
-
-    ERROR_CHECK(esp_ota_begin(pOTAPartition, OTA_SIZE_UNKNOWN, &otaHandle)); //start ota update process
-
-    //partition segement loop through partition to read in segmensts until end or error or abort called
-    while((bComplete == false) && (err == ESP_OK) && (bAbort == false) && (u32OTABytesWritten <= pOTAPartition->size))
-        {
-            bNodeIsResponding = false; //reset to default
-
-            // loop through all OTA messages or until abort is called
-            for (uint32_t u32Index = 0; ((u32Index < QUEUE_MESSAGE_OTA_SIZE) && (bAbort == false)); u32Index++) //loop through all OTA messages
-                {
-                    //if(uxQueueSpacesAvailable(queueMessageOTA) < QUEUE_MESSAGE_OTA_SIZE)
-                    //   {
-                    //queue not empty
-                    if (xQueueReceive(queueMessageOTA, &sMeshPacket, ((OTA_MESH_TIMEOUT) / portTICK_PERIOD_MS)) != pdTRUE)
-                        {
-                            ESP_LOGE(LOG_TAG, "Unable to receive OTA Messages from queue");
-                            err = ESP_FAIL;
-                        }
-
-                    if((err == ESP_OK) && (bCheckMACEquality(sMeshPacket.meshSenderAddr.addr, pMeshNodeAddr->addr))) //if OTA_Version_Request
-                        {
-                            //packet from node received
-                            switch (sMeshPacket.type)
-                                {
-                                case OTA_Complete: //signal end of this OTA process, fall through because same behavior as OTA_Data
-                                    bComplete = true;
-                                    ESP_LOGI(LOG_TAG, "OTA-RX: rec Complete --> last segment");
-                                //fall through
-                                case OTA_Data: //data segement received
-                                    bNodeIsResponding = true;
-                                    ERROR_CHECK(esp_ota_write(otaHandle, sMeshPacket.au8Payload, OTA_MESH_SEGMENT_SIZE));
-                                    u32OTABytesWritten = ((u32SegmentCounter+1) * OTA_MESH_SEGMENT_SIZE);
-                                    vPrintOTAProgress(&(pOTAPartition->size), &u32OTABytesWritten, Receiver);
-                                    u32Index = QUEUE_MESSAGE_OTA_SIZE; //this will end the loop through all OTA messages
-                                    break;
-                                case OTA_Abort: //abort this OTA process
-                                    bAbort = true;
-                                    bNodeIsResponding = true;
-                                    ESP_LOGI(LOG_TAG, "OTA-RX: rec Abort");
-                                    //this will end the loop through all OTA messages
-                                    break;
-                                default:
-                                    //receives wrong OTA message type from node --> back to queue
-                                    //vAddOtaMessageToQueue(&sMeshPacket);
-                                    break;
-                                }
-                        }
-                    else if (err == ESP_OK)
-                        {
-                            //received from wrong node --> back to queue
-                            vAddOtaMessageToQueue(&sMeshPacket);
-                        }
-
-                    /*  }
-                    else
-                      {
-                          ESP_LOGI(LOG_TAG, "OTA-RX: ota message queue empty --> wait");
-                          // OTA Message queue is empty --> wait some time
-                          vTaskDelay( (OTA_MESH_TIMEOUT) / portTICK_PERIOD_MS);
-                      }
-                      */
-
-                }//end of OTA message loop
-
-            if(bNodeIsResponding == false)
-                {
-                    //no abort was called but node didn’t responded --> error
-                    ESP_LOGI(LOG_TAG, "OTA-RX: no abort was called but node didn’t responded --> error");
-                    bAbort = true; //this will stop the partition segement loop
-                    err = ESP_FAIL; //this OTA process failed with error
-                }
-            else
-                {
-                    //node has responded with OTA_DATA or OTA_Complete or OTA_ABORT
-                    if(err == ESP_OK)
-                        {
-
-                            if(bAbort == false)
-                                {
-                                    //no error while ota write --> send OTA_ACK packet
-                                    //ESP_LOGI(LOG_TAG, "OTA-RX: no error while ota write --> send OTA_ACK packet");
-                                    sMeshPacket.type = OTA_ACK;
-                                    err = errSendMeshPacket(pMeshNodeAddr, &sMeshPacket);
-                                }
-                        }
-                    else
-                        {
-                            // error while read --> send OTA_ABORT and abort this OTA process
-                            sMeshPacket.type = OTA_Abort;
-                            bAbort = true;
-                            ESP_LOGI(LOG_TAG, "OTA-RX: abort --> send ABORT");
-                            errSendMeshPacket(pMeshNodeAddr, &sMeshPacket);
-                        }
-                }
-            u32SegmentCounter++;
-        }//end of partition segement loop
-
-    if(bComplete == true)
-        {
-            //all OTA segments received --> validate
-            ESP_LOGI(LOG_TAG, "OTA-RX: validate image ");
-            ERROR_CHECK(esp_ota_end(otaHandle));
-            ERROR_CHECK(esp_ota_set_boot_partition(pOTAPartition));
-            if(err == ESP_OK)
-                {
-                    //successfully updated OTA partition
-                    *pbNewOTAImage = true;
-                }
-        }
-    else
-        {
-            //not all OTA segments received --> abort this OTA process
-            ERROR_CHECK(esp_ota_abort(otaHandle));
-        }
-        vClearOtaMessageQueue(pMeshNodeAddr);
-    return err;
-}

components/mesh_ota/Mesh_OTA_Globals.c

@@ -0,0 +1,15 @@
+#include "Mesh_OTA_Globals.h"
+
+xQueueHandle queueNodes; //nodes that should be checked for ota update (contains children and parent)
+xQueueHandle queueMessageOTA; //mesh ota controll messages like "OTA_Version_Response" "OTA_ACK"
+
+SemaphoreHandle_t bsStartStopServerWorker; //binary semaphore
+SemaphoreHandle_t bsOTAProcess; //binary semaphore
+
+//w: errMeshOTAInitialize;
+//r: errMeshOTAInitialize; errMeshOtaPartitionAccessHttps; errMeshOtaPartitionAccessMeshReceive;
+const esp_partition_t* pOTAPartition; //pointer to ota partition
+
+//w: errMeshOTAInitialize; vMeshOtaTaskOTAWorker; vMeshOtaTaskServerWorker
+//r: errMeshOTAInitialize; vMeshOtaTaskOTAWorker; vMeshOtaTaskServerWorker
+bool bWantReboot; //flag to signal pending reboot

components/mesh_ota/Mesh_OTA_Partition_Access.c

@@ -0,0 +1,324 @@
+#include "Mesh_OTA.h"
+#include "Mesh_OTA_Util.h"
+#include "Mesh_OTA_Globals.h"
+#include "Mesh_OTA_Partition_Access.h"
+
+static const char *LOG_TAG = "mesh_ota_partition_access";
+
+esp_err_t errMeshOtaPartitionAccessHttps(bool* const cpbNewOTAImage)
+{
+    esp_err_t err = ESP_OK;
+    char u8OTABuffer[OTA_HTTPS_SEGMENT_SIZE]; //store image segment from server before ota write
+    uint32_t u32BufferLenght = OTA_HTTPS_SEGMENT_SIZE; //size of buffer
+    uint32_t u32BytesRead = 0; //number of bytes that are read from server, <= u32BufferLenght
+    char pcRemoteVersionNumber[12]; //string for version number in server image
+    const esp_partition_t* pBootPartition; //pointer to boot partition (that will booted after reset)
+    static esp_ota_handle_t otaHandle; //OTA process handle
+    uint32_t u32StartOffset = 0U; //start offset for image (exclude the http response data)
+    esp_app_desc_t bootPartitionDesc; //Metadate from boot partition
+    uint32_t u32OTABytesWritten = 0U; //counter unsed for progress log
+
+    ERROR_CHECK(errHTTPSClientRetrieveData(u8OTABuffer, &u32BufferLenght, &u32BytesRead)); //read first bytes if image, including the version
+
+    ERROR_CHECK(errMeshOtaUtilExtractVersionNumber(u8OTABuffer, &u32BytesRead, pcRemoteVersionNumber)); //extract version numbers
+
+    if(err == ESP_OK) //check if version number is found
+        {
+            xSemaphoreTake(bsOTAProcess, portMAX_DELAY); //wait for binary semaphore that allows to start the OTA process
+
+            pBootPartition = esp_ota_get_boot_partition(); //get boot partition (that will booted after reset), not the running partition
+            ERROR_CHECK(esp_ota_get_partition_description(pBootPartition, &bootPartitionDesc)); //get metadata of partition
+
+            if(bMeshOtaUtilNewerVersion((bootPartitionDesc).version, pcRemoteVersionNumber)) //compare local and remote version
+                {
+                    // server image is newer --> OTA update required
+                    ESP_LOGI(LOG_TAG, "Server: image is newer --> OTA update required");
+
+                    ERROR_CHECK(errMeshOtaUtilFindImageStart(u8OTABuffer, &u32BufferLenght, &u32StartOffset)); //get image start offset
+
+                    ERROR_CHECK(esp_ota_begin(pOTAPartition, OTA_SIZE_UNKNOWN, &otaHandle)); //start ota update process
+                    if(err == ESP_OK)
+                        {
+                            //image download and ota partition write
+                            ESP_LOGI(LOG_TAG, "start OTA download via HTTPS");
+                            do
+                                {
+                                    vMeshOtaUtilPrintOTAProgress(&(pOTAPartition->size), &u32OTABytesWritten, Receiver);
+                                    ERROR_CHECK(esp_ota_write(otaHandle, (const void*) u8OTABuffer+u32StartOffset, (u32BytesRead-u32StartOffset)));
+
+                                    if(err == ESP_OK)
+                                        {
+                                            //write was succsesfull
+                                            u32StartOffset = 0U; //reset the offset for next download
+                                            ERROR_CHECK(errHTTPSClientRetrieveData(u8OTABuffer, &u32BufferLenght, &u32BytesRead)); //download next data segment
+                                            u32OTABytesWritten = u32OTABytesWritten + u32BytesRead; //update counter
+                                        }
+                                }
+                            while ((u32BytesRead > 0) && (err == ESP_OK) && (u32OTABytesWritten <= pOTAPartition->size)); //loop until error or complete image downloaded
+                        }
+
+                    if(err == ESP_OK)
+                        {
+                            //no error occurred --> finish ota update process
+                            ERROR_CHECK(esp_ota_end(otaHandle)); //finish process
+                            ERROR_CHECK(esp_ota_set_boot_partition(pOTAPartition)); //set new image as boot
+                            if(err == ESP_OK)
+                                {
+                                    *cpbNewOTAImage = true; //image validated
+                                }
+                        }
+                    else
+                        {
+                            //error occurred --> abort ota update process
+                            ESP_LOGE(LOG_TAG, "abort ota process due to error 0x%x -> %s", err, esp_err_to_name(err));
+                            ERROR_CHECK(esp_ota_abort(otaHandle));
+                            *cpbNewOTAImage = false; //ota update failed
+                        }
+                }
+            else
+                {
+                    ESP_LOGI(LOG_TAG, "server image is NOT newer --> OTA update NOT required");
+                }
+            xSemaphoreGive(bsOTAProcess); //free binary semaphore, this allows other tasks to start the OTA process
+        } //end version number extracted
+    return err;
+}
+
+esp_err_t errMeshOtaPartitionAccessMeshTransmit(const mesh_addr_t* const cpcMeshNodeAddr)
+{
+    esp_err_t err = ESP_OK;
+    const esp_partition_t* pBootPartition; //pointer to boot partition (that will booted after reset)
+    MESH_PACKET_t sMeshPacket; //packet for sending and receiving
+    // uint32_t u32Index = 0U; //index for partition read offset
+    bool bAbort = false; //abort the OTA process
+    bool bNodeIsResponding = false; //remote node is still active
+    uint32_t u32OTABytesWritten = 0U;
+    uint32_t u32SegmentCounter = 0U;
+
+    pBootPartition = esp_ota_get_boot_partition(); //get boot partition (that will booted after reset), not the running partition
+
+    //loop through partition to read in segmensts until end or error or abort called
+    while( ((OTA_MESH_SEGMENT_SIZE * u32SegmentCounter) < pBootPartition->size) && (err == ESP_OK) && (bAbort == false))
+        {
+            bNodeIsResponding = false; //reset to default
+
+            // read partition with offset based in index
+            ERROR_CHECK(esp_partition_read(pBootPartition, (OTA_MESH_SEGMENT_SIZE * u32SegmentCounter), sMeshPacket.au8Payload, OTA_MESH_SEGMENT_SIZE));
+            u32OTABytesWritten = ((u32SegmentCounter+1) * OTA_MESH_SEGMENT_SIZE);
+            vMeshOtaUtilPrintOTAProgress(&(pBootPartition->size), &u32OTABytesWritten, Transmitter);
+
+            if(err == ESP_OK)
+                {
+                    //no error while read --> send OTA_DATA packet
+                    sMeshPacket.type = OTA_Data;
+
+                    if((OTA_MESH_SEGMENT_SIZE * (u32SegmentCounter+1)) >= pBootPartition->size) //check if last segment
+                        {
+                            //last partition image segment --> send OTA_Complete
+                            ESP_LOGI(LOG_TAG, "OTA-TX: last segment--> send Complete");
+                            sMeshPacket.type = OTA_Complete;
+                        }
+                    //ESP_LOGI(LOG_TAG, "OTA-TX: send packet");
+                    err = errMeshNetworkSendMeshPacket(cpcMeshNodeAddr, &sMeshPacket);
+                }
+            else
+                {
+                    // error while read --> send OTA_ABORT and abort this OTA process
+                    sMeshPacket.type = OTA_Abort;
+                    bAbort = true;
+                    ESP_LOGI(LOG_TAG, "OTA-TX: error while read --> send ABORT");
+                    errMeshNetworkSendMeshPacket(cpcMeshNodeAddr, &sMeshPacket);
+                }
+
+            // loop through all OTA messages or until abort is called or error
+            for (uint32_t u32Index = 0; ((u32Index < QUEUE_MESSAGE_OTA_SIZE) && (bAbort == false) && (err == ESP_OK)); u32Index++) //loop through all OTA messages
+                {
+                    // if(uxQueueSpacesAvailable(queueMessageOTA) < QUEUE_MESSAGE_OTA_SIZE)
+                    //   {
+                    //queue not empty
+                    if (xQueueReceive(queueMessageOTA, &sMeshPacket, ((OTA_MESH_TIMEOUT) / portTICK_PERIOD_MS)) != pdTRUE)
+                        {
+                            ESP_LOGE(LOG_TAG, "Unable to receive OTA Messages from queue");
+                            err = ESP_FAIL;
+                        }
+
+                    if((err == ESP_OK) && (bMeshNetworkCheckMACEquality(sMeshPacket.meshSenderAddr.addr, cpcMeshNodeAddr->addr))) //if OTA_Version_Request
+                        {
+                            //packet from node received
+                            switch (sMeshPacket.type)
+                                {
+                                case OTA_ACK: //increase index for next round
+                                    u32Index++;
+                                    bNodeIsResponding = true;
+                                    u32Index = QUEUE_MESSAGE_OTA_SIZE;//this will end the loop through all OTA messages
+                                    break;
+                                case OTA_Abort: //abort this OTA process
+                                    bAbort = true;
+                                    bNodeIsResponding = true;
+                                    break;
+                                default:
+                                    //receives wrong OTA message type from node --> back to queue
+                                    //vMeshOtaUtilAddOtaMessageToQueue(&sMeshPacket);
+                                    break;
+                                }
+                        }
+                    else if (err == ESP_OK)
+                        {
+                            //received from wrong node --> back to queue
+                            vMeshOtaUtilAddOtaMessageToQueue(&sMeshPacket);
+                        }
+                    /*
+                    }
+                    else
+                    {
+                        // OTA Message queue is empty --> wait some time
+                        ESP_LOGI(LOG_TAG, "OTA-TX: ota message queue empty --> wait");
+                        vTaskDelay( (OTA_MESH_TIMEOUT) / portTICK_PERIOD_MS);
+                    }
+                    */
+
+                }//end OTA message loop
+
+            if(bNodeIsResponding == false)
+                {
+                    //no abort was called but node didn’t responded
+                    ESP_LOGE(LOG_TAG, "OTA-TX: no abort was called but node didn’t responded --> error");
+                    bAbort = true;
+                    err = ESP_FAIL; //this OTA process failed with error
+                }
+            u32SegmentCounter++;
+        }//end of partition segment loop
+    vMeshOtaUtilClearOtaMessageQueue(cpcMeshNodeAddr);
+    return err;
+}
+
+esp_err_t errMeshOtaPartitionAccessMeshReceive(bool* const cpbNewOTAImage, const mesh_addr_t* const cpcMeshNodeAddr)
+{
+    esp_err_t err = ESP_OK;
+    MESH_PACKET_t sMeshPacket; //packet for sending and receiving
+    bool bComplete = false; //complete the OTA process
+    bool bAbort = false; //abort the OTA process
+    bool bNodeIsResponding = false; //remote node is still active
+    uint32_t u32OTABytesWritten = 0U; //counter unsed for progress log
+    static esp_ota_handle_t otaHandle; //OTA process handle
+    *cpbNewOTAImage = false;
+    uint32_t u32SegmentCounter = 0U;
+
+    ERROR_CHECK(esp_ota_begin(pOTAPartition, OTA_SIZE_UNKNOWN, &otaHandle)); //start ota update process
+
+    //partition segement loop through partition to read in segmensts until end or error or abort called
+    while((bComplete == false) && (err == ESP_OK) && (bAbort == false) && (u32OTABytesWritten <= pOTAPartition->size))
+        {
+            bNodeIsResponding = false; //reset to default
+
+            // loop through all OTA messages or until abort is called
+            for (uint32_t u32Index = 0; ((u32Index < QUEUE_MESSAGE_OTA_SIZE) && (bAbort == false)); u32Index++) //loop through all OTA messages
+                {
+                    //if(uxQueueSpacesAvailable(queueMessageOTA) < QUEUE_MESSAGE_OTA_SIZE)
+                    //   {
+                    //queue not empty
+                    if (xQueueReceive(queueMessageOTA, &sMeshPacket, ((OTA_MESH_TIMEOUT) / portTICK_PERIOD_MS)) != pdTRUE)
+                        {
+                            ESP_LOGE(LOG_TAG, "Unable to receive OTA Messages from queue");
+                            err = ESP_FAIL;
+                        }
+
+                    if((err == ESP_OK) && (bMeshNetworkCheckMACEquality(sMeshPacket.meshSenderAddr.addr, cpcMeshNodeAddr->addr))) //if OTA_Version_Request
+                        {
+                            //packet from node received
+                            switch (sMeshPacket.type)
+                                {
+                                case OTA_Complete: //signal end of this OTA process, fall through because same behavior as OTA_Data
+                                    bComplete = true;
+                                    ESP_LOGI(LOG_TAG, "OTA-RX: rec Complete --> last segment");
+                                //fall through
+                                case OTA_Data: //data segement received
+                                    bNodeIsResponding = true;
+                                    ERROR_CHECK(esp_ota_write(otaHandle, sMeshPacket.au8Payload, OTA_MESH_SEGMENT_SIZE));
+                                    u32OTABytesWritten = ((u32SegmentCounter+1) * OTA_MESH_SEGMENT_SIZE);
+                                    vMeshOtaUtilPrintOTAProgress(&(pOTAPartition->size), &u32OTABytesWritten, Receiver);
+                                    u32Index = QUEUE_MESSAGE_OTA_SIZE; //this will end the loop through all OTA messages
+                                    break;
+                                case OTA_Abort: //abort this OTA process
+                                    bAbort = true;
+                                    bNodeIsResponding = true;
+                                    ESP_LOGI(LOG_TAG, "OTA-RX: rec Abort");
+                                    //this will end the loop through all OTA messages
+                                    break;
+                                default:
+                                    //receives wrong OTA message type from node --> back to queue
+                                    //vMeshOtaUtilAddOtaMessageToQueue(&sMeshPacket);
+                                    break;
+                                }
+                        }
+                    else if (err == ESP_OK)
+                        {
+                            //received from wrong node --> back to queue
+                            vMeshOtaUtilAddOtaMessageToQueue(&sMeshPacket);
+                        }
+
+                    /*  }
+                    else
+                      {
+                          ESP_LOGI(LOG_TAG, "OTA-RX: ota message queue empty --> wait");
+                          // OTA Message queue is empty --> wait some time
+                          vTaskDelay( (OTA_MESH_TIMEOUT) / portTICK_PERIOD_MS);
+                      }
+                      */
+
+                }//end of OTA message loop
+
+            if(bNodeIsResponding == false)
+                {
+                    //no abort was called but node didn’t responded --> error
+                    ESP_LOGI(LOG_TAG, "OTA-RX: no abort was called but node didn’t responded --> error");
+                    bAbort = true; //this will stop the partition segement loop
+                    err = ESP_FAIL; //this OTA process failed with error
+                }
+            else
+                {
+                    //node has responded with OTA_DATA or OTA_Complete or OTA_ABORT
+                    if(err == ESP_OK)
+                        {
+
+                            if(bAbort == false)
+                                {
+                                    //no error while ota write --> send OTA_ACK packet
+                                    //ESP_LOGI(LOG_TAG, "OTA-RX: no error while ota write --> send OTA_ACK packet");
+                                    sMeshPacket.type = OTA_ACK;
+                                    err = errMeshNetworkSendMeshPacket(cpcMeshNodeAddr, &sMeshPacket);
+                                }
+                        }
+                    else
+                        {
+                            // error while read --> send OTA_ABORT and abort this OTA process
+                            sMeshPacket.type = OTA_Abort;
+                            bAbort = true;
+                            ESP_LOGI(LOG_TAG, "OTA-RX: abort --> send ABORT");
+                            errMeshNetworkSendMeshPacket(cpcMeshNodeAddr, &sMeshPacket);
+                        }
+                }
+            u32SegmentCounter++;
+        }//end of partition segement loop
+
+    if(bComplete == true)
+        {
+            //all OTA segments received --> validate
+            ESP_LOGI(LOG_TAG, "OTA-RX: validate image ");
+            ERROR_CHECK(esp_ota_end(otaHandle));
+            ERROR_CHECK(esp_ota_set_boot_partition(pOTAPartition));
+            if(err == ESP_OK)
+                {
+                    //successfully updated OTA partition
+                    *cpbNewOTAImage = true;
+                }
+        }
+    else
+        {
+            //not all OTA segments received --> abort this OTA process
+            ERROR_CHECK(esp_ota_abort(otaHandle));
+        }
+    vMeshOtaUtilClearOtaMessageQueue(cpcMeshNodeAddr);
+    return err;
+}
+

components/mesh_ota/Mesh_OTA_Util.c

@@ -0,0 +1,334 @@
+#include "Mesh_OTA_Util.h"
+#include "Mesh_OTA_Globals.h"
+
+static const char *LOG_TAG = "mesh_ota";
+
+bool bMeshOtaUtilNewerVersion(const char* cpu8Local, const char* cpu8Remote)
+{
+    /*
+     * Return true if remote version is newer (higher) than local version
+    */
+    char u8LocalTmp[12]; //local version
+    char u8RemoteTmp[12]; //remote version
+    char* pu8saveptrLocal; //context for strok_r
+    char* pu8saveptrRemote; //context for strok_r
+    bool bReturn = false; //flag to stop loop
+    uint8_t u8Index = 0; //numbers counter in version string
+
+    strncpy(u8LocalTmp, cpu8Local, 12); //copy in tmp
+    strncpy(u8RemoteTmp, cpu8Remote, 12); //copy in tmp
+
+    char* pu8TokenLocal = strtok_r(u8LocalTmp, ".", &pu8saveptrLocal); //split tokens
+    char* pu8TokenRemote = strtok_r(u8RemoteTmp, ".", &pu8saveptrRemote); //split tokens
+
+    while( (u8Index <= 2) && (bReturn == false)) //loop through tokens
+        {
+            u8Index++;
+            if(atoi(pu8TokenLocal) < atoi(pu8TokenRemote))
+                {
+                    bReturn = true; //version number difference --> stop loop
+                }
+            pu8TokenLocal = strtok_r(NULL, ".", &pu8saveptrLocal); //split tokens
+            pu8TokenRemote = strtok_r(NULL, ".", &pu8saveptrRemote); //split tokens
+        }
+    return bReturn;
+}
+
+esp_err_t errMeshOtaUtilExtractVersionNumber(const char* cpu8Data, uint32_t* const cpcu32DataLenght, char* const pc8RemoteVersionNumber)
+{
+    uint32_t u32StartOffset;
+    esp_err_t err = ESP_OK;
+
+    strcpy(pc8RemoteVersionNumber, "999.999.999"); //init value
+    err = errMeshOtaUtilFindImageStart(cpu8Data, cpcu32DataLenght, &u32StartOffset); //get image start offset
+
+    if(err == ESP_OK)
+        {
+            //image found
+            strncpy(pc8RemoteVersionNumber, cpu8Data+(u32StartOffset+48), 11); //copy version number
+            pc8RemoteVersionNumber[12] = '\0';
+        }
+    return err;
+}
+
+esp_err_t errMeshOtaUtilFindImageStart(const char* const cpu8Data, const uint32_t* const cpcu32DataLenght, uint32_t* const cpu32StartOffset)
+{
+    /*
+    Offset  value
+    0      = 0xE9 (first byte in image --> magic byte)
+    48     = first digit of version number
+    */
+
+    esp_err_t errReturn = ESP_OK;
+    bool bImageStartOffsetFound = false;
+    uint32_t u32DataIndex = 0;
+    uint32_t u32FirstDotOffset = 0;
+    uint32_t u32SecondDotOffset = 0;
+    uint8_t u8FirstDotIndex = 0;
+    uint8_t u8SecondDotIndex = 0;
+
+    *cpu32StartOffset = 0U; //reset offset to zero
+
+    while((u32DataIndex < *cpcu32DataLenght) &&  (bImageStartOffsetFound == false))
+        {
+            //search for magic byte
+            if(cpu8Data[u32DataIndex] == 0xe9)
+                {
+                    //magic byte found
+                    while ((u8FirstDotIndex < 3) && (u32FirstDotOffset == 0))
+                        {
+                            //search first dot in version number
+                            if((u32DataIndex+49+u8FirstDotIndex) < *cpcu32DataLenght)
+                                {
+                                    if((cpu8Data[(u32DataIndex+49+u8FirstDotIndex)] == 0x2e))
+                                        {
+                                            //first dot found
+                                            u32FirstDotOffset = (u32DataIndex+49+u8FirstDotIndex);
+                                        }
+                                }
+                            u8FirstDotIndex++;
+                        }
+
+                    while ((u8SecondDotIndex < 3) && (u32SecondDotOffset == 0) && (u32FirstDotOffset != 0))
+                        {
+                            //search first dot in version number
+                            if((u32FirstDotOffset+(u8SecondDotIndex+2)) < *cpcu32DataLenght)
+                                {
+                                    if((cpu8Data[(u32FirstDotOffset+(u8SecondDotIndex+2))] == 0x2e))
+                                        {
+                                            //second dot found
+                                            u32SecondDotOffset = (u32FirstDotOffset+(u8SecondDotIndex+2));
+                                        }
+                                }
+                            u8SecondDotIndex++;
+                        }
+
+                    if((u32FirstDotOffset != 0) && (u32SecondDotOffset != 0))
+                        {
+                            //image start found based on magic byte and version number systax
+                            *cpu32StartOffset = u32DataIndex; //store image start offset
+                            bImageStartOffsetFound = true;
+                        }
+                    else
+                        {
+                            // this is propably not the magic byte --> reset
+                            u32FirstDotOffset = 0;
+                            u32SecondDotOffset = 0;
+                            u8FirstDotIndex = 0;
+                            u8SecondDotIndex = 0;
+                        }
+                }
+            u32DataIndex++;
+        }
+
+    if(bImageStartOffsetFound == false)
+        {
+            errReturn = ESP_ERR_NOT_FOUND;
+        }
+
+    return errReturn;
+}
+
+esp_err_t errMeshOtaUtilSendOTAVersionRequest(const mesh_addr_t* const cpcMeshReceiverAddr)
+{
+    esp_err_t err = ESP_OK;
+    MESH_PACKET_t packet;
+    packet.type = OTA_Version_Request;
+
+    const esp_partition_t* pBootPartition; //pointer to boot partition (that will booted after reset)
+    esp_app_desc_t bootPartitionDesc; //Metadata from boot partition
+
+    pBootPartition = esp_ota_get_boot_partition(); //get boot partition (that will booted after reset), not the running partition
+    ERROR_CHECK(esp_ota_get_partition_description(pBootPartition, &bootPartitionDesc)); //get metadate of partition
+    memcpy(&packet.au8Payload, &bootPartitionDesc.version, 12); //copy local version to OTA_Version_Request packet
+    err = errMeshNetworkSendMeshPacket(cpcMeshReceiverAddr, &packet);
+    return err;
+}
+
+esp_err_t errMeshOtaUtilSendOTAVersionResponse(const mesh_addr_t* const cpcMeshReceiverAddr)
+{
+    esp_err_t err = ESP_OK;
+    MESH_PACKET_t packet;
+    packet.type = OTA_Version_Response;
+
+    const esp_partition_t* pBootPartition; //pointer to boot partition (that will booted after reset)
+    esp_app_desc_t bootPartitionDesc; //Metadata from boot partition
+
+    pBootPartition = esp_ota_get_boot_partition(); //get boot partition (that will booted after reset), not the running partition
+    ERROR_CHECK(esp_ota_get_partition_description(pBootPartition, &bootPartitionDesc)); //get metadate of partition
+    memcpy(&packet.au8Payload, &bootPartitionDesc.version, 12); //copy local version to OTA_Version_Response packet
+
+    ESP_LOGI(LOG_TAG, "Send OTA_Version_Response to 0x%x", cpcMeshReceiverAddr->addr[5]);
+
+    err = errMeshNetworkSendMeshPacket(cpcMeshReceiverAddr, &packet);
+    return err;
+}
+
+void vMeshOtaUtilPrintOTAProgress(const uint32_t* const cpcu32TotalImageSize, const uint32_t* const cpcu32BytesWritten, const OTA_MESH_ROLE_t ceRole)
+{
+    uint32_t u32Percentage = 0U;
+    static uint32_t u32LastPercentage = 0U;
+
+    if((*cpcu32BytesWritten) >= (*cpcu32TotalImageSize))
+        {
+            u32Percentage = 100;
+        }
+    else
+        {
+            u32Percentage = (uint32_t) (((float) (*cpcu32BytesWritten)/(float) (*cpcu32TotalImageSize)) * 100.0);
+        }
+
+    if((u32Percentage-u32LastPercentage) >= OTA_PROGRESS_LOG_INTERVAL)
+        {
+            if(ceRole == Transmitter)
+                {
+                    ESP_LOGI(LOG_TAG, "Transmitting OTA update: %i %%", u32Percentage);
+                }
+
+            if(ceRole == Receiver)
+                {
+                    ESP_LOGI(LOG_TAG, "Receiving OTA update: %i %%", u32Percentage);
+                }
+
+
+
+            u32LastPercentage = u32Percentage;
+        }
+}
+
+void vMeshOtaUtilAddAllNeighboursToQueue(void)
+{
+    esp_err_t err = ESP_OK;
+
+    mesh_addr_t addrParent;  //addr of parent node
+    mesh_addr_t childrenAddr[CONFIG_MESH_ROUTE_TABLE_SIZE]; //array of children attached to this node
+    uint16_t u16ChildrenSize = 0U; //number of children attached to this node
+
+    err = errMeshNetworkGetParentNode(&addrParent);
+
+    if(err == ESP_OK)
+        {
+            vMeshOtaUtilAddNodeToPossibleUpdatableQueue(addrParent.addr);
+            ESP_LOGI(LOG_TAG, "added parent");
+        }
+
+    err = ESP_OK; //reset error code
+
+    ERROR_CHECK(errMeshNetworkGetChildren(childrenAddr, &u16ChildrenSize)); //get all children
+
+    for (uint16_t u16Index = 0; ((u16Index < u16ChildrenSize) && (err == ESP_OK)); u16Index++)
+        {
+            vMeshOtaUtilAddNodeToPossibleUpdatableQueue(childrenAddr[u16Index].addr);
+            ESP_LOGI(LOG_TAG, "added child");
+        }
+}
+
+void vMeshOtaUtilClearOtaMessageQueue(const mesh_addr_t* const cpcMeshNodeAddr)
+{
+    MESH_PACKET_t sMeshPacket; //packet for sending and receiving
+    for (uint32_t u32Index = 0; (u32Index < QUEUE_MESSAGE_OTA_SIZE); u32Index++) //loop through all OTA messages
+        {
+            if (xQueueReceive(queueMessageOTA, &sMeshPacket, 0) == pdTRUE)
+                {
+                    if(!(bMeshNetworkCheckMACEquality(sMeshPacket.meshSenderAddr.addr, cpcMeshNodeAddr->addr)))
+                        {
+                            //received OTA message is NOT from cpcMeshNodeAddr --> keep it in queue
+                            vMeshOtaUtilAddOtaMessageToQueue(&sMeshPacket);
+                        }
+                    else
+                        {
+                            ESP_LOGI(LOG_TAG, "Removed type %i from node 0x%x", sMeshPacket.type, cpcMeshNodeAddr->addr[5]);
+                        }
+                }
+        }//end OTA message loop
+}
+
+void vMeshOtaUtilClearNeighboursQueue(const mesh_addr_t* const cpcMeshNodeAddr)
+{
+    mesh_addr_t sNode; //packet for sending and receiving
+    for (uint32_t u32Index = 0; (u32Index < QUEUE_MESSAGE_OTA_SIZE); u32Index++) //loop through all OTA messages
+        {
+            if (xQueueReceive(queueNodes, &sNode, 0) == pdTRUE)
+                {
+                    if(!(bMeshNetworkCheckMACEquality(sNode.addr, cpcMeshNodeAddr->addr)))
+                        {
+                            //node is NOT cpcMeshNodeAddr --> keep it in queue
+                            vMeshOtaUtilAddNodeToPossibleUpdatableQueue(cpcMeshNodeAddr->addr);
+                        }
+                    else
+                        {
+                            ESP_LOGI(LOG_TAG, "Removed node 0x%x", cpcMeshNodeAddr->addr[5]);
+                        }
+                }
+        }//end OTA message loop
+}
+
+
+void vMeshOtaUtilAddNodeToPossibleUpdatableQueue(const uint8_t* const cpcu8MAC)
+{
+    //send payload to node queues
+    mesh_addr_t addrNode;
+    memcpy(&addrNode.addr, (uint8_t *)cpcu8MAC, 6); //copy MAC
+
+    if (xQueueSend(queueNodes, &addrNode, portMAX_DELAY) != pdPASS)
+        {
+            ESP_LOGE(LOG_TAG, "Unable to push node into node queue");
+        }
+    else
+        {
+            ESP_LOGI(LOG_TAG, "added node \"%x:%x:%x:%x:%x:%x\" to possible updatable queue", addrNode.addr[0], addrNode.addr[1], addrNode.addr[2], addrNode.addr[3], addrNode.addr[4], addrNode.addr[5]);
+        }
+}
+
+void vMeshOtaUtilAddOtaMessageToQueue(const MESH_PACKET_t* const cpcuMeshPacket)
+{
+    //send ota packet to packet queue
+    if (xQueueSend(queueMessageOTA, cpcuMeshPacket, portMAX_DELAY) != pdPASS)
+        {
+            ESP_LOGE(LOG_TAG, "Unable to push ota packet into packet queue");
+        }
+    else
+        {
+            switch (cpcuMeshPacket->type)
+                {
+                case OTA_Abort:
+                    ESP_LOGI(LOG_TAG, "added ota message to queue: OTA_Abort from 0x%x", cpcuMeshPacket->meshSenderAddr.addr[5]);
+                    break;
+                case OTA_Version_Request:
+                    ESP_LOGI(LOG_TAG, "added ota message to queue: OTA_Version_Request from 0x%x", cpcuMeshPacket->meshSenderAddr.addr[5]);
+                    break;
+
+                case OTA_Version_Response:
+                    ESP_LOGI(LOG_TAG, "added ota message to queue: OTA_Version Response from 0x%x", cpcuMeshPacket->meshSenderAddr.addr[5]);
+                    break;
+                default:
+                    break;
+                }
+        }
+}
+
+void vMeshOtaUtilChangeStateOfServerWorker(const bool cbState) //allow access via function ptn to network_handler
+{
+    static bool bLastState = false;
+
+    if(cbState != bLastState) //change only if necessary
+        {
+            ESP_LOGI(LOG_TAG, "server worker change handler");
+
+            if(cbState == true)
+                {
+                    if (xSemaphoreGive(bsStartStopServerWorker)  != pdTRUE)
+                        {
+                            ESP_LOGE(LOG_TAG, "Unable to give mutex to activate the server worker");
+                        }
+                }
+            else
+                {
+                    if (xSemaphoreTake(bsStartStopServerWorker,( TickType_t ) 10 )  != pdTRUE)
+                        {
+                            ESP_LOGE(LOG_TAG, "Unable to obtain mutex to deactivate the server worker");
+                        }
+                }
+            bLastState = cbState;
+        }
+}

components/mesh_ota/include/HTTPS_Client.h

@@ -5,19 +5,10 @@
 #include <stdlib.h>
 #include "freertos/FreeRTOS.h"
 #include "freertos/task.h"
-#include "esp_wifi.h"
 #include "esp_event.h"
 #include "esp_log.h"
 #include "esp_system.h"
-#include "nvs_flash.h"
 #include "esp_netif.h"
-
-#include "lwip/err.h"
-#include "lwip/sockets.h"
-#include "lwip/sys.h"
-#include "lwip/netdb.h"
-#include "lwip/dns.h"
-
 #include "mbedtls/platform.h"
 #include "mbedtls/net_sockets.h"
 #include "mbedtls/esp_debug.h"
@@ -66,12 +57,12 @@ struct HTTPS_Client
 typedef int32_t https_client_ret_t;
 typedef struct HTTPS_Client HTTPS_Client_t;
 
-https_client_ret_t errHTTPSClientInitialize();
-https_client_ret_t errHTTPSClientConnectToServer();
-https_client_ret_t errHTTPSClientValidateServer();
-https_client_ret_t errHTTPSClientSendRequest();
-https_client_ret_t errHTTPSClientRetrieveData(char* pu8Data, uint32_t* pu32DataLenght, uint32_t* pu32BytesRead);
-https_client_ret_t errHTTPSClientReset();
+https_client_ret_t errHTTPSClientInitialize(void);
+https_client_ret_t errHTTPSClientConnectToServer(void);
+https_client_ret_t errHTTPSClientValidateServer(void);
+https_client_ret_t errHTTPSClientSendRequest(void);
+https_client_ret_t errHTTPSClientRetrieveData(char* const cpu8Data, const uint32_t* const cpcu32DataLenght, uint32_t* pu32BytesRead);
+https_client_ret_t errHTTPSClientReset(void);
 
 #endif /* H_HTTPS_CLIENT */
 

components/mesh_ota/include/Mesh_Network.h

@@ -0,0 +1,111 @@
+#ifndef H_MESH_NETWORK
+#define H_MESH_NETWORK
+
+#include <string.h>
+#include "esp_wifi.h"
+#include "esp_system.h"
+#include "esp_event.h"
+#include "esp_log.h"
+#include "esp_mesh.h"
+#include "esp_mesh_internal.h"
+#include "nvs_flash.h"
+
+#ifndef CONFIG_MESH_MESSAGE_SIZE
+#define CONFIG_MESH_MESSAGE_SIZE 1500
+#endif
+#ifndef CONFIG_MESH_TOPOLOGY
+#define CONFIG_MESH_TOPOLOGY MESH_TOPO_TREE
+#endif
+#ifndef CONFIG_MESH_MAX_LAYER
+#define CONFIG_MESH_MAX_LAYER 6
+#endif
+#ifndef CONFIG_MESH_ID
+#define CONFIG_MESH_ID "00, 00, 00, 00, 00, 00"
+#endif
+#ifndef CONFIG_MESH_AP_AUTHMODE
+#define CONFIG_MESH_AP_AUTHMODE WIFI_AUTH_WPA2_PSK
+#endif
+#ifndef CONFIG_MESH_AP_CONNECTIONS
+#define CONFIG_MESH_AP_CONNECTIONS 6
+#endif
+#ifndef CONFIG_MESH_AP_PASSWD
+#define CONFIG_MESH_AP_PASSWD "MAP_PASSWD"
+#endif
+#ifndef CONFIG_MESH_CHANNEL
+#define CONFIG_MESH_CHANNEL 0
+#endif
+
+#ifndef CONFIG_MESH_ROUTER_SSID
+#define CONFIG_MESH_ROUTER_SSID "ROUTER_SSID"
+#endif
+
+#ifndef CONFIG_MESH_ROUTER_PASSWD
+#define CONFIG_MESH_ROUTER_PASSWD "ROUTER_PASSWD"
+#endif
+
+#ifndef CONFIG_MESH_ROUTE_TABLE_SIZE
+#define CONFIG_MESH_ROUTE_TABLE_SIZE 50
+#endif
+
+#define MESH_NETWORK_PAYLOAD_SIZE 1024U
+
+struct meshPacket
+{
+    enum otaMeshPacketType
+    {
+        APP_Data,            //data for application
+        OTA_Version_Request, //send own version in payload
+        OTA_Version_Response, //send own version in payload
+        OTA_Data,            //send image segment
+        OTA_ACK,             //ack image segment
+        OTA_Complete,         //signal end of image
+        OTA_Abort             //abort OTA process
+    } type;
+    uint8_t au8Payload[MESH_NETWORK_PAYLOAD_SIZE];
+    mesh_addr_t meshSenderAddr;
+};
+
+typedef struct meshPacket MESH_PACKET_t;
+
+#define ERROR_CHECK(x) if (err == ESP_OK)                                                               \
+    {                                                                                                   \
+        err = (x);                                                                                      \
+        if (err != ESP_OK)                                                                              \
+            {                                                                                           \
+                ESP_LOGE(LOG_TAG,  "%s failed with error: 0x%x -> %s", #x,  err, esp_err_to_name(err)); \
+            }                                                                                           \
+    }                                                                                                   \
+
+extern bool bIsMeshConnected;
+extern int32_t i32MeshLayer;
+extern mesh_addr_t meshParentAddr;
+extern esp_netif_t* pNetifSta;
+extern uint8_t u8ownMAC[6];
+extern void (*pOTAChildConnectHandle)(const uint8_t* const);
+extern void (*pChangeStateOfServerWorkerHandle)(const bool );
+
+esp_err_t errMeshNetworkInitialize(void);
+esp_err_t errMeshNetworkInitializeWiFi(void);
+esp_err_t errMeshNetworkInitializeRouter(mesh_cfg_t* cfg);
+
+esp_err_t errMeshNetworkSetChildConnectedHandle(void (*pChildConnectHandleTmp)(const uint8_t* const cpcu8Data));
+esp_err_t errMeshNetworkSetAppReceiveHandle(void (*pAppRxHandleTmp)(const uint8_t* const cpcu8Data, const uint8_t* const cpcu8Sender));
+esp_err_t errMeshNetworkSetOTAMessageHandleHandle(void (*pOTAMessageHandleTmp)(const MESH_PACKET_t* const cpcuMeshPacket));
+esp_err_t errMeshNetworkSetChangeStateOfServerWorkerHandle(void (*pChangeStateOfServerWorkerHandleTmp)(const bool cbState));
+
+bool bMeshNetworkIsRootNode(void);
+bool bMeshNetworkIsNodeNeighbour(const mesh_addr_t* const cpcNode);
+bool bMeshNetworkCheckMACEquality(const uint8_t* const cpcu8aMAC, const uint8_t* const cpcu8bMAC);
+
+esp_err_t errMeshNetworkStartReceiveTask(void);
+esp_err_t errMeshNetworkGetParentNode(mesh_addr_t* const cpMeshParentAddr);
+esp_err_t errMeshNetworkGetChildren(mesh_addr_t* const cpChildren, uint16_t* const cpu16ChildrenSize);
+esp_err_t errMeshNetworkSendMeshPacket(const mesh_addr_t* const cpcAddrDest, const MESH_PACKET_t* const cpcPacket);
+
+void vMeshNetworkTaskReceiveMeshData(void *arg);
+void vMeshNetworkGetOwnAddr(mesh_addr_t* const cpMeshOwnAddr);
+void vMeshNetworkIpEventHandler(void *arg, esp_event_base_t event_base, int32_t i32EventID, void *vpEventData);
+void vMeshNetworkMeshEventHandler(void *arg, esp_event_base_t event_base, int32_t i32EventID, void* vpEventData);
+
+#endif /* H_MESH_NETWORK */
+

components/mesh_ota/include/Mesh_OTA.h

@@ -1,20 +1,14 @@
 #ifndef H_MESH_OTA
 #define H_MESH_OTA
 
-#include <string.h>
-#include "esp_wifi.h"
 #include "esp_system.h"
 #include "esp_event.h"
 #include "esp_log.h"
-#include "esp_mesh.h"
-#include "esp_mesh_internal.h"
-#include "nvs_flash.h"
-#include "driver/gpio.h"
 #include "esp_ota_ops.h"
 #include "esp_partition.h"
 
-#include "Mesh_network.h"
-#include "HTTPS_client.h"
+#include "Mesh_Network.h"
+#include "HTTPS_Client.h"
 
 #define ERASE_NVS //erase non volatile storage if full
 #define QUEUE_NODES_SIZE 10
@@ -24,6 +18,7 @@
 #define OTA_PROGRESS_LOG_INTERVAL 7U
 #define OTA_MESH_SEGMENT_SIZE MESH_NETWORK_PAYLOAD_SIZE
 #define OTA_MESH_TIMEOUT 20000U //in ms
+#define OTA_ALLOW_REBOOT 0
 
 #define ERROR_CHECK(x) if (err == ESP_OK)                                                               \
     {                                                                                                   \
@@ -34,42 +29,14 @@
             }                                                                                           \
     }                                                                                                   \
 
-enum otaMeshRole
-{
-    Transmitter,
-    Receiver
-};
-
-typedef  enum otaMeshRole OTA_MESH_ROLE_t;
-
-esp_err_t errMeshOTAInitialize();
-
-esp_err_t errOTAHTTPS(bool* pbNewOTAImage);
-esp_err_t errOTAMeshSlave(bool* pbNewOTAImage);
-esp_err_t errOTAMeshMaster(bool* pbNewOTAImage, mesh_addr_t* pMeshNodeAddr);
-esp_err_t errOTAMeshTransmit(mesh_addr_t* pMeshNodeAddr);
-esp_err_t errOTAMeshReceive(bool* pbNewOTAImage, mesh_addr_t* pMeshNodeAddr);
-
-
-//helper functions
-bool bNewerVersion(const char* pu8Local, const char* pu8Remote);
-esp_err_t errExtractVersionNumber(const  char* pu8Data, uint32_t* pu32DataLenght, char* pc8RemoteVersionNumber);
-esp_err_t errFindImageStart(const  char* pu8Data, uint32_t* pu32DataLenght, uint32_t* pu32StartOffset);
-void vPrintOTAProgress(const uint32_t* const pu32TotalImageSize, const uint32_t* const pu32BytesWritten, OTA_MESH_ROLE_t eRole);
-void vAddAllNeighboursToQueue(void);
-esp_err_t errSendOTAVersionResponse(mesh_addr_t* meshReceiverAddr);
-esp_err_t errSendOTAVersionRequest(mesh_addr_t* meshReceiverAddr);
-void vClearOtaMessageQueue(mesh_addr_t* pMeshNodeAddr);
-
-//Handler
-void vAddNodeToPossibleUpdatableQueue(uint8_t* pu8MAC);
-void vAddOtaMessageToQueue(MESH_PACKET_t* puMeshPacket);
-void vChangeStateOfServerWorker(bool state);
+esp_err_t errMeshOTAInitialize(void);
 
 //Tasks
-void vTaskServerWorker(void *arg);
-void vTaskOTAWorker(void *arg);
-
+void vMeshOtaTaskServerWorker(void *arg);
+void vMeshOtaTaskOTAWorker(void *arg);
 
+//OTA process endpoints
+esp_err_t errMeshOtaSlaveEndpoint(bool* const cpbNewOTAImage);
+esp_err_t errMeshOtaMasterEndpoint(bool* const cpbNewOTAImage, const mesh_addr_t* const cpcMeshNodeAddr);
 
 #endif /* H_MESH_OTA */

components/mesh_ota/include/Mesh_OTA_Globals.h

@@ -0,0 +1,19 @@
+#ifndef H_MESH_OTA_GLOBALS
+#define H_MESH_OTA_GLOBALS
+
+#include "esp_system.h"
+#include "esp_partition.h"
+
+#include "Mesh_Network.h"
+#include "HTTPS_Client.h"
+
+extern xQueueHandle queueNodes; //nodes that should be checked for ota update (contains children and parent)
+extern xQueueHandle queueMessageOTA; //mesh ota controll messages like "OTA_Version_Response" "OTA_ACK"
+
+extern SemaphoreHandle_t bsStartStopServerWorker; //binary semaphore
+extern SemaphoreHandle_t bsOTAProcess; //binary semaphore
+
+extern const esp_partition_t* pOTAPartition; //pointer to ota partition
+extern bool bWantReboot; //flag to signal pending reboot
+
+#endif /* H_MESH_OTA_GLOBALS */

components/mesh_ota/include/Mesh_OTA_Partition_Access.h

@@ -0,0 +1,27 @@
+#ifndef H_MESH_OTA_PARTITION_ACCESS
+#define H_MESH_OTA_PARTITION_ACCESS
+
+#include "esp_system.h"
+#include "esp_event.h"
+#include "esp_log.h"
+#include "nvs_flash.h"
+#include "esp_ota_ops.h"
+#include "esp_partition.h"
+
+#include "Mesh_Network.h"
+#include "HTTPS_Client.h"
+
+#define ERROR_CHECK(x) if (err == ESP_OK)                                                               \
+    {                                                                                                   \
+        err = (x);                                                                                      \
+        if (err != ESP_OK)                                                                              \
+            {                                                                                           \
+                ESP_LOGE(LOG_TAG,  "%s failed with error: 0x%x -> %s", #x,  err, esp_err_to_name(err)); \
+            }                                                                                           \
+    }                                                                                                   \
+
+esp_err_t errMeshOtaPartitionAccessHttps(bool* const cpbNewOTAImage);
+esp_err_t errMeshOtaPartitionAccessMeshTransmit(const mesh_addr_t* const cpcMeshNodeAddr);
+esp_err_t errMeshOtaPartitionAccessMeshReceive(bool* const cpbNewOTAImage, const mesh_addr_t* const cpcMeshNodeAddr);
+
+#endif /* H_MESH_OTA_PARTITION_ACCESS */

components/mesh_ota/include/Mesh_OTA_Util.h

@@ -0,0 +1,37 @@
+#ifndef H_MESH_OTA_UTIL
+#define H_MESH_OTA_UTIL
+
+#include "esp_system.h"
+#include "esp_event.h"
+#include "esp_log.h"
+
+#include "Mesh_Network.h"
+#include "HTTPS_Client.h"
+#include "Mesh_OTA.h"
+
+enum otaMeshRole
+{
+    Transmitter,
+    Receiver
+};
+
+typedef  enum otaMeshRole OTA_MESH_ROLE_t;
+
+//helper functions
+bool bMeshOtaUtilNewerVersion(const char* cpu8Local, const char* cpu8Remote);
+esp_err_t errMeshOtaUtilExtractVersionNumber(const char* cpu8Data, uint32_t* const cpu32DataLenght, char* const pc8RemoteVersionNumber);
+esp_err_t errMeshOtaUtilFindImageStart(const  char* const cpu8Data, const uint32_t* const cpu32DataLenght, uint32_t* const cpu32StartOffset);
+esp_err_t errMeshOtaUtilSendOTAVersionRequest(const mesh_addr_t* const cpcMeshReceiverAddr);
+esp_err_t errMeshOtaUtilSendOTAVersionResponse(const mesh_addr_t* const cpcMeshReceiverAddr);
+void vMeshOtaUtilPrintOTAProgress(const uint32_t* const cpcu32TotalImageSize, const uint32_t* const cpcu32BytesWritten, const OTA_MESH_ROLE_t ceRole);
+void vMeshOtaUtilAddAllNeighboursToQueue(void);
+void vMeshOtaUtilClearOtaMessageQueue(const mesh_addr_t* const cpcMeshNodeAddr);
+void vMeshOtaUtilClearNeighboursQueue(const mesh_addr_t* const cpcMeshNodeAddr);
+
+//Handler
+void vMeshOtaUtilAddNodeToPossibleUpdatableQueue(const uint8_t* const cpcu8MAC);
+void vMeshOtaUtilAddOtaMessageToQueue(const MESH_PACKET_t* const cpcuMeshPacket);
+void vMeshOtaUtilChangeStateOfServerWorker(const bool cbState);
+
+#endif /* H_MESH_OTA_UTIL */
+

components/mesh_ota/include/Mesh_network.h

@@ -1,106 +0,0 @@
-#ifndef H_MESH_NETWORK
-#define H_MESH_NETWORK
-
-#include <string.h>
-#include "esp_wifi.h"
-#include "esp_system.h"
-#include "esp_event.h"
-#include "esp_log.h"
-#include "esp_mesh.h"
-#include "esp_mesh_internal.h"
-#include <stdlib.h>
-
-#ifndef CONFIG_MESH_MESSAGE_SIZE
-#define CONFIG_MESH_MESSAGE_SIZE 1500
-#endif
-#ifndef CONFIG_MESH_TOPOLOGY
-#define CONFIG_MESH_TOPOLOGY MESH_TOPO_TREE
-#endif
-#ifndef CONFIG_MESH_MAX_LAYER
-#define CONFIG_MESH_MAX_LAYER 6
-#endif
-#ifndef CONFIG_MESH_ID
-#define CONFIG_MESH_ID "00, 00, 00, 00, 00, 00"
-#endif
-#ifndef CONFIG_MESH_AP_AUTHMODE
-#define CONFIG_MESH_AP_AUTHMODE WIFI_AUTH_WPA2_PSK
-#endif
-#ifndef CONFIG_MESH_AP_CONNECTIONS
-#define CONFIG_MESH_AP_CONNECTIONS 6
-#endif
-#ifndef CONFIG_MESH_AP_PASSWD
-#define CONFIG_MESH_AP_PASSWD "MAP_PASSWD"
-#endif
-#ifndef CONFIG_MESH_CHANNEL
-#define CONFIG_MESH_CHANNEL 0
-#endif
-
-#ifndef CONFIG_MESH_ROUTER_SSID
-#define CONFIG_MESH_ROUTER_SSID "ROUTER_SSID"
-#endif
-
-#ifndef CONFIG_MESH_ROUTER_PASSWD
-#define CONFIG_MESH_ROUTER_PASSWD "ROUTER_PASSWD"
-#endif
-
-#ifndef CONFIG_MESH_ROUTE_TABLE_SIZE
-#define CONFIG_MESH_ROUTE_TABLE_SIZE 50
-#endif
-
-#define MESH_NETWORK_PAYLOAD_SIZE 1024U
-
-struct meshPacket
-{
-    enum otaMeshPacketType
-    {
-        APP_Data,            //data for application
-        OTA_Version_Request, //send own version in payload
-        OTA_Version_Response, //send own version in payload
-        OTA_Data,            //send image segment
-        OTA_ACK,             //ack image segment
-        OTA_Complete,         //signal end of image
-        OTA_Abort             //abort OTA process
-    } type;
-    uint8_t au8Payload[MESH_NETWORK_PAYLOAD_SIZE];
-    mesh_addr_t meshSenderAddr;
-};
-
-typedef struct meshPacket MESH_PACKET_t;
-
-extern bool bIsMeshConnected;
-extern int32_t i32MeshLayer;
-extern mesh_addr_t meshParentAddr;
-extern esp_netif_t* netif_sta;
-extern uint8_t u8ownMAC[6];
-extern void (*pOTAChildConnectHandle)(uint8_t* );
-extern void (*pChangeStateOfServerWorkerHandle)(bool );
-
-esp_err_t errMeshNetworkInitialize();
-esp_err_t errMeshNetworkInitializeWiFi();
-esp_err_t errMeshNetworkInitializeRouter(mesh_cfg_t* cfg);
-
-esp_err_t errMeshNetworkSetAppReceiveHandle(void (*pAppRxHandleTmp)(uint8_t * pu8Data, uint8_t* pu8Sender));
-esp_err_t errMeshNetworkSetChildConnectedHandle(void (*pChildConnectHandleTmp)(uint8_t * pu8Data));
-esp_err_t errMeshNetworkSetOTAMessageHandleHandle(void (*pOTAMessageHandleTmp)(MESH_PACKET_t* puMeshPacket));
-
-esp_err_t errMeshNetworkSetChangeStateOfServerWorkerHandle(void (*pChangeStateOfServerWorkerHandleTmp)(bool bState));
-
-bool bCheckMACEquality(uint8_t* pu8aMAC,  uint8_t* pu8bMAC);
-void vGetOwnAddr(mesh_addr_t* pMeshOwnAddr);
-esp_err_t errGetParentNode(mesh_addr_t* pMeshParentAddr);
-esp_err_t errGetChildren(mesh_addr_t* pChildren, uint16_t* pu16ChildrenSize);
-bool bIsRootNode();
-bool bIsNodeNeighbour(mesh_addr_t* pNode);
-
-esp_err_t errStartReceiveTask();
-void vTaskReceiveMeshData(void *arg);
-void vMeshEventHandler(void *arg, esp_event_base_t event_base, int32_t i32EventID, void* vpEventData);
-void vIPEventHandler(void *arg, esp_event_base_t event_base, int32_t i32EventID, void *event_data);
-
-esp_err_t errSendMeshPacket(mesh_addr_t* pAddrDest, MESH_PACKET_t* pPacket);
-
-
-
-
-#endif /* H_MESH_NETWORK */
-

components/mesh_ota/test/test_mesh_ota.c

@@ -10,56 +10,56 @@ TEST_CASE("Remote got patch", "[distinguish newer image version]")
 {
     char versionLocal[] = "1.2.3";  //current running image
     char versionRemote[] = "1.2.4"; //image from server
-    TEST_ASSERT_TRUE( bNewerVersion(versionLocal, versionRemote)  );
+    TEST_ASSERT_TRUE( bMeshOtaUtilNewerVersion(versionLocal, versionRemote)  );
 }
 
 TEST_CASE("Remote got minor", "[distinguish newer image version]")
 {
     char versionLocal[] = "1.2.3";  //current running image
     char versionRemote[] = "1.3.3"; //image from server
-    TEST_ASSERT_TRUE( bNewerVersion(versionLocal, versionRemote)  );
+    TEST_ASSERT_TRUE( bMeshOtaUtilNewerVersion(versionLocal, versionRemote)  );
 }
 
 TEST_CASE("Remote got major", "[distinguish newer image version]")
 {
     char versionLocal[] = "1.2.3";  //current running image
     char versionRemote[] = "2.2.3"; //image from server
-    TEST_ASSERT_TRUE( bNewerVersion(versionLocal, versionRemote)  );
+    TEST_ASSERT_TRUE( bMeshOtaUtilNewerVersion(versionLocal, versionRemote)  );
 }
 
 TEST_CASE("Local got patch", "[distinguish newer image version]")
 {
     char versionLocal[] = "1.2.4";  //current running image
     char versionRemote[] = "1.2.3"; //image from server
-    TEST_ASSERT_FALSE( bNewerVersion(versionLocal, versionRemote)  );
+    TEST_ASSERT_FALSE( bMeshOtaUtilNewerVersion(versionLocal, versionRemote)  );
 }
 
 TEST_CASE("Local got minor", "[distinguish newer image version]")
 {
     char versionLocal[] = "1.3.3";  //current running image
     char versionRemote[] = "1.2.3"; //image from server
-    TEST_ASSERT_FALSE( bNewerVersion(versionLocal, versionRemote)  );
+    TEST_ASSERT_FALSE( bMeshOtaUtilNewerVersion(versionLocal, versionRemote)  );
 }
 
 TEST_CASE("Local got major", "[distinguish newer image version]")
 {
     char versionLocal[] = "2.2.3";  //current running image
     char versionRemote[] = "1.2.3"; //image from server
-    TEST_ASSERT_FALSE( bNewerVersion(versionLocal, versionRemote)  );
+    TEST_ASSERT_FALSE( bMeshOtaUtilNewerVersion(versionLocal, versionRemote)  );
 }
 
 TEST_CASE("Remote got alpha and patch", "[distinguish newer image version]")
 {
     char versionLocal[] = "2.2.3";  //current running image
     char versionRemote[] = "a2.2.4"; //image from server
-    TEST_ASSERT_TRUE( bNewerVersion(versionLocal, versionRemote)  );
+    TEST_ASSERT_TRUE( bMeshOtaUtilNewerVersion(versionLocal, versionRemote)  );
 }
 
 TEST_CASE("Remote got max", "[distinguish newer image version]")
 {
     char versionLocal[] = "2.2.3";  //current running image
     char versionRemote[] = "999.999.999"; //image from server
-    TEST_ASSERT_TRUE( bNewerVersion(versionLocal, versionRemote)  );
+    TEST_ASSERT_TRUE( bMeshOtaUtilNewerVersion(versionLocal, versionRemote)  );
 }
 
 // ### ### ###  find start offset in firmware image ### ### ###
@@ -68,7 +68,7 @@ TEST_CASE("with http response +  0.0.1", "[find start offset in firmware image]"
 {
     uint32_t u32StartOffset;
     uint32_t u32DataLenght = sizeof(dataWithHttpRespone0_0_1)/sizeof(dataWithHttpRespone0_0_1[0]);
-    esp_err_t err = errFindImageStart(dataWithHttpRespone0_0_1, &u32DataLenght, &u32StartOffset);
+    esp_err_t err = errMeshOtaUtilFindImageStart(dataWithHttpRespone0_0_1, &u32DataLenght, &u32StartOffset);
     if(err == ESP_OK)
     {
         TEST_ASSERT_EQUAL_INT(305, u32StartOffset);
@@ -83,7 +83,7 @@ TEST_CASE("without http response +  0.0.1", "[find start offset in firmware imag
 {
     uint32_t u32StartOffset;
     uint32_t u32DataLenght = sizeof(dataWithoutHttpRespone0_0_1)/sizeof(dataWithoutHttpRespone0_0_1[0]);
-    esp_err_t err =  errFindImageStart(dataWithoutHttpRespone0_0_1, &u32DataLenght, &u32StartOffset);
+    esp_err_t err =  errMeshOtaUtilFindImageStart(dataWithoutHttpRespone0_0_1, &u32DataLenght, &u32StartOffset);
     if(err == ESP_OK)
     {
         TEST_ASSERT_EQUAL_INT(0, u32StartOffset);
@@ -99,7 +99,7 @@ TEST_CASE("with http response +  999.999.999", "[find start offset in firmware i
 {
     uint32_t u32StartOffset;
     uint32_t u32DataLenght = sizeof(dataWithHttpRespone999_999_999)/sizeof(dataWithHttpRespone999_999_999[0]);
-    esp_err_t err = errFindImageStart(dataWithHttpRespone999_999_999, &u32DataLenght, &u32StartOffset);
+    esp_err_t err = errMeshOtaUtilFindImageStart(dataWithHttpRespone999_999_999, &u32DataLenght, &u32StartOffset);
     if(err == ESP_OK)
     {
         TEST_ASSERT_EQUAL_INT(305, u32StartOffset);
@@ -114,7 +114,7 @@ TEST_CASE("without http response +  999.999.999", "[find start offset in firmwar
 {
     uint32_t u32StartOffset;
     uint32_t u32DataLenght = sizeof(dataWithoutHttpRespone999_999_999)/sizeof(dataWithoutHttpRespone999_999_999[0]);
-    esp_err_t err = errFindImageStart(dataWithoutHttpRespone999_999_999, &u32DataLenght, &u32StartOffset);
+    esp_err_t err = errMeshOtaUtilFindImageStart(dataWithoutHttpRespone999_999_999, &u32DataLenght, &u32StartOffset);
     if(err == ESP_OK)
     {
         TEST_ASSERT_EQUAL_INT(0, u32StartOffset);
@@ -129,7 +129,7 @@ TEST_CASE("with http response +  999.9.999", "[find start offset in firmware ima
 {
     uint32_t u32StartOffset;
     uint32_t u32DataLenght = sizeof(dataWithHttpRespone999_9_999)/sizeof(dataWithHttpRespone999_9_999[0]);
-    esp_err_t err = errFindImageStart(dataWithHttpRespone999_9_999, &u32DataLenght, &u32StartOffset);
+    esp_err_t err = errMeshOtaUtilFindImageStart(dataWithHttpRespone999_9_999, &u32DataLenght, &u32StartOffset);
     if(err == ESP_OK)
     {
         TEST_ASSERT_EQUAL_INT(302, u32StartOffset);
@@ -144,7 +144,7 @@ TEST_CASE("with http response +  999.99.999", "[find start offset in firmware im
 {
     uint32_t u32StartOffset;
     uint32_t u32DataLenght = sizeof(dataWithHttpRespone999_99_999)/sizeof(dataWithHttpRespone999_99_999[0]);
-    esp_err_t err = errFindImageStart(dataWithHttpRespone999_99_999, &u32DataLenght, &u32StartOffset);
+    esp_err_t err = errMeshOtaUtilFindImageStart(dataWithHttpRespone999_99_999, &u32DataLenght, &u32StartOffset);
     if(err == ESP_OK)
     {
         TEST_ASSERT_EQUAL_INT(299, u32StartOffset);
@@ -162,10 +162,10 @@ TEST_CASE("extract version 0.0.1", "[extract image version number]")
     char versionLocal[] = "0.0.0";  //current running image
     char versionRemote[12];//image from server
     uint32_t u32DataLenght = sizeof(dataWithHttpRespone0_0_1)/sizeof(dataWithHttpRespone0_0_1[0]);
-    esp_err_t err = errExtractVersionNumber(dataWithHttpRespone0_0_1, &u32DataLenght, versionRemote);
+    esp_err_t err = errMeshOtaUtilExtractVersionNumber(dataWithHttpRespone0_0_1, &u32DataLenght, versionRemote);
     if(err == ESP_OK)
     {
-        TEST_ASSERT_TRUE( bNewerVersion(versionLocal, versionRemote)  );
+        TEST_ASSERT_TRUE( bMeshOtaUtilNewerVersion(versionLocal, versionRemote)  );
     }
     else
     {
@@ -178,10 +178,10 @@ TEST_CASE("extract version 999.999.999", "[extract image version number]")
     char versionLocal[] = "0.0.0";  //current running image
     char versionRemote[12];//image from server
     uint32_t u32DataLenght = sizeof(dataWithHttpRespone999_999_999)/sizeof(dataWithHttpRespone999_999_999[0]);
-    esp_err_t err = errExtractVersionNumber(dataWithHttpRespone999_999_999, &u32DataLenght, versionRemote);
+    esp_err_t err = errMeshOtaUtilExtractVersionNumber(dataWithHttpRespone999_999_999, &u32DataLenght, versionRemote);
     if(err == ESP_OK)
     {
-        TEST_ASSERT_TRUE( bNewerVersion(versionLocal, versionRemote)  );
+        TEST_ASSERT_TRUE( bMeshOtaUtilNewerVersion(versionLocal, versionRemote)  );
     }
     else
     {
@@ -194,10 +194,10 @@ TEST_CASE("extract version 999.99.999", "[extract image version number]")
     char versionLocal[] = "999.100.999";  //current running image
     char versionRemote[12];//image from server
     uint32_t u32DataLenght = sizeof(dataWithHttpRespone999_99_999)/sizeof(dataWithHttpRespone999_99_999[0]);
-    esp_err_t err = errExtractVersionNumber(dataWithHttpRespone999_99_999, &u32DataLenght, versionRemote);
+    esp_err_t err = errMeshOtaUtilExtractVersionNumber(dataWithHttpRespone999_99_999, &u32DataLenght, versionRemote);
     if(err == ESP_OK)
     {
-        TEST_ASSERT_FALSE( bNewerVersion(versionLocal, versionRemote)  );
+        TEST_ASSERT_FALSE( bMeshOtaUtilNewerVersion(versionLocal, versionRemote)  );
     }
     else
     {

main/Blinky_LED.c

@@ -62,7 +62,7 @@ void vGPIOInitialize()
     gpio_config(&gpioConf);
 }
 
-void rxHandle(uint8_t* pu8Data, uint8_t* pu8Sender)
+void rxHandle(const uint8_t* const pu8Data, const uint8_t* const pu8Sender)
 {
     //send payload to app queue
     BLINKY_PACKET_t bTmpPacket;
@@ -107,20 +107,20 @@ void vTaskReadUserInput(void *arg)
 
                     memcpy(meshPacket.au8Payload, &bTmpPacket, sizeof(BLINKY_PACKET_t));
 
-                    if(bIsRootNode() == false)
+                    if(bMeshNetworkIsRootNode() == false)
                         {
                             //this node is not root --> send led action to parent
-                            ERROR_CHECK(errGetParentNode(&addrParent));
-                            ERROR_CHECK(errSendMeshPacket(&addrParent, &meshPacket));
+                            ERROR_CHECK(errMeshNetworkGetParentNode(&addrParent));
+                            ERROR_CHECK(errMeshNetworkSendMeshPacket(&addrParent, &meshPacket));
                         }
                     else
                         {
                             //this node is root --> send led action to children
-                            ERROR_CHECK(errGetChildren(childrenAddr, &u16ChildrenSize));
+                            ERROR_CHECK(errMeshNetworkGetChildren(childrenAddr, &u16ChildrenSize));
 
                             for (uint16_t u16Index = 0; u16Index < u16ChildrenSize; u16Index++)
                                 {
-                                    ERROR_CHECK (errSendMeshPacket(&childrenAddr[u16Index], &meshPacket));
+                                    ERROR_CHECK (errMeshNetworkSendMeshPacket(&childrenAddr[u16Index], &meshPacket));
                                 }
                         }
                     vTaskDelay(200 / portTICK_PERIOD_MS);
@@ -170,17 +170,17 @@ void vTaskReceiveData(void *arg)
                         }
                 }
 
-            ERROR_CHECK(errGetChildren(childrenAddr, &u16ChildrenSize)); //get all children attached to this node
+            ERROR_CHECK(errMeshNetworkGetChildren(childrenAddr, &u16ChildrenSize)); //get all children attached to this node
             memcpy(meshPacket.au8Payload, &bTmpPacket, sizeof(BLINKY_PACKET_t)); //copy led action in mesh packet payload
 
             for (uint16_t u16Index = 0; u16Index < u16ChildrenSize; u16Index++)
                 {
                     //loop through children
-                    if(bCheckMACEquality(bTmpPacket.meshSenderAddr.addr,  childrenAddr[u16Index].addr) == false) //exclude the sender node
+                    if(bMeshNetworkCheckMACEquality(bTmpPacket.meshSenderAddr.addr,  childrenAddr[u16Index].addr) == false) //exclude the sender node
                         {
-                            ERROR_CHECK (errSendMeshPacket(&childrenAddr[u16Index], &meshPacket)); //send to child
+                            ERROR_CHECK (errMeshNetworkSendMeshPacket(&childrenAddr[u16Index], &meshPacket)); //send to child
                         }
                 }
             vTaskDelay(200 / portTICK_PERIOD_MS);
         }
-}
+}

main/Blinky_LED.h

@@ -11,6 +11,7 @@
 
 #include "Mesh_OTA.h"
 
+
 #define GPIO_BOOT_BTN   0 //GPIO0 (Boot BTN)
 #define GPIO_LED        2 //GPIO2 (internal blue LED in DevKit V1.0)
 
@@ -30,7 +31,7 @@ typedef struct blinky_packet BLINKY_PACKET_t;
 
 esp_err_t errBlinkyLEDInitialize();
 void vGPIOInitialize();
-void rxHandle(uint8_t* pu8Data, uint8_t* pu8Sender);
+void rxHandle(const uint8_t* const pu8Data, const uint8_t* const pu8Sender);
 void vTaskReadUserInput(void *arg);
 void vTaskReceiveData(void *arg);
 

main/Main.c

@@ -1,15 +1,9 @@
-
-#include <string.h>
-#include "esp_wifi.h"
+#include <stdio.h>
+#include "sdkconfig.h"
+#include "freertos/FreeRTOS.h"
+#include "freertos/task.h"
 #include "esp_system.h"
-#include "esp_event.h"
-#include "esp_log.h"
-#include "esp_mesh.h"
-#include "esp_mesh_internal.h"
-#include "nvs_flash.h"
-#include "driver/gpio.h"
-#include "esp_ota_ops.h"
-#include "esp_partition.h"
+#include "esp_spi_flash.h"
 
 #include "Mesh_OTA.h"
 #include "Blinky_LED.h"
@@ -19,7 +13,7 @@ static const char *LOG_TAG = "esp_main";
 void app_main(void)
 {
     esp_err_t err = ESP_OK;
-    ESP_LOGI(LOG_TAG, "hardcoded: 0.0.1");
+    ESP_LOGI(LOG_TAG, "hardcoded version: 0.0.1");
 
     ESP_LOGI(LOG_TAG, "start mesh network");
     err = errMeshNetworkInitialize();