Workflow for avr build

.github/actions/define-firmware-ver-action/action.yml

@@ -0,0 +1,14 @@
+name: Define the firmware version
+
+outputs:
+  firmware_ver:
+    description: the firmware version number 0x000N
+    value: ${{ steps.define_firmware_ver.outputs.firmware_ver }}
+
+runs:
+  using: "composite"
+  steps:
+    - name: define firmware_ver
+      id: define_firmware_ver
+      run: echo "firmware_ver=0x0007" >> $GITHUB_OUTPUT
+      shell: bash

.github/actions/download-firmware-action/action.yml

@@ -0,0 +1,63 @@
+name: Download the firmware
+
+inputs:
+  FIRMWARE_VARIANT:
+    required: true
+    type: string
+  FIRMWARE_RUN_ID:
+    required: false
+    type: string
+
+runs:
+  using: "composite"
+  steps:
+# when the build is NOT part of a continuous release, the firware hex from the most recent continuous release will be packaged with the desktop interface
+    - name: Determine download url for the firmware from the most recent continuous release
+      if: github.event.workflow != '.github/workflows/continuous.yml' 
+      id: run_query
+      run: |
+        HEX_URL=$(gh api graphql -f query='query {repository ( owner : "brentfpage", name: "Labrador") {release ( tagName: "continuous" ) {releaseAssets(first:10) {nodes {downloadUrl}}}}}' | jq -r '.data.repository.release.releaseAssets.nodes[] | select(.downloadUrl| test("${{ inputs.FIRMWARE_VARIANT }}.hex")) | .[]')
+        echo "firmware_url=${HEX_URL}" >> $GITHUB_OUTPUT
+      env:
+        GH_TOKEN: ${{ github.token }}
+      shell: bash
+
+# query description: get at most 10 assets from the most recent continuous release (assume there are fewer than 10), find the one that includes FIRMWARE_VARIANT.hex in the download url
+# prettified (ish) query:
+# query {\
+#         repository ( owner : "espotek-org", name: "Labrador") {\
+#           release ( tagName: "continuous" ) {\
+#             releaseAssets(first:10) {\
+#               nodes {\
+#                 downloadUrl\
+#               }\
+#             }\
+#           }\
+#         }\
+#       }\
+# ' | jq -r '.data.repository.release.releaseAssets.nodes[] | select(.downloadUrl| test("${{ inputs.FIRMWARE_VARIANT }}.hex")) | .[]'
+
+    - name: Download firmware from most recent continuous release
+      if: github.event.workflow != '.github/workflows/continuous.yml' 
+      run: |
+        mkdir asset-hex
+        wget --directory-prefix=asset-hex ${{ steps.run_query.outputs.firmware_url }}
+      shell: bash
+
+# when the build is part of a continuous release, the release's firmware hex will be packaged with the desktop interface
+    - name: Download firmware from in-process continuous release
+      if: github.event.workflow == '.github/workflows/continuous.yml' 
+      uses: actions/download-artifact@v4
+      with:
+        run-id: ${{ inputs.FIRMWARE_RUN_ID }}
+        github-token: ${{ secrets.GITHUB_TOKEN }}
+
+    - name: move firmware to appropriate directory
+      run: |
+        mv asset-hex/*${{ inputs.FIRMWARE_VARIANT }}.hex Desktop_Interface/resources/firmware
+      shell: bash
+
+
+
+
+

.github/workflows/android.yml

@@ -7,6 +7,10 @@ permissions:
 on: 
   workflow_dispatch:
   workflow_call:
+    inputs:
+      FIRMWARE_RUN_ID:
+        required: true
+        type: string
 
   push:
     branches:
@@ -31,6 +35,17 @@ jobs:
       - name: Checkout repository
         uses: actions/checkout@v4
 
+      - name: Define firmware version
+        id: define_firmware_version
+        uses: ./.github/actions/define-firmware-ver-action
+
+      - name: Download firmware
+        id: download_firmware
+        uses: ./.github/actions/download-firmware-action
+        with:
+          FIRMWARE_VARIANT: '02'
+          FIRMWARE_RUN_ID: ${{ github.event.workflow == './github/workflows/continuous.yml' && inputs.FIRMWARE_RUN_ID || ''}} # for grabbing the firmware from an in-process continuous release
+
       - name: Install Qt
         uses: jurplel/install-qt-action@v4
         with:
@@ -74,13 +89,13 @@ jobs:
           export ANDROID_NDK_ROOT="${ANDROID_SDK_ROOT}/ndk/21.3.6528147"
           APK_BASENAME="Labrador-$(git rev-parse --short HEAD)"
           if [ -e cert.cer ] && [ -e cert.p8 ]; then
-            qmake -config release
+            qmake -config release EXPECTED_FIRMWARE_VERSION=${{ steps.define_firmware_version.outputs.firmware_ver }}
             make -j$(nproc)
             make INSTALL_ROOT=android-build install
             JAVA_HOME=${JAVA_HOME_8_X64} androiddeployqt --input android-Labrador-deployment-settings.json --output android-build --aab --android-platform android-31 --verbose --gradle --release
             ${ANDROID_SDK_ROOT}/build-tools/31.0.0/apksigner sign --in android-build/build/outputs/apk/release/android-build-release-unsigned.apk --out ${APK_BASENAME}-release-signed.apk --key cert.p8 --cert cert.cer --verbose
           else
-            qmake -config debug
+            qmake -config debug EXPECTED_FIRMWARE_VERSION=${{ steps.define_firmware_version.outputs.firmware_ver }}
             make -j$(nproc)
             make INSTALL_ROOT=android-build install
             JAVA_HOME=${JAVA_HOME_8_X64} androiddeployqt --input android-Labrador-deployment-settings.json --output android-build --aab --android-platform android-31 --verbose --gradle

.github/workflows/continuous.yml

@@ -8,27 +8,48 @@ on:
   workflow_dispatch:
 
 jobs:
+  build-firmware:
+    uses: ./.github/workflows/firmware.yml
+    secrets: inherit
   build-android:
+    needs:
+      - build-firmware
     uses: ./.github/workflows/android.yml
+    with:
+      FIRMWARE_RUN_ID: ${{ needs.build-firmware.outputs.run_id }}
     secrets: inherit
   build-linux:
+    needs:
+      - build-firmware
     uses: ./.github/workflows/linux.yml
+    with:
+      FIRMWARE_RUN_ID: ${{ needs.build-firmware.outputs.run_id }}
     secrets: inherit
   build-mac:
+    needs:
+      - build-firmware
     uses: ./.github/workflows/mac.yml
+    with:
+      FIRMWARE_RUN_ID: ${{ needs.build-firmware.outputs.run_id }}
     secrets: inherit
-  build-windows:
-    uses: ./.github/workflows/windows.yml
-    secrets: inherit
+
+#  build-windows:
+#    needs:
+#      - build-firmware
+#    uses: ./.github/workflows/windows.yml
+#    with:
+#      FIRMWARE_RUN_ID: ${{ needs.build-firmware.outputs.run_id }}
+#    secrets: inherit
 
   release:
     permissions:
       contents: write
     needs:
+      - build-firmware
       - build-android
       - build-linux
       - build-mac
-      - build-windows
+#      - build-windows
     if: github.ref == 'refs/heads/master'
     runs-on: ubuntu-latest
     steps:

.github/workflows/firmware.yml

@@ -0,0 +1,62 @@
+name: Build firmware
+
+permissions:
+  contents: read
+  pull-requests: write
+
+on:
+  workflow_call:
+    outputs:
+      run_id:
+        description: the run-id of the workflow run
+        value: ${{ jobs.build-hex.outputs.run_id }}
+  workflow_dispatch:
+  push:
+
+
+jobs:
+  build-hex:
+    runs-on: ubuntu-latest
+    outputs:
+      run_id: ${{ steps.step_get_run_id.outputs.RUN_ID }}
+    steps:
+      - name : Checkout repository
+        uses: actions/checkout@v4
+
+      - name: Define firmware version
+        id: define_firmware_version
+        uses: ./.github/actions/define-firmware-ver-action
+
+      - name : make 01
+        uses: bazhenov/action-avr-make@v1.1
+        with:
+          dir: AVR_Code
+          target: '01'
+        env:
+          FIRMWARE_VERSION_ID: ${{ steps.define_firmware_version.outputs.firmware_ver }}
+
+      - name : make clean
+        uses: bazhenov/action-avr-make@v1.1
+        with:
+          dir: AVR_Code
+          target: clean_o_d
+
+      - name : make 02
+        uses: bazhenov/action-avr-make@v1.1
+        with:
+          dir: AVR_Code
+          target: '02'
+        env:
+          FIRMWARE_VERSION_ID: ${{ steps.define_firmware_version.outputs.firmware_ver }}
+
+      - name: Upload hex artifacts
+        uses: actions/upload-artifact@v4
+        with:
+          name: asset-hex
+          path: AVR_Code/labrafirm*.hex
+          compression-level: 0
+          if-no-files-found: error
+
+      - name: Prepare workflow run ID output
+        id: step_get_run_id
+        run: echo "RUN_ID=${{ github.run_id }}" >> "$GITHUB_OUTPUT"

.github/workflows/linux.yml

@@ -7,6 +7,10 @@ permissions:
 on: 
   workflow_dispatch:
   workflow_call:
+    inputs:
+      FIRMWARE_RUN_ID:
+        required: true
+        type: string
 
   push:
     branches:
@@ -37,6 +41,17 @@ jobs:
       - name: Checkout repository
         uses: actions/checkout@v4
 
+      - name: Define firmware version
+        id: define_firmware_version
+        uses: ./.github/actions/define-firmware-ver-action
+
+      - name: Download firmware
+        id: download_firmware
+        uses: ./.github/actions/download-firmware-action
+        with:
+          FIRMWARE_VARIANT: '02'
+          FIRMWARE_RUN_ID: ${{ github.event.workflow == './github/workflows/continuous.yml' && inputs.FIRMWARE_RUN_ID || ''}} # for grabbing the firmware from an in-process continuous release
+
       - name: Install dependencies
         run: |
           sudo apt-get update
@@ -46,24 +61,25 @@ jobs:
       - name: Build librador
         working-directory: Librador_API/___librador/librador
         run: |
-          qmake -config release
+          qmake -config release EXPECTED_FIRMWARE_VERSION=${{ steps.define_firmware_version.outputs.firmware_ver }}
           make -j$(nproc)
 
       - name: Build librademo
         working-directory: Librador_API/___librador/librademo
         run: |
-          qmake -config release
+          qmake -config release EXPECTED_FIRMWARE_VERSION=${{ steps.define_firmware_version.outputs.firmware_ver }}
           make -j$(nproc)
 
       - name: Build basicdemo
         working-directory: Librador_API/___librador/basicdemo
         run: |
-          qmake -config release
+          qmake -config release EXPECTED_FIRMWARE_VERSION=${{ steps.define_firmware_version.outputs.firmware_ver }}
           make -j$(nproc)
 
       - name: Build AppImage
         working-directory: Desktop_Interface
         run: |
+          export EXPECTED_FIRMWARE_VERSION=${{ steps.define_firmware_version.outputs.firmware_ver }}
           ./make_appimage
 
       - name: Upload artifacts
@@ -88,6 +104,17 @@ jobs:
       - name: Checkout repository
         uses: actions/checkout@v4
 
+      - name: Define firmware version
+        id: define_firmware_version
+        uses: ./.github/actions/define-firmware-ver-action
+
+      - name: Download firmware
+        id: download_firmware
+        uses: ./.github/actions/download-firmware-action
+        with:
+          FIRMWARE_VARIANT: '02'
+#          FIRMWARE_RUN_ID: ${{ inputs.FIRMWARE_RUN_ID }} # for grabbing the firmware from an in-process continuous release
+
       - name: Install dependencies
         run: |
           sudo apt-get update
@@ -97,24 +124,25 @@ jobs:
       - name: Build librador
         working-directory: Librador_API/___librador/librador
         run: |
-          qmake -config release
+          qmake -config release EXPECTED_FIRMWARE_VERSION=${{ steps.define_firmware_version.outputs.firmware_ver }}
           make -j$(nproc)
 
       - name: Build librademo
         working-directory: Librador_API/___librador/librademo
         run: |
-          qmake -config release
+          qmake -config release EXPECTED_FIRMWARE_VERSION=${{ steps.define_firmware_version.outputs.firmware_ver }}
           make -j$(nproc)
 
       - name: Build basicdemo
         working-directory: Librador_API/___librador/basicdemo
         run: |
-          qmake -config release
+          qmake -config release EXPECTED_FIRMWARE_VERSION=${{ steps.define_firmware_version.outputs.firmware_ver }}
           make -j$(nproc)
 
       - name: Build Debian package
         working-directory: Desktop_Interface
         run: |
+          export EXPECTED_FIRMWARE_VERSION=${{ steps.define_firmware_version.outputs.firmware_ver }}
           DEB_BUILD_OPTIONS=nostrip dpkg-buildpackage -b
           mv ../espotek-labrador*.deb ../Labrador-$(git rev-parse --short HEAD)-${{ matrix.arch }}.deb