Added support for IPSTUBE clocks - Model H401 and H402

.github/workflows/pio-build-multi-platform.yml

@@ -14,11 +14,10 @@ jobs:
       # Set fail-fast to false to ensure that feedback is delivered for all matrix combinations. Consider changing this to true when your workflow is stable.
       fail-fast: false
 
-      # Set up a matrix to run the following 3 configurations:
-      # 1. <Windows, Release, latest MSVC compiler toolchain on the default runner image, default generator>
-      # 2. <Linux, Release, latest GCC compiler toolchain on the default runner image, default generator>
-      # 3. <Linux, Release, latest Clang compiler toolchain on the default runner image, default generator>
-      #
+      # Set up a matrix to run the following 2 configurations:
+      # 1. <Windows, Release, toolchain on the default runner image, default generator>
+      # 2. <Linux, Release, toolchain on the default runner image, default generator>
+
       # To add more build types (Release, Debug, RelWithDebInfo, etc.) customize the build_type list.
       matrix:        
         os: [ubuntu-latest, windows-latest]
@@ -52,3 +51,7 @@ jobs:
     - name: Build PlatformIO Project for 4MB flash
       run: pio run --environment esp32dev
       working-directory: ./EleksTubeHAX_pio
+
+    - name: Build PlatformIO Project for 8MB flash
+      run: pio run --environment esp32dev8MB
+      working-directory: ./EleksTubeHAX_pio

EleksTubeHAX_pio/boards/esp32dev8MB.json

@@ -0,0 +1,37 @@
+{
+  "build": {
+    "arduino":{
+      "ldscript": "esp32_out.ld"
+    },
+    "core": "esp32",
+    "extra_flags": "-DARDUINO_ESP32_DEV",
+    "f_cpu": "240000000L",
+    "f_flash": "40000000L",
+    "flash_mode": "dio",
+    "mcu": "esp32",
+    "variant": "esp32"
+  },
+  "connectivity": [
+    "wifi",
+    "bluetooth",
+    "ethernet",
+    "can"
+  ],
+  "debug": {
+    "openocd_board": "esp-wroom-32.cfg"
+  },
+  "frameworks": [
+    "arduino",
+    "espidf"
+  ],
+  "name": "Espressif ESP32 Dev Module 8MB",
+  "upload": {
+    "flash_size": "8MB",
+    "maximum_ram_size": 327680,
+    "maximum_size": 8388608,
+    "require_upload_port": true,
+    "speed": 460800
+  },
+  "url": "https://en.wikipedia.org/wiki/ESP32",
+  "vendor": "Espressif"
+}

EleksTubeHAX_pio/partition_noOta_1Mapp_3Mspiffs.csv

@@ -5,9 +5,9 @@
 #
 # app0 must be aligned on 0x10000 (!)
 #
-# Name,   Type, SubType, Offset,  Size, Flags
-# partition table          0x0000,   0x9000,  <- automatically generated, do not un-comment.
-nvs,      data, nvs,       0x9000,   0x7000,
-app0,     app,  factory,  0x10000, 0x120000,
+# Name,   Type, SubType, Offset,   Size,     Flags
+# partition table        0x000000, 0x009000, <- automatically generated, do not un-comment.
+nvs,      data, nvs,     0x009000, 0x007000,
+app0,     app,  factory, 0x010000, 0x120000,
 spiffs,   data, spiffs,  0x130000, 0x2D0000,
 # end of 4 MB flash      0x400000

EleksTubeHAX_pio/partition_noOta_1Mapp_7Mspiffs.csv

@@ -0,0 +1,13 @@
+#
+# manual: https://docs.espressif.com/projects/esp-idf/en/latest/esp32/api-guides/partition-tables.html
+#
+# examples: https://github.com/espressif/arduino-esp32/tree/master/tools/partitions
+#
+# app0 must be aligned on 0x10000 (!)
+#
+# Name,   Type, SubType, Offset,   Size,     Flags
+# partition table        0x000000, 0x009000, <- automatically generated, do not un-comment.
+nvs,      data, nvs,     0x009000, 0x007000,
+app0,     app,  factory, 0x010000, 0x120000,
+spiffs,   data, spiffs,  0x130000, 0x6D0000,
+# end of 8 MB flash      0x800000

EleksTubeHAX_pio/platformio.ini

@@ -8,17 +8,10 @@
 ; Please visit documentation for the other options and examples
 ; https://docs.platformio.org/page/projectconf.html
 
-[env:esp32dev]
+; common settings for all environments
+[env]
 platform = espressif32
-board = esp32dev
 framework = arduino
