@alteriom/painlessmesh 1.6.1 → 1.7.3

package/src/painlessMesh.h

@@ -1,70 +1,70 @@
-#ifndef _EASY_MESH_H_
-#define _EASY_MESH_H_
-
-#include "painlessTaskOptions.h"
-
-#include <Arduino.h>
-#include <functional>
-#include <list>
-#include <memory>
-#include "painlessmesh/configuration.hpp"
-#ifdef ESP32
-#include <AsyncTCP.h>
-#include <WiFi.h>
-#if ESP_ARDUINO_VERSION_MAJOR >= 3
-#include "esp_mac.h"  // required for core 3.x - exposes esp_mac_type_t values
-#endif
-#elif defined(ESP8266)
-#include <ESP8266WiFi.h>
-#include <ESPAsyncTCP.h>
-#endif  // ESP32
-
-#ifdef PAINLESSMESH_ENABLE_ARDUINO_WIFI
-#include "painlessMeshSTA.h"
-
-#include "arduino/wifi.hpp"
-#endif
-
-#ifdef PAINLESSMESH_ENABLE_OTA
-#include "painlessmesh/ota.hpp"
-#endif
-
-// Include improvement modules when enabled
-#ifdef PAINLESSMESH_ENABLE_VALIDATION
-#include "painlessmesh/validation.hpp"
-#endif
-
-#ifdef PAINLESSMESH_ENABLE_METRICS
-#include "painlessmesh/metrics.hpp"
-#endif
-
-#ifdef PAINLESSMESH_ENABLE_MEMORY_OPTIMIZATION
-#include "painlessmesh/memory.hpp"
-#endif
-
-#include "painlessmesh/buffer.hpp"
-#include "painlessmesh/layout.hpp"
-#include "painlessmesh/logger.hpp"
-#include "painlessmesh/mesh.hpp"
-#include "painlessmesh/ntp.hpp"
-#include "painlessmesh/plugin.hpp"
-#include "painlessmesh/protocol.hpp"
-#include "painlessmesh/router.hpp"
-#include "painlessmesh/tcp.hpp"
-using namespace painlessmesh::logger;
-
-/*! \mainpage painlessMesh: A painless way to setup a mesh.
- *
- * painlessMesh is designed in a modular way, with many parent classes. The best
- * place to get started with the documentation is to have a look at
- * painlessmesh::wifi::Mesh (the main painlessMesh class is an alias (typedef)
- * of the painlessmesh::wifi::Mesh class). Make sure to also explore the public
- * member functions inherited from other classes, to get full information on the
- * functions available to you.
- */
-
-#ifndef PAINLESSMESH_ENABLE_ARDUINO_WIFI
-using painlessMesh = painlessmesh::Mesh<Connection>;
-#endif
-
-#endif  //   _EASY_MESH_H_
+#ifndef _EASY_MESH_H_
+#define _EASY_MESH_H_
+
+#include "painlessTaskOptions.h"
+
+#include <Arduino.h>
+#include <functional>
+#include <list>
+#include <memory>
+#include "painlessmesh/configuration.hpp"
+#ifdef ESP32
+#include <AsyncTCP.h>
+#include <WiFi.h>
+#if ESP_ARDUINO_VERSION_MAJOR >= 3
+#include "esp_mac.h"  // required for core 3.x - exposes esp_mac_type_t values
+#endif
+#elif defined(ESP8266)
+#include <ESP8266WiFi.h>
+#include <ESPAsyncTCP.h>
+#endif  // ESP32
+
+#ifdef PAINLESSMESH_ENABLE_ARDUINO_WIFI
+#include "painlessMeshSTA.h"
+
+#include "arduino/wifi.hpp"
+#endif
+
+#ifdef PAINLESSMESH_ENABLE_OTA
+#include "painlessmesh/ota.hpp"
+#endif
+
+// Include improvement modules when enabled
+#ifdef PAINLESSMESH_ENABLE_VALIDATION
+#include "painlessmesh/validation.hpp"
+#endif
+
+#ifdef PAINLESSMESH_ENABLE_METRICS
+#include "painlessmesh/metrics.hpp"
+#endif
+
+#ifdef PAINLESSMESH_ENABLE_MEMORY_OPTIMIZATION
+#include "painlessmesh/memory.hpp"
+#endif
+
+#include "painlessmesh/buffer.hpp"
+#include "painlessmesh/layout.hpp"
+#include "painlessmesh/logger.hpp"
+#include "painlessmesh/mesh.hpp"
+#include "painlessmesh/ntp.hpp"
+#include "painlessmesh/plugin.hpp"
+#include "painlessmesh/protocol.hpp"
+#include "painlessmesh/router.hpp"
+#include "painlessmesh/tcp.hpp"
+using namespace painlessmesh::logger;
+
+/*! \mainpage painlessMesh: A painless way to setup a mesh.
+ *
+ * painlessMesh is designed in a modular way, with many parent classes. The best
+ * place to get started with the documentation is to have a look at
+ * painlessmesh::wifi::Mesh (the main painlessMesh class is an alias (typedef)
+ * of the painlessmesh::wifi::Mesh class). Make sure to also explore the public
+ * member functions inherited from other classes, to get full information on the
+ * functions available to you.
+ */
+
+#ifndef PAINLESSMESH_ENABLE_ARDUINO_WIFI
+using painlessMesh = painlessmesh::Mesh<Connection>;
+#endif
+
+#endif  //   _EASY_MESH_H_

