refactor: Misc

Author: 3urobeat

README.md

@@ -72,11 +72,17 @@ You can either use the aforementioned setupMode at runtime or edit the `config.c
 
  
 
+## FAQ
+
 **What needs to be configured?**  
 - You always need to have at least one wifi network configured.  
 - Depending on which pages you use you need to have the API keys they require configured (see [Pages](https://github.com/3urobeat/nodemcu-clock/#pages) for more information)
 
 Everything else can be left at default.
 
 **How do I get the API keys?**  
-TBA
+TBA
+
+**The clock won't connect to my iPhone hotpot!**  
+Open the settings app and leave the "Personal Hotspot" page open while the clock attempts to connect to available WiFi networks.  
+This ensures that the WiFi network is visible.

platformio.ini

@@ -36,13 +36,13 @@ extra_flags =
 # Do not modify these settings
 # ------------------------------------------------------------------------------
 # Settings for all platforms
-monitor_filters = 
+monitor_filters =
 	default
 	;time                 ;; Must be disabled for exception decoder to work
 build_flags =
 	-I config             ;; Includes config directory which is outside the default pio dirs
 	${common.extra_flags} ;; Includes extra_flags var from above
-lib_deps = 
+lib_deps =
 	paulstoffregen/Time@^1.6.1
 	arduino-libraries/NTPClient@^3.1.0
 	ottowinter/ESPAsyncWebServer-esphome@^3.0.0
@@ -57,12 +57,12 @@ framework = arduino
 upload_speed = ${common.upload_speed}
 upload_port = ${common.upload_port}
 monitor_port = ${common.upload_port}
-monitor_filters = 
+monitor_filters =
 	${common.monitor_filters}
 	esp8266_exception_decoder
 build_type = ${common.build_type}
 build_flags = ${common.build_flags}
-lib_deps = 
+lib_deps =
 	${common.lib_deps}
 	vshymanskyy/Preferences@^2.0.0  ;; The ESP32 has a native prefs lib, the 8266 doesn't
 
@@ -76,9 +76,9 @@ framework = arduino
 upload_speed = ${common.upload_speed}
 upload_port = ${common.upload_port}
 monitor_port = ${common.upload_port}
-monitor_filters = 
+monitor_filters =
 	${common.monitor_filters}
 	esp32_exception_decoder
 build_type = ${common.build_type}
 build_flags = ${common.build_flags} -DBOARD_HAS_PSRAM -mfix-esp32-psram-cache-issue
-lib_deps = ${common.lib_deps}
+lib_deps = ${common.lib_deps}

src/helpers/httpGetJson.cpp

@@ -4,10 +4,10 @@
  * Created Date: 2021-08-30 22:37:00
  * Author: 3urobeat
  *
- * Last Modified: 2023-12-27 13:48:09
+ * Last Modified: 2024-05-11 11:23:26
  * Modified By: 3urobeat
  *
- * Copyright (c) 2021 - 2023 3urobeat <https://github.com/3urobeat>
+ * Copyright (c) 2021 - 2024 3urobeat <https://github.com/3urobeat>
  *
  * This program is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.
  * This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.
@@ -34,7 +34,9 @@ int16_t httpGetJson(const char *host, const char *path, uint16_t port, JsonHandl
     #ifdef CLOCK_DEBUG
         Serial.print("httpGetJson(): Sending GET request to: ");
         Serial.print(host);
-        Serial.println(path);
+        Serial.print(path);
+        Serial.print(":");
+        Serial.println(port);
 
         debug(F("httpGetJson(): Creating new lib objects..."));
     #endif
@@ -112,7 +114,7 @@ int16_t httpGetJson(const char *host, const char *path, uint16_t port, JsonHandl
         wifiSecureClient->setInsecure();
 
         if (wifiSecureClient->connect(host, port)) { // Only proceed if connection succeeded
-            wifiSecureClient->print(request); // Send our GET req data over
+            wifiSecureClient->print(request);        // Send our GET req data over
 
             // Get HTTP Code
             strncpy(buf, wifiSecureClient->readStringUntil('\r').c_str() + 9, 3); // Substring HTTP Code from "HTTP/1.1 200 OK" to "200"

src/helpers/initWifi.cpp

@@ -4,7 +4,7 @@
  * Created Date: 2021-08-30 15:42:00
  * Author: 3urobeat
  *
- * Last Modified: 2024-05-11 11:03:41
+ * Last Modified: 2024-05-11 11:13:26
  * Modified By: 3urobeat
  *
  * Copyright (c) 2021 - 2024 3urobeat <https://github.com/3urobeat>
@@ -56,7 +56,6 @@ void initWifi(uint8_t row)
             #endif
 
             if (strlen(thisSSID) > 0 && strcmp(thisSSID, Config::wifiSSID[j]) == 0) { // Checking if thisSSID is >0 seems to make this check a bit more reliable, not exactly sure why though
-
                 WiFiLib.begin(Config::wifiSSID[j], Config::wifiPW[j]);
 
                 found = true; // Stop parent loop

src/pages/pagesJsonParser.h

@@ -4,7 +4,7 @@
  * Created Date: 2023-01-12 12:40:54
  * Author: 3urobeat
  *
- * Last Modified: 2024-05-10 11:14:45
+ * Last Modified: 2024-05-11 11:05:39
  * Modified By: 3urobeat
  *
  * Copyright (c) 2023 - 2024 3urobeat <https://github.com/3urobeat>
@@ -77,9 +77,9 @@ class NewsJsonHandler final : public JsonHandler
         uint8_t  _pubAtCacheSize;
         char    *_titleCache;
         uint16_t _titleCacheSize;
-        uint8_t  _cacheSize;      // Thats the amount of different articles in cache
+        uint8_t  _cacheSize;        // Thats the amount of different articles in cache
 
-        uint8_t  _currentIndex = 0;   // Stores index of article we are at right now
+        uint8_t  _currentIndex = 0; // Stores index of article we are at right now
 
     public:
         // Constructor that takes pointers to char arrays where the result should go to
@@ -109,7 +109,7 @@ class NewsJsonHandler final : public JsonHandler
 
             if (_currentIndex >= _cacheSize) return; // This should never happen when the URL has the right amount of pages set but let's make sure
 
-            // Quick pointer arithmetic to make passing 2D arrays easier. We just pass pointer to element 0 of array to function and offset correctly inside function wiht passed sizes to reach desired element
+            // Quick pointer arithmetic to make passing 2D arrays easier. We just pass pointer to element 0 of array to function and offset correctly inside function with passed sizes to reach desired element
             if (strcmp(key, "name") == 0) {
                 strncpy(_sourceCache + (_sourceCacheSize * _currentIndex), value.getString(), _sourceCacheSize - 1);
 

src/pages/spotify.cpp

@@ -4,7 +4,7 @@
  * Created Date: 2023-01-17 10:39:35
  * Author: 3urobeat
  *
- * Last Modified: 2024-05-10 11:15:07
+ * Last Modified: 2024-05-11 11:33:13
  * Modified By: 3urobeat
  *
  * Copyright (c) 2023 - 2024 3urobeat <https://github.com/3urobeat>
@@ -129,7 +129,9 @@ namespace spotifyPage
 
                 // Don't clear/write anything if user just paused playback
                 if (!spotifyData.currentlyPlaying) return; // Next update() iteration will immediately run and skip page
+
                 displayCurrentData();
+
                 lcd.clearLine(1);
                 lcd.clearLine(2);
                 lcd.clearLine(3);
@@ -147,13 +149,16 @@ namespace spotifyPage
         lcd.setCursor(0, 2);
         lcd.movingPrint(spotifyData.title, &spotifyTitleOffset, Config::maxcol);
 
+
         // Calculate progress with current timestamp and last update timestamp
         char buf[4] = "";
         uint32_t currentProgress = (millis() - spotifyLastPlaybackUpdate) + spotifyData.progressTimestamp - 1000; // Subtract last API update timestamp from now, add the difference to progressTimestamp and subtract some tolerance
 
         // Set max if song ended and we need to wait for the next data refresh
         if (currentProgress > spotifyData.songLength) currentProgress = spotifyData.songLength;
 
+
+        // Construct page content and update screen
         char progressStr[12] = "";
         char *p = progressStr;
 
@@ -171,6 +176,7 @@ namespace spotifyPage
         lcd.setCursor(spaceLeft, 3);
         lcd.print(progressStr);
 
+
         // Display progress bar based on currentProgress
         uint8_t amountOfHashtags = (spaceLeft - 1) * ((float) currentProgress / (float) spotifyData.songLength); // Calculate amount of hashtags by calculating percentage and stuff lol