jeka/OTGateway
1
0
Fork 0
mirror of https://github.com/Laxilef/OTGateway.git synced 2025-12-10 18:24:27 +05:00
Code Issues Packages Projects Releases Wiki Activity

refactor: migrating from Telnet to WebSerial for remote logging

Browse Source
This commit is contained in:
Yurii
2025-11-06 13:29:59 +03:00
parent 192f4ee18b
commit 1d7f85f462
17 changed files with 75 additions and 130 deletions
Download Patch File Download Diff File Expand all files Collapse all files

9
platformio.ini
View File

@@ -20,16 +20,17 @@ lib_deps =
ESP32Async/AsyncTCP
;ESP32Async/ESPAsyncWebServer
https://github.com/ESP32Async/ESPAsyncWebServer#main
mathieucarbou/MycilaWebSerial@^8.2.0
bblanchon/ArduinoJson@^7.4.2
;ihormelnyk/OpenTherm Library@^1.1.5
https://github.com/Laxilef/opentherm_library#esp32_timer
arduino-libraries/ArduinoMqttClient@^0.1.8
lennarthennigs/ESP Telnet@^2.2.3
gyverlibs/FileData@^1.0.3
gyverlibs/GyverPID@^3.3.2
gyverlibs/GyverBlinker@^1.1.1
https://github.com/pstolarz/Arduino-Temperature-Control-Library.git#OneWireNg
laxilef/TinyLogger@^1.1.1
;laxilef/TinyLogger@^1.1.1
https://github.com/Laxilef/TinyLogger#custom_handlers
build_type = ${secrets.build_type}
build_flags =
-mtext-section-literals
@@ -40,10 +41,10 @@ build_flags =
-D CONFIG_ASYNC_TCP_STACK_SIZE=4096
-D ARDUINOJSON_USE_DOUBLE=0
-D ARDUINOJSON_USE_LONG_LONG=0
-D TINYLOGGER_GLOBAL
-D DEFAULT_SERIAL_ENABLED=${secrets.serial_enabled}
-D DEFAULT_SERIAL_BAUD=${secrets.serial_baud}
-D DEFAULT_TELNET_ENABLED=${secrets.telnet_enabled}
-D DEFAULT_TELNET_PORT=${secrets.telnet_port}
-D DEFAULT_WEBSERIAL_ENABLED=${secrets.webserial_enabled}
-D DEFAULT_LOG_LEVEL=${secrets.log_level}
-D DEFAULT_HOSTNAME='"${secrets.hostname}"'
-D DEFAULT_AP_SSID='"${secrets.ap_ssid}"'

3
secrets.default.ini
View File

@@ -3,8 +3,7 @@ build_type = release
serial_enabled = true
serial_baud = 115200
telnet_enabled = true
telnet_port = 23
webserial_enabled = true
log_level = 5
hostname = opentherm

35
src/MainTask.h
View File

