Merge for release v1.2.4

.github/workflows/release-gui.yml

@@ -0,0 +1,59 @@
+name: GUI Release
+on:
+  push:
+  pull_request:
+    branches:
+      - main
+jobs:
+  Build-Action:
+    runs-on: windows-latest
+    steps:
+      - uses: actions/checkout@v5
+      - uses: actions/setup-node@v4
+      - uses: actions/setup-python@v5
+        with:
+          python-version: "3.9"
+      - name: Install uv
+        uses: astral-sh/setup-uv@v6
+      - name: Install npm dependencies
+        run: npm ci
+        working-directory: ./sw/wulpus-frontend
+      - name: Build UI (react)
+        run: python build.py
+        working-directory: ./sw/wulpus-frontend
+      - name: Install python dependencies
+        working-directory: ./sw
+        run: uv sync --locked
+      - name: Build .exe
+        working-directory: ./sw
+        run: uv run pyinstaller ./wulpus/main.spec --noconfirm
+      - name: Bump version and push tag
+        id: tag_version
+        uses: mathieudutour/github-tag-action@v6.2
+        with:
+          github_token: ${{ secrets.GITHUB_TOKEN }}
+          dry_run: ${{ github.event_name == 'pull_request' || github.ref != 'refs/heads/main'}}
+      - name: Write version info to artifact
+        working-directory: ./sw
+        shell: pwsh
+        run: |
+          $commitHash = (git rev-parse HEAD).Trim()
+          $commitDateFull = (git show -s --format=%cd --date=iso-strict HEAD).Trim()
+          $commitDate = $commitDateFull.Split('T')[0]
+          $text = "$commitHash from $commitDate (${{ steps.tag_version.outputs.new_tag }})"
+          $target = "./dist/main/_internal/wulpus/version.txt"
+          New-Item -ItemType Directory -Force -Path (Split-Path -Parent $target) | Out-Null
+          Set-Content -Path $target -Value $text -Encoding UTF8
+      - uses: actions/upload-artifact@v4
+        id: artifact-upload-step
+        with:
+          name: wulpus-all-in-one
+          path: ./sw/dist/main/
+          compression-level: 8
+      - name: Create release
+        uses: softprops/action-gh-release@v2
+        if: ${{ github.event_name != 'pull_request' && github.ref == 'refs/heads/main'}}
+        with:
+          tag_name: ${{ steps.tag_version.outputs.new_tag }}
+          name: UI-Release ${{ steps.tag_version.outputs.new_tag }}
+          body: Automated release of Wulpus GUI version ${{ steps.tag_version.outputs.new_tag }}. The release can be downloaded here [${{ steps.artifact-upload-step.outputs.artifact-url }}](${{ steps.artifact-upload-step.outputs.artifact-url }}) (github-login required)

.gitignore

@@ -1,5 +1,12 @@
 *.ipynb_checkpoints
 *.pyc
 __pycache__/
+*.egg-info/
 .ipynb_checkpoints/
 .vscode
+*.clangd
+sw/.venv
+sw/build/
+sw/dist/
+.uv-cache/
+local-development/

CHANGELOG.md

@@ -6,6 +6,20 @@ For the detailed description, please explore nested folders and corresponding CH
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+
+## [1.2.4] - 2026-08-31
+
+### Added
+
+### Fixed
+
+- Acquisition PCB layout changes to improve RF performance
+- Firmware improvements on nRF52 to improve reliability
+
+### Changed
+
+- Added new antenna (NN02-201) and corresponding matching network on Acquisition PCB
+
 ## [1.2.3] - 2026-04-02
 
 ### Added

README.md

@@ -1,6 +1,6 @@
 <img src="docs/images/wulpus_main.png" alt="WULPUS main" width="100%"/>
 
-# WULPUS v1.2.3
+# WULPUS v1.2.4
 ## Wearable Ultra Low-Power Ultrasound
 
 # Introduction
@@ -35,7 +35,7 @@ This repository has the following folders:
     - source code for the nRF52832 MCU of the WULPUS probe, located at `fw/nrf52/ble_peripheral/US_probe_nRF52_firmware`
     - source code for the nRF52840 USB dongle, located at `fw/nrf52/peripheral/US_probe_dongle_firmware`
     - source code for the MSP430 ultrasound MCU, located at `fw/msp430`
-- `sw`, containing the Python code for the WULPUS Graphical User Interface
+- `sw`, containing the Python code for the WULPUS Graphical User Interface (web-based version).
 
 - `hw`, containing the CAD source files for 
     - WULPUS Acquisition PCB (located at `hw/wulpus_acquisition_pcb`)
@@ -49,19 +49,22 @@ This repository has the following folders:
 
 The comprehensive [WULPUS User Manual](docs/wulpus_user_manual.pdf) can be found in the `docs/` folder. It covers everything about WULPUS, from assembly instructions to example measurements and troubleshooting, making the platform user-friendly for everyone, regardless of technical expertise.
 
