Fix version check, add flash script

Author: Boernsman

.github/workflows/ci.yml

@@ -19,19 +19,26 @@ jobs:
     steps:
       - name: Checkout code
         uses: actions/checkout@v4
-
+        with:
+          fetch-depth: 0
+          fetch-tags: true
+      
       - name: Prepare environment
         run: |
           mkdir -p $HOME/.local/bin
           echo "$HOME/.local/bin" >> $GITHUB_PATH
-          echo "git_hash=$(git rev-parse --short $GITHUB_SHA)" >> $GITHUB_ENV
-          echo "version=$(git describe --tags --abbrev=0)" >> $GITHUB_ENV
-          echo "Building firmware with version: ${{ env.version }} and git hash: ${{ env.git_hash }}"
+          GIT_HASH="\"$(git rev-parse --short $GITHUB_SHA)\""
+          echo "Git hash: $GIT_HASH"
+          echo "git_hash=$GIT_HASH" >> $GITHUB_ENV
+          VERSION="\"$(git describe --tags --abbrev=0)\""
+          echo "Version: $VERSION"
+          echo "version=$VERSION" >> $GITHUB_ENV
 
       - name: Compile
         uses: arduino/compile-sketches@v1
         with:
           fqbn: ${{ matrix.board.fqbn }}
+          verbose: true
           sketch-paths: |
             - ./firmware/
           libraries: |
@@ -40,7 +47,7 @@ jobs:
           cli-compile-flags: |
             - --export-binaries
             - --build-property 
-            - build.extra_flags="-DVERSION=${{ env.version }} -DGIT_HASH=${{ env.git_hash }}"
+            - build.extra_flags="-DVERSION=${{ env.version }}" "-DGIT_HASH=${{ env.git_hash }}"
 
       - name: Upload build artifacts
         uses: actions/upload-artifact@v4
@@ -62,6 +69,9 @@ jobs:
     steps:
       - name: Checkout code
         uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+          fetch-tags: true
 
       - name: Download build artifacts
         uses: actions/download-artifact@v4

firmware/firmware.ino

@@ -5,8 +5,13 @@
 #include <ArduinoJson.h>
 
 // Git version hash (replace with actual hash during build process)
+#ifndef VERSION
 #define VERSION "0.0.0"
+#endif
+
+#ifndef GIT_HASH
 #define GIT_HASH "00000000"
+#endif
 
 // Define the LED pin and state
 const int ledPin = 13;  // Pin connected to the onboard LED

scripts/build_firmware.sh

@@ -2,14 +2,14 @@
 
 # Copyright © 2024 Bitcrush Testing
 
-VERSION=$(git describe --tags --abbrev=0)
+VERSION="\"$(git describe --tags --abbrev=0)\""
 
 if [ -z "$VERSION" ]; then
   echo "Error: VERSION is empty"
   exit 1
 fi
 
-GIT_HASH=$(git rev-parse --short HEAD)
+GIT_HASH="\"$(git rev-parse --short HEAD)\""
 BOARDS=("arduino:avr:uno" "arduino:renesas_uno:minima")
 SCRIPT_DIR="$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)"
 
@@ -20,7 +20,7 @@ arduino-cli core install arduino:renesas_uno
 
 for BOARD in "${BOARDS[@]}"; do
     echo "Building $BOARD"
-    arduino-cli compile --fqbn ${BOARD} --build-property build.extra_flags="-DVERSION=${VERSION} -DGIT_HASH=${GIT_HASH}" ${SCRIPT_DIR}/../firmware --export-binaries
+    arduino-cli compile --fqbn "${BOARD}" --build-property build.extra_flags="-DVERSION=${VERSION} -DGIT_HASH=${GIT_HASH}" "${SCRIPT_DIR}/../firmware" --export-binaries
 done
 
 echo "-------- DONE ---------"

scripts/flash_firmware.sh

