Add devcontainer, github action firmware build

Author: edholmes2232

.devcontainer/Dockerfile

@@ -0,0 +1,38 @@
+# Using Ubuntu image contents, see here for details: https://github.com/devcontainers/images/tree/main/src/base-ubuntu
+# Select Ubuntu version, options are "20.04" (Focal), "22.04" (Jammy) or "24.04" (noble)
+ARG VARIANT="24.04"
+
+FROM mcr.microsoft.com/devcontainers/base:ubuntu-${VARIANT}
+
+# Prevent interactive prompts during package installation
+ARG DEBIAN_FRONTEND=noninteractive
+
+# Install required packages to build firmware and documentation
+RUN apt-get update \
+    && apt-get -y install --no-install-recommends \
+        software-properties-common \
+        build-essential \
+        git \
+        symlinks \
+        expect \
+        bash-completion \
+        cmake \
+        ninja-build \
+        wget \
+    && apt-get clean \
+    && rm -rf /var/lib/apt/lists/*
+
+# Download and install the Arm GNU toolchain
+ARG TOOLCHAIN_VER="12.2.rel1"
+ARG TOOLCHAIN_URL="https://developer.arm.com/-/media/Files/downloads/gnu/${TOOLCHAIN_VER}/binrel/arm-gnu-toolchain-${TOOLCHAIN_VER}-x86_64-arm-none-eabi.tar.xz"
+
+RUN wget -q $TOOLCHAIN_URL -O /tmp/arm-gnu-toolchain.tar.xz \
+    && mkdir -p /opt/arm-gnu-toolchain \
+    && tar -xf /tmp/arm-gnu-toolchain.tar.xz -C /opt/arm-gnu-toolchain --strip-components=1 \
+    && rm /tmp/arm-gnu-toolchain.tar.xz \
+    && for tool in gcc gdb g++ size objcopy objdump nm c++filt; do \
+        ln -s /opt/arm-gnu-toolchain/bin/arm-none-eabi-${tool} /usr/bin/arm-none-eabi-${TOOLCHAIN_VER}-${tool}; \
+    done
+
+# Add toolchain to PATH
+ENV PATH="/opt/arm-gnu-toolchain/bin:${PATH}"

.devcontainer/devcontainer.json

@@ -0,0 +1,23 @@
+{
+    "name": "S2T Env",
+    "build": {
+        // Path is relative to the devcontainer.json file.
+        "dockerfile": "Dockerfile"
+    },
+    "runArgs": [
+        "--privileged"
+    ],
+    // Mount USB devices for flashing firmware
+    "mounts": [
+        "source=/dev,target=/dev,type=bind"
+    ],
+    // Run commands after container is created
+    "postCreateCommand": "git config --global --add safe.directory ${containerWorkspaceFolder}",
+    "customizations": {
+        "vscode": {
+            "extensions": [
+                "ms-vscode.cmake-tools"
+            ]
+        }
+    }
+}

.github/workflows/build-firmware.yml

@@ -0,0 +1,107 @@
+name: 'Build Firmware'
+
+on:
+  push:
+    branches: [ master, feature/dev-container ]
+  pull_request:
+    branches: [ master, feature/dev-container ]
+  workflow_dispatch:
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v4
+        with:
+          submodules: recursive
+      
+      - name: Create access key header
+        run: |
+          cat > Core/Lib/picovoice/include/pv_access_key.h << 'EOF'
+          #ifndef ACCESS_KEY_H
+          #define ACCESS_KEY_H
+          
+          // Picovoice Access Key
+          #define PV_ACCESS_KEY "${{ secrets.PV_ACCESS_KEY }}"
+          
+          #endif
+          EOF
+
+      - name: Build Docker image
+        run: |
+          docker build -t s2t-builder:latest -f .devcontainer/Dockerfile .devcontainer/
+
+      - name: Build firmware in container
+        run: |
+          # Create container with source mounted
+          docker run -d --name s2t-build \
+            --user $(id -u):$(id -g) \
+            -v ${{ github.workspace }}:/workspaces/Speech2Touch \
+            -w /workspaces/Speech2Touch \
+            s2t-builder:latest \
+            tail -f /dev/null
+          
+          # Configure CMake
+          docker exec s2t-build /usr/bin/cmake \
+            -DCMAKE_BUILD_TYPE=Release \
+            -DCMAKE_TOOLCHAIN_FILE=/workspaces/Speech2Touch/cmake/gcc-arm-none-eabi.cmake \
+            -S /workspaces/Speech2Touch \
+            -B /workspaces/Speech2Touch/build/Release \
+            -G Ninja
+          
+          # Clean build
+          docker exec s2t-build /usr/bin/cmake \
+            --build /workspaces/Speech2Touch/build/Release --target clean --
+          
+          # Build firmware
+          docker exec s2t-build /usr/bin/cmake \
+            --build /workspaces/Speech2Touch/build/Release --target all --
+          
+          # List built files
+          docker exec s2t-build ls -la /workspaces/Speech2Touch/build/Release/
+
+      - name: Copy artifacts from container
+        run: |
+          # Create build directory on host
+          mkdir -p ${{ github.workspace }}/build/Release
+          
+          # Copy artifacts from container to host
+          docker cp s2t-build:/workspaces/Speech2Touch/build/Release/Speech2Touch.bin \
+            ${{ github.workspace }}/build/Release/Speech2Touch.bin
+          docker cp s2t-build:/workspaces/Speech2Touch/build/Release/Speech2Touch.elf \
+            ${{ github.workspace }}/build/Release/Speech2Touch.elf
+          docker cp s2t-build:/workspaces/Speech2Touch/build/Release/Speech2Touch.hex \
+            ${{ github.workspace }}/build/Release/Speech2Touch.hex
+          docker cp s2t-build:/workspaces/Speech2Touch/build/Release/Speech2Touch.map \
+            ${{ github.workspace }}/build/Release/Speech2Touch.map
+          
+          # Ensure correct ownership
+          sudo chown -R $(id -u):$(id -g) ${{ github.workspace }}/build/Release/
+          
+          # Stop and remove container
+          docker stop s2t-build
+          docker rm s2t-build
+
+      - name: Verify build artifacts
+        run: |
+          echo "Build artifacts on host:"
+          ls -lah ${{ github.workspace }}/build/Release/
+
+      - name: Upload firmware artifact
+        uses: actions/upload-artifact@v4
+        with:
+          name: speech2touch-firmware-${{ github.sha }}
+          path: ${{ github.workspace }}/build/Release/Speech2Touch.bin
+          if-no-files-found: error
+          retention-days: 90
+
+      - name: Upload firmware artifact (latest)
+        if: github.ref == 'refs/heads/master'
+        uses: actions/upload-artifact@v4
+        with:
+          name: speech2touch-firmware-latest
+          path: ${{ github.workspace }}/build/Release/Speech2Touch.bin
+          if-no-files-found: error
+          retention-days: 90

README.md

@@ -1,6 +1,6 @@
 # Speech2Touch 🗣️👆
 
-[![Build Status](https://img.shields.io/badge/build-passing-brightgreen)](https://github.com/edholmes2232/Speech2Touch/actions)
+[![Build Firmware](https://github.com/edholmes2232/Speech2Touch/actions/workflows/build-firmware.yml/badge.svg)](https://github.com/edholmes2232/Speech2Touch/actions/workflows/build-firmware.yml)
 [![License](https://img.shields.io/badge/license-MIT-blue)](LICENSE.md)
 [![Test Coverage](https://img.shields.io/badge/tests-pending-lightgrey)](https://github.com/edholmes2232/Speech2Touch/actions)
 
@@ -12,12 +12,17 @@ Based on STM32WB55, it leverages [Picovoice](https://picovoice.ai/) to process s
 
 The INMP441 MEMS microphone is used for voice input.
 
+**Pre-built firmware:** [Download latest](https://github.com/edholmes2232/Speech2Touch/actions/workflows/build-firmware.yml) (select latest successful run → Artifacts)
+
+**Coverage:** This project has been written about on [Hackaday](https://hackaday.com/2025/09/24/coffee-by-command-the-speech2touch-voice-hack/) and [Hackster.io](https://www.hackster.io/news/espresso-yourself-with-your-voice-b83a2757f170).
+
 ---
 
 ## ☕️ Demo
 
 https://github.com/user-attachments/assets/7025197e-daeb-4745-9b6d-d1ec124fa88a
 
+---
 
 ## 🤖 Prototype Hardware
 
@@ -27,6 +32,7 @@ https://github.com/user-attachments/assets/7025197e-daeb-4745-9b6d-d1ec124fa88a
 
 The shape and orientation of the protoboard were dictated by the position of the USB ports of the Franke A600.
 
+---
 
 ## 🏭 Hardware-In-Loop (HIL) Test
 
@@ -40,47 +46,57 @@ https://github.com/user-attachments/assets/d8d1ce1c-74fb-45fa-a442-dd6b9ee583c0
 - STM32WB55 USB Dongle dev board
 - INMP441 microphone
 - Franke A600 (or compatible) touchscreen device
-- QT (for HIL testing)
-- VSCode (for debugging)
-- [STM32Cube for Visual Studio Code](https://www.st.com/content/st_com/en/stm32-mcu-developer-zone/software-development-tools/stm32cubevscode.html) extension
+- Qt (for HIL testing)
+- VSCode with [STM32Cube extension](https://www.st.com/content/st_com/en/stm32-mcu-developer-zone/software-development-tools/stm32cubevscode.html)
+- See `Dockerfile` for toolchain and package requirements
 
 ### 🚀 Container Build & Flash (Recommended)
-Coming soon...
+
+1. Open in VSCode and reopen in dev container (`F1` → "Dev Containers: Reopen in Container")
+2. Configure and build:
+```bash
+cmake -DCMAKE_BUILD_TYPE=Release \
+  -DCMAKE_TOOLCHAIN_FILE=/workspaces/Speech2Touch/cmake/gcc-arm-none-eabi.cmake \
+  -S /workspaces/Speech2Touch -B /workspaces/Speech2Touch/build/Release -G Ninja
+cmake --build /workspaces/Speech2Touch/build/Release --target all
+```
+3. Flash `build/Release/Speech2Touch.bin` to your STM32WB55
 
 ### 🛠️ Manual Build & Flash
 
-1. Clone this repository.
-2. Set up the project in VSCode using the STM32Cube extension.
-3. Build and flash the firmware from VSCode menus.
-4. Connect the device to the coffee machine via USB.
+1. Clone this repository
+2. Set up the project in VSCode using the STM32Cube extension
+3. Build and flash the firmware from VSCode
+4. Connect the device to the coffee machine via USB
 
 ### 🧪 HIL Testing
 
-The Hardware-In-Loop test creates a QT GUI window which emulates the position of touch targets to match the Franke A600. It utilizes Linux text-to-speech utilities to trigger the device, and tests that the correct corresponding touch target is triggered.
+The Hardware-In-Loop test suite uses a Qt GUI to emulate the Franke A600 touchscreen layout. It leverages Linux text-to-speech utilities to trigger the device and validates that commands activate the correct touch targets.
 
-1. Build the QT test suite:
-```
-$ cmake -DCMAKE_BUILD_TYPE=Test -S Speech2Touch -B Speech2Touch/build/Test -G Ninja
-$ cmake --build /home/ed/Projects/Speech2Touch/build/Test --target all --
-```
-2. Connect the embedded device with the latest firmware to the host PC USB port.
-3. Use `dmesg` to find the `/dev/input/eventX` USB input device path.
-4. Run automated test:
+1. Build the Qt test suite:
+```bash
+cmake -DCMAKE_BUILD_TYPE=Test -S Speech2Touch -B Speech2Touch/build/Test -G Ninja
+cmake --build Speech2Touch/build/Test --target all
 ```
-$ ./build/Test/Test/hil/runner/test_full_loop --input /dev/input/event10
+2. Connect the embedded device with the latest firmware to the host PC USB port
+3. Use `dmesg` to identify the `/dev/input/eventX` USB input device path
+4. Run the automated test:
+```bash
+./build/Test/Test/hil/runner/test_full_loop --input /dev/input/event10
 ```
 
 ---
 
 ## 🏗️ Architecture Overview
 
 ```
-[INMP441 microphone] → [Picovoice Speech Recognition] → [STM32WB55 MCU] → [Custom USB HID] → [Touchscreen Device]
+[INMP441 Microphone] → [Picovoice Speech Recognition] → [STM32WB55 MCU] → [Custom USB HID] → [Touchscreen Device]
 ```
-- **Input:** Microphone captures user speech.
-- **Processing:** Picovoice library processes audio and extracts commands.
-- **Translation:** Commands are mapped to touchscreen coordinates.
-- **Output:** Custom USB HID packets simulate touch events on the target device.
+
+- **Input:** INMP441 microphone captures audio
+- **Processing:** Picovoice library performs speech recognition and command extraction
+- **Translation:** Commands are mapped to touchscreen coordinates
+- **Output:** Custom USB HID packets simulate touch events
 
 ### 🧵 Threading
 
@@ -100,26 +116,14 @@ sequenceDiagram
   end
 
   activate Speech
-  Speech->>Speech: Speech Regognition
-  Speech->>Speech: Convert to target co-ords
+  Speech->>Speech: Speech Recognition
+  Speech->>Speech: Convert to Target Coords
   deactivate Speech
 
   Speech->>Touch: Touch Coordinates
   Touch->>USB: USB HID Report
-
 ```
 
-
-
-
----
-
-## 🔬 HIL Testing Suite
-
-- **QT-based GUI** replicates the Franke A600 touchscreen.
-- **Automated tests** ensure voice commands map to correct on-screen buttons.
-- **Continuous integration** ready.
-
 ---
 
 ## 🔮 Extending
@@ -139,14 +143,13 @@ The Picovoice precompiled binary at `Core/Lib/picovoice/libpicovoice.a` is pulle
 The configuration files in `Core/Lib/picovoice/include` are specifically set up for a Franke A600, including using "Franke" as the wake-word. New configuration files can be generated from the [Picovoice Console](https://console.picovoice.ai/).
 
 ---
-## ☑️ To Do
-- Create .devcontainer for firmware builds within a container.
-- Replace Dev Board + Protoboard with a PCB.
+
+## ☑️ Roadmap
+
+- Replace Dev Board + Protoboard with a PCB
 - Unit testing.
-- CI/CD with GitHub Actions for generating firmware, running unit tests.
 - Extract audio over RTT for tuning.
-- Decouple Franke A600 specific functionality for easier adapting of Speech2Touch to different applications. 
-
+- Decouple Franke A600-specific functionality for easier adapting of Speech2Touch to different applications.
 
 ---