updated comments

This commit is contained in:
Proddy
2023-07-15 11:34:38 +02:00
parent 37724814be
commit 7bb6427ec9
15 changed files with 20 additions and 25 deletions

View File

@@ -1,6 +1,6 @@
#include <APSettingsService.h>
#include "../../src/emsesp_stub.hpp" // proddy added
#include "../../src/emsesp_stub.hpp"
APSettingsService::APSettingsService(AsyncWebServer * server, FS * fs, SecurityManager * securityManager)
: _httpEndpoint(APSettings::read, APSettings::update, this, server, AP_SETTINGS_SERVICE_PATH, securityManager)

View File

@@ -18,10 +18,7 @@ void FactoryResetService::handleRequest(AsyncWebServerRequest * request) {
* Delete function assumes that all files are stored flat, within the config directory.
*/
void FactoryResetService::factoryReset() {
/*
* Based on LittleFS. Modified by proddy
* Could be replaced with fs.rmdir(FS_CONFIG_DIRECTORY) in IDF 4.2
*/
// TODO Could be replaced with fs.rmdir(FS_CONFIG_DIRECTORY) in IDF 4.2
File root = fs->open(FS_CONFIG_DIRECTORY);
File file;
while (file = root.openNextFile()) {

View File

@@ -1,5 +1,5 @@
#include <FeaturesService.h>
#include "../../src/emsesp_stub.hpp" // proddy added
#include "../../src/emsesp_stub.hpp"
using namespace std::placeholders; // for `_1` etc

View File

@@ -115,7 +115,7 @@ class HttpPostEndpoint {
response->setLength();
if (outcome == StateUpdateResult::CHANGED_RESTART) {
response->setCode(205); // added by proddy, reboot required
response->setCode(205); // reboot required
}
request->send(response);
}

View File

@@ -1,6 +1,6 @@
#include <MqttSettingsService.h>
#include "../../src/emsesp_stub.hpp" // proddy added
#include "../../src/emsesp_stub.hpp"
using namespace std::placeholders; // for `_1` etc
@@ -144,7 +144,6 @@ void MqttSettingsService::onConfigUpdated() {
_reconfigureMqtt = true;
_disconnectedAt = 0;
// added by proddy
startClient();
emsesp::EMSESP::mqtt_.start(); // reload EMS-ESP MQTT settings
}
@@ -231,7 +230,6 @@ void MqttSettings::read(MqttSettings & settings, JsonObject & root) {
root["clean_session"] = settings.cleanSession;
root["entity_format"] = settings.entity_format;
// added by proddy for EMS-ESP
root["publish_time_boiler"] = settings.publish_time_boiler;
root["publish_time_thermostat"] = settings.publish_time_thermostat;
root["publish_time_solar"] = settings.publish_time_solar;

View File

@@ -76,7 +76,7 @@ class MqttSettings {
uint16_t keepAlive;
bool cleanSession;
// proddy EMS-ESP specific
// EMS-ESP specific
String base;
uint16_t publish_time_boiler;
uint16_t publish_time_thermostat;

View File

@@ -1,6 +1,6 @@
#include <MqttStatus.h>
#include "../../src/emsesp_stub.hpp" // proddy added
#include "../../src/emsesp_stub.hpp"
using namespace std::placeholders; // for `_1` etc
@@ -20,9 +20,9 @@ void MqttStatus::mqttStatus(AsyncWebServerRequest * request) {
root["client_id"] = _mqttSettingsService->getClientId();
root["disconnect_reason"] = (uint8_t)_mqttSettingsService->getDisconnectReason();
root["mqtt_queued"] = emsesp::Mqtt::publish_queued(); // mdvp added
root["mqtt_fails"] = emsesp::Mqtt::publish_fails(); // proddy added
root["connect_count"] = emsesp::Mqtt::connect_count(); // mdvp added
root["mqtt_queued"] = emsesp::Mqtt::publish_queued();
root["mqtt_fails"] = emsesp::Mqtt::publish_fails();
root["connect_count"] = emsesp::Mqtt::connect_count();
response->setLength();
request->send(response);

View File

@@ -1,7 +1,7 @@
#include <NTPSettingsService.h>
#include <esp_sntp.h>
#include "../../src/emsesp_stub.hpp" // proddy added
#include "../../src/emsesp_stub.hpp"
using namespace std::placeholders; // for `_1` etc

View File

@@ -1,5 +1,5 @@
#include <NTPStatus.h>
#include "../../src/emsesp_stub.hpp" // proddy added
#include "../../src/emsesp_stub.hpp"
using namespace std::placeholders; // for `_1` etc

View File

@@ -1,6 +1,6 @@
#include <NetworkStatus.h>
#include "../../src/emsesp_stub.hpp" // proddy added
#include "../../src/emsesp_stub.hpp"
using namespace std::placeholders; // for `_1` etc

View File

@@ -1,6 +1,6 @@
#include <OTASettingsService.h>
#include "../../src/emsesp_stub.hpp" // proddy added
#include "../../src/emsesp_stub.hpp"
using namespace std::placeholders; // for `_1` etc

View File

@@ -2,7 +2,7 @@
#if FT_ENABLED(FT_SECURITY)
#include "../../src/emsesp_stub.hpp" // proddy added
#include "../../src/emsesp_stub.hpp"
SecuritySettingsService::SecuritySettingsService(AsyncWebServer * server, FS * fs)
: _httpEndpoint(SecuritySettings::read, SecuritySettings::update, this, server, SECURITY_SETTINGS_PATH, this)

View File

@@ -19,7 +19,7 @@
enum class StateUpdateResult {
CHANGED = 0, // The update changed the state and propagation should take place if required
CHANGED_RESTART, // a restart of the device is needed - added by proddy
CHANGED_RESTART, // a restart of the device is needed
UNCHANGED, // The state was unchanged, propagation should not take place
ERROR // There was a problem updating the state, propagation should not take place
};

View File

@@ -1,7 +1,7 @@
#include <SystemStatus.h>
#include <esp_ota_ops.h>
#include "../../src/emsesp_stub.hpp" // proddy added
#include "../../src/emsesp_stub.hpp"
using namespace std::placeholders; // for `_1` etc