tidy up EMSESP_DEBUG

This commit is contained in:
proddy
2024-09-15 18:09:15 +02:00
parent 3e9b18222b
commit 77b5e934a3
9 changed files with 30 additions and 52 deletions

View File

@@ -3,8 +3,9 @@
# This is mainly used to generate the .o files for SonarQube analysis # This is mainly used to generate the .o files for SonarQube analysis
# #
NUMJOBS=${NUMJOBS:-" -j2 "} # NUMJOBS=${NUMJOBS:-" -j10 "}
MAKEFLAGS+="j " # MAKEFLAGS+="j "
#---------------------------------------------------------------------- #----------------------------------------------------------------------
# Project Structure # Project Structure
#---------------------------------------------------------------------- #----------------------------------------------------------------------

View File

@@ -26,11 +26,11 @@ class FSPersistence {
if (error == DeserializationError::Ok && jsonDocument.is<JsonObject>()) { if (error == DeserializationError::Ok && jsonDocument.is<JsonObject>()) {
JsonObject jsonObject = jsonDocument.as<JsonObject>(); JsonObject jsonObject = jsonDocument.as<JsonObject>();
_statefulService->updateWithoutPropagation(jsonObject, _stateUpdater); _statefulService->updateWithoutPropagation(jsonObject, _stateUpdater);
#ifdef EMSESP_DEBUG #if defined(EMSESP_DEBUG)
Serial.println(); // Serial.println();
Serial.printf("Reading settings from %s ", _filePath); // Serial.printf("Reading settings from %s ", _filePath);
serializeJson(jsonDocument, Serial); // serializeJson(jsonDocument, Serial);
Serial.println(); // Serial.println();
#endif #endif
settingsFile.close(); settingsFile.close();
return; return;
@@ -40,10 +40,10 @@ class FSPersistence {
// If we reach here we have not been successful in loading the config, // If we reach here we have not been successful in loading the config,
// hard-coded emergency defaults are now applied. // hard-coded emergency defaults are now applied.
#ifdef EMSESP_DEBUG #if defined(EMSESP_DEBUG)
Serial.println(); // Serial.println();
Serial.printf("Applying defaults to %s", _filePath); // Serial.printf("Applying defaults to %s", _filePath);
Serial.println(); // Serial.println();
#endif #endif
applyDefaults(); applyDefaults();
writeToFS(); // added to make sure the initial file is created writeToFS(); // added to make sure the initial file is created
@@ -74,11 +74,11 @@ class FSPersistence {
} }
// serialize the data to the file // serialize the data to the file
#ifdef EMSESP_DEBUG #if defined(EMSESP_DEBUG)
Serial.println(); // Serial.println();
Serial.printf("Writing settings to %s ", _filePath); // Serial.printf("Writing settings to %s ", _filePath);
serializeJson(jsonDocument, Serial); // serializeJson(jsonDocument, Serial);
Serial.println(); // Serial.println();
#endif #endif
serializeJson(jsonDocument, settingsFile); serializeJson(jsonDocument, settingsFile);
settingsFile.close(); settingsFile.close();

View File

@@ -133,11 +133,7 @@ MqttClient * MqttSettingsService::getMqttClient() {
void MqttSettingsService::onMqttConnect(bool sessionPresent) { void MqttSettingsService::onMqttConnect(bool sessionPresent) {
(void)sessionPresent; (void)sessionPresent;
// _disconnectedAt = 0;
emsesp::EMSESP::mqtt_.on_connect(); emsesp::EMSESP::mqtt_.on_connect();
#ifdef EMSESP_DEBUG
emsesp::EMSESP::logger().debug("Connected to MQTT, %s", (sessionPresent) ? ("with persistent session") : ("without persistent session"));
#endif
} }
void MqttSettingsService::onMqttDisconnect(espMqttClientTypes::DisconnectReason reason) { void MqttSettingsService::onMqttDisconnect(espMqttClientTypes::DisconnectReason reason) {
@@ -190,7 +186,7 @@ bool MqttSettingsService::configureMqtt() {
_reconfigureMqtt = false; _reconfigureMqtt = false;
#ifndef TASMOTA_SDK #ifndef TASMOTA_SDK
if (_state.enableTLS) { if (_state.enableTLS) {
#if EMSESP_DEBUG #if defined(EMSESP_DEBUG)
emsesp::EMSESP::logger().debug("Start secure MQTT with rootCA"); emsesp::EMSESP::logger().debug("Start secure MQTT with rootCA");
#endif #endif
static_cast<espMqttClientSecure *>(_mqttClient)->setServer(_state.host.c_str(), _state.port); static_cast<espMqttClientSecure *>(_mqttClient)->setServer(_state.host.c_str(), _state.port);

View File

@@ -180,9 +180,8 @@ void NetworkSettingsService::setWiFiPowerOnRSSI() {
else if (min_tx_pwr > 20) else if (min_tx_pwr > 20)
p = WIFI_POWER_5dBm; p = WIFI_POWER_5dBm;
#ifdef EMSESP_DEBUG #if defined(EMSESP_DEBUG)
uint8_t set_power = min_tx_pwr / 10; // this is the recommended power setting to use // emsesp::EMSESP::logger().debug("Recommended WiFi Tx Power (set_power %d, new power %d, rssi %d, threshold %d)", min_tx_pwr / 10, p, rssi, threshold);
emsesp::EMSESP::logger().debug("Recommended WiFi Tx Power (set_power %d, new power %d, rssi %d, threshold %d)", set_power, p, rssi, threshold);
#endif #endif
if (!WiFi.setTxPower(p)) { if (!WiFi.setTxPower(p)) {

View File

@@ -686,7 +686,7 @@ void EMSESPShell::end_of_transmission() {
void EMSESPShell::main_help_function(Shell & shell, const std::vector<std::string> & arguments) { void EMSESPShell::main_help_function(Shell & shell, const std::vector<std::string> & arguments) {
shell.println(); shell.println();
#ifndef EMSESP_DEBUG #if defined(EMSESP_DEBUG)
shell.printfln("%s%sEMS-ESP version %s%s", COLOR_BRIGHT_GREEN, COLOR_BOLD_ON, EMSESP_APP_VERSION, COLOR_RESET); shell.printfln("%s%sEMS-ESP version %s%s", COLOR_BRIGHT_GREEN, COLOR_BOLD_ON, EMSESP_APP_VERSION, COLOR_RESET);
#else #else
shell.printfln("%s%sEMS-ESP version %s%s (DEBUG)", COLOR_BRIGHT_GREEN, COLOR_BOLD_ON, EMSESP_APP_VERSION, COLOR_RESET); shell.printfln("%s%sEMS-ESP version %s%s (DEBUG)", COLOR_BRIGHT_GREEN, COLOR_BOLD_ON, EMSESP_APP_VERSION, COLOR_RESET);

View File

@@ -1682,8 +1682,8 @@ bool EMSdevice::generate_values(JsonObject output, const int8_t tag_filter, cons
// do not overwrite // do not overwrite
if (json.containsKey(name)) { if (json.containsKey(name)) {
#ifdef EMSESP_DEBUG #if defined(EMSESP_DEBUG)
EMSESP::logger().debug("double json key: %s", name); EMSESP::logger().debug("warning: double json key: %s", name);
#endif #endif
continue; continue;
} }

View File

@@ -132,19 +132,6 @@ class Telegram {
// check for out of bounds, if so don't modify the value // check for out of bounds, if so don't modify the value
auto msg_size = (index - this->offset + num_bytes - 1); auto msg_size = (index - this->offset + num_bytes - 1);
#ifdef EMSESP_DEBUG
// Serial.print(" index: ");
// Serial.print(index);
// Serial.print(" offset: ");
// Serial.print(offset);
// Serial.print(" index: ");
// Serial.print(" message_length: ");
// Serial.print(this->message_length);
// Serial.print(" msg_size: ");
// Serial.print(msg_size);
// Serial.println();
#endif
if ((index < this->offset) || (msg_size >= this->message_length) || (msg_size > EMS_MAX_TELEGRAM_MESSAGE_LENGTH)) { if ((index < this->offset) || (msg_size >= this->message_length) || (msg_size > EMS_MAX_TELEGRAM_MESSAGE_LENGTH)) {
return false; return false;
} }
@@ -443,13 +430,8 @@ class TxService : public EMSbus {
return tx_telegrams_.empty(); return tx_telegrams_.empty();
} }
#if defined(EMSESP_DEBUG) static constexpr uint8_t MAXIMUM_TX_RETRIES = 3;
static constexpr uint8_t MAXIMUM_TX_RETRIES = 0; // when compiled with EMSESP_DEBUG don't retry static constexpr uint32_t POST_SEND_DELAY = 2000;
#else
static constexpr uint8_t MAXIMUM_TX_RETRIES = 3;
#endif
static constexpr uint32_t POST_SEND_DELAY = 2000;
private: private:
std::deque<QueuedTxTelegram> tx_telegrams_; // the Tx queue std::deque<QueuedTxTelegram> tx_telegrams_; // the Tx queue

View File

@@ -93,7 +93,7 @@ StateUpdateResult WebSettings::update(JsonObject root, WebSettings & settings) {
bool psram = false; bool psram = false;
#endif #endif
#ifdef EMSESP_DEBUG #if defined(EMSESP_DEBUG)
EMSESP::logger().debug("NVS boot value=[%s], board profile=[%s], EMSESP_DEFAULT_BOARD_PROFILE=[%s]", EMSESP::logger().debug("NVS boot value=[%s], board profile=[%s], EMSESP_DEFAULT_BOARD_PROFILE=[%s]",
EMSESP::nvs_.getString("boot").c_str(), EMSESP::nvs_.getString("boot").c_str(),
root["board_profile"] | "", root["board_profile"] | "",
@@ -111,7 +111,7 @@ StateUpdateResult WebSettings::update(JsonObject root, WebSettings & settings) {
if (!EMSESP::system_.getBBQKeesGatewayDetails().isEmpty()) { if (!EMSESP::system_.getBBQKeesGatewayDetails().isEmpty()) {
String nvs_boot = EMSESP::nvs_.getString("boot"); String nvs_boot = EMSESP::nvs_.getString("boot");
if (!nvs_boot.isEmpty()) { if (!nvs_boot.isEmpty()) {
#ifdef EMSESP_DEBUG #if defined(EMSESP_DEBUG)
EMSESP::logger().debug("Overriding board profile with NVS boot value %s"); EMSESP::logger().debug("Overriding board profile with NVS boot value %s");
#endif #endif
settings.board_profile = nvs_boot; settings.board_profile = nvs_boot;
@@ -145,7 +145,7 @@ StateUpdateResult WebSettings::update(JsonObject root, WebSettings & settings) {
// still don't have a valid board profile. Let's see if we can determine one // still don't have a valid board profile. Let's see if we can determine one
if (settings.board_profile == "default") { if (settings.board_profile == "default") {
#ifdef EMSESP_DEBUG #if defined(EMSESP_DEBUG)
EMSESP::logger().debug("Trying to detect board and set board profile..."); EMSESP::logger().debug("Trying to detect board and set board profile...");
#endif #endif

View File

@@ -82,7 +82,7 @@ void WebStatusService::systemStatus(AsyncWebServerRequest * request) {
#endif #endif
} }
#ifdef EMSESP_DEBUG #if defined(EMSESP_DEBUG)
#ifdef EMSESP_TEST #ifdef EMSESP_TEST
root["build_flags"] = "DEBUG,TEST"; root["build_flags"] = "DEBUG,TEST";
#else #else
@@ -155,7 +155,7 @@ void WebStatusService::checkUpgrade(AsyncWebServerRequest * request, JsonVariant
const std::string latest_version = json["version"] | EMSESP_APP_VERSION; const std::string latest_version = json["version"] | EMSESP_APP_VERSION;
version::Semver200_version this_version(latest_version); version::Semver200_version this_version(latest_version);
#ifdef EMSESP_DEBUG #if defined(EMSESP_DEBUG)
emsesp::EMSESP::logger().debug("Checking for upgrade: %s > %s", EMSESP_APP_VERSION, latest_version.c_str()); emsesp::EMSESP::logger().debug("Checking for upgrade: %s > %s", EMSESP_APP_VERSION, latest_version.c_str());
#endif #endif