-
-build_flags =
-	-DCORE_DEBUG_LEVEL=5	; Set to 0 for no debug; saves flash memory
-							; Set to 5 for full debug
-
-; https://docs.espressif.com/projects/esp-idf/en/latest/esp32/api-guides/partition-tables.html
-board_build.partitions = partition_noOta_1Mapp_3Mspiffs.csv
 upload_speed = 921600
 monitor_speed = 115200
 lib_deps = 
@@ -38,22 +31,39 @@ lib_deps =
 	; These libraries and source files are causing boot-loop-crash. Do not use. TO-DO: replace with different libraries and source files.
 	;milesburton/DallasTemperature
 	;OneWire
-
-; === Tested and working with following versions. If you have issues, revert to libraries listed below. ===
-; arduino-libraries/NTPClient@^3.2.1
-; adafruit/Adafruit NeoPixel@^1.12.0
-; paulstoffregen/Time@^1.6.1
-; paulstoffregen/DS1307RTC
-; bodmer/TFT_eSPI@^2.5.43
-; knolleary/PubSubClient@^2.8
-; bblanchon/ArduinoJson@^7.0.3
-; milesburton/DallasTemperature@^3.11.0
-; sparkfun/SparkFun APDS9960 RGB and Gesture Sensor@^1.4.3
-; makuna/RTC@^2.4.2
-
-extra_scripts = 
+
+	; === Tested and working with following versions. If you have issues, revert to libraries listed below. ===
+	; adafruit/Adafruit NeoPixel@^1.12.0
+	; paulstoffregen/Time@^1.6.1
+	; paulstoffregen/DS1307RTC
+	; bodmer/TFT_eSPI@^2.5.43
+	; knolleary/PubSubClient@^2.8
+	; bblanchon/ArduinoJson@^7.0.3
+	; sparkfun/SparkFun APDS9960 RGB and Gesture Sensor@^1.4.3
+	; makuna/RTC@^2.4.2
+build_flags =
+	-DCORE_DEBUG_LEVEL=5	; Set to 0 for no debug; saves flash memory or set to 5 for full debug
+extra_scripts =
 	; copy configuration files into TFT_eSPI library folder
 	script_configure_tft_lib.py
 	; modify the library files from the APDS9660 gesture sensor library to match ID if the used sensor
-    script_adjust_gesture_sensor_lib.py 
-
+	script_adjust_gesture_sensor_lib.py
+
+
+; env for all clocks with 4MB flash on PCB!
+[env:esp32dev]
+board = esp32dev
+lib_deps =
+	${env.lib_deps}
+	;add env specific libraries here
+board_build.partitions = partition_noOta_1Mapp_3Mspiffs.csv ; https://docs.espressif.com/projects/esp-idf/en/latest/esp32/api-guides/partition-tables.html
+
+
+; This is for all clocks with 8MB flash on PCB (like the IPSTUBE clocks)!
+[env:esp32dev8MB]
+board = esp32dev8MB
+lib_deps =
+	${env.lib_deps}
+	;add env specific libraries here
+board_build.partitions = partition_noOta_1Mapp_7Mspiffs.csv ; https://docs.espressif.com/projects/esp-idf/en/latest/esp32/api-guides/partition-tables.html
+

EleksTubeHAX_pio/script_adjust_gesture_sensor_lib.py

@@ -1,3 +1,10 @@
+# In pure Python environment, the script looks broken!
+# Import from SCons.Script is already available, if the PlatformIO build environment is used to call it.
+#from SCons.Script import Import
+
+#To have access to the PIO build environment variables, we need to import the env modul
+Import("env")
+
 def inplace_change(filename, old_string, new_string):
     # Safely read the input filename using 'with'
     with open(filename) as f:
@@ -16,10 +23,15 @@ def inplace_change(filename, old_string, new_string):
 
 print("===== adjusting APDS sensor libs ===== ")
 
+# Get the board type from the used environment
+board = env.GetProjectOption("board")
+
 new_string_to_check = "#define APDS9960_ID_3"
 
-filename1 = "./.pio/libdeps/esp32dev/SparkFun APDS9960 RGB and Gesture Sensor/src/SparkFun_APDS9960.h"
-filename2 = "./.pio/libdeps/esp32dev/SparkFun APDS9960 RGB and Gesture Sensor/src/SparkFun_APDS9960.cpp"
+# define target files with the name of the board in the path
+filename1 = "./.pio/libdeps/" + board + "/SparkFun APDS9960 RGB and Gesture Sensor/src/SparkFun_APDS9960.h"
+filename2 = "./.pio/libdeps/" + board + "/SparkFun APDS9960 RGB and Gesture Sensor/src/SparkFun_APDS9960.cpp"
+
 with open(filename1) as f:
     s = f.read()
     if new_string_to_check not in s:
