Merge pull request #556 from Hyperloop-UPV/develop

Prepare v11.1.0

Author: JavierRibaldelRio

.github/workflows/frontend-tests.yaml

@@ -29,7 +29,7 @@ jobs:
           cache: "pnpm"
 
       - name: Install dependencies
-        run: pnpm install --frozen-lockfile --filter=testing-view --filter=ui --filter=core
+        run: pnpm install --frozen-lockfile --filter=testing-view --filter=flashing-view --filter=competition-view --filter=ui --filter=core
 
       - name: Build frontend
         run: pnpm build --filter="./frontend/**"

.github/workflows/release.yaml

@@ -10,9 +10,19 @@ on:
         description: "Create as draft release"
         type: boolean
         default: true
+      include-testing:
+        description: "Include Testing View"
+        type: boolean
+        default: true
+      include-competition:
+        description: "Include Competition View"
+        type: boolean
+        default: true
+      include-flashing:
+        description: "Include Flashing View"
+        type: boolean
+        default: true
 
-env:
-  FORCE_JAVASCRIPT_ACTIONS_TO_NODE24: true
 
 jobs:
   determine-version:
@@ -21,12 +31,18 @@ jobs:
     outputs:
       version: ${{ steps.get_version.outputs.version }}
       is_draft: ${{ steps.get_version.outputs.is_draft }}
+      include_testing: ${{ steps.get_version.outputs.include_testing }}
+      include_competition: ${{ steps.get_version.outputs.include_competition }}
+      include_flashing: ${{ steps.get_version.outputs.include_flashing }}
     steps:
       - name: Determine version
         id: get_version
         run: |
           echo "version=${{ github.event.inputs.version }}" >> $GITHUB_OUTPUT
           echo "is_draft=${{ github.event.inputs.draft }}" >> $GITHUB_OUTPUT
+          echo "include_testing=${{ github.event.inputs.include-testing }}" >> $GITHUB_OUTPUT
+          echo "include_competition=${{ github.event.inputs.include-competition }}" >> $GITHUB_OUTPUT
+          echo "include_flashing=${{ github.event.inputs.include-flashing }}" >> $GITHUB_OUTPUT
 
   create-draft-release:
     name: Create Draft Release
@@ -62,20 +78,46 @@ jobs:
 
       - uses: actions/setup-node@v4
         with:
-          node-version: "20"
+          node-version: "24"
 
       - name: Install dependencies
         run: pnpm install --frozen-lockfile
 
       - name: Build with Turbo
-        run: pnpm turbo build --filter=testing-view
+        run: |
+          FILTERS=""
+          if [ "${{ needs.determine-version.outputs.include_testing }}" = "true" ]; then
+            FILTERS="$FILTERS --filter=testing-view"
+          fi
+          if [ "${{ needs.determine-version.outputs.include_competition }}" = "true" ]; then
+            FILTERS="$FILTERS --filter=competition-view"
+          fi
+          if [ "${{ needs.determine-version.outputs.include_flashing }}" = "true" ]; then
+            FILTERS="$FILTERS --filter=flashing-view"
+          fi
+          pnpm turbo build $FILTERS
 
       - uses: actions/upload-artifact@v4
