Updated ESP32 Example - Backport from matthias-bs/BresserWeatherSensorTTN with fixes and additional features

.github/workflows/CI.yml

@@ -0,0 +1,136 @@
+name: CI
+
+on:
+  push:
+    branches: [ "master" ]
+  pull_request:
+    branches: [ "master" ]
+  workflow_dispatch:
+
+jobs:
+
+  build:
+    strategy:
+      matrix:
+        board:
+          - esp32:esp32:esp32:DebugLevel=none
+          - esp32:esp32:esp32:DebugLevel=verbose
+          #- esp32:esp32:firebeetle32
+          #- esp32:esp32:ttgo-lora32:Revision=TTGO_LoRa32_V1
+          #- esp32:esp32:ttgo-lora32:Revision=TTGO_LoRa32_V2
+          #- esp32:esp32:ttgo-lora32:Revision=TTGO_LoRa32_v21new
+          #- esp32:esp32:heltec_wireless_stick:PSRAM=disabled
+          #- esp32:esp32:featheresp32
+          #- esp32:esp32:adafruit_feather_esp32s2
+          - rp2040:rp2040:adafruit_feather:dbgport=Serial
+    runs-on: ubuntu-latest
+    name: ${{ matrix.board }}
+    env:
+      GH_TOKEN: ${{ github.token }}
+      run-build: ${{ contains(matrix.board, 'esp32:esp32') || contains(matrix.board, 'rp2040:rp2040') || contains(github.event.head_commit.message, 'CI_BUILD_ALL') || contains(github.event.head_commit.message, 'Bump version to') || contains(github.event.head_commit.message, format('{0}', matrix.board)) }}
+
+    steps:
+      - name: Install arduino-cli
+        if: ${{ env.run-build == 'true' }}
+        run:
+          |
+          mkdir -p ~/.local/bin
+          echo "~/.local/bin" >> $GITHUB_PATH
+          curl -fsSL https://raw.githubusercontent.com/arduino/arduino-cli/master/install.sh | BINDIR=~/.local/bin sh
+
+      - name: Get platform name
+        if: ${{ env.run-build == 'true' }}
+        uses: jungwinter/split@v2
+        id: split
+        with:
+          msg: ${{ matrix.board }}
+          separator: ':'
+
+      - name: Prepare platform-specific settings
+        if: ${{ env.run-build == 'true' }}
+        id: prep
+        run:
+          |
+          # common settings - no extra options, skip nothing, all warnings
+          echo "skip-pattern='simple_sensor_bme280'" >> $GITHUB_OUTPUT
+          echo "warnings='all'" >> $GITHUB_OUTPUT
+
+          # platform-dependent settings - extra board options, board index URLs, skip patterns etc.
+          if [[ "${{ contains(matrix.board, 'esp32:esp32') }}" == "true" ]]; then
+            # ESP32
+            python -m pip install pyserial
+            echo "index-url=--additional-urls https://raw.githubusercontent.com/espressif/arduino-esp32/gh-pages/package_esp32_index.json" >> $GITHUB_OUTPUT
+          elif [[ "${{ contains(matrix.board, 'rp2040:rp2040') }}" == "true" ]]; then
+            # RP2040
+            echo "index-url=--additional-urls https://github.com/earlephilhower/arduino-pico/releases/download/global/package_rp2040_index.json" >> $GITHUB_OUTPUT
+          fi
+
+      - name: Install libraries
+        if: ${{ env.run-build == 'true' }}
+        run:
+          |
+          declare -a required_libs=(
+            "MCCI LoRaWAN LMIC [email protected]"
+            "MCCI Arduino LoRaWAN [email protected]"
+            "MCCI Arduino Development Kit [email protected]"
+            "LoRa [email protected]"
+            "[email protected]"
+            "[email protected]"
+            "[email protected]")
+          for i in "${required_libs[@]}"
+          do
+            arduino-cli lib install "$i"
+          done
+
+      - name: Install platform
+        if: ${{ env.run-build == 'true' }}
+        run:
+          |
+          arduino-cli core update-index ${{ format('{0}', steps.prep.outputs.index-url) }}
+          arduino-cli core install ${{ format('{0}:{1} {2}', steps.split.outputs._0, steps.split.outputs._1, steps.prep.outputs.index-url) }}
+
+      - name: Checkout repository
+        if: ${{ env.run-build == 'true' }}
+        uses: actions/checkout@v3
+
+      - name: Customizing lmic_project_config.h (LMIC_ENABLE_DeviceTimeReq)
+        if: ${{ env.run-build == 'true' }}
+        run:
+          |
+          echo "#define LMIC_ENABLE_DeviceTimeReq 1" >> /home/runner/Arduino/libraries/MCCI_LoRaWAN_LMIC_library/project_config/lmic_project_config.h
+          # Fix for linker error with Arduino core for ESP32 v2.0.x as suggested in https://github.com/mcci-catena/arduino-lmic/issues/714#issuecomment-822051171
+          echo "#define hal_init LMICHAL_init" >> /home/runner/Arduino/libraries/MCCI_LoRaWAN_LMIC_library/project_config/lmic_project_config.h
+
+      - name: Copy secrets.h from secrets.h.template
+        if: ${{ env.run-build == 'true' }}
+        run:
+          |
+          pwd
+          ls
+          cp /home/runner/work/arduino-lorawan/arduino-lorawan/examples/arduino_lorawan_esp32_example/secrets.h.template \
+          /home/runner/work/arduino-lorawan/arduino-lorawan/examples/arduino_lorawan_esp32_example/secrets.h
+
+      - name: Build sketch
+        if: ${{ env.run-build == 'true' }}
+        run:
+          |
+          #for example in $(find $PWD/examples -name '*.ino' | sort); do
+          # modified to compile a singe sketch (instead of a library's examples)
+          for example in $(find $PWD -name '*.ino' | sort); do
+            # check whether to skip this sketch
+            if [ ! -z '${{ steps.prep.outputs.skip-pattern }}' ] && [[ ${example} =~ ${{ steps.prep.outputs.skip-pattern }} ]]; then
+              # skip sketch
+              echo -e "\n\033[1;33mSkipped ${example##*/} (matched with ${{ steps.prep.outputs.skip-pattern }})\033[0m";
+            else
+              # build sketch
+              echo -e "\n\033[1;33mBuilding ${example##*/} ... \033[0m";
+              arduino-cli compile --libraries /home/runner/work/arduino-lorawan --fqbn ${{ matrix.board }}${{ steps.prep.outputs.options }} $example --warnings=${{ steps.prep.outputs.warnings }}
+
+              if [ $? -ne 0 ]; then
+                echo -e "\033[1;31m${example##*/} build FAILED\033[0m\n";
+                exit 1;
+              else
+                echo -e "\033[1;32m${example##*/} build PASSED\033[0m\n";
+              fi
+            fi
+          done

