Batch of enhancements and fixes: optional user.ini support, filesystem check, improved Spotify messaging

Author: Electric-Diversions

.gitignore

@@ -1,3 +1,4 @@
 .pio
 .vscode
 src/compile_time.h
+data/user.ini

data/user.ini.template

@@ -0,0 +1,31 @@
+;
+; User settings for Spotify Controller.  Make sure to Upload Filesystem
+; Image after updating.
+;
+; ----------------------------------------------------------------------
+; Privacy Levels:
+;    0 - None (credentials in clear text)
+;    1 - Good (encrypted, reusable across devices)
+;    2 - Better (encrypted, tied to this device)
+; ----------------------------------------------------------------------
+[vault]
+privacy_level = 0
+; ----------------------------------------------------------------------
+; WiFi:
+; ----------------------------------------------------------------------
+[wifi]
+ssid = Your WiFi Name Here
+password = Your WiFi Password Here
+; ----------------------------------------------------------------------
+; Spotify:
+; ----------------------------------------------------------------------
+[spotify]
+client_id = Enter your Spotify Client ID here
+client_secret = Enter your Spotify Client Secret here
+; ----------------------------------------------------------------------
+; System Settings:
+; Timezone format - see
+;      https://github.com/nayarsystems/posix_tz_db/blob/master/zones.csv
+; ----------------------------------------------------------------------
+[system]
+timezone = CST6CDT,M3.2.0,M11.1.0

src/SCFileIO.cpp

@@ -63,34 +63,36 @@ SCFileIO::~SCFileIO()
 **
 ** ===================================================================
 */
