Skip to content

Fix heap memory leak and reporting of saved Wi-Fi networks #676

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
JanPetterMG merged 16 commits into from
Jun 27, 2026
Merged

Fix heap memory leak and reporting of saved Wi-Fi networks #676

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
16 commits
Select commit Hold shift + click to select a range
22e6e28
Various bug fixes and connectovity-scoped refactor.
JanPetterMG Jun 23, 2026
10b7bea
Re-add nolint comment
JanPetterMG Jun 23, 2026
2c2e843
Refactor IP address terminal print
JanPetterMG Jun 23, 2026
6f521f5
Refactor IPv4 and IPv6 logging in ConnectivityService for improved cl…
JanPetterMG Jun 23, 2026
9b2502c
Adjust clang nolint comments
JanPetterMG Jun 24, 2026
a28e058
More clang nolint comment adjustments
JanPetterMG Jun 24, 2026
1b238de
Re-add hicpp-vararg
JanPetterMG Jun 24, 2026
bbe98c3
Add nolint misc-unused-parameters comment to false positive
JanPetterMG Jun 24, 2026
eccc208
Refactor NVS open calls to use data() for string handling and improve…
JanPetterMG Jun 24, 2026
73ade37
Refactor ConnectivityService event handlers to simplify parameters an…
JanPetterMG Jun 24, 2026
4b4fc5e
Revert most recent changes
JanPetterMG Jun 25, 2026
da3394c
Merge branch 'main' into fix/connectivity-various-fixes-and-refactor
JanPetterMG Jun 26, 2026
9e586be
Refactored events
JanPetterMG Jun 26, 2026
e8401b4
Refactor IP assembly
JanPetterMG Jun 26, 2026
faa4ff8
Mechanical refactor of onRoutable()
JanPetterMG Jun 26, 2026
419b138
Add missing #endif comment
JanPetterMG Jun 26, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 9 additions & 9 deletions firmware/include/services/ConnectivityService.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,11 +12,11 @@ class ConnectivityService final : public ServiceModule
private:
explicit ConnectivityService() : ServiceModule("Connectivity") {};

bool mDNS = false;
bool pending = false;
bool routable = false;
bool mdns{false};
bool pending{false};
bool routable{false};

unsigned long lastMillis = 0;
unsigned long lastMillis{0UL};

std::unique_ptr<DNSServer> dns{};

Expand All @@ -27,12 +27,12 @@ class ConnectivityService final : public ServiceModule
void connect(const char *ssid, const char *key);
void transmit();

static void onConnected(WiFiEvent_t event, WiFiEventInfo_t info);
static void onDisconnected(WiFiEvent_t event, WiFiEventInfo_t info);
static void onIPv4(WiFiEvent_t event, WiFiEventInfo_t info);
static void onIPv6(WiFiEvent_t event, WiFiEventInfo_t info);
static void onConnected(arduino_event_id_t event);
static void onDisconnected(arduino_event_id_t event, arduino_event_info_t info);
static void onIPv4(arduino_event_id_t event, arduino_event_info_t info);
static void onIPv6(arduino_event_id_t event, arduino_event_info_t info);
static void onRoutable();
static void onScan(WiFiEvent_t event, WiFiEventInfo_t info);
static void onScan(arduino_event_id_t event);