@@ -6,7 +6,6 @@ extern NetworkMgr* network;
extern MqttTask* tMqtt;
extern OpenThermTask* tOt;
extern FileData fsNetworkSettings, fsSettings, fsSensorsSettings;
extern ESPTelnetStream* telnetStream;
class MainTask : public Task {
@@ -40,7 +39,6 @@ protected:
PumpStartReason extPumpStartReason = PumpStartReason::NONE;
unsigned long externalPumpStartTime = 0;
bool ntpStarted = false;
bool telnetStarted = false;
bool emergencyDetected = false;
unsigned long emergencyFlipTime = 0;
bool freezeDetected = false;
@@ -106,9 +104,9 @@ protected:
vars.network.connected = network->isConnected();
vars.network.rssi = network->isConnected() ? WiFi.RSSI() : 0;
if (settings.system.logLevel >= TinyLogger::Level::SILENT && settings.system.logLevel <= TinyLogger::Level::VERBOSE) {
if (settings.system.logLevel >= TinyLoggerLevel::SILENT && settings.system.logLevel <= TinyLoggerLevel::VERBOSE) {
if (Log.getLevel() != settings.system.logLevel) {
Log.setLevel(static_cast<TinyLogger::Level>(settings.system.logLevel));
Log.setLevel(static_cast<TinyLoggerLevel>(settings.system.logLevel));
}
}
@@ -123,11 +121,6 @@ protected:
}
}
if (!this->telnetStarted && telnetStream != nullptr) {
telnetStream->begin(23, false);
this->telnetStarted = true;
}
if (settings.mqtt.enabled && !tMqtt->isEnabled()) {
tMqtt->enable();
@@ -142,11 +135,6 @@ protected:
this->ntpStarted = false;
}
if (this->telnetStarted) {
telnetStream->stop();
this->telnetStarted = false;
}
if (tMqtt->isEnabled()) {
tMqtt->disable();
}
@@ -160,23 +148,10 @@ protected:
}
this->ledStatus();
// telnet
if (this->telnetStarted) {
this->yield();
telnetStream->loop();
this->yield();
}
// anti memory leak
for (Stream* stream : Log.getStreams()) {
while (stream->available() > 0) {
stream->read();
#ifdef ARDUINO_ARCH_ESP8266
::optimistic_yield(1000);
#endif
}
while (Serial.available() > 0) {
Serial.read();
}
// heap info
@@ -215,7 +190,7 @@ protected:
vars.states.restarting = true;
}
if (settings.system.logLevel < TinyLogger::Level::VERBOSE) {
if (settings.system.logLevel < TinyLoggerLevel::VERBOSE) {
return;
}

2
src/MqttTask.h
View File

@@ -416,7 +416,7 @@ protected:
return;
}
if (settings.system.logLevel >= TinyLogger::Level::TRACE) {
if (settings.system.logLevel >= TinyLoggerLevel::TRACE) {
Log.strace(FPSTR(L_MQTT_MSG), F("Topic: %s\r\n> "), topic.c_str());
if (Log.lock()) {
for (size_t i = 0; i < length; i++) {

6
src/PortalTask.h
View File

@@ -13,6 +13,7 @@ using namespace NetworkUtils;
extern NetworkMgr* network;
extern FileData fsNetworkSettings, fsSettings, fsSensorsSettings;
extern MqttTask* tMqtt;
extern WebSerial* webSerial;
class PortalTask : public LeanTask {
@@ -76,6 +77,11 @@ protected:
return request->requestAuthentication(AsyncAuthType::AUTH_BASIC, PROJECT_NAME, "Authentication failed");
});
// web serial
if (webSerial != nullptr) {
webSerial->begin(this->webServer);
}
// index page
this->webServer->on("/", HTTP_GET, [](AsyncWebServerRequest *request) {
request->redirect("/index.html");

5
src/Settings.h
View File

@@ -32,9 +32,8 @@ struct Settings {
} serial;
struct {
bool enabled = DEFAULT_TELNET_ENABLED;
unsigned short port = DEFAULT_TELNET_PORT;
} telnet;
bool enabled = DEFAULT_WEBSERIAL_ENABLED;
} webSerial;
struct {
char server[49] = "pool.ntp.org";

10
src/defines.h
View File

@@ -42,12 +42,8 @@
#define DEFAULT_SERIAL_BAUD 115200
#endif
#ifndef DEFAULT_TELNET_ENABLED
#define DEFAULT_TELNET_ENABLED true
#endif
#ifndef DEFAULT_TELNET_PORT
#define DEFAULT_TELNET_PORT 23
#ifndef DEFAULT_WEBSERIAL_ENABLED
#define DEFAULT_WEBSERIAL_ENABLED true
#endif
#ifndef USE_BLE
@@ -75,7 +71,7 @@
#endif
#ifndef DEFAULT_LOG_LEVEL
#define DEFAULT_LOG_LEVEL TinyLogger::Level::VERBOSE
#define DEFAULT_LOG_LEVEL TinyLoggerLevel::VERBOSE
#endif
#ifndef DEFAULT_STATUS_LED_GPIO

26
src/main.cpp
View File

@@ -2,7 +2,7 @@
#include <ArduinoJson.h>
#include <FileData.h>
#include <LittleFS.h>
#include <ESPTelnetStream.h>
#include <MycilaWebSerial.h>
#include "defines.h"
#include "strings.h"
@@ -34,7 +34,7 @@
using namespace NetworkUtils;
// Vars
ESPTelnetStream* telnetStream = nullptr;
WebSerial* webSerial = nullptr;
NetworkMgr* network = nullptr;
Sensors::Result sensorsResults[SENSORS_AMOUNT];
@@ -58,7 +58,7 @@ void setup() {
Sensors::results = sensorsResults;
LittleFS.begin();
Log.setLevel(TinyLogger::Level::VERBOSE);
Log.setLevel(TinyLoggerLevel::VERBOSE);
Log.setServiceTemplate("\033[1m[%s]\033[22m");
Log.setLevelTemplate("\033[1m[%s]\033[22m");
Log.setMsgPrefix("\033[m ");
@@ -76,7 +76,7 @@ void setup() {
#if ARDUINO_USB_MODE
Serial.setTxBufferSize(512);
#endif
Log.addStream(&Serial);
Log.addHandler(&Serial);
Log.print("\n\n\r");
//
@@ -160,24 +160,24 @@ void setup() {
// Logs settings
if (!settings.system.serial.enabled) {
Serial.end();
Log.clearStreams();
Log.clearHandlers();
} else if (settings.system.serial.baudrate != 115200) {
Serial.end();
Log.clearStreams();
Log.clearHandlers();
Serial.begin(settings.system.serial.baudrate);
Log.addStream(&Serial);
Log.addHandler(&Serial);
}
if (settings.system.telnet.enabled) {
telnetStream = new ESPTelnetStream;
telnetStream->setKeepAliveInterval(500);
Log.addStream(telnetStream);
if (settings.system.webSerial.enabled) {
webSerial = new WebSerial();
webSerial->setBuffer(100);
Log.addHandler(webSerial);
}
if (settings.system.logLevel >= TinyLogger::Level::SILENT && settings.system.logLevel <= TinyLogger::Level::VERBOSE) {
Log.setLevel(static_cast<TinyLogger::Level>(settings.system.logLevel));
if (settings.system.logLevel >= TinyLoggerLevel::SILENT && settings.system.logLevel <= TinyLoggerLevel::VERBOSE) {
Log.setLevel(static_cast<TinyLoggerLevel>(settings.system.logLevel));
}
//

2
src/strings.h
View File

@@ -198,7 +198,6 @@ const char S_SUMMER_WINTER_MODE[] PROGMEM = "summerWinterMode"
const char S_SYSTEM[] PROGMEM = "system";
const char S_TARGET[] PROGMEM = "target";
const char S_TARGET_TEMP[] PROGMEM = "targetTemp";
const char S_TELNET[] PROGMEM = "telnet";
const char S_TEMPERATURE[] PROGMEM = "temperature";
const char S_THRESHOLD_HIGH[] PROGMEM = "thresholdHigh";
const char S_THRESHOLD_LOW[] PROGMEM = "thresholdLow";
@@ -217,3 +216,4 @@ const char S_USE_DHCP[] PROGMEM = "useDhcp";
const char S_USER[] PROGMEM = "user";
const char S_VALUE[] PROGMEM = "value";
const char S_VERSION[] PROGMEM = "version";
const char S_WEBSERIAL[] PROGMEM = "webSerial";

24
src/utils.h
View File

@@ -425,9 +425,8 @@ void settingsToJson(const Settings& src, JsonVariant dst, bool safe = false) {
serial[FPSTR(S_ENABLED)] = src.system.serial.enabled;
serial[FPSTR(S_BAUDRATE)] = src.system.serial.baudrate;
auto telnet = system[FPSTR(S_TELNET)].to<JsonObject>();
telnet[FPSTR(S_ENABLED)] = src.system.telnet.enabled;
telnet[FPSTR(S_PORT)] = src.system.telnet.port;
auto webSerial = system[FPSTR(S_WEBSERIAL)].to<JsonObject>();
webSerial[FPSTR(S_ENABLED)] = src.system.webSerial.enabled;
auto ntp = system[FPSTR(S_NTP)].to<JsonObject>();
ntp[FPSTR(S_SERVER)] = src.system.ntp.server;
@@ -576,7 +575,7 @@ bool jsonToSettings(const JsonVariantConst src, Settings& dst, bool safe = false
if (!src[FPSTR(S_SYSTEM)][FPSTR(S_LOG_LEVEL)].isNull()) {
uint8_t value = src[FPSTR(S_SYSTEM)][FPSTR(S_LOG_LEVEL)].as<uint8_t>();
if (value != dst.system.logLevel && value >= TinyLogger::Level::SILENT && value <= TinyLogger::Level::VERBOSE) {
if (value != dst.system.logLevel && value >= TinyLoggerLevel::SILENT && value <= TinyLoggerLevel::VERBOSE) {
dst.system.logLevel = value;
changed = true;
}
@@ -602,20 +601,11 @@ bool jsonToSettings(const JsonVariantConst src, Settings& dst, bool safe = false
}
}
if (src[FPSTR(S_SYSTEM)][FPSTR(S_TELNET)][FPSTR(S_ENABLED)].is<bool>()) {
bool value = src[FPSTR(S_SYSTEM)][FPSTR(S_TELNET)][FPSTR(S_ENABLED)].as<bool>();
if (src[FPSTR(S_SYSTEM)][FPSTR(S_WEBSERIAL)][FPSTR(S_ENABLED)].is<bool>()) {
bool value = src[FPSTR(S_SYSTEM)][FPSTR(S_WEBSERIAL)][FPSTR(S_ENABLED)].as<bool>();
if (value != dst.system.telnet.enabled) {
dst.system.telnet.enabled = value;
changed = true;
}
}
if (!src[FPSTR(S_SYSTEM)][FPSTR(S_TELNET)][FPSTR(S_PORT)].isNull()) {
unsigned short value = src[FPSTR(S_SYSTEM)][FPSTR(S_TELNET)][FPSTR(S_PORT)].as<unsigned short>();
if (value > 0 && value <= 65535 && value != dst.system.telnet.port) {
dst.system.telnet.port = value;
if (value != dst.system.webSerial.enabled) {
dst.system.webSerial.enabled = value;
changed = true;
}
}

8
src_data/locales/cn.json
View File

@@ -341,12 +341,8 @@
"enable": "启用串口",
"baud": "串口波特率"
},
"telnet": {
"enable": "启用 Telnet",
"port": {
"title": "Telnet 端口",
"note": "默认值：23"
}
"webSerial": {
"enable": "启用 WebSerial"
},
"ntp": {
"server": "NTP服务器",

8
src_data/locales/en.json
View File

@@ -341,12 +341,8 @@
"enable": "Enabled Serial port",
"baud": "Serial port baud rate"
},
"telnet": {
"enable": "Enabled Telnet",
"port": {
"title": "Telnet port",
"note": "Default: 23"
}
"webSerial": {
"enable": "Enabled WebSerial"
},
"ntp": {
"server": "NTP server",

8
src_data/locales/it.json
View File

@@ -341,12 +341,8 @@
"enable": "Porta seriale attivata",
"baud": "Porta seriale baud rate"
},
"telnet": {
"enable": "Telnet attivato",
"port": {
"title": "Porta Telnet",
"note": "Default: 23"
}
"webSerial": {
"enable": "WebSerial attivato"
},
"ntp": {
"server": "NTP server",

8
src_data/locales/nl.json
View File

@@ -313,12 +313,8 @@
"enable": "Seriële poort ingeschakeld",
"baud": "Baudrate seriële poort"
},
"telnet": {
"enable": "Telnet ingeschakeld",
"port": {
"title": "Telnet-poort",
"note": "Standaard: 23"
}
"webSerial": {
"enable": "WebSerial ingeschakeld"
},
"ntp": {
"server": "NTP-server",

8
src_data/locales/ru.json
View File

@@ -341,12 +341,8 @@
"enable": "Вкл. Serial порт",
"baud": "Скорость Serial порта"
},
"telnet": {
"enable": "Вкл. Telnet",
"port": {
"title": "Telnet порт",
"note": "По умолчанию: 23"
}
"webSerial": {
"enable": "Вкл. WebSerial"
},
"ntp": {
"server": "NTP сервер",

13
src_data/pages/settings.html
View File

@@ -126,8 +126,8 @@
</label>
<label>
<input type="checkbox" name="system[telnet][enabled]" value="true">
<span data-i18n>settings.system.telnet.enable</span>
<input type="checkbox" name="system[webSerial][enabled]" value="true">
<span data-i18n>settings.system.webSerial.enable</span>
</label>
<label>
@@ -156,12 +156,6 @@
<option value="115200">115200</option>
</select>
</label>
<label>
<span data-i18n>settings.system.telnet.port.title</span>
<input type="number" inputmode="numeric" name="system[telnet][port]" min="1" max="65535" step="1" required>
<small data-i18n>settings.system.telnet.port.note</small>
</label>
</div>
<mark data-i18n>settings.note.restart</mark>
@@ -876,8 +870,7 @@
setSelectValue("[name='system[logLevel]']", data.system.logLevel);
setCheckboxValue("[name='system[serial][enabled]']", data.system.serial.enabled);
setSelectValue("[name='system[serial][baudrate]']", data.system.serial.baudrate);
setCheckboxValue("[name='system[telnet][enabled]']", data.system.telnet.enabled);
setInputValue("[name='system[telnet][port]']", data.system.telnet.port);
setCheckboxValue("[name='system[webSerial][enabled]']", data.system.webSerial.enabled);
setInputValue("[name='system[ntp][server]']", data.system.ntp.server);
setInputValue("[name='system[ntp][timezone]']", data.system.ntp.timezone);
setRadioValue("[name='system[unitSystem]']", data.system.unitSystem);

8
src_data/scripts/utils.js
View File

@@ -313,6 +313,7 @@ const setupRestoreBackupForm = (formSelector) => {
console.log("Backup: ", data);
if (data.settings != undefined) {
for (var key in data.settings) {
let response = await fetch(url, {
method: "POST",
cache: "no-cache",
@@ -320,7 +321,11 @@ const setupRestoreBackupForm = (formSelector) => {
headers: {
"Content-Type": "application/json"
},
body: JSON.stringify({"settings": data.settings})
body: JSON.stringify({
"settings": {
[key]: data.settings[key]
}
})
});
if (!response.ok) {
@@ -328,6 +333,7 @@ const setupRestoreBackupForm = (formSelector) => {
return;
}
}
}
if (data.sensors != undefined) {
for (const sensorId in data.sensors) {