@@ -0,0 +1,21 @@
+#!/bin/bash
+
+# Copyright © 2024 Bitcrush Testing
+
+BOARDS=("arduino:avr:uno" "arduino:renesas_uno:minima")
+SCRIPT_DIR="$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)"
+BUILD_DIR="$SCRIPT_DIR/../firmware/build"
+
+if [ ! -e "$BUILD_DIR" ]; then
+  echo "Build the firmware first"
+  exit 1
+fi
+
+for BOARD in "${BOARDS[@]}"; do
+    PORT=$(python3 ./find_board_port.py "$BOARD")
+    echo "Flashing $BOARD on port $PORT"
+    INPUT_DIR=$BUILD_DIR/$(echo "$BOARD" | tr ':' '.')
+    arduino-cli upload -p "${PORT}" --fqbn "${BOARD}" --input-dir "${INPUT_DIR}" --verify --verbose
+done
+
+echo "-------- DONE ---------"

scripts/install_agent_node_dependencies.sh

@@ -17,7 +17,8 @@ check_raspberry_pi() {
 prompt_for_input() {
     local prompt_message="$1"
     local input_variable_name="$2"
-    read -p "$prompt_message: " $input_variable_name
+    # shellcheck disable=SC2229
+    read -rp "$prompt_message: " "$input_variable_name"
 }
 
 # Function to check if arduino-cli is installed
@@ -43,10 +44,10 @@ install_github_runner() {
     echo "Installing GitHub runner..."
     RUNNER_DIR=${HOME}/actions-runner
 
-    if [ -d ${RUNNER_DIR} ] 
+    if [ -d "${RUNNER_DIR}" ] 
     then
         echo "GitHub runner is already installed."
-        read -p "Do you want to overwrite it? (yes/no) " yn
+        read -rp "Do you want to overwrite it? (yes/no) " yn
 
         case $yn in 
 	        yes ) echo "Ok, proceeding";;
@@ -56,8 +57,8 @@ install_github_runner() {
 		        return;;
         esac
     fi 
-    rm -rf ${RUNNER_DIR}
-    mkdir -p ${RUNNER_DIR} && cd ${RUNNER_DIR}
+    rm -rf "${RUNNER_DIR}"
+    mkdir -p "${RUNNER_DIR}" && cd "${RUNNER_DIR}"
     echo "Install folder: ${RUNNER_DIR}"
     curl -o actions-runner-linux-arm64-2.317.0.tar.gz -L https://github.com/actions/runner/releases/download/v2.317.0/actions-runner-linux-arm64-2.317.0.tar.gz
     echo "7e8e2095d2c30bbaa3d2ef03505622b883d9cb985add6596dbe2f234ece308f3  actions-runner-linux-arm64-2.317.0.tar.gz" | shasum -a 256 -c
@@ -74,7 +75,7 @@ install_github_runner() {
 
     # Create the systemd service file
     SERVICE_FILE="/etc/systemd/system/github-runner.service"
-    sudo rm -f ${SERVICE_FILE}
+    sudo rm -f "${SERVICE_FILE}"
     sudo bash -c "cat > $SERVICE_FILE" <<EOL
 [Unit]
 Description=GitHub Actions Runner
@@ -119,9 +120,9 @@ install_python() {
 
 # Main script execution
 set -e
-user_id=`id -u`
+USER_ID=$(id -u)
 
-if [ $user_id -eq 0 -a -z "$RUNNER_ALLOW_RUNASROOT" ]; then
+if [[ "$USER_ID" -eq 0 ]] && [[ -z "$RUNNER_ALLOW_RUNASROOT" ]]; then
     echo "Must not run with sudo"
     exit 1
 fi

tests/test_arduino.py

@@ -22,7 +22,7 @@ def get_git_hash(short=True):
 
     try:
         # Command to get the Git hash
-        cmd = ['git', 'rev-parse', '--short' if short else 'HEAD']
+        cmd = ['git', 'rev-parse', '--short', 'HEAD']
 
         # Execute the command and get the output
         git_hash = subprocess.check_output(cmd).decode('utf-8').strip()