Adding PIO support

Author: witnessmenow

.github/workflows/build-deploy-webflash.yml

@@ -6,7 +6,7 @@ on:
   push:
     branches: ["main"]
     paths-ignore:
-      - '**.md'
+      - "**.md"
 
   # Allows you to run this workflow manually from the Actions tab
   workflow_dispatch:
@@ -28,113 +28,70 @@ jobs:
   build:
     runs-on: ubuntu-latest
     steps:
-      - name: Checkout
-        uses: actions/checkout@v3
-
-      # Install the Arduino CLI
-      - name: Install Arduino CLI
-        uses: arduino/setup-arduino-cli@v1
-
-      # Install TFT_eSPI
-      - name: Install TFT_eSPI library to prepare for modifications
-        run: |
-          arduino-cli lib install TFT_eSPI
-
-      # Copy binaries to GitHubPages folder for publishing
-      - name: Copy User_Setup.h for TFT_eSPI
+      - uses: actions/checkout@v4
+      - uses: actions/cache@v3
+      - name: Cache pip
+        uses: actions/cache@v3
+        with:
+          path: ~/.cache/pip
+          key: ${{ runner.os }}-pip-${{ hashFiles('**/requirements.txt') }}
+          restore-keys: |
+            ${{ runner.os }}-pip-
+      - name: Cache PlatformIO
+        uses: actions/cache@v3
+        with:
+          path: ~/.platformio
+          key: ${{ runner.os }}-${{ hashFiles('**/lockfiles') }}
+      - name: Set up Python
+        uses: actions/setup-python@v4
+        with:
+          python-version: "3.10"
+      - name: Install PlatformIO
         run: |
-          \cp -fR DisplayConfig/User_Setup.h ~/Arduino/libraries/TFT_eSPI/
-
-      # Build CYD Arduino Code
-      - uses: arduino/compile-sketches@v1
-        name: Compile CYD code
-        with: 
-          fqbn: "esp32:esp32:esp32"
-          platforms: |
-            - name: esp32:esp32
-              source-url: https://raw.githubusercontent.com/espressif/arduino-esp32/gh-pages/package_esp32_index.json
-          # No need to specify ESP-libraries as these are installed with the platform (on the line above). 
-          # Downloading SpeedyStepper from source to get correct casing on import of Arduino.h (spelled arduino.h in the version from Arduino Library Manager)
-          libraries: | 
-            - name: SpotifyArduino
-              source-url: https://github.com/witnessmenow/spotify-api-arduino.git
-            - name: WiFiManager
-            - name: ESP_DoubleResetDetector 
-            - name: ArduinoJson 
-            - name: JPEGDEC
-            - name: Seeed_Arduino_NFC
-              source-url: https://github.com/witnessmenow/Seeed_Arduino_NFC.git
-          sketch-paths: |
-            - SpotifyDiyThing
-          enable-warnings-report: true
-          verbose: false
-          cli-compile-flags: |
-            - --export-binaries
-            - --build-property 
-            - compiler.warning_flags=-Wno-error
-
-      # Copy binaries to GitHubPages folder for publishing
-      - name: Copy compiled binaries to CYD
+          python -m pip install --upgrade pip
+          pip install --upgrade platformio
+
+      #Build CYD
+      - name: Build CYD
+        run: platformio run -e cyd
+      - name: Upload artifact
+        uses: actions/upload-artifact@v3
+        with:
+          name: CYD Firmware
+          path: .pio/build/cyd/firmware.bin
+          if-no-files-found: error
+      - name: Copy compiled binaries for webflash
         run: |
-          # mkdir GitHubPages/ESPWebTools/esp32Firmware
           mkdir GitHubPages/ESPWebTools/cyd
 
           # Copy the manifest file for the CYD
           cp GitHubPages/ESPWebTools/manifest.json GitHubPages/ESPWebTools/cyd
-          
-          # Copy compiled binaries that were exported by the `-e` flag in the arduino/compile-sketches task
-          # Maintain folder structure, for cases where we are compiling for multiple board versions 
-          # If we were sure that we would never need to compile for anything other then esp32:esp32:esp32, we could have used this command instead: cp -r OpenMacroRail_Arduino/build/esp32.esp32.esp32/*.bin GitHubPages/ESPWebTools/esp32Firmware
-          cd SpotifyDiyThing/build
-          find . -print | grep -i .bin$ | xargs -i cp --parent {} ../../GitHubPages/ESPWebTools/cyd
-          cd ../..
-          
-          # Copy boot_app0.bin to the esp32Firmware folder. This file will be common for all esp32 boards (i think) 
-          # Using a version agnostic search to find the file. grep -m 1 makes sure only one file is copied in case multiple versions are installed.
-          find /home/runner/.arduino15/packages/esp32/hardware/esp32/ -type f | grep -i -m 1 boot_app0.bin$ | xargs -i cp {} GitHubPages/ESPWebTools/cyd
 
