Add OBSPro support (#357)

* Switch to U8g2 display library
* OpenSans fonts were reconverted for U8g2.
* Remove remnant from VL53 ToF sensor
* Rename class `SSD1306DisplayDevice` to `DisplayDevice`
* Added .vscode to gitignore
* Set ports and build type in platformio.ini
* Add OBSPro support with button and variant selection
* CI build for classic and pro variant
* No SQ for now
* Next release is 0.21 which includes obs classic and obs pro

---------

Co-authored-by: j000bs <[email protected]>
Co-authored-by: amandel <[email protected]>

Author: 3 people

.github/workflows/ci.yml

@@ -97,11 +97,13 @@ jobs:
       run: |
         mkdir sonarqube-out
         ./sonarqube/build-wrapper-linux-x86/build-wrapper-linux-x86-64 --out-dir sonarqube-out \
-          platformio ci --build-dir="./bin" --keep-build-dir --project-conf=platformio.ini ./src/
+          platformio ci --environment obspro --environment obs --build-dir ./bin --keep-build-dir --project-conf platformio.ini ./src/
 
-    - name: Package firmware
+    - name: Package firmware OBS classic
       run: |
         set -eux
+        mkdir -p obs-classic
+        cd obs-classic
         if [ -f "/github/home/.platformio/packages/framework-arduinoespressif32/tools/sdk/esp32/bin/bootloader_dio_40m.elf" ]; then
            cp /github/home/.platformio/packages/framework-arduinoespressif32/tools/sdk/esp32/bin/bootloader_dio_40m.elf 0x01000.elf
         elif [ -f "/github/home/.platformio/packages/framework-arduinoespressif32/tools/sdk/bin/bootloader_dio_40m.bin" ]; then
@@ -112,10 +114,10 @@ jobs:
            find /github/home/.platformio/ -name "bootloader*.elf"
            exit 1
         fi
-        cp bin/.pio/build/esp32dev/partitions.bin 0x08000.bin
+        cp ../bin/.pio/build/obs/partitions.bin 0x08000.bin
         cp /github/home/.platformio/packages/framework-arduinoespressif32/tools/partitions/boot_app0.bin 0x0e000.bin
-        cp bin/.pio/build/esp32dev/firmware.bin 0x10000.bin
-        cp bin/.pio/build/esp32dev/firmware.bin firmware.bin
+        cp ../bin/.pio/build/obs/firmware.bin 0x10000.bin
+        cp ../bin/.pio/build/obs/firmware.bin firmware.bin
         ESPTOOL=/github/home/.platformio/packages/tool-esptoolpy/esptool.py
         chmod +x ${ESPTOOL}
         # CMD to create a merged binary (still missing flash.app)
@@ -138,23 +140,81 @@ jobs:
             0x01000 0x01000.bin.org
         echo OpenBikeSensor bootloader params
         ${ESPTOOL} --chip esp32 image_info --version 2 0x01000.bin || echo image_info failed
-        cp src/fonts/LICENSE.txt LICENSE-OpenSans.txt
+        cp ../src/fonts/LICENSE.txt LICENSE-OpenSans.txt
         wget --no-verbose -O COPYRIGHT-ESP.html https://docs.espressif.com/projects/esp-idf/en/latest/esp32/COPYRIGHT.html
         wget --no-verbose -O LICENSE-ARDUINO-ESP32.md https://github.com/espressif/arduino-esp32/raw/master/LICENSE.md
-        zip --junk-paths obs-${{ env.OBS_VERSION }}-initial-flash.zip \
+        zip --junk-paths ../obs-${{ env.OBS_VERSION }}-initial-flash.zip \
           0x*.bin \
           COPYRIGHT-ESP.html \
           LICENSE-ARDUINO-ESP32.md \
           LICENSE-OpenSans.txt \
           LICENSE
-        zip --junk-paths obs-${{ env.OBS_VERSION }}.zip \
+        zip --junk-paths ../obs-${{ env.OBS_VERSION }}.zip \
+          firmware.bin \
+          COPYRIGHT-ESP.html \
+          LICENSE-ARDUINO-ESP32.md \
+          LICENSE-OpenSans.txt \
+          LICENSE
+
+    - name: Package firmware OBS pro
+      run: |
+        set -eux
+        mkdir -p obs-pro
+        cd obs-pro
+        if [ -f "/github/home/.platformio/packages/framework-arduinoespressif32/tools/sdk/esp32/bin/bootloader_dio_40m.elf" ]; then
+           cp /github/home/.platformio/packages/framework-arduinoespressif32/tools/sdk/esp32/bin/bootloader_dio_40m.elf 0x01000.elf
+        elif [ -f "/github/home/.platformio/packages/framework-arduinoespressif32/tools/sdk/bin/bootloader_dio_40m.bin" ]; then
+           cp /github/home/.platformio/packages/framework-arduinoespressif32/tools/sdk/bin/bootloader_dio_40m.bin 0x01000.bin
+        else 
+           echo could not find bootloader_dio_40m.bin, new location?
+           find /github/home/.platformio/ -name "bootloader*.bin"
+           find /github/home/.platformio/ -name "bootloader*.elf"
+           exit 1
+        fi
+        cp ../bin/.pio/build/obspro/partitions.bin 0x08000.bin
+        cp /github/home/.platformio/packages/framework-arduinoespressif32/tools/partitions/boot_app0.bin 0x0e000.bin
+        cp ../bin/.pio/build/obspro/firmware.bin 0x10000.bin
+        cp ../bin/.pio/build/obspro/firmware.bin firmware.bin
+        ESPTOOL=/github/home/.platformio/packages/tool-esptoolpy/esptool.py
+        chmod +x ${ESPTOOL}
+        # CMD to create a merged binary (still missing flash.app)
+        # ${ESPTOOL} --trace --chip esp32 merge_bin --output merged.bin  \
+        #    --flash_freq keep --flash_mode dio --flash_size 4MB \
+        #    0x01000 0x01000.bin \
+        #    0x08000 0x08000.bin \
+        #    0x0e000 0x0e000.bin \
+        #    0x10000 0x10000.bin
+        ${ESPTOOL} --trace --chip esp32 elf2image \
+            --dont-append-digest \
+            --flash_freq 40m --flash_mode dio \
+            0x01000.elf
+        echo Original bootloader params after elf2image
+        ${ESPTOOL} --chip esp32 image_info --version 2 0x01000.bin || echo image_info for converted bootloader failed
+        mv 0x01000.bin 0x01000.bin.org
+        ${ESPTOOL} --trace --chip esp32 merge_bin --output 0x01000.bin  \
+            --flash_freq 40m --flash_mode dio --flash_size 4MB \
+            --target-offset 0x01000 \
+            0x01000 0x01000.bin.org
+        echo OpenBikeSensor bootloader params
+        ${ESPTOOL} --chip esp32 image_info --version 2 0x01000.bin || echo image_info failed
+        cp ../src/fonts/LICENSE.txt LICENSE-OpenSans.txt
+        wget --no-verbose -O COPYRIGHT-ESP.html https://docs.espressif.com/projects/esp-idf/en/latest/esp32/COPYRIGHT.html
+        wget --no-verbose -O LICENSE-ARDUINO-ESP32.md https://github.com/espressif/arduino-esp32/raw/master/LICENSE.md
+        zip --junk-paths ../obspro-${{ env.OBS_VERSION }}-initial-flash.zip \
+          0x*.bin \
+          COPYRIGHT-ESP.html \
+          LICENSE-ARDUINO-ESP32.md \
+          LICENSE-OpenSans.txt \
+          LICENSE
+        zip --junk-paths ../obspro-${{ env.OBS_VERSION }}.zip \
           firmware.bin \
           COPYRIGHT-ESP.html \
           LICENSE-ARDUINO-ESP32.md \
           LICENSE-OpenSans.txt \
           LICENSE
 
     - name: Analyze with SonarCloud
+      if: false
       env:
         SONAR_TOKEN: ${{ secrets.SONAR_TOKEN }}
         GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
@@ -186,26 +246,50 @@ jobs:
       with:
         name: obs-${{ env.OBS_VERSION }}
         path: |
-          firmware.bin
-          COPYRIGHT-ESP.html
-          LICENSE-ARDUINO-ESP32.md
-          LICENSE-OpenSans.txt
-          LICENSE
+          obs-classic/firmware.bin
+          obs-classic/COPYRIGHT-ESP.html
+          obs-classic/LICENSE-ARDUINO-ESP32.md
+          obs-classic/LICENSE-OpenSans.txt
+          obs-classic/LICENSE
         if-no-files-found: error
 
     - name: Upload Build Asset Initial Flash
       uses: actions/upload-artifact@v4
       with:
         name: obs-${{ env.OBS_VERSION }}-initial-flash
         path: |
-          0x*.bin
-          COPYRIGHT-ESP.html
-          LICENSE-ARDUINO-ESP32.md
-          LICENSE-OpenSans.txt
-          LICENSE
+          obs-classic/0x*.bin
+          obs-classic/COPYRIGHT-ESP.html
+          obs-classic/LICENSE-ARDUINO-ESP32.md
+          obs-classic/LICENSE-OpenSans.txt
+          obs-classic/LICENSE
           sonarqube-out/build-wrapper-dump.json
         if-no-files-found: error
 
+    - name: Upload Build Asset obspro
+      uses: actions/upload-artifact@v4
+      with:
+        name: obspro-${{ env.OBS_VERSION }}
+        path: |
+          obs-pro/firmware.bin
+          obs-pro/COPYRIGHT-ESP.html
+          obs-pro/LICENSE-ARDUINO-ESP32.md
+          obs-pro/LICENSE-OpenSans.txt
+          obs-pro/LICENSE
+        if-no-files-found: error
+
+    - name: Upload Build Asset Initial Flash obspro
+      uses: actions/upload-artifact@v4
+      with:
+        name: obspro-${{ env.OBS_VERSION }}-initial-flash
+        path: |
+          obs-pro/0x*.bin
+          obs-pro/COPYRIGHT-ESP.html
+          obs-pro/LICENSE-ARDUINO-ESP32.md
+          obs-pro/LICENSE-OpenSans.txt
+          obs-pro/LICENSE
+        if-no-files-found: error
+
     - name: Generate changelog
       id: changelog
       if: ${{ env.OBS_PREPARE_RELEASE == 'true' }}
@@ -275,6 +359,42 @@ jobs:
         GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
       with:
         upload_url: ${{ steps.create_release.outputs.upload_url }}
-        asset_path: ./bin/.pio/build/esp32dev/firmware.bin
+        asset_path: ./bin/.pio/build/obs/firmware.bin
         asset_name: firmware.bin
         asset_content_type: application/x-esp32
+
+    - name: Upload Release Asset obspro
+      id: upload-obspro-release-asset
+      if: ${{ env.OBS_PREPARE_RELEASE == 'true' }}
+      uses: actions/upload-release-asset@v1
+      env:
+        GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+      with:
+        upload_url: ${{ steps.create_release.outputs.upload_url }}
+        asset_path: ./obspro-${{ env.OBS_VERSION }}.zip
+        asset_name: obspro-${{ env.OBS_VERSION }}.zip
+        asset_content_type: application/zip
+
+    - name: Upload Release Asset Initial Flash pro
+      id: upload-obspro-release-asset-initial-flash
+      if: ${{ env.OBS_PREPARE_RELEASE == 'true' }}
+      uses: actions/upload-release-asset@v1
+      env:
+        GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+      with:
+        upload_url: ${{ steps.create_release.outputs.upload_url }}
+        asset_path: ./obspro-${{ env.OBS_VERSION }}-initial-flash.zip
+        asset_name: obspro-${{ env.OBS_VERSION }}-initial-flash.zip
+        asset_content_type: application/zip
+
+    - name: Upload Release Asset app bin pro
+      id: upload-obspro-release-asset-app-bin
+      if: ${{ env.OBS_PREPARE_RELEASE == 'true' }}
+      uses: actions/upload-release-asset@v1
+      env:
+        GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+      with:
+        upload_url: ${{ steps.create_release.outputs.upload_url }}
+        asset_path: ./bin/.pio/build/obspro/firmware.bin
+        asset_name: firmware-obspro.bin
+        asset_content_type: application/x-esp32

.gitignore

@@ -24,6 +24,7 @@ docs/.jekyll-metadata
 docs/vendor
 
 .DS_Store
+.vscode
 
 # for people installing pio venv style
 venv

custom_config.ini.example

@@ -1,13 +1,8 @@
 ; This file should contain your local modifications to the PlatformIO.ini file.
 
-[env:esp32dev]
+[env:myObs]
 build_flags =
-; settings needed by the build
-    -DHTTPS_REQUEST_MAX_REQUEST_LENGTH=1024
-; reduce probability of https://github.com/fhessel/esp32_https_server/pull/123
-    -DHTTPS_CONNECTION_DATA_CHUNK_SIZE=1024
-; custom default configuration
-;
+    ${env.build_flags}
 ; you can specify a custom config json (see docs/software/firmware/obs_cfg.md)
 ; here which will be used for fresh installs based on this firmware
     -DCUSTOM_OBS_DEFAULT_CONFIG='"{ obs: [ { displayConfig: 15, offset: [ 30, 30 ], httpPin: \\"12345678\\", wifiSsid: \\"SID\\", wifiPassword: \\"87654321\\" } ] }"'
@@ -18,6 +13,9 @@ build_flags =
     -DDEVELOP
 ; http lib loglevel
     -DHTTPS_LOGLEVEL=3
+; select OBS Variant
+    -DOBSCLASSIC
+;    -DOBSPRO
 
 
 ; === upload_port ===

platformio.ini

@@ -37,9 +37,8 @@
 src_dir = src
 extra_configs = custom_config.ini
 
-[env:esp32dev]
-platform = espressif32 @ 6.6.0
-; 5.4.0
+[env]
+platform = espressif32 @ 6.8.1
 board = esp32dev
 framework = arduino
 monitor_speed = 115200
@@ -52,7 +51,9 @@ lib_deps =
     ; https://arduinojson.org/v6/api/
     bblanchon/ArduinoJson @ ^6.21.5
     rlogiacco/CircularBuffer @ ^1.4.0
-    thingpulse/ESP8266 and ESP32 OLED driver for SSD1306 displays @ ^4.5.0
+    ; olikraus/U8g2 @ ^2.35.9
+    https://codeberg.org/j000bs/U8g2_Arduino.git#jhd-fix
+    ; replaced by U8g2 thingpulse/ESP8266 and ESP32 OLED driver for SSD1306 displays @ ^4.5.0
     adafruit/Adafruit BMP280 Library@^2.6.8
     pololu/VL53L0X@^1.3.1
     ; https://github.com/fhessel/esp32_https_server
@@ -67,3 +68,13 @@ build_flags =
     -DHTTPS_CONNECTION_DATA_CHUNK_SIZE=1024
     ; build number "-dev" will be replaced in github action
     -DBUILD_NUMBER=\"-dev\"
+
+[env:obs]
+build_flags =
+    ${env.build_flags}
+    -DOBSCLASSIC
+
+[env:obspro]
+build_flags =
+    ${env.build_flags}
+    -DOBSPRO