-void SCFileIO::initialize()
+bool SCFileIO::initialize()
 {
     if (!xSemaphoreFileIO)
     {
         xSemaphoreFileIO = xSemaphoreCreateMutex();
         if (!xSemaphoreFileIO)
         {
             spLogE(LOGTAG_FILEIO, "Failed to create semaphore!");
-            return;
+            return false;
         }
     }
 
     if (!takeSemaphore())
     {
         spLogE(LOGTAG_FILEIO, "Failed to acquire semaphore for initialize().");
-        return;
+        return false;
     }
 
     if (LittleFS.begin())
     {
         spLogI(LOGTAG_FILEIO, "Flash FS available!");
         giveSemaphore();
         listFiles();
+        return true;
     }
     else
     {
         giveSemaphore();
         spLogE(LOGTAG_FILEIO, "Flash FS initialization failed!");
+        return false;
     }
 
 

src/SCFileIO.h

@@ -32,7 +32,7 @@ class SCFileIO
     static SCFileIO& getInstance();
 
     // Initializes the semaphore. Must be called before using the class.
-    void initialize();
+    bool initialize();
 
     // Opens a file safely using LittleFS
     File open(const char *path, const char *mode);

src/SpotifyPlayer.cpp

@@ -29,57 +29,6 @@
 
 #include <TJpg_Decoder.h> // Ensure you include the required decoder library
 
-// HTTP client setup remains as is in your project
-
-int SpotifyPlayer::getAlbumReleaseYear() 
-{
-    // // if (!_pCurrentTrack->albumUri || strlen(_pCurrentTrack->albumUri) == 0) 
-    // if (_currentlyPlayingMetadata.albumUri == nullptr)
-    // {
-    //     spLogE(LOGTAG_PLAYER, "Album URI is empty.");
-    //     return -1; // Indicate error
-    // }
-
-    // // Extract album ID from albumUri (typically of the form spotify:album:<id>)
-    // String albumId = String(_currentlyPlayingMetadata.albumUri).substring(14); // Skip "spotify:album:"
-
-    // String url = "https://api.spotify.com/v1/albums/" + albumId + "?market=US";
-
-    // HTTPClient http;
-    // WiFiClientSecure wifiClient;
-    // //wifiClient.setInsecure();  // TODO: Remove... just debugging...
-    // wifiClient.setCACert(spotify_server_cert); // Ensure proper certificate
-
-    // http.begin(wifiClient, url);
-    // http.addHeader("Authorization", "Bearer " + _spotifyRefreshToken); // Use your Spotify token
-
-    // int httpCode = http.GET();
-    // if (httpCode != 200) 
-    // {
-    //     spLogE(LOGTAG_PLAYER, "Failed to get album details, HTTP code: %d", httpCode);
-    //     http.end();
-    //     return -1;
-    // }
-
-    // // Parse JSON response
-    // String payload = http.getString();
-    // http.end();
-
-    // DynamicJsonDocument doc(1024);
-    // deserializeJson(doc, payload);
-
-    // // Get release_date (e.g., "2020-05-01")
-    // const char* releaseDate = doc["release_date"];
-    // if (releaseDate && strlen(releaseDate) >= 4) 
-    // {
-    //     String year = String(releaseDate).substring(0, 4);
-    //     return year.toInt();
-    // }
-
-    // // spLogE(LOGTAG_PLAYER, "Release date not found in album details.");
-    return -1; // Indicate error
-}
-
 // Spotify related
 #define SP_SPOTIFY_MARKET         "IE"
 
@@ -127,9 +76,21 @@ SpotifyPlayer& SpotifyPlayer::getInstance()
 
 void SpotifyPlayer::initialize(QueueHandle_t    *pScuiQueue)
 {
-    // _pUI        = pUI;
     _pScuiQueue = pScuiQueue;
-    initSpotify();
+
+    // keep reference since SpotifyArduino is dependent on values
+    // remaining in memory
+    _spotifyClientId     = Vault::getInstance().getSpotifyClientID();
+    _spotifyClientSecret = Vault::getInstance().getSpotifyClientSecret();
+
+   _pSpotify = new SpotifyArduino(
+        client,
+        _spotifyClientId.c_str(),
+        _spotifyClientSecret.c_str()
+    );    
+    // client is defined in ThingPulse/spotify.h
+    client.setCACert(spotify_server_cert);  
+    
 }
 
 /*
@@ -170,30 +131,48 @@ void SpotifyPlayer::startBackgroundRefreshes()
 
 /*
 ** ===================================================================
-** verifyRefreshToken()
+** isRefreshTokenAvailable()
 **
-** Returns true if previously saved token found; false otherwise.
+** Returns whether the refresh token is available.  This will also
+** internally initialize the token if it exists.
 ** ===================================================================
 */
-bool SpotifyPlayer::verifyRefreshToken()
+bool SpotifyPlayer::isRefreshTokenAvailable()
 {
-    _spotifyRefreshToken = SCFileIO::getInstance().readFsString(SPOTIFY_REFRESH_TOKEN_FILE_NAME);
-    if (_spotifyRefreshToken == "") 
-    {
-        spLogI(LOGTAG_PLAYER, "No Spotify refresh token found. Requesting one through the browser via auth code.");
+   _spotifyRefreshToken = SCFileIO::getInstance().readFsString(SPOTIFY_REFRESH_TOKEN_FILE_NAME);
+   
+   if (_spotifyRefreshToken == "")
+   {
+        spLogI(LOGTAG_PLAYER, "Spotify refresh token not found.");
+        return false;
+   }
+   else
+   {
+        spLogI(LOGTAG_PLAYER, "Spotify refresh token found.");
+        return true;
+   }
+}
 
-        String spotifyAuthCode = fetchSpotifyAuthCode();
-        _spotifyRefreshToken = spotify.requestAccessTokens(spotifyAuthCode.c_str(), SPOTIFY_REDIRECT_URI);
-        SCFileIO::getInstance().saveFsString(SPOTIFY_REFRESH_TOKEN_FILE_NAME, _spotifyRefreshToken);
+/*
+** ===================================================================
+** requestRefreshToken()
+**
+** Requests a fresh refresh token.  A refresh token is a security 
+** credential that allows client applications to obtain new access
+** tokens without requiring users to reauthorize the application.
+** ===================================================================
+*/
+bool SpotifyPlayer::requestRefreshToken()
+{
 
-        return false;
+    spLogI(LOGTAG_PLAYER, "Requesting Spotify refresh token through the browser via auth code.");
+
+    String spotifyAuthCode = fetchSpotifyAuthCode();
+    _spotifyRefreshToken = _pSpotify->requestAccessTokens(spotifyAuthCode.c_str(), SPOTIFY_REDIRECT_URI);
+    SCFileIO::getInstance().saveFsString(SPOTIFY_REFRESH_TOKEN_FILE_NAME, _spotifyRefreshToken);
+
+    return true;
 
-    } 
-    else 
-    {
-        spLogI(LOGTAG_PLAYER, "Using previously saved Spotify refresh token.");
-        return true;
-    }
 }
 
 /*
@@ -217,8 +196,8 @@ void SpotifyPlayer::login()
     // - keeps track of the refresh token and its TTL internally
     // - automatically renews the actual access token using the refresh token
     // -> see SpotifyArduino.h#autoTokenRefresh and SpotifyArduino::checkAndRefreshAccessToken() (called before every API function)
-    spotify.setRefreshToken(_spotifyRefreshToken.c_str());
-    spotify.refreshAccessToken();
+    _pSpotify->setRefreshToken(_spotifyRefreshToken.c_str());
+    _pSpotify->refreshAccessToken();
     spLogI(LOGTAG_PLAYER, "Authentication against Spotify done. Refresh token: %s", _spotifyRefreshToken.c_str());    
 }
 
@@ -273,7 +252,7 @@ void SpotifyPlayer::nextSong()
                     static_cast<int>(TFTColor::SC_NetworkInProgress));
     if (xSemaphoreTake(_xSemaphoreNetwork, portMAX_DELAY)) 
     {
-        if (spotify.nextTrack())
+        if (_pSpotify->nextTrack())
         {
             //_pUI->drawStatusBox(TFTColor::SC_NetworkSuccess); 
             postScuiMessage(SCUIMessageType::UM_STATUS_BOX,
@@ -316,7 +295,7 @@ void SpotifyPlayer::previousSong()
 
     if (xSemaphoreTake(_xSemaphoreNetwork, portMAX_DELAY)) 
     {
-        if (spotify.previousTrack())
+        if (_pSpotify->previousTrack())
         {
             // _pUI->drawStatusBox(TFTColor::SC_NetworkSuccess); 
             postScuiMessage(SCUIMessageType::UM_STATUS_BOX,
@@ -362,7 +341,7 @@ void SpotifyPlayer::pauseSong()
             postScuiMessage(SCUIMessageType::UM_STATUS_BOX,
                             "Making Call",
                             static_cast<int>(TFTColor::SC_NetworkInProgress));    
-            if (spotify.pause())
+            if (_pSpotify->pause())
             {
                 // _pUI->drawStatusBox(TFTColor::SC_NetworkSuccess); 
                 postScuiMessage(SCUIMessageType::UM_STATUS_BOX,
@@ -385,7 +364,7 @@ void SpotifyPlayer::pauseSong()
             postScuiMessage(SCUIMessageType::UM_STATUS_BOX,
                             "Making Call",
                             static_cast<int>(TFTColor::SC_NetworkInProgress));    
-            if (spotify.play())
+            if (_pSpotify->play())
             {
                 // _pUI->drawStatusBox(TFTColor::SC_NetworkSuccess); 
                 postScuiMessage(SCUIMessageType::UM_STATUS_BOX,
@@ -435,7 +414,7 @@ void SpotifyPlayer::refreshCurrentTrack()
             spLogI(LOGTAG_MULTITASK, "Invoking spotify.getCurrentlyPlaying(...)");
             // vTaskDelay(pdMS_TO_TICKS(200));
             Monitor::start(MONITOR_ID_SPOTIFY_GET_CURRENTLY_PLAYING, LOGTAG_METRICS, "spotify.getCurrentlyPlaying(...)");
-            status = spotify.getCurrentlyPlaying(SpotifyPlayer::getCurrentlyPlayingCallback, SP_SPOTIFY_MARKET);
+            status = _pSpotify->getCurrentlyPlaying(SpotifyPlayer::getCurrentlyPlayingCallback, SP_SPOTIFY_MARKET);
             Monitor::stop(MONITOR_ID_SPOTIFY_GET_CURRENTLY_PLAYING);
             xSemaphoreGive(_xSemaphoreNetwork);
         }

src/SpotifyPlayer.h

@@ -21,14 +21,17 @@
 #include "PlayingMetadata.h"
 #include "scui.h"
 
+// Forward declaration to avoid including full spotify.h in the header
+class SpotifyArduino;
 class SpotifyPlayer {
 public:
     // Public method to access the singleton instance
     static SpotifyPlayer& getInstance();
 
     // initialization related
     void   initialize(QueueHandle_t    *pScuiQueue);
-    bool   verifyRefreshToken();
+    bool   isRefreshTokenAvailable();
+    bool   requestRefreshToken();
     String getNodeName();
     void   login();
     void   startBackgroundRefreshes();
@@ -63,6 +66,9 @@ class SpotifyPlayer {
     SemaphoreHandle_t   _xSemaphoreNetwork     = xSemaphoreCreateMutex();
     SemaphoreHandle_t   _xSemaphoreDataCopy    = xSemaphoreCreateMutex();
     TaskHandle_t        _refreshTaskHandle;
+    SpotifyArduino      *_pSpotify             = nullptr;
+    String              _spotifyClientId;
+    String              _spotifyClientSecret;
 
     // Methods
 
@@ -82,6 +88,5 @@ class SpotifyPlayer {
     void   postScuiMessage(SCUIMessageType type, const String& str, int num);
 
     void   saveCache();
-    int    getAlbumReleaseYear();
 
 };

src/ThingPulse/connectivity.cpp

@@ -20,27 +20,24 @@
 #include <WiFi.h>
 
 #include "connectivity.h"
-#include "../settings.h"
-#include "ThingPulse/util.h"  
+#include "ThingPulse/util.h"
+#include "../Vault.h"  
 
 /*
 ** ===================================================================
-** WiFi settings
+** startWiFi()
+**    Attempt to connect to the configured WiFi network
 ** ===================================================================
 */
-const char *SSIDEnc      = "SSID Goes Here";
-const char *WIFI_PWD_Enc = "WiFi Password Goes Here";
+void startWiFi() {
 
+ String ssid = Vault::getInstance().getSSID();
 
-// Updated to use encrypted network credentials
-void startWiFi() {
-  static const char k[] = "42";
-  char decryptedSSID[50]; 
-  char decryptedWIFI_PWD[50];
-  simpleDecrypt(SSIDEnc, k, decryptedSSID);
-  simpleDecrypt(WIFI_PWD_Enc, k , decryptedWIFI_PWD);
-  WiFi.begin(decryptedSSID, decryptedWIFI_PWD);
-  log_i("Connecting to WiFi '%s'...", decryptedSSID);
+//  log_i("WiFi ssid/pw '%s' '%s'", ssid.c_str(), Vault::getInstance().getWiFiPassword().c_str());
+
+  WiFi.begin(ssid, Vault::getInstance().getWiFiPassword());
+
+  log_i("Connecting to WiFi '%s'...", ssid);
   while (WiFi.status() != WL_CONNECTED) {
     //log_i(".");
     Serial.print(".");