+        if: needs.determine-version.outputs.include_testing == 'true'
         with:
           name: frontend-dist
           path: frontend/testing-view/dist/**
           retention-days: 1
 
+      - uses: actions/upload-artifact@v4
+        if: needs.determine-version.outputs.include_competition == 'true'
+        with:
+          name: competition-dist
+          path: frontend/competition-view/dist/**
+          retention-days: 1
+
+      - uses: actions/upload-artifact@v4
+        if: needs.determine-version.outputs.include_flashing == 'true'
+        with:
+          name: flashing-dist
+          path: frontend/flashing-view/dist/**
+          retention-days: 1
+
   build-backend:
     name: Build Backend - ${{ matrix.os }}
     needs: determine-version
@@ -121,22 +163,103 @@ jobs:
           path: electron-app/binaries/${{ matrix.binary }}
           retention-days: 1
 
+  build-blcu:
+    name: Build BLCU - ${{ matrix.os }}
+    needs: determine-version
+    runs-on: ${{ matrix.os }}
+    strategy:
+      fail-fast: true
+      matrix:
+        include:
+          - os: windows-latest
+            binary: blcu-programming-windows-amd64.exe
+            binary-base: blcu-programming-windows-amd64
+          - os: ubuntu-latest
+            binary: blcu-programming-linux-amd64
+            binary-base: blcu-programming-linux-amd64
+          - os: macos-latest
+            binary: blcu-programming-darwin-arm64
+            binary-base: blcu-programming-darwin-arm64
+          - os: macos-15-intel
+            binary: blcu-programming-darwin-amd64
+            binary-base: blcu-programming-darwin-amd64
+    steps:
+      - uses: actions/checkout@v4
+
+      - uses: actions/setup-python@v5
+        with:
+          python-version: "3.11"
+
+      - name: Create virtual environment
+        working-directory: blcu-programming
+        run: python -m venv .venv-build
+
+      - name: Install dependencies
+        working-directory: blcu-programming
+        shell: bash
+        run: |
+          if [ "${{ runner.os }}" = "Windows" ]; then
+            .venv-build/Scripts/pip install -r requirements-build.txt
+          else
+            .venv-build/bin/pip install -r requirements-build.txt
+          fi
+
+      - name: Build with PyInstaller
+        working-directory: blcu-programming
+        shell: bash
+        run: |
+          if [ "${{ runner.os }}" = "Windows" ]; then
+            PYTHON=".venv-build/Scripts/python"
+          else
+            PYTHON=".venv-build/bin/python"
+          fi
+          if [ "${{ runner.os }}" = "Windows" ]; then
+            PATH_SEP=";"
+          else
+            PATH_SEP=":"
+          fi
+          "$PYTHON" -m PyInstaller \
+            --clean \
+            --noconfirm \
+            --onefile \
+            --name "${{ matrix.binary-base }}" \
+            --distpath "../electron-app/binaries" \
+            --hidden-import uvicorn.loops.auto \
+            --hidden-import uvicorn.protocols.http.auto \
+            --hidden-import uvicorn.protocols.websockets.auto \
+            --hidden-import uvicorn.lifespan.on \
+            --hidden-import multipart \
+            --hidden-import multipart.multiparser \
+            --paths "." \
+            --add-data "BLCU-config.json${PATH_SEP}." \
+            api/main.py
+
+      - uses: actions/upload-artifact@v4
+        with:
+          name: blcu-${{ matrix.os }}
+          path: electron-app/binaries/${{ matrix.binary }}
+          retention-days: 1
+
   package-and-upload:
     name: Package & Upload - ${{ matrix.os }}
-    needs: [determine-version, create-draft-release, build-frontend, build-backend]
+    needs: [determine-version, create-draft-release, build-frontend, build-backend, build-blcu]
     runs-on: ${{ matrix.os }}
     strategy:
       fail-fast: true
       matrix:
         include:
           - os: windows-latest
             binary: backend-windows-amd64.exe
+            blcu-binary: blcu-programming-windows-amd64.exe
           - os: ubuntu-latest
             binary: backend-linux-amd64
+            blcu-binary: blcu-programming-linux-amd64
           - os: macos-latest
             binary: backend-darwin-arm64
+            blcu-binary: blcu-programming-darwin-arm64
           - os: macos-15-intel
             binary: backend-darwin-amd64
+            blcu-binary: blcu-programming-darwin-amd64
     steps:
       - uses: actions/checkout@v4
 
@@ -146,23 +269,44 @@ jobs:
           name: backend-${{ matrix.os }}
           path: electron-app/binaries
 
+      - name: Download BLCU binary
+        uses: actions/download-artifact@v4
+        with:
+          name: blcu-${{ matrix.os }}
+          path: electron-app/binaries
+
       - name: Set executable permissions (Unix)
         if: runner.os != 'Windows'
         run: chmod +x electron-app/binaries/*
 
       - name: Download frontend dist
+        if: needs.determine-version.outputs.include_testing == 'true'
         uses: actions/download-artifact@v4
         with:
           name: frontend-dist
           path: electron-app/renderer/testing-view
 
+      - name: Download competition-view dist
+        if: needs.determine-version.outputs.include_competition == 'true'
+        uses: actions/download-artifact@v4
+        with:
+          name: competition-dist
+          path: electron-app/renderer/competition-view
+
+      - name: Download flashing-view dist
+        if: needs.determine-version.outputs.include_flashing == 'true'
+        uses: actions/download-artifact@v4
+        with:
+          name: flashing-dist
+          path: electron-app/renderer/flashing-view
+
       - uses: pnpm/action-setup@v4
         with:
           version: 10.26.0
 
       - uses: actions/setup-node@v4
         with:
-          node-version: "20"
+          node-version: "24"
 
       - name: Update version in package.json
         working-directory: electron-app
@@ -186,7 +330,7 @@ jobs:
         run: |
           find electron-app/dist -maxdepth 1 -type f \
             \( -name "*.exe" -o -name "*.AppImage" -o -name "*.deb" \
-               -o -name "*.dmg" -o -name "*.zip" -o -name "*.yml" -o -name "*.blockmap" \) \
+               -o -name "*.rpm" -o -name "*.dmg" -o -name "*.zip" -o -name "*.yml" -o -name "*.blockmap" \) \
             | xargs gh release upload v${{ needs.determine-version.outputs.version }} --clobber
         env:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

.gitignore

@@ -9,4 +9,8 @@ node_modules/
 .env
 
 # Global binaries
-*.exe
+*.exe
+
+# electron modules
+electron-app/python
+electron-app/logger

README.md

@@ -13,7 +13,9 @@ Before starting, ensure you have the following installed:
 - **PNPM** (v10.26.0+)
 - **Node.js** (v20+)
 - **Go** (for the backend)
-- **Rust/Cargo** (for the packet-sender)
+- **Python** (v3.11+, for the BLCU programming service)
+
+`pnpm install` automatically creates the Python virtual environment and installs dependencies for the BLCU programming service on Windows, macOS, and Linux.
 
 ---
 
@@ -25,8 +27,9 @@ Our `pnpm-workspace.yaml` defines the following workspaces:
 | :----------------------------- | :------- | :---------------------------------------------------- |
 | `testing-view`                 | TS/React | Web interface for telemetry testing                   |
 | `competition-view`             | TS/React | UI for the competition                                |
+| `flashing-view`                | TS/React | UI for flashing firmware to the BLCU board            |
 | `backend`                      | Go       | Data ingestion and pod communication server           |
-| `packet-sender`                | Rust     | Utility for simulating vehicle packets                |
+| `blcu-programming`             | Python   | FastAPI service that flashes firmware to the BLCU board via TFTP |
 | `hyperloop-control-station`    | JS       | The main Control Station electron desktop application |
 | `e2e`                          | TS       | End-to-end tests for the whole app (Playwright)       |
 | `@workspace/ui`                | TS/React | Shared UI component library (frontend-kit)            |
@@ -44,7 +47,7 @@ These commands should be executed from the root directory (`/software`).
 
 #### Global Development Scripts
 
-- `pnpm dev` – Runs both frontends, the backend (with `dev-config.toml`), and the packet-sender in a single terminal window.
+- `pnpm dev` – Runs both frontends and the backend (with `dev-config.toml`) in a single terminal window.
 - `pnpm dev:main` – Runs frontends and the backend using the standard `config.toml`.
 
 #### Turbo Filtering
@@ -69,8 +72,14 @@ All Turbo scripts support filtering to target specific workspaces:
 - `pnpm build:linux` – Packages the Electron app for Linux.
 - `pnpm build:mac` – Packages the Electron app for macOS.
 
+#### Frontend View Scripts
+
+- `pnpm build:testing-view` – Builds only the Testing View frontend.
+- `pnpm build:competition-view` – Builds only the Competition View frontend.
+- `pnpm build:flashing-view` – Builds only the Flashing View frontend.
+
 #### Utility Scripts
 
 - `pnpm ui:add <component-name>` - To add shadcn/ui components
 
-  > Note: don't forget to also include it in frontend-kit/ui/src/components/shadcn/index.ts to be able to access it from @workspace/ui
+  > Note: don't forget to also include it in frontend-kit/ui/src/components/shadcn/index.ts to be able to access it from @workspace/ui

backend/cmd/main.go

@@ -9,6 +9,7 @@ import (
 	"github.com/HyperloopUPV-H8/h9-backend/internal/flags"
 	"github.com/HyperloopUPV-H8/h9-backend/internal/pod_data"
 	"github.com/HyperloopUPV-H8/h9-backend/internal/update_factory"
+	"github.com/HyperloopUPV-H8/h9-backend/pkg/logger"
 	tracelogger "github.com/HyperloopUPV-H8/h9-backend/pkg/logger/trace"
 
 	vehicle_models "github.com/HyperloopUPV-H8/h9-backend/internal/vehicle/models"
@@ -34,12 +35,6 @@ func main() {
 	flags.Init()
 	handleVersionFlag()
 
-	// Configure trace
-	traceFile := tracelogger.InitTrace(flags.TraceLevel)
-	if traceFile != nil {
-		defer traceFile.Close()
-	}
-
 	// Set use to all available CPUs and setup CPU profiling if enabled
 	cleanup := setupRuntimeCPU()
 	defer cleanup()
@@ -50,12 +45,26 @@ func main() {
 		trace.Fatal().Err(err).Msg("error unmarshaling toml file")
 	}
 
+	// Configure BasePath before InitTrace and NewADJ so all "others" files land in the right place
+	if err := logger.ConfigureLogger(config.Logging.TimeUnit, config.Logging.LoggingPath, ""); err != nil {
+		trace.Fatal().Err(err).Msg("configuring logger")
+	}
+
+	// Configure trace
+	traceFile := tracelogger.InitTrace(flags.TraceLevel)
+	if traceFile != nil {
+		defer traceFile.Close()
+	}
+
 	// <--- ADJ --->
 	adj, err := adj_module.NewADJ(config.Adj)
 	if err != nil {
 		trace.Fatal().Err(err).Msg("setting up ADJ")
 	}
 
+	// Now that we have the commit hash, update it in the logger
+	logger.CommitHash = adj.Commit
+
 	// <--- pod data --->
 	podData, err := pod_data.NewPodData(adj.Boards, adj.Info.Units)
 	if err != nil {
@@ -75,7 +84,7 @@ func main() {
 	updateFactory := update_factory.NewFactory(boardToPackets)
 
 	// <--- logger --->
-	loggerHandler, subloggers := setUpLogger(config)
+	loggerHandler, subloggers := setUpLogger()
 
 	// <-- connections & upgrader -->
 	connections := make(chan *websocket.Client)