-# How to reproduce?
+# How to use?
 
 Please find the detailed instructions in chapter 2 of the [WULPUS User Manual](docs/wulpus_user_manual.pdf).
 
 In a nutshell, to build your own instance of WULPUS, the following steps should be completed:
 1. *PCBs manufacturing and assembly*<br>
    You can find the design files (Altium source files, schematics, bills of materials) under the `hw` folder.
 2. *Flashing MSP430 firmware*<br>
-   You can find the instructions on seting-up the toolchain, compiling the firmware and flashing the MSP430 MCU in the `fw/msp430` folder.
+   You can find the instructions on setting up the toolchain, compiling the firmware and flashing the MSP430 MCU in the `fw/msp430` folder.
 3. *Flashing nRF52 MCU and USB dongle firmware*<br>
    You can find the instructions on setting-up the toolchain, compiling the firmware, flashing the nRF52 MCU and USB dongle in the `fw/nrf52` folder.
-4. *Python dependencies installation on the host PC*<br>
-   Follow the instructions in the `sw` folder to install the dependencies.
+4. *GUI installation on the host PC*<br>
+   Choose one of the following interfaces depending on your application:
+   - **BioGUI** *(Recommended for general use & HMI applications)*: Modular PySide6 GUI for acquiring and visualizing bio-signals from different sources. Follow the setup instructions in the [BioGUI repository](https://github.com/pulp-bio/biogui).
+   - **Web-based GUI** *(Recommended for NDT applications & acquisition sequences)*: Features a React/Vite frontend and FastAPI backend. Follow the setup instructions in [`sw/`](sw/).
+   - **Legacy Jupyter Notebook GUI** *(Deprecated / not recommended for new projects)*: Legacy interactive notebooks are located in [`sw/jupyter notebook (legacy)/`](<sw/jupyter notebook (legacy)/>).
 
 # Usage
 
@@ -70,7 +73,7 @@ Please refer to chapter 3 of the [WULPUS User Manual](docs/wulpus_user_manual.pd
 Starting a measurement with WULPUS can be accomplished in three simple steps:
 - Power up the probe, either from the micro-USB connector or from the battery connector
 - Connect the USB dongle to the host PC
-- Activate the Python environent, launch the Jupyter notebook located in `sw` folder, and follow the instructions in the notebook
+- Launch your chosen interface (**[BioGUI repository](https://github.com/pulp-bio/biogui)** or the **Web-based GUI** in [`sw/`](sw/)).
 
 # Citation
 If you would like to reference the project, please cite the following paper:
@@ -97,6 +100,12 @@ If you would like to reference the project, please cite the following paper:
 
 [5] Spacone G, Vostrikov S, Kartsch V, Benatti S, Benini L, Cossettini A. "Tracking of Wrist and Hand Kinematics with Ultra Low Power Wearable A-mode Ultrasound." IEEE Transactions on Biomedical Circuits and Systems. 2024 Sep 23.
 
+[6] Spacone, Giusy, et al. "Wearable and Ultra-Low-Power Fusion of EMG and A-Mode US for Hand-Wrist Kinematic Tracking." 2025 IEEE Biomedical Circuits and Systems Conference (BioCAS). IEEE, 2025.
+
+[7] Spacone, Giusy, et al. "Towards Fully Wearable Muscle Fatigue Assessment with A-mode Ultrasound." 2025 IEEE International Ultrasonics Symposium (IUS). IEEE, 2025.
+
+[8] Spacone, Giusy, et al. "Towards Whole Hand and Wrist Kinematic Tracking with a Wearable A-Mode Ultrasound Probe." IEEE Open Journal of Ultrasonics, Ferroelectrics, and Frequency Control. 2026.
+
 # Authors
 
 The WULPUS system was developed at the [Integrated Systems Laboratory (IIS)](https://iis.ee.ethz.ch/) at ETH Zurich by:
@@ -109,7 +118,7 @@ Thanks to all the people who contributed to the WULPUS platform:
 - [Cédric Hirschi](https://www.linkedin.com/in/c%C3%A9dric-cyril-hirschi-09624021b/) (GUI improvements, Documentation)
 - [Josquin Tille](https://www.linkedin.com/in/josquin-tille-829a341a7/) (Silicone package design, Documentation)
 - [William Bruderer](https://www.linkedin.com/in/william-bruderer-59ba9b26b/) (Documentation)
-
+- [Louis Dod](https://github.com/13Bytes) (GUI Rework)
 
 # License
 The following files are released under Apache License 2.0 (`Apache-2.0`) (see `sw/LICENSE`):

docs/CHANGELOG.md

@@ -5,6 +5,17 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## [Unreleased]
+
+## [1.3.0] - 2025-08-28
+
+### Added
+- New GUI with replay-functionality and extended logging, which is running in the browser
+- This required a new API, which structures the way of communicating with the wulpus-server
+
+(More details can be found in the [sw-changelog](../sw/CHANGELOG.md))
+
+
 ## [1.2.0] - 2025-01-27
 
 ### Added