package/src/painlessMeshSTA.cpp

@@ -1,236 +1,236 @@
-//
-//  painlessMeshSTA.cpp
-//
-//
-//  Created by Bill Gray on 7/26/16.
-//
-//
-#include "painlessmesh/configuration.hpp"
-
-#ifdef PAINLESSMESH_ENABLE_ARDUINO_WIFI
-
-#include <Arduino.h>
-#include <algorithm>
-#include <memory>
-
-#include "arduino/wifi.hpp"
-
-#include "painlessmesh/layout.hpp"
-#include "painlessmesh/tcp.hpp"
-
-extern painlessmesh::logger::LogClass Log;
-
-//***********************************************************************
-// Calculate NodeID from a hardware MAC address
-void ICACHE_FLASH_ATTR StationScan::init(painlessmesh::wifi::Mesh *pMesh,
-                                         TSTRING pssid, TSTRING ppassword,
-                                         uint16_t pport, uint8_t pchannel,
-                                         bool phidden) {
-  ssid = pssid;
-  password = ppassword;
-  mesh = pMesh;
-  port = pport;
-  channel = pchannel;
-  hidden = phidden;
-
-  task.set(SCAN_INTERVAL, TASK_FOREVER, [this]() { stationScan(); });
-}
-
-// Starts scan for APs whose name is Mesh SSID
-void ICACHE_FLASH_ATTR StationScan::stationScan() {
-  using namespace painlessmesh::logger;
-  Log(CONNECTION, "stationScan(): %s\n", ssid.c_str());
-
-#ifdef ESP32
-  WiFi.scanNetworks(true, hidden, false, 300U, channel);
-#elif defined(ESP8266)
-  // WiFi.scanNetworksAsync([&](int networks) { this->scanComplete(); }, true);
-  // Try 600 times (60 seconds). If not completed after that, give up
-  asyncTask.set(100 * TASK_MILLISECOND, 600, [this]() {
-    auto num = WiFi.scanComplete();
-    if (num == WIFI_SCAN_FAILED || num > 0) {
-      this->asyncTask.disable();
-      this->scanComplete();
-    }
-  });
-  mesh->mScheduler->addTask(asyncTask);
-  asyncTask.enableDelayed();
-  WiFi.scanNetworks(true, hidden, channel);
-#endif
-
-  task.delay(10 * SCAN_INTERVAL);  // Scan should be completed by then and next
-                                   // step called. If not then we restart here.
-  return;
-}
-
-void ICACHE_FLASH_ATTR StationScan::scanComplete() {
-  using namespace painlessmesh::logger;
-  Log(CONNECTION, "scanComplete(): Scan finished\n");
-
-  aps.clear();
-  Log(CONNECTION, "scanComplete():-- > Cleared old APs.\n");
-
-  auto num = WiFi.scanComplete();
-  if (num == WIFI_SCAN_FAILED) {
-    Log(ERROR, "wifi scan failed. Retrying....\n");
-    task.forceNextIteration();
-    return;
-  } else if (num == WIFI_SCAN_RUNNING) {
-    Log(ERROR,
-        "scanComplete should never be called when scan is still running.\n");
-    return;
-  }
-
-  Log(CONNECTION, "scanComplete(): num = %d\n", num);
-
-  for (auto i = 0; i < num; ++i) {
-    WiFi_AP_Record_t record;
-    record.ssid = WiFi.SSID(i);
-
-    if (WiFi.channel(i) != mesh->_meshChannel) {
-      continue;
-    }
-
-    if (record.ssid != ssid) {
-      if (record.ssid.equals("") && mesh->_meshHidden) {
-        // Hidden mesh
-        record.ssid = ssid;
-      } else {
-        continue;
-      }
-    }
-
-    record.rssi = WiFi.RSSI(i);
-    if (record.rssi == 0) continue;
-
-    memcpy((void *)&record.bssid, (void *)WiFi.BSSID(i), sizeof(record.bssid));
-    aps.push_back(record);
-    Log(CONNECTION, "\tfound : %s, %ddBm\n", record.ssid.c_str(),
-        (int16_t)record.rssi);
-  }
-
-  Log(CONNECTION, "\tFound %d nodes\n", aps.size());
-
-  task.yield([this]() {
-    // Task filter all unknown
-    filterAPs();
-
-    lastAPs = aps;
-
-    // Next task is to sort by strength
-    task.yield([this] {
-      aps.sort([](WiFi_AP_Record_t a, WiFi_AP_Record_t b) {
-        return a.rssi > b.rssi;
-      });
-      // Next task is to connect to the top ap
-      task.yield([this]() { connectToAP(); });
-    });
-  });
-}
-
-void ICACHE_FLASH_ATTR StationScan::filterAPs() {
-  auto ap = aps.begin();
-  while (ap != aps.end()) {
-    auto apNodeId = painlessmesh::tcp::encodeNodeId(ap->bssid);
-    if (painlessmesh::router::findRoute<painlessmesh::Connection>(
-            (*mesh), apNodeId) != NULL) {
-      ap = aps.erase(ap);
-    } else {
-      ap++;
-    }
-  }
-}
-
-void ICACHE_FLASH_ATTR StationScan::requestIP(WiFi_AP_Record_t &ap) {
-  using namespace painlessmesh::logger;
-  Log(CONNECTION, "connectToAP(): Best AP is %u<---\n",
-      painlessmesh::tcp::encodeNodeId(ap.bssid));
-  WiFi.begin(ap.ssid.c_str(), password.c_str(), mesh->_meshChannel, ap.bssid);
-  return;
-}
-
-void ICACHE_FLASH_ATTR StationScan::connectToAP() {
-  using namespace painlessmesh;
-  using namespace painlessmesh::logger;
-  // Next task will be to rescan
-  task.setCallback([this]() { stationScan(); });
-
-  if (manual) {
-    if ((WiFi.SSID() == ssid) && WiFi.status() == WL_CONNECTED) {
-      Log(CONNECTION,
-          "connectToAP(): Already connected using manual connection. "
-          "Disabling scanning.\n");
-      task.disable();
-      return;
-    } else {
-      if (WiFi.status() == WL_CONNECTED) {
-        Log.remote("Close Sta because trying to connect manually\n");
-        mesh->closeConnectionSTA();
-        task.enableDelayed(10 * SCAN_INTERVAL);
-        return;
-      } else if (aps.empty() || !ssid.equals(aps.begin()->ssid)) {
-        task.enableDelayed(SCAN_INTERVAL);
-        return;
-      }
-    }
-  }
-  bool isRooted = layout::isRooted(mesh->asNodeTree());
-  if (aps.empty()) {
-    // No unknown nodes found
-    if (WiFi.status() == WL_CONNECTED &&
-        !(mesh->shouldContainRoot && !isRooted)) {
-      // if already connected -> scan slow
-      Log(CONNECTION,
-          "connectToAP(): Already connected, and no unknown nodes found: "
-          "scan rate set to slow\n");
-      task.delay(4 * SCAN_INTERVAL);
-    } else {
-      // else scan fast (SCAN_INTERVAL)
-      Log(CONNECTION,
-          "connectToAP(): No unknown nodes found scan rate set to "
-          "fast\n");
-      task.setInterval(0.5 * SCAN_INTERVAL);
-    }
-    mesh->stability += min(1000 - mesh->stability, (size_t)25);
-  } else {
-    if (WiFi.status() == WL_CONNECTED) {
-      // TODO: Use %u instead of String() here and below
-      // Also prob is always equal to stability, so we should use that directly
-      Log(CONNECTION,
-          "connectToAP(): Unknown nodes found. Current stability: %s\n",
-          String(mesh->stability).c_str());
-
-      int prob = mesh->stability;
-      if (!isRooted && random(0, 1000) < prob) {
-        Log(CONNECTION, "connectToAP(): Reconfigure network: %s\n",
-            String(prob).c_str());
-        // close STA connection, this will trigger station disconnect which
-        // will trigger connectToAP()
-        mesh->closeConnectionSTA();
-        mesh->stability = 0;  // Discourage switching again
-        Log.remote("Close Sta to reconfigure network\n");
-        // wifiEventCB should be triggered before this delay runs out
-        // and reset the connecting
-        task.delay(4 * SCAN_INTERVAL);
-      } else {
-        if (!isRooted && mesh->shouldContainRoot)
-          // Increase scanning rate, because we want to find root
-          task.delay(0.5 * SCAN_INTERVAL);
-        else
-          task.delay(4 * SCAN_INTERVAL);
-      }
-    } else {
-      // Else try to connect to first
-      auto ap = aps.front();
-      aps.pop_front();  // drop bestAP from mesh list, so if doesn't work out,
-                        // we can try the next one
-      requestIP(ap);
-      // Trying to connect, if that fails we will reconnect later
-      Log(CONNECTION,
-          "connectToAP(): Trying to connect, scan rate set to "
-          "4*normal\n");
-      task.delay(4 * SCAN_INTERVAL);
-    }
-  }
-}
-#endif
+//
+//  painlessMeshSTA.cpp
+//
+//
+//  Created by Bill Gray on 7/26/16.
+//
+//
+#include "painlessmesh/configuration.hpp"
+
+#ifdef PAINLESSMESH_ENABLE_ARDUINO_WIFI
+
+#include <Arduino.h>
+#include <algorithm>
+#include <memory>
+
+#include "arduino/wifi.hpp"
+
+#include "painlessmesh/layout.hpp"
+#include "painlessmesh/tcp.hpp"
+
+extern painlessmesh::logger::LogClass Log;
+
+//***********************************************************************
+// Calculate NodeID from a hardware MAC address
+void ICACHE_FLASH_ATTR StationScan::init(painlessmesh::wifi::Mesh *pMesh,
+                                         TSTRING pssid, TSTRING ppassword,
+                                         uint16_t pport, uint8_t pchannel,
+                                         bool phidden) {
+  ssid = pssid;
+  password = ppassword;
+  mesh = pMesh;
+  port = pport;
+  channel = pchannel;
+  hidden = phidden;
+
+  task.set(SCAN_INTERVAL, TASK_FOREVER, [this]() { stationScan(); });
+}
+
+// Starts scan for APs whose name is Mesh SSID
+void ICACHE_FLASH_ATTR StationScan::stationScan() {
+  using namespace painlessmesh::logger;
+  Log(CONNECTION, "stationScan(): %s\n", ssid.c_str());
+
+#ifdef ESP32
+  WiFi.scanNetworks(true, hidden, false, 300U, channel);
+#elif defined(ESP8266)
+  // WiFi.scanNetworksAsync([&](int networks) { this->scanComplete(); }, true);
+  // Try 600 times (60 seconds). If not completed after that, give up
+  asyncTask.set(100 * TASK_MILLISECOND, 600, [this]() {
+    auto num = WiFi.scanComplete();
+    if (num == WIFI_SCAN_FAILED || num > 0) {
+      this->asyncTask.disable();
+      this->scanComplete();
+    }
+  });
+  mesh->mScheduler->addTask(asyncTask);
+  asyncTask.enableDelayed();
+  WiFi.scanNetworks(true, hidden, channel);
+#endif
+
+  task.delay(10 * SCAN_INTERVAL);  // Scan should be completed by then and next
+                                   // step called. If not then we restart here.
+  return;
+}
+
+void ICACHE_FLASH_ATTR StationScan::scanComplete() {
+  using namespace painlessmesh::logger;
+  Log(CONNECTION, "scanComplete(): Scan finished\n");
+
+  aps.clear();
+  Log(CONNECTION, "scanComplete():-- > Cleared old APs.\n");
+
+  auto num = WiFi.scanComplete();
+  if (num == WIFI_SCAN_FAILED) {
+    Log(ERROR, "wifi scan failed. Retrying....\n");
+    task.forceNextIteration();
+    return;
+  } else if (num == WIFI_SCAN_RUNNING) {
+    Log(ERROR,
+        "scanComplete should never be called when scan is still running.\n");
+    return;
+  }
+
+  Log(CONNECTION, "scanComplete(): num = %d\n", num);
+
+  for (auto i = 0; i < num; ++i) {
+    WiFi_AP_Record_t record;
+    record.ssid = WiFi.SSID(i);
+
+    if (WiFi.channel(i) != mesh->_meshChannel) {
+      continue;
+    }
+
+    if (record.ssid != ssid) {
+      if (record.ssid.equals("") && mesh->_meshHidden) {
+        // Hidden mesh
+        record.ssid = ssid;
+      } else {
+        continue;
+      }
+    }
+
+    record.rssi = WiFi.RSSI(i);
+    if (record.rssi == 0) continue;
+
+    memcpy((void *)&record.bssid, (void *)WiFi.BSSID(i), sizeof(record.bssid));
+    aps.push_back(record);
+    Log(CONNECTION, "\tfound : %s, %ddBm\n", record.ssid.c_str(),
+        (int16_t)record.rssi);
+  }
+
+  Log(CONNECTION, "\tFound %d nodes\n", aps.size());
+
+  task.yield([this]() {
+    // Task filter all unknown
+    filterAPs();
+
+    lastAPs = aps;
+
+    // Next task is to sort by strength
+    task.yield([this] {
+      aps.sort([](WiFi_AP_Record_t a, WiFi_AP_Record_t b) {
+        return a.rssi > b.rssi;
+      });
+      // Next task is to connect to the top ap
+      task.yield([this]() { connectToAP(); });
+    });
+  });
+}
+
+void ICACHE_FLASH_ATTR StationScan::filterAPs() {
+  auto ap = aps.begin();
+  while (ap != aps.end()) {
+    auto apNodeId = painlessmesh::tcp::encodeNodeId(ap->bssid);
+    if (painlessmesh::router::findRoute<painlessmesh::Connection>(
+            (*mesh), apNodeId) != NULL) {
+      ap = aps.erase(ap);
+    } else {
+      ap++;
+    }
+  }
+}
+
+void ICACHE_FLASH_ATTR StationScan::requestIP(WiFi_AP_Record_t &ap) {
+  using namespace painlessmesh::logger;
+  Log(CONNECTION, "connectToAP(): Best AP is %u<---\n",
+      painlessmesh::tcp::encodeNodeId(ap.bssid));
+  WiFi.begin(ap.ssid.c_str(), password.c_str(), mesh->_meshChannel, ap.bssid);
+  return;
+}
+
+void ICACHE_FLASH_ATTR StationScan::connectToAP() {
+  using namespace painlessmesh;
+  using namespace painlessmesh::logger;
+  // Next task will be to rescan
+  task.setCallback([this]() { stationScan(); });
+
+  if (manual) {
+    if ((WiFi.SSID() == ssid) && WiFi.status() == WL_CONNECTED) {
+      Log(CONNECTION,
+          "connectToAP(): Already connected using manual connection. "
+          "Disabling scanning.\n");
+      task.disable();
+      return;
+    } else {
+      if (WiFi.status() == WL_CONNECTED) {
+        Log.remote("Close Sta because trying to connect manually\n");
+        mesh->closeConnectionSTA();
+        task.enableDelayed(10 * SCAN_INTERVAL);
+        return;
+      } else if (aps.empty() || !ssid.equals(aps.begin()->ssid)) {
+        task.enableDelayed(SCAN_INTERVAL);
+        return;
+      }
+    }
+  }
+  bool isRooted = layout::isRooted(mesh->asNodeTree());
+  if (aps.empty()) {
+    // No unknown nodes found
+    if (WiFi.status() == WL_CONNECTED &&
+        !(mesh->shouldContainRoot && !isRooted)) {
+      // if already connected -> scan slow
+      Log(CONNECTION,
+          "connectToAP(): Already connected, and no unknown nodes found: "
+          "scan rate set to slow\n");
+      task.delay(4 * SCAN_INTERVAL);
+    } else {
+      // else scan fast (SCAN_INTERVAL)
+      Log(CONNECTION,
+          "connectToAP(): No unknown nodes found scan rate set to "
+          "fast\n");
+      task.setInterval(0.5 * SCAN_INTERVAL);
+    }
+    mesh->stability += min(1000 - mesh->stability, (size_t)25);
+  } else {
+    if (WiFi.status() == WL_CONNECTED) {
+      // TODO: Use %u instead of String() here and below
+      // Also prob is always equal to stability, so we should use that directly
+      Log(CONNECTION,
+          "connectToAP(): Unknown nodes found. Current stability: %s\n",
+          String(mesh->stability).c_str());
+
+      int prob = mesh->stability;
+      if (!isRooted && random(0, 1000) < prob) {
+        Log(CONNECTION, "connectToAP(): Reconfigure network: %s\n",
+            String(prob).c_str());
+        // close STA connection, this will trigger station disconnect which
+        // will trigger connectToAP()
+        mesh->closeConnectionSTA();
+        mesh->stability = 0;  // Discourage switching again
+        Log.remote("Close Sta to reconfigure network\n");
+        // wifiEventCB should be triggered before this delay runs out
+        // and reset the connecting
+        task.delay(4 * SCAN_INTERVAL);
+      } else {
+        if (!isRooted && mesh->shouldContainRoot)
+          // Increase scanning rate, because we want to find root
+          task.delay(0.5 * SCAN_INTERVAL);
+        else
+          task.delay(4 * SCAN_INTERVAL);
+      }
+    } else {
+      // Else try to connect to first
+      auto ap = aps.front();
+      aps.pop_front();  // drop bestAP from mesh list, so if doesn't work out,
+                        // we can try the next one
+      requestIP(ap);
+      // Trying to connect, if that fails we will reconnect later
+      Log(CONNECTION,
+          "connectToAP(): Trying to connect, scan rate set to "
+          "4*normal\n");
+      task.delay(4 * SCAN_INTERVAL);
+    }
+  }
+}
+#endif