examples/arduino_lorawan_esp32_example/DEBUG_OUTPUT.md

@@ -0,0 +1,22 @@
+# Debug Output Configuration in Arduino IDE
+
+## ESP32
+
+1. Select appropriate (USB-)serial port for your board
+
+    ![Arduino_IDE-Tools_Port](https://github.com/matthias-bs/BresserWeatherSensorTTN/assets/83612361/be496bf8-89ce-4db5-b1bf-c88a7f5e99cb)
+
+**or**
+
+   ![Arduino_IDE-Select_Other_Board_and_Port](https://github.com/matthias-bs/BresserWeatherSensorTTN/assets/83612361/ac847f23-4fe6-4111-929f-ac6d36cb8a53)
+
+2. Select desired debug level
+
+    ![Arduino_IDE-Tools_CoreDebugLevel](https://github.com/matthias-bs/BresserWeatherSensorTTN/assets/83612361/72a8b1d9-8d39-41fc-9658-78b432b73d56)
+
+  This passes the define `CORE_DEBUG_LEVEL`to the compiler accordingly.
+
+Refer to the following for some background information
+* https://thingpulse.com/esp32-logging/
+* https://www.mischianti.org/2020/09/20/esp32-manage-multiple-serial-and-logging-for-debugging-3/
+* https://github.com/espressif/arduino-esp32/blob/master/cores/esp32/esp32-hal-log.h