@@ -28,4 +40,5 @@ def inplace_change(filename, old_string, new_string):
         inplace_change(filename2,"if( !(id == APDS9960_ID_1 || id == APDS9960_ID_2) ) {","if( !(id == APDS9960_ID_1 || id == APDS9960_ID_2 || id == APDS9960_ID_3) ) {")
     else:
         print("Lib files seems to be adjusted already! Doing nothing.")
+
 print("Done adjusting APDS sensor libs!")

EleksTubeHAX_pio/script_configure_tft_lib.py

@@ -1,27 +1,32 @@
-# Import("env")  # should not be required; un-comment if you have issues
-import shutil
+# In pure Python environment, the script looks broken!
+# Import from SCons.Script is already available, if the PlatformIO build environment is used to call it.
+#from SCons.Script import Import
+
+#To have access to the PIO build environment variables, we need to import the env modul from SCons.Script
+Import("env")
 
-# print("Current CLI targets", COMMAND_LINE_TARGETS)
-# print("Current Build targets", BUILD_TARGETS)
+import shutil
 
 print("===== copying TFT config files ===== ")
 
 # https://stackoverflow.com/questions/123198/how-to-copy-files
 
 # source file location: EleksTubeHAX_pio\src\GLOBAL_DEFINES.h  &  _USER_DEFINES.h
-# target file location: EleksTubeHAX_pio\.pio\libdeps\esp32dev\TFT_eSPI\User_Setup.h
+# target file location: EleksTubeHAX_pio\.pio\libdeps\esp32dev8MB\TFT_eSPI\User_Setup.h
+
+# Get the board type from the used environment
+board = env.GetProjectOption("board")
+
+# define target file and directory with the name of the board in the path
+targetDir = "./.pio/libdeps/" + board + "/TFT_eSPI"
+targetFile = targetDir + "/User_Setup.h"
 
 # copy using Python libraries
 # "copy" changes file timestamp -> lib is always recompiled.
-# "copy2" keeps file timestamp -> lib is compiled once
-ret = shutil.copy2('./src/_USER_DEFINES.h', './.pio/libdeps/esp32dev/TFT_eSPI')
+# "copy2" keeps file timestamp -> lib is compiled once (until changed define files)
+ret = shutil.copy2('./src/_USER_DEFINES.h', targetDir)
 print("Copied {ret}".format(**locals()))
-ret2 = shutil.copy2('./src/GLOBAL_DEFINES.h', './.pio/libdeps/esp32dev/TFT_eSPI/User_Setup.h')
+ret2 = shutil.copy2('./src/GLOBAL_DEFINES.h', targetFile)
 print("Copied {ret2}".format(**locals()))
 
-# copy using Windows command line
-# native "copy" command keeps file timestamp -> lib is compiled once
-# env.Execute("copy .\\src\\_USER_DEFINES.h .\\.pio\\libdeps\\esp32dev\\TFT_eSPI")
-# env.Execute("copy .\\src\\GLOBAL_DEFINES.h .\\.pio\\libdeps\\esp32dev\\TFT_eSPI\\User_Setup.h")
-
 print("Done copying TFT config files!")

EleksTubeHAX_pio/src/Backlights.cpp

@@ -124,7 +124,7 @@ void Backlights::breathPattern() {
 
 void Backlights::testPattern() {
   const uint8_t num_colors = 4;  // or 3 if you don't want black
-  uint8_t num_states = NUM_DIGITS * num_colors;
+  uint8_t num_states = NUM_BACKLIGHT_LEDS * num_colors;
   uint8_t state = (millis()/test_ms_delay) % num_states;
 
   uint8_t digit = state/num_colors;
@@ -191,7 +191,7 @@ float Backlights::phaseToHue(uint32_t phase) {
 void Backlights::rainbowPattern() {
   // Divide by 3 to spread it out some, so the whole rainbow isn't displayed at once.
   // TODO Make this /3 a parameter
-  const uint16_t phase_per_digit = (max_phase/NUM_DIGITS)/3;
+  const uint16_t phase_per_digit = (max_phase/NUM_BACKLIGHT_LEDS)/3;
 
   // Rainbow roatation speed now configurable
   uint16_t duration = uint16_t(round(getRainbowDuration() * 1000));

EleksTubeHAX_pio/src/Backlights.h

@@ -21,7 +21,7 @@
 class Backlights: public Adafruit_NeoPixel {
 public:
   Backlights() : config(NULL), pattern_needs_init(true), off(true),
-    Adafruit_NeoPixel(NUM_DIGITS, BACKLIGHTS_PIN, NEO_GRB + NEO_KHZ800)
+    Adafruit_NeoPixel(NUM_BACKLIGHT_LEDS, BACKLIGHTS_PIN, NEO_GRB + NEO_KHZ800)
     {}
 
   enum patterns { dark, test, constant, rainbow, pulse, breath, num_patterns };