Add Tips and Known Issues. Minor code cleanup.

Author: Electric-Diversions

README.md

@@ -137,4 +137,8 @@ See [full user settings documentation](./documentation/UserSettings.md) for deta
 
   <img src="./images/platformio-task-upload.png" width="400">
 
-See [instructions](https://docs.thingpulse.com/guides/esp32-color-kit-grande/#development-environment) if you encounter problems and need Trouble Shooting tips.
+See [instructions](https://docs.thingpulse.com/guides/esp32-color-kit-grande/#development-environment) if you encounter problems and need Trouble Shooting tips.
+
+## Tips and Known Issues
+
+To see a list of tips and known issues, see [Tips and Known Issues](./documentation/TipsAndKnownIssues.md).

documentation/TipsAndKnownIssues.md

@@ -0,0 +1,35 @@
+# Tips
+- To surpress logging from the SpotifyAruduion library, goto the `SpotifyArduino.h` and commend out the following lines: 
+```
+#define SPOTIFY_DEBUG 1
+
+// Comment out if you want to disable any serial output from this library (also comment out DEBUG and PRINT_JSON_PARSE)
+#define SPOTIFY_SERIAL_OUTPUT 1
+
+// Prints the JSON received to serial (only use for debugging as it will be slow)
+#define SPOTIFY_PRINT_JSON_PARSE 1
+```
+
+- If you have a Color Kit Grande with 8 MB or more of Flash memory, you can expand the album art cache from 10 albums to 60 albums by using these settings in `platformio.ini`.  See the file for additional comments.
+```
+board = custom_esp-wrover-kit
+board_build.partitions = partitions/custom_no_ota.csv
+```
+
+- If you want to update your WiFi and Spotify credentials without modifying the source code, use the optional `user.ini` file.  The file is ignored by Git and does not require changing code. See [full user settings documentation](./UserSettings.md) for details.
+
+# Known Issues
+- Some capabilities require a Spotify Premium subscription and may not work fully on the ad supported tier. https://developer.spotify.com/documentation/web-playback-sdk
+
+- At startup if nothing is playing the following may be logged repeatedly:
+`20:13:34.148 > [ 15318][E][ssl_client.cpp:37] _handle_error(): [data_to_read():361]: (-76) UNKNOWN ERROR CODE (004C)`
+When there isn't currently an active device or a device has been stopped for a period of time, playback controls may not work and these errors may be seen in the logs.  Once music is started/resumed on the active device the errors will go away.
+
+- When playback operations are performed, the SpotifyArdiuno library may log the following. It doesn't appear to affect the operation from actually working.
+```
+23:24:36.283 > [ 67244][V][ssl_client.cpp:369] send_ssl_data(): Writing HTTP request with 0 bytes...
+23:24:36.440 > [ 67407][V][ssl_client.cpp:381] send_ssl_data(): Handling error -80
+23:24:36.446 > [ 67408][E][ssl_client.cpp:37] _handle_error(): [send_ssl_data():382]: (-80) UNKNOWN ERROR CODE (0050)
+23:24:36.452 > [ 67412][V][ssl_client.cpp:321] stop_ssl_socket(): Cleaning SSL connection.
+23:24:36.457 > Failed to send request
+```

documentation/UserSettings.md

@@ -1,6 +1,6 @@
 # Color Kit Grande Spotify Controller User Settings
 
-This document explains how to configure the required user settings for the Color Kit Grande Spotify Controller. These include your Wi-Fi credentials, Spotify developer information, and timezone configuration.
+In order for this project to function, it needs to be able to connect to a WiFi network and authenticate with Spotify. This document explains how to configure it to do these things. 
 
 These values must be set before the device can connect to your network or Spotify account.
 

src/SCFileIO.cpp

@@ -446,7 +446,7 @@ void SCFileIO::giveSemaphore()
 void SCFileIO::hexDump(const char* tag, const char* filePath)
 {
 
-    spLogI(tag, "attempting hexDump in SCFileIO::hexDump()... ");
+    spLogV(tag, "attempting hexDump in SCFileIO::hexDump()... ");
     // Check if logging level is at least verbose
     if (SCLogger::getInstance().getLogLevel(tag) < ESP_LOG_VERBOSE)
     {

src/SpotifyPlayer.cpp

@@ -556,9 +556,7 @@ void SpotifyPlayer::refreshCoverArt()
 */
 void SpotifyPlayer::refreshCurrentSong(CurrentlyPlaying currentlyPlaying)
 {
-    // Use the details in this method or if you want to store them
-    // make sure you copy them (using something like strncpy)
-    // const char* artist =
+
     spLogI(LOGTAG_MULTITASK, "Refreshing current song.  SpotifyPlayer::refreshCurrentSong(CurrentlyPlaying currentlyPlaying)");
 
     // If not a track or episode, update the UI accordingly and indicate music isn't available

src/ThingPulse/spotify.h

@@ -36,17 +36,10 @@ extern const char *spotify_image_server_cert;
 // If you change the value here, you need to modify the redirect URI on Spotify as well.
 #define SPOTIFY_ESPOTIFIER_NODE_NAME "tp-spotify"
 
-// the spotify-api-arduino library sets this to 1 (i.e. enabled) by default
-#define SPOTIFY_DEBUG 0
-//#define SPOTIFY_DEBUG 1
-#define SPOTIFY_SERIAL_OUTPUT 0
-#define SPOTIFY_PRINT_JSON_PARSE 0
-
 #define SPOTIFY_REFRESH_TOKEN_FILE_NAME "/refresh-token.txt"
 // the '/callback/' path is essential as spotify.h#fetchSpotifyAuthCode() registers a handler for it
 #define SPOTIFY_REDIRECT_URI "http%3A%2F%2F" SPOTIFY_ESPOTIFIER_NODE_NAME ".local%2Fcallback%2F"
 
-
 String authCode = "";
 String scope    = "user-read-playback-state%20user-modify-playback-state";
 WebServer server(80);

src/main.cpp

@@ -316,7 +316,7 @@ void setupLogging()
     logger.setLogLevel(LOGTAG_HEAP, ESP_LOG_INFO);
     //logger.setLogLevel(LOGTAG_TRACE, ESP_LOG_INFO);
     logger.setLogLevel(LOGTAG_FILEIO, ESP_LOG_INFO);
-    logger.setLogLevel(LOGTAG_CACHE, ESP_LOG_INFO);
+    // logger.setLogLevel(LOGTAG_CACHE, ESP_LOG_INFO);
     logger.setLogLevel(LOGTAG_VAULT, ESP_LOG_INFO);    
 
     // Supress logs for ESP32 components