@alteriom/painlessmesh 1.6.1 → 1.7.2

package/examples/otaSender/otaSender.ino

@@ -1,151 +1,160 @@
-//************************************************************
-// this is an example that uses the painlessmesh library to
-// upload firmware to another node on the network. 
-// This will upload to an ESP device running the otaReceiver.ino
-//
-// The naming convetions should be as follows for bin files
-// firmware_<hardware>_<role>.bin
-// To create your own binary files, export them and rename
-// them to follow this format, where hardware will be
-// "ESP8266" or "ESP32" (capitalized.)
-// If sending to the otacreceiver sketch, role should be
-// "otareceiver" (lowercase)
-//
-// This sketch assumes a Nodemcu-32s with an SD card
-// connected as shown in the jpg included in the sketch folder
-// This code may have to be reworked/hardware adjusted for
-// other boards or ESP8266. The core code works well though
-//
-// MAKE SURE YOUR UPLOADED OTA FIRMWARE INCLUDES OTA SUPPORT 
-// OR YOU WILL LOSE THE ABILITY TO UPLOAD MORE FIRMWARE.
-// THE INCLUDED .bin DOES NOT HAVE OTA SUPPORT SO THIS MUST BE
-// REFLASHED
-//************************************************************
-
-#ifdef ESP32
-#else
-#define CS_PIN  D8
-#endif
-
-#include "painlessMesh.h"
-
-#include <FS.h>
-#include "SD.h"
-#include "SPI.h"
-
-#define MESH_PREFIX "whateverYouLike"
-#define MESH_PASSWORD "somethingSneaky"
-#define MESH_PORT 5555
-
-#define OTA_PART_SIZE 1024 //How many bytes to send per OTA data packet
-
-painlessMesh mesh;
-
-void setup() {
-  Serial.begin(115200);
-  delay(1000);
-  mesh.setDebugMsgTypes(
-      ERROR | STARTUP | CONNECTION |
-      DEBUG);  // set before init() so that you can see startup messages
-
-  mesh.init(MESH_PREFIX, MESH_PASSWORD, MESH_PORT);
-
-  // Bridge node, should (in most cases) be a root node. See [the
-  // wiki](https://gitlab.com/painlessMesh/painlessMesh/wikis/Possible-challenges-in-mesh-formation)
-  // for some background
-  mesh.setRoot(true);
-  // This node and all other nodes should ideally know the mesh contains a root,
-  // so call this on all nodes
-  mesh.setContainsRoot(true);
-
-  delay(1000);
-  #ifdef ESP32
-  if (!SD.begin()) {
-  #else
-  if (!SD.begin(CS_PIN)) {
-  #endif
-    rebootEspWithReason("Could not mount SD card, restarting");
-  }
-
-  File dir = SD.open("/");
-  while (true) {
-    File entry = dir.openNextFile();
-    if (!entry) { //End of files
-      rebootEspWithReason("Could not find valid firmware, please validate");
-    }
-
-    //This block of code parses the file name to make sure it is valid.
-    //It will also get the role and hardware the firmware is targeted at.
-    if (!entry.isDirectory()) {
-      TSTRING name = entry.name();
-      if (name.length() > 1 && name.indexOf('_') != -1 &&
-          name.indexOf('_') != name.lastIndexOf('_') &&
-          name.indexOf('.') != -1) {
-        TSTRING firmware = name.substring(1, name.indexOf('_'));
-        TSTRING hardware =
-            name.substring(name.indexOf('_') + 1, name.lastIndexOf('_'));
-        TSTRING role =
-            name.substring(name.lastIndexOf('_') + 1, name.indexOf('.'));
-        TSTRING extension =
-            name.substring(name.indexOf('.') + 1, name.length());
-        if (firmware.equals("firmware") &&
-            (hardware.equals("ESP8266") || hardware.equals("ESP32")) &&
-            extension.equals("bin")) {
-
-          Serial.println("OTA FIRMWARE FOUND, NOW BROADCASTING");
-
-          //This is the important bit for OTA, up to now was just getting the file. 
-          //If you are using some other way to upload firmware, possibly from 
-          //mqtt or something, this is what needs to be changed.
-          //This function could also be changed to support OTA of multiple files
-          //at the same time, potentially through using the pkg.md5 as a key in
-          //a map to determine which to send
-          mesh.initOTASend(
-              [&entry](painlessmesh::plugin::ota::DataRequest pkg,
-                       char* buffer) {
-                
-                //fill the buffer with the requested data packet from the node.
-                entry.seek(OTA_PART_SIZE * pkg.partNo);
-                entry.readBytes(buffer, OTA_PART_SIZE);
-                
-                //The buffer can hold OTA_PART_SIZE bytes, but the last packet may
-                //not be that long. Return the actual size of the packet.
-                return min((unsigned)OTA_PART_SIZE,
-                           entry.size() - (OTA_PART_SIZE * pkg.partNo));
-              },
-              OTA_PART_SIZE);
-
-          //Calculate the MD5 hash of the firmware we are trying to send. This will be used
-          //to validate the firmware as well as tell if a node needs this firmware.
-          MD5Builder md5;
-          md5.begin();
-          md5.addStream(entry, entry.size());
-          md5.calculate(); 
-
-          //Make it known to the network that there is OTA firmware available.
-          //This will send a message every minute for an hour letting nodes know
-          //that firmware is available.
-          //This returns a task that allows you to do things on disable or more,
-          //like closing your files or whatever.
-          mesh.offerOTA(role, hardware, md5.toString(),
-                        ceil(((float)entry.size()) / OTA_PART_SIZE), false);
-
-          while (true) {
-            //This program will not reach loop() so we dont have to worry about
-            //file scope.
-            mesh.update();
-            delay(1000);
-          }
-        }
-      }
-    }
-  }
-}
-
-void rebootEspWithReason(String reason) {
-  Serial.println(reason);
-  delay(1000);
-  ESP.restart();
-}
-
-void loop(){};
+//************************************************************
+// this is an example that uses the painlessmesh library to
+// upload firmware to another node on the network. 
+// This will upload to an ESP device running the otaReceiver.ino
+//
+// The naming convetions should be as follows for bin files
+// firmware_<hardware>_<role>.bin
+// To create your own binary files, export them and rename
+// them to follow this format, where hardware will be
+// "ESP8266" or "ESP32" (capitalized.)
+// If sending to the otacreceiver sketch, role should be
+// "otareceiver" (lowercase)
+//
+// This sketch assumes a Nodemcu-32s with an SD card
+// connected as shown in the jpg included in the sketch folder
+// This code may have to be reworked/hardware adjusted for
+// other boards or ESP8266. The core code works well though
+//
+// MAKE SURE YOUR UPLOADED OTA FIRMWARE INCLUDES OTA SUPPORT 
+// OR YOU WILL LOSE THE ABILITY TO UPLOAD MORE FIRMWARE.
+// THE INCLUDED .bin DOES NOT HAVE OTA SUPPORT SO THIS MUST BE
+// REFLASHED
+//************************************************************
+
+#ifdef ESP32
+#else
+#define CS_PIN  D8
+#endif
+
+#include "painlessMesh.h"
+
+#include <FS.h>
+#include "SD.h"
+#include "SPI.h"
+
+#define MESH_PREFIX "whateverYouLike"
+#define MESH_PASSWORD "somethingSneaky"
+#define MESH_PORT 5555
+
+#define OTA_PART_SIZE 1024 //How many bytes to send per OTA data packet
+
+painlessMesh mesh;
+
+void setup() {
+  Serial.begin(115200);
+  delay(1000);
+  mesh.setDebugMsgTypes(
+      ERROR | STARTUP | CONNECTION |
+      DEBUG);  // set before init() so that you can see startup messages
+
+  mesh.init(MESH_PREFIX, MESH_PASSWORD, MESH_PORT);
+
+  // Bridge node, should (in most cases) be a root node. See [the
+  // wiki](https://gitlab.com/painlessMesh/painlessMesh/wikis/Possible-challenges-in-mesh-formation)
+  // for some background
+  mesh.setRoot(true);
+  // This node and all other nodes should ideally know the mesh contains a root,
+  // so call this on all nodes
+  mesh.setContainsRoot(true);
+
+  delay(1000);
+  #ifdef ESP32
+  if (!SD.begin()) {
+  #else
+  if (!SD.begin(CS_PIN)) {
+  #endif
+    rebootEspWithReason("Could not mount SD card, restarting");
+  }
+
+  File dir = SD.open("/");
+  while (true) {
+    File entry = dir.openNextFile();
+    if (!entry) { //End of files
+      rebootEspWithReason("Could not find valid firmware, please validate");
+    }
+
+    //This block of code parses the file name to make sure it is valid.
+    //It will also get the role and hardware the firmware is targeted at.
+    if (!entry.isDirectory()) {
+      TSTRING name = entry.name();
+      if (name.length() > 1 && name.indexOf('_') != -1 &&
+          name.indexOf('_') != name.lastIndexOf('_') &&
+          name.indexOf('.') != -1) {
+        TSTRING firmware = name.substring(1, name.indexOf('_'));
+        TSTRING hardware =
+            name.substring(name.indexOf('_') + 1, name.lastIndexOf('_'));
+        TSTRING role =
+            name.substring(name.lastIndexOf('_') + 1, name.indexOf('.'));
+        TSTRING extension =
+            name.substring(name.indexOf('.') + 1, name.length());
+        if (firmware.equals("firmware") &&
+            (hardware.equals("ESP8266") || hardware.equals("ESP32")) &&
+            extension.equals("bin")) {
+
+          Serial.println("OTA FIRMWARE FOUND, NOW BROADCASTING");
+
+          //This is the important bit for OTA, up to now was just getting the file. 
+          //If you are using some other way to upload firmware, possibly from 
+          //mqtt or something, this is what needs to be changed.
+          //This function could also be changed to support OTA of multiple files
+          //at the same time, potentially through using the pkg.md5 as a key in
+          //a map to determine which to send
+          mesh.initOTASend(
+              [&entry](painlessmesh::plugin::ota::DataRequest pkg,
+                       char* buffer) {
+                
+                //fill the buffer with the requested data packet from the node.
+                entry.seek(OTA_PART_SIZE * pkg.partNo);
+                entry.readBytes(buffer, OTA_PART_SIZE);
+                
+                //The buffer can hold OTA_PART_SIZE bytes, but the last packet may
+                //not be that long. Return the actual size of the packet.
+                return min((unsigned)OTA_PART_SIZE,
+                           entry.size() - (OTA_PART_SIZE * pkg.partNo));
+              },
+              OTA_PART_SIZE);
+
+          //Calculate the MD5 hash of the firmware we are trying to send. This will be used
+          //to validate the firmware as well as tell if a node needs this firmware.
+          MD5Builder md5;
+          md5.begin();
+          md5.addStream(entry, entry.size());
+          md5.calculate(); 
+
+          //Make it known to the network that there is OTA firmware available.
+          //This will send a message every minute for an hour letting nodes know
+          //that firmware is available.
+          //This returns a task that allows you to do things on disable or more,
+          //like closing your files or whatever.
+          
+          // Phase 1 Enhancement: To enable compressed OTA (40-60% bandwidth reduction),
+          // add two additional parameters: broadcasted and compressed flags:
+          // mesh.offerOTA(role, hardware, md5.toString(),
+          //               ceil(((float)entry.size()) / OTA_PART_SIZE), 
+          //               false,  // forced
+          //               false,  // broadcasted (Phase 2 feature)
+          //               true);  // compressed (Phase 1 feature - 40-60% savings!)
+          
+          mesh.offerOTA(role, hardware, md5.toString(),
+                        ceil(((float)entry.size()) / OTA_PART_SIZE), false);
+
+          while (true) {
+            //This program will not reach loop() so we dont have to worry about
+            //file scope.
+            mesh.update();
+            delay(1000);
+          }
+        }
+      }
+    }
+  }
+}
+
+void rebootEspWithReason(String reason) {
+  Serial.println(reason);
+  delay(1000);
+  ESP.restart();
+}
+
+void loop(){};

package/examples/otaSender/platformio.ini

@@ -1,25 +1,25 @@
-[platformio]
-src_dir = .
-
-[env]
-lib_deps =
-    bblanchon/ArduinoJson
-    arkhipenko/TaskScheduler
-
-[env:esp8266]
-platform = espressif8266
-board = nodemcuv2
-framework = arduino
-lib_extra_dirs = ../../
-lib_deps =
-    ${env.lib_deps}  ; Inherit common dependencies
-    esp32async/ESPAsyncTCP@^2.0.0  ; Only for ESP8266
-
-[env:esp32]
-platform = espressif32
-board = esp32dev
-framework = arduino
-lib_extra_dirs = ../../
-lib_deps =
-    ${env.lib_deps}  ; Inherit common dependencies
-    esp32async/AsyncTCP
+[platformio]
+src_dir = .
+
+[env]
+lib_deps =
+    bblanchon/ArduinoJson
+    arkhipenko/TaskScheduler
+
+[env:esp8266]
+platform = espressif8266
+board = nodemcuv2
+framework = arduino
+lib_extra_dirs = ../../
+lib_deps =
+    ${env.lib_deps}  ; Inherit common dependencies
+    esp32async/ESPAsyncTCP@^2.0.0  ; Only for ESP8266
+
+[env:esp32]
+platform = espressif32
+board = esp32dev
+framework = arduino
+lib_extra_dirs = ../../
+lib_deps =
+    ${env.lib_deps}  ; Inherit common dependencies
+    esp32async/AsyncTCP

package/examples/startHere/platformio.ini

@@ -1,25 +1,25 @@
-[platformio]
-src_dir = .
-
-[env]
-lib_deps =
-    bblanchon/ArduinoJson
-    arkhipenko/TaskScheduler
-
-[env:esp8266]
-platform = espressif8266
-board = nodemcuv2
-framework = arduino
-lib_extra_dirs = ../../  ; Load the local copy of painlessmesh. For your own example add painlessmesh to the lib_deps
-lib_deps =
-    ${env.lib_deps}  ; Inherit common dependencies
-    esp32async/ESPAsyncTCP  ; Only for ESP8266
-
-[env:esp32]
-platform = espressif32
-board = esp32dev
-framework = arduino
-lib_extra_dirs = ../../  ; Load the local copy of painlessmesh. For your own example add painlessmesh to the lib_deps
-lib_deps =
-    ${env.lib_deps}  ; Inherit common dependencies
-    esp32async/AsyncTCP
+[platformio]
+src_dir = .
+
+[env]
+lib_deps =
+    bblanchon/ArduinoJson
+    arkhipenko/TaskScheduler
+
+[env:esp8266]
+platform = espressif8266
+board = nodemcuv2
+framework = arduino
+lib_extra_dirs = ../../  ; Load the local copy of painlessmesh. For your own example add painlessmesh to the lib_deps
+lib_deps =
+    ${env.lib_deps}  ; Inherit common dependencies
+    esp32async/ESPAsyncTCP  ; Only for ESP8266
+
+[env:esp32]
+platform = espressif32
+board = esp32dev
+framework = arduino
+lib_extra_dirs = ../../  ; Load the local copy of painlessmesh. For your own example add painlessmesh to the lib_deps
+lib_deps =
+    ${env.lib_deps}  ; Inherit common dependencies
+    esp32async/AsyncTCP