tobimai/waterlevel-software
1
0
Fork 0
Code Issues Pull Requests Actions 1 Packages Projects Releases Wiki Activity

Rework logging
Some checks failed
Test compiling project / test (push) Failing after 1m34s
Details

Browse Source
This commit is contained in:
Tobias Maier
2025-03-10 23:33:41 +01:00
parent 374b23d99a
commit eeaac9548e
12 changed files with 111 additions and 121 deletions
Download Patch File Download Diff File Expand all files Collapse all files

3
.vscode/settings.json vendored
View File

@@ -1,6 +1,7 @@
{ {
"files.associations": { "files.associations": {
"iostream": "cpp", "iostream": "cpp",
"random": "cpp" "random": "cpp",
"vector": "cpp"
} }
} }

10
data/update_progress.html
View File

@@ -18,13 +18,13 @@
</body> </body>
<script> <script>
const ws = new WebSocket('ws://' + window.location.host + '/ws'); const webSocket = new WebSocket('webSocket://' + window.location.host + '/webSocket');
ws.onopen = function() { webSocket.onopen = function() {
console.log('WebSocket connection opened.'); console.log('WebSocket connection opened.');
}; };
ws.onmessage = function(event) { webSocket.onmessage = function(event) {
console.log('Progress:', event.data); console.log('Progress:', event.data);
// Update the progress bar // Update the progress bar
let progress = parseInt(event.data); let progress = parseInt(event.data);
@@ -48,11 +48,11 @@
}; };
ws.onerror = function(error) { webSocket.onerror = function(error) {
console.error('WebSocket error:', error); console.error('WebSocket error:', error);
}; };
ws.onclose = function() { webSocket.onclose = function() {
console.log('WebSocket connection closed.'); console.log('WebSocket connection closed.');
}; };
</script> </script>

6
documentation/old.md
View File