public:
void configure();
Expand Down
196 changes: 97 additions & 99 deletions firmware/src/services/ConnectivityService.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,28 +20,24 @@ void ConnectivityService::configure()
WiFiClass::setHostname(HOSTNAME);
WiFiClass::mode(wifi_mode_t::WIFI_MODE_STA);
WiFi.enableIPv6();
WiFi.onEvent(&onConnected, WiFiEvent_t::ARDUINO_EVENT_WIFI_STA_CONNECTED);
WiFi.onEvent(&onDisconnected, WiFiEvent_t::ARDUINO_EVENT_WIFI_STA_DISCONNECTED);
WiFi.onEvent(&onIPv4, WiFiEvent_t::ARDUINO_EVENT_WIFI_STA_GOT_IP);
WiFi.onEvent(&onIPv6, WiFiEvent_t::ARDUINO_EVENT_WIFI_STA_GOT_IP6);
WiFi.onEvent(&onScan, WiFiEvent_t::ARDUINO_EVENT_WIFI_SCAN_DONE);
WiFi.onEvent(&onConnected, arduino_event_id_t::ARDUINO_EVENT_WIFI_STA_CONNECTED);
WiFi.onEvent(&onDisconnected, arduino_event_id_t::ARDUINO_EVENT_WIFI_STA_DISCONNECTED);
WiFi.onEvent(&onIPv4, arduino_event_id_t::ARDUINO_EVENT_WIFI_STA_GOT_IP);
WiFi.onEvent(&onIPv6, arduino_event_id_t::ARDUINO_EVENT_WIFI_STA_GOT_IP6);
WiFi.onEvent(&onScan, arduino_event_id_t::ARDUINO_EVENT_WIFI_SCAN_DONE);
#ifdef WIFI_COUNTRY
esp_wifi_set_country_code(WIFI_COUNTRY, false);
#else
nvs_handle_t handle{};
if (nvs_open(std::string(name).c_str(), nvs_open_mode_t::NVS_READONLY, &handle) == ESP_OK)
if (nvs_open(name.data(), nvs_open_mode_t::NVS_READONLY, &handle) == ESP_OK)
{
std::array<char, 3> country{};
size_t len{country.size()}; // NOLINT(cppcoreguidelines-init-variables)
if (nvs_get_str(handle, "country", country.data(), &len) == ESP_OK)
std::array<char, 3U> country{};
size_t length{country.size()}; // NOLINT(cppcoreguidelines-init-variables)
if (nvs_get_str(handle, "country", country.data(), &length) == ESP_OK && length == country.size())
{
nvs_close(handle);
esp_wifi_set_country_code(country.data(), true);
}
else
{
nvs_close(handle);
}
nvs_close(handle);
}
#endif // WIFI_COUNTRY
#if defined(PIN_SW1) || defined(PIN_SW2)
Expand Down Expand Up @@ -88,47 +84,43 @@ void ConnectivityService::initStation()
{
JsonDocument doc; // NOLINT(misc-const-correctness)
nvs_handle_t handle{};
if (nvs_open(std::string(name).c_str(), nvs_open_mode_t::NVS_READONLY, &handle) == ESP_OK)
if (nvs_open(name.data(), nvs_open_mode_t::NVS_READONLY, &handle) == ESP_OK)
{
size_t _len{0};
if (nvs_get_blob(handle, "Wi-Fi", nullptr, &_len) == ESP_OK && _len > 0)
size_t _length{0U};
if (nvs_get_blob(handle, "Wi-Fi", nullptr, &_length) == ESP_OK && _length != 0U)
{
std::vector<char> _buffer(_len);
if (nvs_get_blob(handle, "Wi-Fi", _buffer.data(), &_len) == ESP_OK)
{
nvs_close(handle);
deserializeJson(doc, _buffer.data(), _len);
}
else
std::vector<char> _buffer(_length);
if (nvs_get_blob(handle, "Wi-Fi", _buffer.data(), &_length) == ESP_OK)
{
nvs_close(handle);
deserializeJson(doc, _buffer.data(), _length);
}
}
nvs_close(handle);
}
wifi_config_t config;
if (esp_wifi_get_config(wifi_interface_t::WIFI_IF_STA, &config) == ESP_OK)
{
// NOLINTNEXTLINE(cppcoreguidelines-pro-type-reinterpret-cast)
const char *const ssid_ptr = reinterpret_cast<const char *>(config.sta.ssid);
const char *const ssid_ptr{reinterpret_cast<const char *>(config.sta.ssid)};
const std::string_view ssid(ssid_ptr, strnlen(ssid_ptr, sizeof(config.sta.ssid)));
if (!ssid.empty())
{
// NOLINTNEXTLINE(cppcoreguidelines-pro-type-reinterpret-cast)
const char *const key_ptr = reinterpret_cast<const char *>(config.sta.password);
const char *const key_ptr{reinterpret_cast<const char *>(config.sta.password)};
const std::string_view key(key_ptr, strnlen(key_ptr, sizeof(config.sta.password)));
doc[ssid] = key.length() ? key : nullptr;
doc[ssid].set(key.length() ? key : nullptr);
}
}
if (doc[WIFI_SSID].isUnbound())
{
doc[WIFI_SSID] = WIFI_KEY;
doc[WIFI_SSID].set(WIFI_KEY);
}
const size_t len = measureJson(doc);
std::vector<uint8_t> buffer(len + 1);
serializeJson(doc, reinterpret_cast<char *>(buffer.data()), len + 1);
if (nvs_open(std::string(name).c_str(), nvs_open_mode_t::NVS_READWRITE, &handle) == ESP_OK)
const size_t length{measureJson(doc) + 1U};
std::vector<char> buffer(length);
serializeJson(doc, reinterpret_cast<char *>(buffer.data()), length);
if (nvs_open(name.data(), nvs_open_mode_t::NVS_READWRITE, &handle) == ESP_OK)
{
nvs_set_blob(handle, "Wi-Fi", buffer.data(), len + 1);
nvs_set_blob(handle, "Wi-Fi", buffer.data(), length);
nvs_commit(handle);
nvs_close(handle);
}
Expand All @@ -148,7 +140,7 @@ void ConnectivityService::initHotspot()
{
dns = std::make_unique<DNSServer>();
dns->setErrorReplyCode(DNSReplyCode::NoError);
dns->start(53, "*", WiFi.softAPIP());
dns->start(53U, "*", WiFi.softAPIP());
}
#if EXTENSION_WEBAPP
// NOLINTNEXTLINE(cppcoreguidelines-pro-type-vararg,hicpp-vararg)
Expand All @@ -170,20 +162,19 @@ void ConnectivityService::connect(const char *ssid, const char *key) // NOLINT(b
multi.run();
}