-       # Build Matrix Arduino Code
-      - uses: arduino/compile-sketches@v1
-        name: Compile Matrix code
-        with: 
-          fqbn: "esp32:esp32:esp32"
-          platforms: |
-            - name: esp32:esp32
-              source-url: https://raw.githubusercontent.com/espressif/arduino-esp32/gh-pages/package_esp32_index.json
-          # No need to specify ESP-libraries as these are installed with the platform (on the line above). 
-          # Just need to specify the matrix specific libraries, the others are already installed.
-          libraries: | 
-            - name: ESP32 HUB75 LED MATRIX PANEL DMA Display
-              source-url: https://github.com/witnessmenow/ESP32-HUB75-MatrixPanel-I2S-DMA.git
-            - name: Adafruit GFX Library
-          sketch-paths: |
-            - SpotifyDiyThing
-          enable-warnings-report: true
-          verbose: false
-          cli-compile-flags: |
-            - --build-property 
-            - compiler.cpp.extra_flags=-DMATRIX_DISPLAY
-            - --build-property 
-            - compiler.warning_flags=-Wno-error
-            - --export-binaries
-            
-      # Copy binaries to GitHubPages folder for publishing
-      - name: Copy compiled binaries to Matrix
+          cp .pio/build/cyd/bootloader.bin GitHubPages/ESPWebTools/cyd
+          cp .pio/build/cyd/partitions.bin GitHubPages/ESPWebTools/cyd
+          cp /home/runner/.platformio/packages/framework-arduinoespressif32/tools/partitions/boot_app0.bin GitHubPages/ESPWebTools/cyd
+          cp .pio/build/cyd/firmware.bin GitHubPages/ESPWebTools/cyd
+
+      #Build Matrix
+      - name: Build Matrix
+        run: platformio run -e trinity
+      - name: Upload artifact
+        uses: actions/upload-artifact@v3
+        with:
+          name: CYD Firmware
+          path: .pio/build/trinity/firmware.bin
+          if-no-files-found: error
+      - name: Copy compiled binaries for webflash
         run: |
-          # Make matrix directory
           mkdir GitHubPages/ESPWebTools/matrix
 
-          # Copy the manifest file for the matrix
+          # Copy the manifest file for the CYD
           cp GitHubPages/ESPWebTools/manifest.json GitHubPages/ESPWebTools/matrix
-          
-          cd SpotifyDiyThing/build
-          find . -print | grep -i .bin$ | xargs -i cp --parent {} ../../GitHubPages/ESPWebTools/matrix
-          cd ../..
-          
-          # Copy boot_app0.bin to the esp32Firmware folder. This file will be common for all esp32 boards (i think) 
-          # Using a version agnostic search to find the file. grep -m 1 makes sure only one file is copied in case multiple versions are installed.
-          find /home/runner/.arduino15/packages/esp32/hardware/esp32/ -type f | grep -i -m 1 boot_app0.bin$ | xargs -i cp {} GitHubPages/ESPWebTools/matrix
 
+          cp .pio/build/trinity/bootloader.bin GitHubPages/ESPWebTools/matrix
+          cp .pio/build/trinity/partitions.bin GitHubPages/ESPWebTools/matrix
+          cp /home/runner/.platformio/packages/framework-arduinoespressif32/tools/partitions/boot_app0.bin GitHubPages/ESPWebTools/matrix
+          cp .pio/build/trinity/firmware.bin GitHubPages/ESPWebTools/matrix
 
       # Build GitHub Page
       - name: Setup Github Page

.gitignore

@@ -1,3 +1,6 @@
 # Ignore Mac DS_Store files
 .DS_Store
 **/.DS_Store
+
+.pio
+.vscode

SpotifyDiyThing/SpotifyDiyThing.ino

@@ -15,24 +15,23 @@
 // (Uncomment the required #define)
 
 // 1. Cheap yellow display (Using TFT-eSPI library)
-//#define YELLOW_DISPLAY
+// #define YELLOW_DISPLAY
 
 // 2. Matrix Displays (Like the ESP32 Trinity)
-//#define MATRIX_DISPLAY
+// #define MATRIX_DISPLAY
 
 // If no defines are set, it will default to CYD
 #if !defined(YELLOW_DISPLAY) && !defined(MATRIX_DISPLAY)
 #define YELLOW_DISPLAY // Default to Yellow Display for display type
 #endif
 
-
 #define NFC_ENABLED 1
 
 // ----------------------------
 // Library Defines - Need to be defined before library import
 // ----------------------------
 