@@ -17,7 +17,7 @@ void listNetworkInterfaces() {
} }
void setEthernetAsDefault() { void setEthernetAsDefault() {
Log.verbose("+++++++++++++++++++++++++++++++++++++++++++++++++++++++++"); logger.log(0, DEBUG, "+++++++++++++++++++++++++++++++++++++++++++++++++++++++++");
listNetworkInterfaces(); listNetworkInterfaces();
// Attempt to locate the Ethernet network interface. // Attempt to locate the Ethernet network interface.
// (The name may vary—on some systems it might be "eth0") // (The name may vary—on some systems it might be "eth0")
@@ -31,8 +31,8 @@ void setEthernetAsDefault() {
struct netif *eth_netif2 = netif_find("ETH_DEF"); struct netif *eth_netif2 = netif_find("ETH_DEF");
if (netif) { if (netif) {
netif_set_default(eth_netif2); netif_set_default(eth_netif2);
Log.verbose("Ethernet set as default network interface."); logger.log(0, DEBUG, "Ethernet set as default network interface.");
} else { } else {
Log.verbose("Could not find Ethernet netif."); logger.log(0, DEBUG, "Could not find Ethernet netif.");
} }
} }

42
lib/fetchOTA/fetchOTA.cpp
View File

@@ -6,7 +6,7 @@
#include <ArduinoJson.h> #include <ArduinoJson.h>
#include <HTTPClient.h> #include <HTTPClient.h>
#include <vector> #include <vector>
#include <ArduinoLog.h> #include <Elog.h>
#include <HTTPUpdate.h> #include <HTTPUpdate.h>
@@ -22,14 +22,14 @@ Firmware OTA::getLatestVersionOnServer() {
HTTPClient http; HTTPClient http;
http.begin(_serverUrl); http.begin(_serverUrl);
int httpCode = http.GET(); int httpCode = http.GET();
Log.verbose("HTTP Code: %d", httpCode); logger.log(0, DEBUG, "HTTP Code: %d", httpCode);
if (httpCode != 200) { if (httpCode != 200) {
return createErrorResponse("HTTP GET request failed with code " + String(httpCode)); return createErrorResponse("HTTP GET request failed with code " + String(httpCode));
} }
String payload = http.getString(); String payload = http.getString();
Log.verbose("Payload: %s", payload.c_str()); logger.log(0, DEBUG, "Payload: %s", payload.c_str());
DynamicJsonDocument doc(4096); DynamicJsonDocument doc(4096);
DeserializationError error = deserializeJson(doc, payload); DeserializationError error = deserializeJson(doc, payload);
@@ -54,7 +54,7 @@ Firmware OTA::getLatestVersionOnServer() {
deviceConfig deviceConfig
}); });
} else { } else {
Log.verbose("Configuration %s does not match current device configuration %s", deviceConfig.c_str(), _current_device_configuration.c_str()); logger.log(0, DEBUG, "Configuration %s does not match current device configuration %s", deviceConfig.c_str(), _current_device_configuration.c_str());
} }
} }
} }
@@ -67,7 +67,7 @@ Firmware OTA::getLatestVersionOnServer() {
Configuration latest = getLatestConfiguration(configs.data(), configs.size()); Configuration latest = getLatestConfiguration(configs.data(), configs.size());
if (!isVersionNewer(_currentVersion, latest.version)) { if (!isVersionNewer(_currentVersion, latest.version)) {
Log.verbose("No newer version found. Server version: %d.%d.%d", latest.version.major, latest.version.minor, latest.version.patch); logger.log(0, DEBUG, "No newer version found. Server version: %d.%d.%d", latest.version.major, latest.version.minor, latest.version.patch);
} }
return Firmware{ return Firmware{
@@ -88,79 +88,79 @@ Firmware OTA::createErrorResponse(const String& errorMsg) {
} }
void run_ota_update(String url, std::function<void()> callback_started, std::function<void()> callback_finished, std::function<void(int, int)> callback_progress, std::function<void(int)> callback_error) { void run_ota_update(String url, std::function<void()> callback_started, std::function<void()> callback_finished, std::function<void(int, int)> callback_progress, std::function<void(int)> callback_error) {
Log.verbose("Starting OTA upgrade"); logger.log(0, DEBUG, "Starting OTA upgrade");
HTTPUpdate httpUpdate; HTTPUpdate httpUpdate;
httpUpdate.onStart(callback_started); httpUpdate.onStart(callback_started);
httpUpdate.onEnd(callback_finished); httpUpdate.onEnd(callback_finished);
httpUpdate.onProgress(callback_progress); httpUpdate.onProgress(callback_progress);
httpUpdate.onError(callback_error); httpUpdate.onError(callback_error);
Log.verbose("Defined callbacks, Starting update now"); logger.log(0, DEBUG, "Defined callbacks, Starting update now");
t_httpUpdate_return ret; t_httpUpdate_return ret;
if (url.startsWith("https")) { if (url.startsWith("https")) {
Log.verbose("HTTPS URL"); logger.log(0, DEBUG, "HTTPS URL");
WiFiClientSecure client; WiFiClientSecure client;
client.setInsecure(); client.setInsecure();
ret = httpUpdate.update(client, url); ret = httpUpdate.update(client, url);
} else if (url.startsWith("http")) { } else if (url.startsWith("http")) {
Log.verbose("HTTP URL"); logger.log(0, DEBUG, "HTTP URL");
WiFiClient client; WiFiClient client;
ret = httpUpdate.update(client, url); ret = httpUpdate.update(client, url);
} else { } else {
Log.error("URL is not valid: \n%s", url.c_str()); logger.log(0, ERROR, "URL is not valid: \n%s", url.c_str());
} }
switch (ret) { switch (ret) {
case HTTP_UPDATE_FAILED: case HTTP_UPDATE_FAILED:
Log.error("HTTP_UPDATE_FAILED Error (%d): %s\n", httpUpdate.getLastError(), httpUpdate.getLastErrorString().c_str()); logger.log(0, ERROR, "HTTP_UPDATE_FAILED Error (%d): %s\n", httpUpdate.getLastError(), httpUpdate.getLastErrorString().c_str());
break; break;
case HTTP_UPDATE_NO_UPDATES: case HTTP_UPDATE_NO_UPDATES:
Log.error("HTTP_UPDATE_NO_UPDATES"); logger.log(0, ERROR, "HTTP_UPDATE_NO_UPDATES");
break; break;
case HTTP_UPDATE_OK: case HTTP_UPDATE_OK:
Log.verbose("Update done"); logger.log(0, DEBUG, "Update done");
break; break;
} }
} }
void run_ota_spiffs_update(String url, std::function<void()> callback_started, std::function<void()> callback_finished, std::function<void(int, int)> callback_progress, std::function<void(int)> callback_error) { void run_ota_spiffs_update(String url, std::function<void()> callback_started, std::function<void()> callback_finished, std::function<void(int, int)> callback_progress, std::function<void(int)> callback_error) {
Log.verbose("Starting OTA SPIFFS upgrade"); logger.log(0, DEBUG, "Starting OTA SPIFFS upgrade");
HTTPUpdate httpUpdate; HTTPUpdate httpUpdate;
httpUpdate.onStart(callback_started); httpUpdate.onStart(callback_started);
httpUpdate.onEnd(callback_finished); httpUpdate.onEnd(callback_finished);
httpUpdate.onProgress(callback_progress); httpUpdate.onProgress(callback_progress);
httpUpdate.onError(callback_error); httpUpdate.onError(callback_error);
Log.verbose("Defined callbacks, Starting update now"); logger.log(0, DEBUG, "Defined callbacks, Starting update now");
t_httpUpdate_return ret; t_httpUpdate_return ret;
if (url.startsWith("https")) { if (url.startsWith("https")) {
Log.verbose("HTTPS URL"); logger.log(0, DEBUG, "HTTPS URL");
WiFiClientSecure client; WiFiClientSecure client;
client.setInsecure(); client.setInsecure();
ret = httpUpdate.updateSpiffs(client, url); ret = httpUpdate.updateSpiffs(client, url);
} else if (url.startsWith("http")) { } else if (url.startsWith("http")) {
Log.verbose("HTTP URL"); logger.log(0, DEBUG, "HTTP URL");
WiFiClient client; WiFiClient client;
ret = httpUpdate.updateSpiffs(client, url); ret = httpUpdate.updateSpiffs(client, url);
} else { } else {
Log.error("URL is not valid: \n%s", url.c_str()); logger.log(0, ERROR, "URL is not valid: \n%s", url.c_str());
} }
switch (ret) { switch (ret) {
case HTTP_UPDATE_FAILED: case HTTP_UPDATE_FAILED:
Log.error("HTTP_UPDATE_FAILED Error (%d): %s\n", httpUpdate.getLastError(), httpUpdate.getLastErrorString().c_str()); logger.log(0, ERROR, "HTTP_UPDATE_FAILED Error (%d): %s\n", httpUpdate.getLastError(), httpUpdate.getLastErrorString().c_str());
break; break;
case HTTP_UPDATE_NO_UPDATES: case HTTP_UPDATE_NO_UPDATES:
Log.error("HTTP_UPDATE_NO_UPDATES"); logger.log(0, ERROR, "HTTP_UPDATE_NO_UPDATES");
break; break;
case HTTP_UPDATE_OK: case HTTP_UPDATE_OK:
Log.verbose("SPIFFS Update done"); logger.log(0, DEBUG, "SPIFFS Update done");
break; break;
} }
} }

9
platformio.ini
View File

@@ -19,14 +19,14 @@ monitor_speed = 115200
lib_deps = lib_deps =
ottowinter/ESPAsyncWebServer-esphome@^3.3.0 ottowinter/ESPAsyncWebServer-esphome@^3.3.0
bblanchon/ArduinoJson@^6.21.3 bblanchon/ArduinoJson@^6.21.3
jsc/ArduinoLog
fetchOTA fetchOTA
INA322 INA233
ESP32Ping ESP32Ping
https://github.com/x821938/elog
board_build.partitions = default.csv board_build.partitions = default.csv
upload_protocol = espota upload_protocol = espota
upload_port = 192.168.5.180 upload_port = 192.168.5.180
build_flags = -Wall -Wextra build_flags = -Wall -Wextra -DLOGGING_SPIFFS_DISABLE -DLOGGING_SD_DISABLE
[env:ESP32_INA226] [env:ESP32_INA226]
platform = espressif32 platform = espressif32
@@ -39,10 +39,11 @@ lib_deps =
bblanchon/ArduinoJson@^6.21.3 bblanchon/ArduinoJson@^6.21.3
jsc/ArduinoLog jsc/ArduinoLog
ESP32Ping ESP32Ping
https://github.com/x821938/elog
board_build.partitions = default.csv board_build.partitions = default.csv
upload_protocol = espota upload_protocol = espota
upload_port = 192.168.4.18 upload_port = 192.168.4.18
build_flags = -Wall -Wextra -DUSE_INA226 build_flags = -Wall -Wextra -DUSE_INA226 -DLOGGING_SPIFFS_DISABLE -DLOGGING_SD_DISABLE
[env:native] [env:native]
platform = native platform = native

4
src/external_interfacing/leds.cpp
View File

@@ -1,6 +1,6 @@
#include "leds.h" #include "leds.h"
#include <Arduino.h> #include <Arduino.h>
#include <ArduinoLog.h> #include <Elog.h>
#include "../tools/tools.h" #include "../tools/tools.h"
extern ActiveErrors active_errors; extern ActiveErrors active_errors;
@@ -72,7 +72,7 @@ void display_task(void* parameter)
// We have no error, refresh status display and wait half a second // We have no error, refresh status display and wait half a second
display_percentage(water_data.percentage); display_percentage(water_data.percentage);
} else { } else {
Log.verbose("Error detected"); logger.log(0, DEBUG, "Error detected");
// We have an error, display error code for 3 seconds and then water level for 3 seconds // We have an error, display error code for 3 seconds and then water level for 3 seconds
if (active_errors.voltage_low) { if (active_errors.voltage_low) {

74
src/main.cpp
View File

@@ -8,7 +8,7 @@
#include "AsyncJson.h" #include "AsyncJson.h"
#include <ArduinoJson.h> #include <ArduinoJson.h>
#include <ArduinoLog.h> #include <Elog.h>
#include <ArduinoOTA.h> #include <ArduinoOTA.h>
@@ -26,6 +26,7 @@
#include <fetchOTA.h> #include <fetchOTA.h>
#include <ESP32Ping.h> #include <ESP32Ping.h>
#define MYLOG 0
Preferences prefs; Preferences prefs;
@@ -40,19 +41,18 @@ extern "C" int rom_phy_get_vdd33();
Version current_spiffs_version; Version current_spiffs_version;
AsyncWebServer server(80); AsyncWebServer server(80);
AsyncWebSocket ws("/ws"); AsyncWebSocket webSocket("/webSocket");
#define FORMAT_LITTLEFS_IF_FAILED true #define FORMAT_LITTLEFS_IF_FAILED true
void setup() void setup()
{ {
logger.registerSerial(MYLOG, DEBUG, "tst");
logger.
logger.provideTime(2025, 3, 10, 23, 28, 00);
prefs.begin("waterlevel", false); prefs.begin("waterlevel", false);
Serial.begin(115200); Serial.begin(115200);
Log.begin(LOG_LEVEL_VERBOSE, &Serial); logger.log(0, DEBUG, "Init LEDs");
Log.setSuffix(printSuffix);
Log.setPrefix(print_prefix);
Log.verbose("Init LEDs");
pinMode(LED_1, OUTPUT); pinMode(LED_1, OUTPUT);
pinMode(LED_2, OUTPUT); pinMode(LED_2, OUTPUT);
pinMode(LED_3, OUTPUT); pinMode(LED_3, OUTPUT);
@@ -64,7 +64,7 @@ void setup()
display_error_code(17); display_error_code(17);
init_sensor(); init_sensor();
Log.verbose("Beginning SPIFFS"); logger.log(0, DEBUG, "Beginning SPIFFS");
SPIFFS.begin(true); SPIFFS.begin(true);
// Read the current SPIFFS version from the versions file on the spiffs // Read the current SPIFFS version from the versions file on the spiffs
@@ -73,21 +73,21 @@ void setup()
Serial.println("Failed to open version file for reading"); Serial.println("Failed to open version file for reading");
} else { } else {
String version = file.readStringUntil('\n'); String version = file.readStringUntil('\n');
Log.verbose("Version: %s", version); logger.log(0, DEBUG, "Version: %s", version);
current_spiffs_version = parseVersion(version.c_str()); current_spiffs_version = parseVersion(version.c_str());
Log.verbose("Current SPIFFS Version: %d.%d.%d", current_spiffs_version.major, current_spiffs_version.minor, current_spiffs_version.patch); logger.log(0, DEBUG, "Current SPIFFS Version: %d.%d.%d", current_spiffs_version.major, current_spiffs_version.minor, current_spiffs_version.patch);
} }
Log.verbose("SPIFFS initialized"); logger.log(0, DEBUG, "SPIFFS initialized");
display_error_code(19); display_error_code(19);
Log.verbose("Begin INA"); logger.log(0, DEBUG, "Begin INA");
display_error_code(22); display_error_code(22);
/////////////////////////////// ROUTES /////////////////////////////// /////////////////////////////// ROUTES ///////////////////////////////
Log.verbose("Route Setup"); logger.log(0, DEBUG, "Route Setup");
// Normal HTML stuff // Normal HTML stuff
server.on("/", HTTP_GET, [](AsyncWebServerRequest* request) { request->send(SPIFFS, "/status.html", "text/html", false, processor); }); server.on("/", HTTP_GET, [](AsyncWebServerRequest* request) { request->send(SPIFFS, "/status.html", "text/html", false, processor); });
@@ -106,7 +106,7 @@ void setup()
// For settings SSID // For settings SSID
if (request->hasParam(ssid_key, true) && request->hasParam(wifi_password_key, true)) { if (request->hasParam(ssid_key, true) && request->hasParam(wifi_password_key, true)) {
Log.verbose("Updating SSID config"); logger.log(0, DEBUG, "Updating SSID config");
AsyncWebParameter* ssid_param = request->getParam(ssid_key, true); AsyncWebParameter* ssid_param = request->getParam(ssid_key, true);
AsyncWebParameter* password_param = request->getParam(wifi_password_key, true); AsyncWebParameter* password_param = request->getParam(wifi_password_key, true);
prefs.putString(ssid_key, ssid_param->value().c_str()); prefs.putString(ssid_key, ssid_param->value().c_str());
@@ -122,7 +122,7 @@ void setup()
int params = request->params(); int params = request->params();
if (request->hasParam(level_sensor_range_key, true) && request->hasParam(water_level_min_key, true) && request->hasParam(water_level_max_key, true) && request->hasParam(water_volume_key, true)) { if (request->hasParam(level_sensor_range_key, true) && request->hasParam(water_level_min_key, true) && request->hasParam(water_level_max_key, true) && request->hasParam(water_volume_key, true)) {
Log.verbose("Updating Sensor config"); logger.log(0, DEBUG, "Updating Sensor config");
AsyncWebParameter* range_param = request->getParam(level_sensor_range_key, true); AsyncWebParameter* range_param = request->getParam(level_sensor_range_key, true);
AsyncWebParameter* level_min_param = request->getParam(water_level_min_key, true); AsyncWebParameter* level_min_param = request->getParam(water_level_min_key, true);
AsyncWebParameter* level_max_param = request->getParam(water_level_max_key, true); AsyncWebParameter* level_max_param = request->getParam(water_level_max_key, true);
@@ -144,24 +144,24 @@ void setup()
// Convert the C string to a float using strtod // Convert the C string to a float using strtod
float value = strtod(paramCStr, &endPtr); float value = strtod(paramCStr, &endPtr);
Log.verbose("range_float:%D:", range_float); logger.log(0, DEBUG, "range_float:%D:", range_float);
prefs.putFloat(level_sensor_range_key, range_float); prefs.putFloat(level_sensor_range_key, range_float);
prefs.putFloat(water_level_min_key, level_min_float); prefs.putFloat(water_level_min_key, level_min_float);
prefs.putFloat(water_level_max_key, level_max_float); prefs.putFloat(water_level_max_key, level_max_float);
prefs.putFloat(water_volume_key, liters_float); prefs.putFloat(water_volume_key, liters_float);
Log.verbose("range_float_after:%D:", prefs.getFloat(level_sensor_range_key, -1.0)); logger.log(0, DEBUG, "range_float_after:%D:", prefs.getFloat(level_sensor_range_key, -1.0));
} else { } else {
Log.verbose("!!!! FAIL lo"); logger.log(0, DEBUG, "!!!! FAIL lo");
for (int i = 0; i < params; i++) { for (int i = 0; i < params; i++) {
AsyncWebParameter* p = request->getParam(i); AsyncWebParameter* p = request->getParam(i);
if (p->isFile()) { // p->isPost() is also true if (p->isFile()) { // p->isPost() is also true
Log.verbose("POST[%s]: %s\n", p->name().c_str(), p->value().c_str()); logger.log(0, DEBUG, "POST[%s]: %s\n", p->name().c_str(), p->value().c_str());
} else if (p->isPost()) { } else if (p->isPost()) {
Log.verbose("POST[%s]: %s\n", p->name().c_str(), p->value().c_str()); logger.log(0, DEBUG, "POST[%s]: %s\n", p->name().c_str(), p->value().c_str());
} else { } else {
Log.verbose("GET[%s]: %s\n", p->name().c_str(), p->value().c_str()); logger.log(0, DEBUG, "GET[%s]: %s\n", p->name().c_str(), p->value().c_str());
} }
} }
request->send(400, "text/plain", "Missing parameters"); // TODO add proper error messages request->send(400, "text/plain", "Missing parameters"); // TODO add proper error messages
@@ -171,8 +171,8 @@ void setup()
setup_api_endpoints(); setup_api_endpoints();
display_error_code(23); display_error_code(23);
ws.onEvent(onWsEvent); webSocket.onEvent(onWsEvent);
server.addHandler(&ws); server.addHandler(&webSocket);
@@ -181,7 +181,7 @@ void setup()
display_error_code(24); display_error_code(24);
Log.verbose("OTA Setup"); logger.log(0, DEBUG, "OTA Setup");
ArduinoOTA ArduinoOTA
.onStart([]() { .onStart([]() {
String type; String type;
@@ -191,16 +191,16 @@ void setup()
type = "filesystem"; type = "filesystem";
// NOTE: if updating SPIFFS this would be the place to unmount SPIFFS using SPIFFS.end() // NOTE: if updating SPIFFS this would be the place to unmount SPIFFS using SPIFFS.end()
Log.verbose("Start updating %s", type); }) logger.log(0, DEBUG, "Start updating %s", type); })
.onEnd([]() { Log.verbose("\nEnd"); }) .onEnd([]() { logger.log(0, DEBUG, "\nEnd"); })
.onProgress([](unsigned int progress, unsigned int total) { Serial.printf("Progress: %u%%\r", (progress / (total / 100))); }) .onProgress([](unsigned int progress, unsigned int total) { Serial.printf("Progress: %u%%\r", (progress / (total / 100))); })
.onError([](ota_error_t error) { .onError([](ota_error_t error) {
Serial.printf("Error[%u]: ", error); Serial.printf("Error[%u]: ", error);
if (error == OTA_AUTH_ERROR) Log.verbose("Auth Failed"); if (error == OTA_AUTH_ERROR) logger.log(0, DEBUG, "Auth Failed");
else if (error == OTA_BEGIN_ERROR) Log.verbose("Begin Failed"); else if (error == OTA_BEGIN_ERROR) logger.log(0, DEBUG, "Begin Failed");
else if (error == OTA_CONNECT_ERROR) Log.verbose("Connect Failed"); else if (error == OTA_CONNECT_ERROR) logger.log(0, DEBUG, "Connect Failed");
else if (error == OTA_RECEIVE_ERROR) Log.verbose("Receive Failed"); else if (error == OTA_RECEIVE_ERROR) logger.log(0, DEBUG, "Receive Failed");
else if (error == OTA_END_ERROR) Log.verbose("End Failed"); }); else if (error == OTA_END_ERROR) logger.log(0, DEBUG, "End Failed"); });
display_error_code(26); display_error_code(26);
digitalWrite(LED_RED, 0); digitalWrite(LED_RED, 0);
@@ -216,11 +216,13 @@ void setup()
if (!started) { if (!started) {
xTaskCreate(check_update_task, "CheckUpdateTask", 1024 * 8, NULL, 1, NULL); xTaskCreate(check_update_task, "CheckUpdateTask", 1024 * 8, NULL, 1, NULL);
} }
logger.configureSyslog("192.168.6.11", 5514, "esp32");
logger.registerSyslog(MYLOG, DEBUG, FAC_LOCAL4, "mylog");
Log.verbose("Starting webserver"); logger.log(0, DEBUG, "Starting webserver");
server.begin(); server.begin();
ArduinoOTA.begin(); ArduinoOTA.begin();
display_error_code(25); display_error_code(25);
@@ -234,13 +236,13 @@ void setup()
if (WiFi.status() == WL_CONNECTED || ETH.localIP()) { if (WiFi.status() == WL_CONNECTED || ETH.localIP()) {
int pingResult = Ping.ping("8.8.8.8"); // Use Google's public DNS server as a test IP int pingResult = Ping.ping("8.8.8.8"); // Use Google's public DNS server as a test IP
if (pingResult >= 0) { if (pingResult >= 0) {
Log.verbose("Network connection established"); logger.log(0, DEBUG, "Network connection established");
break; break;
} else { } else {
Log.verbose("Network not ready, retrying..."); logger.log(0, DEBUG, "Network not ready, retrying...");
} }
} else { } else {
Log.verbose("No WiFi or Ethernet connection, retrying..."); logger.log(0, DEBUG, "No WiFi or Ethernet connection, retrying...");
} }
delay(1000); // Delay to prevent rapid retry delay(1000); // Delay to prevent rapid retry
} }

2
src/networking/json_builder.cpp
View File

@@ -1,5 +1,5 @@
#include "json_builder.h" #include "json_builder.h"
#include <ArduinoLog.h> #include <Elog.h>
extern WaterData water_data; extern WaterData water_data;
extern DeviceTelemetry telemetry; extern DeviceTelemetry telemetry;

18
src/networking/networking.cpp
View File

@@ -1,4 +1,4 @@
#include <ArduinoLog.h> #include <Elog.h>
#include <ETH.h> #include <ETH.h>
#include <WiFi.h> #include <WiFi.h>
#include "../global_data/defines.h" #include "../global_data/defines.h"
@@ -34,21 +34,21 @@ const char * get_hostname(HostnameType host_type) {
void wifi_task(void* parameter) void wifi_task(void* parameter)
{ {
Log.verbose("Starting WiFi Task"); logger.log(0, DEBUG, "Starting WiFi Task");
WiFi.setHostname(get_hostname(Wireless)); WiFi.setHostname(get_hostname(Wireless));
while (true) { while (true) {
if (prefs.getString(ssid_key, "") == "" || failed_connection_attempts > 5) { if (prefs.getString(ssid_key, "") == "" || failed_connection_attempts > 5) {
wifi_data.link = false; wifi_data.link = false;
if (failed_connection_attempts > 5) { if (failed_connection_attempts > 5) {
Log.verbose("Failed to connecto to currently saved SSID, starting SoftAP"); logger.log(0, DEBUG, "Failed to connecto to currently saved SSID, starting SoftAP");
} else { } else {
Log.verbose("No SSID saved, starting SoftAP"); logger.log(0, DEBUG, "No SSID saved, starting SoftAP");
} }
String ap_ssid = get_hostname(Wireless); String ap_ssid = get_hostname(Wireless);
WiFi.softAP(ap_ssid, ""); WiFi.softAP(ap_ssid, "");
Log.verbose("[WIFI_TASK] Waiting for SSID now..."); logger.log(0, DEBUG, "[WIFI_TASK] Waiting for SSID now...");
String old_ssid = prefs.getString(ssid_key, "xxx"); String old_ssid = prefs.getString(ssid_key, "xxx");
while (prefs.getString(ssid_key, "") == "" || prefs.getString(ssid_key, "") == old_ssid) { while (prefs.getString(ssid_key, "") == "" || prefs.getString(ssid_key, "") == old_ssid) {
@@ -64,11 +64,11 @@ void wifi_task(void* parameter)
wifi_data.network_name = WiFi.SSID(); wifi_data.network_name = WiFi.SSID();
wifi_data.ip_address = WiFi.localIP().toString(); wifi_data.ip_address = WiFi.localIP().toString();
// Log.verbose("RSSI: %F, IP Address, %p, SSID: %s", float(WiFi.RSSI()), WiFi.localIP(), prefs.getString(ssid_key, "NOSSID")); // logger.log(0, DEBUG, "RSSI: %F, IP Address, %p, SSID: %s", float(WiFi.RSSI()), WiFi.localIP(), prefs.getString(ssid_key, "NOSSID"));
// Serial.println(WiFi.channel()); // Serial.println(WiFi.channel());
delay(5000); delay(5000);
} else { } else {
Log.verbose("Connecting to %s using password %s", prefs.getString(ssid_key, ""), prefs.getString(wifi_password_key, "")); logger.log(0, DEBUG, "Connecting to %s using password %s", prefs.getString(ssid_key, ""), prefs.getString(wifi_password_key, ""));
WiFi.mode(WIFI_STA); WiFi.mode(WIFI_STA);
WiFi.begin(prefs.getString(ssid_key, ""), prefs.getString(wifi_password_key, "")); WiFi.begin(prefs.getString(ssid_key, ""), prefs.getString(wifi_password_key, ""));
failed_connection_attempts++; failed_connection_attempts++;
@@ -80,14 +80,14 @@ void wifi_task(void* parameter)
void ethernet_task(void* parameter) void ethernet_task(void* parameter)
{ {
Log.verbose("Connecting Ethernet"); logger.log(0, DEBUG, "Connecting Ethernet");
ETH.begin(0, 17, 23, 18); ETH.begin(0, 17, 23, 18);
ETH.setHostname(get_hostname(Ethernet)); ETH.setHostname(get_hostname(Ethernet));
while (true) { while (true) {
ethernet_data.link = ETH.linkUp(); ethernet_data.link = ETH.linkUp();
ethernet_data.rssi = ETH.linkSpeed(); ethernet_data.rssi = ETH.linkSpeed();
ethernet_data.ip_address = ETH.localIP().toString(); ethernet_data.ip_address = ETH.localIP().toString();
// Log.verbose("Ethernet RSSI: %F, IP Address, %s, LINK: %s", float(ethernet_data.rssi), ethernet_data.ip_address, String(ethernet_data.link)); // logger.log(0, DEBUG, "Ethernet RSSI: %F, IP Address, %s, LINK: %s", float(ethernet_data.rssi), ethernet_data.ip_address, String(ethernet_data.link));
delay(60 * 1000); delay(60 * 1000);
} }
} }

2
src/networking/responses.cpp
View File

@@ -4,7 +4,7 @@
#include <ESPAsyncWebServer.h> #include <ESPAsyncWebServer.h>
#include "AsyncJson.h" #include "AsyncJson.h"
#include <ArduinoJson.h> #include <ArduinoJson.h>
#include <ArduinoLog.h> #include <Elog.h>
#include "json_builder.h" #include "json_builder.h"
#include "../tools/tools.h" #include "../tools/tools.h"
#include <SPIFFS.h> #include <SPIFFS.h>

14
src/sensor/sensor.cpp
View File

@@ -1,6 +1,6 @@
#include "../global_data/defines.h" #include "../global_data/defines.h"
#include <Preferences.h> #include <Preferences.h>
#include <ArduinoLog.h> #include <Elog.h>
#include "Wire.h" #include "Wire.h"
#include "../global_data/global_data.h" #include "../global_data/global_data.h"
@@ -61,8 +61,8 @@ void read_sensor_task(void* parameter)
float min_water_level_mA = 4 + min_water_level_mA_over_zero; float min_water_level_mA = 4 + min_water_level_mA_over_zero;
float max_water_level_mA = 4 + max_water_level_mA_over_zero; float max_water_level_mA = 4 + max_water_level_mA_over_zero;
// Log.verbose("max_water_level_mA: %F", max_water_level_mA); // logger.log(0, DEBUG, "max_water_level_mA: %F", max_water_level_mA);
// Log.verbose("min_water_level_mA_over_zero: %F", min_water_level_mA_over_zero); // logger.log(0, DEBUG, "min_water_level_mA_over_zero: %F", min_water_level_mA_over_zero);
// Current over the 0 level of the water // Current over the 0 level of the water
float shunt_current_over_zero = shunt_current - min_water_level_mA; float shunt_current_over_zero = shunt_current - min_water_level_mA;
@@ -82,10 +82,10 @@ void read_sensor_task(void* parameter)
active_errors.current_high = shunt_current > 20.2; active_errors.current_high = shunt_current > 20.2;
active_errors.voltage_low = bus_voltage < 23; active_errors.voltage_low = bus_voltage < 23;
active_errors.voltage_high = bus_voltage > 25; active_errors.voltage_high = bus_voltage > 25;
// Log.verbose("Shunt current: %F", shunt_current); // logger.log(0, DEBUG, "Shunt current: %F", shunt_current);
// Log.verbose("Shunt voltage: %F", shunt_voltage); // logger.log(0, DEBUG, "Shunt voltage: %F", shunt_voltage);
// Log.verbose("Bus voltage: %F", bus_voltage); // logger.log(0, DEBUG, "Bus voltage: %F", bus_voltage);
// Log.verbose("cm_over_zero: %F", cm_over_zero); // logger.log(0, DEBUG, "cm_over_zero: %F", cm_over_zero);
shunt_data.bus_voltage = bus_voltage; shunt_data.bus_voltage = bus_voltage;
shunt_data.shunt_voltage = shunt_voltage; shunt_data.shunt_voltage = shunt_voltage;

48
src/tools/tools.cpp
View File

@@ -1,6 +1,6 @@
#include <Arduino.h> #include <Arduino.h>
#include "tools.h" #include "tools.h"
#include <ArduinoLog.h> #include <Elog.h>
#include "../global_data/defines.h" #include "../global_data/defines.h"
#include <Preferences.h> #include <Preferences.h>
#include <fetchOTA.h> #include <fetchOTA.h>
@@ -8,24 +8,10 @@
extern Preferences prefs; extern Preferences prefs;
extern OTAStatus ota_status; extern OTAStatus ota_status;
extern AsyncWebSocket ws; extern AsyncWebSocket webSocket;
extern Version current_spiffs_version; extern Version current_spiffs_version;
void printSuffix(Print* _logOutput, int logLevel)
{
_logOutput->print(CR);
}
void print_prefix(Print* _logOutput, int logLevel)
{
_logOutput->print("WATERMETER - TESTLOL - C");
_logOutput->print(xPortGetCoreID());
_logOutput->print(" - ");
_logOutput->print(pcTaskGetName(xTaskGetCurrentTaskHandle()));
_logOutput->print(" - ");
}
bool is_error(ActiveErrors active_errors) { bool is_error(ActiveErrors active_errors) {
return active_errors.current_high || active_errors.current_low || active_errors.level_high || active_errors.level_low || active_errors.voltage_high || active_errors.voltage_low; return active_errors.current_high || active_errors.current_low || active_errors.level_high || active_errors.level_low || active_errors.voltage_high || active_errors.voltage_low;
} }
@@ -49,28 +35,28 @@ String processor(const String& var)
// OTA Callbacks // OTA Callbacks
void update_started() { void update_started() {
Log.verbose("OTA Update started"); logger.log(0, DEBUG, "OTA Update started");
ota_status.update_progress = 0; ota_status.update_progress = 0;
} }
void update_finished() { void update_finished() {
Log.verbose("OTA Update finished"); logger.log(0, DEBUG, "OTA Update finished");
ota_status.update_progress = -1; ota_status.update_progress = -1;
ws.textAll(String(-1).c_str()); webSocket.textAll(String(-1).c_str());
} }
void update_progress(int cur, int total) { void update_progress(int cur, int total) {
ota_status.update_progress = 0; ota_status.update_progress = 0;
if (cur != 0 ) { if (cur != 0 ) {
ota_status.update_progress = int(float(cur)/float(total)*100); ota_status.update_progress = int(float(cur)/float(total)*100);
Log.verbose("OTA Update progress: %d/%d, %i", cur, total, ota_status.update_progress); logger.log(0, DEBUG, "OTA Update progress: %d/%d, %i", cur, total, ota_status.update_progress);
} }
ws.textAll(String(ota_status.update_progress).c_str()); webSocket.textAll(String(ota_status.update_progress).c_str());
Log.verbose("OTA Update progress: %d/%d", cur, total); logger.log(0, DEBUG, "OTA Update progress: %d/%d", cur, total);
} }
void update_error(int err) { void update_error(int err) {
Log.error("OTA Update error: %d", err); logger.log(0, ERROR, "OTA Update error: %d", err);
ota_status.update_progress = -2; ota_status.update_progress = -2;
} }
@@ -89,20 +75,20 @@ void check_update_task(void* parameter) {
// If there is a SPIFSS update it will be ran automatically, as SPIFFS is necessary for the firmware to run // If there is a SPIFSS update it will be ran automatically, as SPIFFS is necessary for the firmware to run
Firmware latest_spiff_version = spiffs_fs.getLatestVersionOnServer(); Firmware latest_spiff_version = spiffs_fs.getLatestVersionOnServer();
Log.verbose("Required SPIFFS Version: %d.%d.%d; Current SPIFFS version: %d.%d.%d; Server SPIFFS Version: %d.%d.%d", REQUIRED_SPIFFS_VERSION.major, REQUIRED_SPIFFS_VERSION.minor, REQUIRED_SPIFFS_VERSION.patch, current_spiffs_version.major, current_spiffs_version.minor, current_spiffs_version.patch, latest_spiff_version.version.major, latest_spiff_version.version.minor, latest_spiff_version.version.patch); logger.log(0, DEBUG, "Required SPIFFS Version: %d.%d.%d; Current SPIFFS version: %d.%d.%d; Server SPIFFS Version: %d.%d.%d", REQUIRED_SPIFFS_VERSION.major, REQUIRED_SPIFFS_VERSION.minor, REQUIRED_SPIFFS_VERSION.patch, current_spiffs_version.major, current_spiffs_version.minor, current_spiffs_version.patch, latest_spiff_version.version.major, latest_spiff_version.version.minor, latest_spiff_version.version.patch);
if (latest_spiff_version.valid) { if (latest_spiff_version.valid) {
if (isVersionNewer(current_spiffs_version, REQUIRED_SPIFFS_VERSION)) { if (isVersionNewer(current_spiffs_version, REQUIRED_SPIFFS_VERSION)) {
// If Required SPIFFS version is newer than current version, update // If Required SPIFFS version is newer than current version, update
Log.verbose("New SPIFFS version, running update now"); logger.log(0, DEBUG, "New SPIFFS version, running update now");
run_ota_spiffs_update(latest_spiff_version.url, update_started, update_finished, update_progress, update_error); run_ota_spiffs_update(latest_spiff_version.url, update_started, update_finished, update_progress, update_error);
// Reboot just to be safe // Reboot just to be safe
ESP.restart(); ESP.restart();
} else if (isVersionNewer(REQUIRED_SPIFFS_VERSION, latest_spiff_version.version)) { } else if (isVersionNewer(REQUIRED_SPIFFS_VERSION, latest_spiff_version.version)) {
// If Server has new SPIFFS version but it's not required // If Server has new SPIFFS version but it's not required
Log.verbose("New SPIFFS version available: %d.%d.%d, current version: %d.%d.%d but not necessary to update", latest_spiff_version.version.major, latest_spiff_version.version.minor, latest_spiff_version.version.patch, REQUIRED_SPIFFS_VERSION.major, REQUIRED_SPIFFS_VERSION.minor, REQUIRED_SPIFFS_VERSION.patch); logger.log(0, DEBUG, "New SPIFFS version available: %d.%d.%d, current version: %d.%d.%d but not necessary to update", latest_spiff_version.version.major, latest_spiff_version.version.minor, latest_spiff_version.version.patch, REQUIRED_SPIFFS_VERSION.major, REQUIRED_SPIFFS_VERSION.minor, REQUIRED_SPIFFS_VERSION.patch);
} else { } else {
Log.verbose("No new SPIFFS version available"); logger.log(0, DEBUG, "No new SPIFFS version available");
} }
} }
@@ -110,11 +96,11 @@ void check_update_task(void* parameter) {
while (true) { while (true) {
Firmware fw = ota.getLatestVersionOnServer(); Firmware fw = ota.getLatestVersionOnServer();
if (fw.valid) { if (fw.valid) {
Log.verbose("New firmware available: %d.%d.%d, current version: %d.%d.%d", fw.version.major, fw.version.minor, fw.version.patch, current_software_version.major, current_software_version.minor, current_software_version.patch); logger.log(0, DEBUG, "New firmware available: %d.%d.%d, current version: %d.%d.%d", fw.version.major, fw.version.minor, fw.version.patch, current_software_version.major, current_software_version.minor, current_software_version.patch);
ota_status.latest_version = fw.version; ota_status.latest_version = fw.version;
ota_status.update_url = fw.url; ota_status.update_url = fw.url;
if (isVersionNewer(current_software_version, fw.version)) { if (isVersionNewer(current_software_version, fw.version)) {
Log.verbose("Remote version is newer than current version"); logger.log(0, DEBUG, "Remote version is newer than current version");
ota_status.update_available = true; ota_status.update_available = true;
} else { } else {
ota_status.update_available = false; ota_status.update_available = false;
@@ -125,7 +111,7 @@ void check_update_task(void* parameter) {
ota_status.update_available = false; ota_status.update_available = false;
} }
Log.verbose("No new firmware available"); logger.log(0, DEBUG, "No new firmware available");
} }
delay(1000 * 60 * 1); delay(1000 * 60 * 1);
} }
@@ -135,7 +121,7 @@ void check_update_task(void* parameter) {
void run_ota_update_task(void* parameter) { void run_ota_update_task(void* parameter) {
TaskArgs_t *args = (TaskArgs_t *) parameter; TaskArgs_t *args = (TaskArgs_t *) parameter;
Log.verbose("Running OTA upgrade now with URL: %s", args->ota_status.update_url.c_str()); logger.log(0, DEBUG, "Running OTA upgrade now with URL: %s", args->ota_status.update_url.c_str());
run_ota_update(args->ota_status.update_url, update_started, update_finished, update_progress, update_error); run_ota_update(args->ota_status.update_url, update_started, update_finished, update_progress, update_error);
vTaskDelete(NULL); vTaskDelete(NULL);
} }