void ConnectivityService::onConnected(WiFiEvent_t event, // NOLINT(misc-unused-parameters)
WiFiEventInfo_t info) // NOLINT(misc-unused-parameters)
void ConnectivityService::onConnected(arduino_event_id_t event) // NOLINT(misc-unused-parameters)
{
ESP_LOGD("Wi-Fi", "connected"); // NOLINT(cppcoreguidelines-pro-type-vararg,hicpp-vararg)
ESP_LOGV("Wi-Fi", "%d dBm", WiFi.RSSI()); // NOLINT(cppcoreguidelines-pro-type-vararg,hicpp-vararg)
ESP_LOGI("Wi-Fi", HOSTNAME ".local"); // NOLINT(cppcoreguidelines-pro-type-vararg,hicpp-vararg)
#ifndef WIFI_COUNTRY
nvs_handle_t handle{};
std::array<char, 3> country{};
std::array<char, 3U> country{};
if (esp_wifi_get_country_code(country.data()) == ESP_OK &&
nvs_open(Connectivity.name.data(), nvs_open_mode_t::NVS_READWRITE, &handle) == ESP_OK)
{
Comment thread
JanPetterMG marked this conversation as resolved.
if (strncmp(country.data(), "01", 2) == 0 ? nvs_erase_key(handle, "country") == ESP_OK
: nvs_set_str(handle, "country", country.data()) == ESP_OK)
if (strncmp(country.data(), "01", 2U) == 0 ? nvs_erase_key(handle, "country") == ESP_OK
: nvs_set_str(handle, "country", country.data()) == ESP_OK)
{
nvs_commit(handle);
}
Expand All @@ -192,85 +183,98 @@ void ConnectivityService::onConnected(WiFiEvent_t event, // NOLINT(misc-unuse
#endif // WIFI_COUNTRY
}

void ConnectivityService::onDisconnected(WiFiEvent_t event, // NOLINT(misc-unused-parameters)
WiFiEventInfo_t info)
void ConnectivityService::onDisconnected(arduino_event_id_t event, // NOLINT(misc-unused-parameters)
arduino_event_info_t info)
{
Connectivity.routable = false;
if (Connectivity.mDNS)
if (Connectivity.mdns)
{
MDNS.end();
Connectivity.mDNS = false;
Connectivity.mdns = false;
}
ESP_LOGI("Wi-Fi", "disconnected"); // NOLINT(cppcoreguidelines-pro-type-vararg,hicpp-vararg)
// NOLINTNEXTLINE(cppcoreguidelines-pro-type-vararg,hicpp-vararg)
ESP_LOGD(
"Wi-Fi", "%s", WiFi.disconnectReasonName(static_cast<wifi_err_reason_t>(info.wifi_sta_disconnected.reason)));
}

void ConnectivityService::onIPv4(WiFiEvent_t event, // NOLINT(misc-unused-parameters)
WiFiEventInfo_t info) // NOLINT(misc-unused-parameters)
void ConnectivityService::onIPv4(arduino_event_id_t event, // NOLINT(misc-unused-parameters)
arduino_event_info_t info)
{
// NOLINTNEXTLINE(cppcoreguidelines-pro-type-vararg,hicpp-vararg)
ESP_LOGI("Wi-Fi", "IPv4 %s", WiFi.localIP().toString().c_str());
if (!Connectivity.routable)
if (WiFi.STA.hasIP())
{
// NOLINTNEXTLINE(cppcoreguidelines-pro-type-vararg,hicpp-vararg)
ESP_LOGI("Wi-Fi",
"IPv4 %u.%u.%u.%u",
static_cast<unsigned>(info.got_ip.ip_info.ip.addr & 0xFFU),
static_cast<unsigned>((info.got_ip.ip_info.ip.addr >> 8U) & 0xFFU),
static_cast<unsigned>((info.got_ip.ip_info.ip.addr >> 16U) & 0xFFU),
static_cast<unsigned>((info.got_ip.ip_info.ip.addr >> 24U) & 0xFFU));
onRoutable();
}
}

void ConnectivityService::onIPv6(WiFiEvent_t event, // NOLINT(misc-unused-parameters)
WiFiEventInfo_t info) // NOLINT(misc-unused-parameters)
void ConnectivityService::onIPv6(arduino_event_id_t event, // NOLINT(misc-unused-parameters)
arduino_event_info_t info)
{
const char *const ipv6 = WiFi.globalIPv6().toString().c_str();
if (strcmp(ipv6, "") != 0)
if (WiFi.STA.hasGlobalIPv6())
{
ESP_LOGI("Wi-Fi", "IPv6 %s", ipv6); // NOLINT(cppcoreguidelines-pro-type-vararg,hicpp-vararg)
if (!Connectivity.routable)
{
onRoutable();
}
// NOLINTNEXTLINE(cppcoreguidelines-pro-type-vararg,hicpp-vararg)
ESP_LOGI("Wi-Fi",
"IPv6 %x:%x:%x:%x:%x:%x:%x:%x",
static_cast<unsigned>((__builtin_bswap32(info.got_ip6.ip6_info.ip.addr[0]) >> 16U) & 0xFFFFU),
static_cast<unsigned>(__builtin_bswap32(info.got_ip6.ip6_info.ip.addr[0]) & 0xFFFFU),
static_cast<unsigned>((__builtin_bswap32(info.got_ip6.ip6_info.ip.addr[1]) >> 16U) & 0xFFFFU),
static_cast<unsigned>(__builtin_bswap32(info.got_ip6.ip6_info.ip.addr[1]) & 0xFFFFU),
static_cast<unsigned>((__builtin_bswap32(info.got_ip6.ip6_info.ip.addr[2]) >> 16U) & 0xFFFFU),
static_cast<unsigned>(__builtin_bswap32(info.got_ip6.ip6_info.ip.addr[2]) & 0xFFFFU),
static_cast<unsigned>((__builtin_bswap32(info.got_ip6.ip6_info.ip.addr[3]) >> 16U) & 0xFFFFU),
static_cast<unsigned>(__builtin_bswap32(info.got_ip6.ip6_info.ip.addr[3]) & 0xFFFFU));
onRoutable();
}
}

void ConnectivityService::onRoutable()
{
Connectivity.routable = true;
if (WiFiClass::getMode() != wifi_mode_t::WIFI_MODE_STA)
{
JsonDocument doc; // NOLINT(misc-const-correctness)
doc["event"].set("connected");
Device.transmit(doc.as<JsonObjectConst>(), Connectivity.name, false);
ESP_LOGD("Wi-Fi", "terminating Wi-Fi hotspot"); // NOLINT(cppcoreguidelines-pro-type-vararg,hicpp-vararg)
Connectivity.dns.reset();
WiFiClass::mode(wifi_mode_t::WIFI_MODE_STA);
}
if (!Connectivity.mDNS && MDNS.begin(HOSTNAME))
if (!Connectivity.routable)
{
Connectivity.mDNS = true;
MDNS.setInstanceName(NAME);
Connectivity.routable = true;
if (WiFiClass::getMode() != wifi_mode_t::WIFI_MODE_STA)
{
JsonDocument doc; // NOLINT(misc-const-correctness)
doc["event"].set("connected");
Device.transmit(doc.as<JsonObjectConst>(), Connectivity.name, false);
ESP_LOGD("Wi-Fi", "terminating Wi-Fi hotspot"); // NOLINT(cppcoreguidelines-pro-type-vararg,hicpp-vararg)
Connectivity.dns.reset();
WiFiClass::mode(wifi_mode_t::WIFI_MODE_STA);
}
if (!Connectivity.mdns && MDNS.begin(HOSTNAME))
{
Connectivity.mdns = true;
MDNS.setInstanceName(NAME);
#if EXTENSION_ALEXA
AlexaExtension::onMdns();
AlexaExtension::onMdns();
#endif // EXTENSION_ALEXA
#if EXTENSION_RESTFUL || EXTENSION_WEBAPP
MDNS.addService("http", "tcp", 80);
#endif
MDNS.addService("http", "tcp", 80U);
#endif // EXTENSION_RESTFUL || EXTENSION_WEBAPP
#if EXTENSION_WEBSOCKET
MDNS.addService("ws", "tcp", 80);
MDNS.addService("ws", "tcp", 80U);
#endif // EXTENSION_WEBSOCKET
}
timeval tv{};
sntp_sync_time(&tv);
}
timeval tv{};
sntp_sync_time(&tv);
}

void ConnectivityService::onScan(WiFiEvent_t event, // NOLINT(misc-unused-parameters)
WiFiEventInfo_t info) // NOLINT(misc-unused-parameters)
void ConnectivityService::onScan(arduino_event_id_t event) // NOLINT(misc-unused-parameters)
{
const int16_t count = WiFi.scanComplete();
const int16_t count{WiFi.scanComplete()};
if (count > 0)
{
JsonDocument doc; // NOLINT(misc-const-correctness)
JsonArray scan{doc["scan"].to<JsonArray>()};
for (int16_t i = 0; i < count; ++i)
for (int16_t i{0}; i < count; ++i)
{
JsonObject _scan{scan.add<JsonObject>()};
_scan["encrypted"].set(WiFi.encryptionType(i) != wifi_auth_mode_t::WIFI_AUTH_OPEN);
Expand All @@ -288,30 +292,24 @@ void ConnectivityService::transmit()
doc["rssi"].set(WiFi.RSSI());
{
nvs_handle_t handle{};
if (nvs_open(std::string(name).c_str(), nvs_open_mode_t::NVS_READONLY, &handle) == ESP_OK)
if (nvs_open(name.data(), nvs_open_mode_t::NVS_READONLY, &handle) == ESP_OK)
{
size_t len{0};
if (nvs_get_blob(handle, "saved", nullptr, &len) == ESP_OK && len > 0)
size_t length{0U};
if (nvs_get_blob(handle, "Wi-Fi", nullptr, &length) == ESP_OK && length != 0U)
{
std::vector<uint8_t> buffer(len);
if (nvs_get_blob(handle, "Wi-Fi", &buffer, &len) == ESP_OK)
JsonDocument _saved; // NOLINT(misc-const-correctness)
std::vector<char> buffer(length);
if (nvs_get_blob(handle, "Wi-Fi", buffer.data(), &length) == ESP_OK &&
deserializeJson(_saved, buffer.data(), length) == DeserializationError::Code::Ok)
{
nvs_close(handle);
JsonDocument _saved; // NOLINT(misc-const-correctness)
if (deserializeJson(_saved, buffer.data(), len) == DeserializationError::Code::Ok)
JsonArray saved{doc["saved"].to<JsonArray>()};
for (const JsonPairConst pair : _saved.as<JsonObjectConst>())
{
JsonArray saved{doc["saved"].to<JsonArray>()};
for (const JsonPairConst pair : _saved.as<JsonObjectConst>())
{
saved.add(pair.key());
}
saved.add(pair.key());
}
}
else
{
nvs_close(handle);
}
}
nvs_close(handle);
}
}
doc["ssid"].set(WiFi.SSID());
Expand Down Expand Up @@ -365,4 +363,4 @@ ConnectivityService &ConnectivityService::getInstance()
}

// NOLINTNEXTLINE(bugprone-throwing-static-initialization,cert-err58-cpp,cppcoreguidelines-avoid-non-const-global-variables)
ConnectivityService &Connectivity = ConnectivityService::getInstance();
ConnectivityService &Connectivity{ConnectivityService::getInstance()};
2 changes: 1 addition & 1 deletion webapp/src/services/Connectivity.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -131,7 +131,7 @@ export const MainThird: Component = () => {

export const SidebarThird: Component = () => {
const handleSelect = (ssid: string) => {
if (window.innerWidth < 800) {
if (innerWidth < 800) {
WebAppSidebarSet(false);
}
setCredentialSsid(ssid);
Expand Down