Tweak handling of json file paths to be consistent across the various spots where they are defined.

Author: MatthewColvin

Platformio/lib/Device/ActiveDeviceConfig.cpp

@@ -48,7 +48,7 @@ std::vector<IDevice::Ptr> ActiveDeviceConfig::loadDevices() {
 
   // #TODO OMOTE-Community/OMOTE-Firmware-object-oriented#72
   // HardwareFactory::getAbstract().debugPrint("Loaded JSON %s", content.c_str());
-  auto configPath = std::filesystem::path(ACTIVE_DEVICES_CONFIG_FILE);
+  std::filesystem::path configPath(ACTIVE_DEVICES_CONFIG_FILE);
   rapidjson::Document doc = OMOTE::JSON::GetDocument(configPath);
 
   if (!doc.IsArray())

Platformio/lib/HAL/Hardware/LoggingInterface.cpp

@@ -4,14 +4,12 @@
 #include <fstream>
 #include <rapidjson/document.h>
 
-#define LOG_SETTINGS_FILE "logSettings.json"
-
 void LoggingInterface::restoreSettings() {
   // Default to warning for all modules before loading from file
   // so new modules default to warning
   std::fill(mCurrentLogLevels.begin(), mCurrentLogLevels.end(), LogLevel::Warning);
 
-  std::filesystem::path settingsPath(FS_PATH LOG_SETTINGS_FILE);
+  std::filesystem::path settingsPath(LOG_SETTINGS_FILE);
   rapidjson::Document d = OMOTE::JSON::GetDocument(settingsPath);
 
   if (!d.HasParseError() && d.IsObject()) {
@@ -41,7 +39,7 @@ void LoggingInterface::saveSettings() {
     d.AddMember(key, val, d.GetAllocator());
   }
 
-  std::filesystem::path settingsPath(FS_PATH LOG_SETTINGS_FILE);
+  std::filesystem::path settingsPath(LOG_SETTINGS_FILE);
   OMOTE::JSON::WriteDocumentToFile(d, settingsPath);
 }
 

Platformio/lib/HAL/Hardware/LoggingInterface.hpp

@@ -101,6 +101,7 @@ class LoggingInterface {
   // Check level and module to see if we want to print the log
   static bool isPrintWanted(LogModule aModule, LogLevel aLevelToCheck);
   static inline std::array<LogLevel, NumLogModules> mCurrentLogLevels{};
+  static constexpr auto LOG_SETTINGS_FILE = FS_PATH "logSettings.json";
 };
 
 inline void LoggingInterface::setLogModule(LogModule aModule) {

Platformio/lib/HAL/Hardware/wifiHandlerInterface.h

@@ -104,4 +104,7 @@ class wifiHandlerInterface {
       std::make_shared<ScanNotificationTy>();
   std::shared_ptr<Notification<wifiStatus>> mStatusUpdate =
       std::make_shared<Notification<wifiStatus>>();
+
+  static constexpr auto MQTT_CONFIG_FILE = FS_PATH "mqtt.json";
+  static constexpr auto NTP_CONFIG_FILE = FS_PATH "ntp.json";
 };

Platformio/lib/SimulatorHalImpl/wifiHandlerSim/wifiHandlerSim.cpp

@@ -209,16 +209,16 @@ void wifiHandlerSim::mqttSaveCredentials() {
     d.AddMember("password", mMqttPassword, d.GetAllocator());
     d.AddMember("client", mMqttClientName, d.GetAllocator());
 
-    std::filesystem::path mqttJsonConfigPath(FS_PATH "mqtt.json");
+    std::filesystem::path mqttJsonConfigPath(MQTT_CONFIG_FILE);
     OMOTE::JSON::WriteDocumentToFile(d, mqttJsonConfigPath);
 
     mMqttSaveOnConnect = false;
   }
 }
 
 void wifiHandlerSim::restoreCredentials() {
-  std::filesystem::path mqttJson(FS_PATH "mqtt.json");
-  rapidjson::Document d = OMOTE::JSON::GetDocument(mqttJson);
+  std::filesystem::path mqttJsonConfigPath(MQTT_CONFIG_FILE);
+  rapidjson::Document d = OMOTE::JSON::GetDocument(mqttJsonConfigPath);
   if (d.HasParseError() || d.IsNull()) {
     return;
   }

Platformio/lib/esp32HalImpl/wifiHandler/wifihandler.cpp

@@ -316,8 +316,8 @@ void wifiHandler::enableMqtt(bool enabled) {
 
 void wifiHandler::mqttRestoreCredentials() {
   // restore from disk
-  std::filesystem::path aMqttPath(MQTT_CONFIG_FILE);
-  rapidjson::Document d = OMOTE::JSON::GetDocument(aMqttPath);
+  std::filesystem::path mqttConfigPath(MQTT_CONFIG_FILE);
+  rapidjson::Document d = OMOTE::JSON::GetDocument(mqttConfigPath);
   if (d.HasParseError() || d.IsNull()) {
     mLogger->error("Could not load MQTT credentials.");
     return;
@@ -369,8 +369,8 @@ void wifiHandler::ntpRestoreCredentials() {
   mNtpDisplayMode = ntpDisplayMode::constant;
 
   // restore from disk
-  std::filesystem::path ntpJsonConfig(NTP_CONFIG_FILE);
-  rapidjson::Document d = OMOTE::JSON::GetDocument(ntpJsonConfig);
+  std::filesystem::path ntpConfigPath(NTP_CONFIG_FILE);
+  rapidjson::Document d = OMOTE::JSON::GetDocument(ntpConfigPath);
 
   if (d.HasParseError() || d.IsNull()) {
     mLogger->error("Could not load NTP credentials.");

Platformio/lib/esp32HalImpl/wifiHandler/wifihandler.hpp

@@ -116,7 +116,6 @@ class wifiHandler : public wifiHandlerInterface {
   /**
    * @brief MQTT variables
    */
-  static constexpr auto MQTT_CONFIG_FILE = FS_PATH "mqtt.json";
   std::string mMqttBroker = "broker";
   std::string mMqttPort = "port";
   std::string mMqttUser = "user";
@@ -132,7 +131,6 @@ class wifiHandler : public wifiHandlerInterface {
   /**
    * @brief NTP variables
    */
-  static constexpr auto NTP_CONFIG_FILE = FS_PATH "ntp.json";
   bool mNtpEnabled = false;
   bool mNtpInitialised = false;
   std::string mNtpServer = "pool.ntp.org";