-#define ESP_DRD_USE_SPIFFS      true
+#define ESP_DRD_USE_SPIFFS true
 
 // ----------------------------
 // Standard Libraries
@@ -57,7 +56,7 @@
 // A library for checking if the reset button has been pressed twice
 // Can be used to enable config mode
 // Can be installed from the library manager (Search for "ESP_DoubleResetDetector")
-//https://github.com/khoih-prog/ESP_DoubleResetDetector
+// https://github.com/khoih-prog/ESP_DoubleResetDetector
 
 #include <SpotifyArduino.h>
 
@@ -88,7 +87,7 @@ WiFiClientSecure client;
 
 #include "serialPrint.h"
 
-#include "WifiManager.h"
+#include "WifiManagerHandler.h"
 
 // ----------------------------
 // Display Handling Code
@@ -98,12 +97,12 @@ WiFiClientSecure client;
 
 #include "cheapYellowLCD.h"
 CheapYellowDisplay cyd;
-SpotifyDisplay* spotifyDisplay = &cyd;
+SpotifyDisplay *spotifyDisplay = &cyd;
 
 #elif defined MATRIX_DISPLAY
 #include "matrixDisplay.h"
 MatrixDisplay matrixDisplay;
-SpotifyDisplay* spotifyDisplay = &matrixDisplay;
+SpotifyDisplay *spotifyDisplay = &matrixDisplay;
 
 #endif
 // ----------------------------
@@ -112,7 +111,8 @@ SpotifyDisplay* spotifyDisplay = &matrixDisplay;
 #include "nfc.h"
 #endif
 
-void drawWifiManagerMessage(WiFiManager *myWiFiManager){
+void drawWifiManagerMessage(WiFiManager *myWiFiManager)
+{
   spotifyDisplay->drawWifiManagerMessage(myWiFiManager);
 }
 
@@ -123,17 +123,21 @@ void setup()
   bool forceConfig = false;
 
   drd = new DoubleResetDetector(DRD_TIMEOUT, DRD_ADDRESS);
-  if (drd->detectDoubleReset()) {
+  if (drd->detectDoubleReset())
+  {
     Serial.println(F("Forcing config mode as there was a Double reset detected"));
     forceConfig = true;
   }
 
   spotifyDisplay->displaySetup(&spotify);
 
 #ifdef NFC_ENABLED
-  if (nfcSetup(&spotify)) {
+  if (nfcSetup(&spotify))
+  {
     Serial.println("NFC Good");
-  } else {
+  }
+  else
+  {
     Serial.println("NFC Bad");
   }
 #endif
@@ -152,9 +156,9 @@ void setup()
   }
   Serial.println("\r\nInitialisation done.");
 
-  pinMode(0, INPUT); //has an internal pullup
   refreshToken[0] = '\0';
-  if (!fetchConfigFile(refreshToken, clientId, clientSecret)) {
+  if (!fetchConfigFile(refreshToken, clientId, clientSecret))
+  {
     // Failed to fetch config file, need to launch Wifi Manager
     forceConfig = true;
   }
@@ -167,11 +171,28 @@ void setup()
 
   spotifySetup(spotifyDisplay, clientId, clientSecret);
 
+#if defined YELLOW_DISPLAY
+
+  pinMode(0, INPUT); // has an internal pullup
+  bool forceRefreshToken = digitalRead(0) == LOW;
+  if (forceRefreshToken)
+  {
+    Serial.println("GPIO 0 is low, forcing refreshToken");
+  }
+
+#else
+  bool forceRefreshToken = false;
+
+#endif
+
   // Check if we have a refresh Token
-  if (digitalRead(0) == LOW || refreshToken[0] == '\0') {
+  if (forceRefreshToken || refreshToken[0] == '\0')
+  {
+
     spotifyDisplay->drawRefreshTokenMessage();
     Serial.println("Launching refresh token flow");
-    if (launchRefreshTokenFlow(&spotify, clientId)) {
+    if (launchRefreshTokenFlow(&spotify, clientId))
+    {
       Serial.print("Refresh Token: ");
       Serial.println(refreshToken);
       saveConfigFile(refreshToken, clientId, clientSecret);
@@ -194,9 +215,8 @@ void loop()
 #else
   bool forceUpdate = false;
 #endif
-  
+
   updateCurrentlyPlaying(forceUpdate);
 
   updateProgressBar();
-
 }

SpotifyDiyThing/WifiManager.h renamed to SpotifyDiyThing/WifiManagerHandler.h

@@ -1,3 +1,4 @@
+
 // Number of seconds after reset during which a
 // subseqent reset will be considered a double reset.
 #define DRD_TIMEOUT 10