Device setup improvments (Device identity, WiFi provisioning, MQTT autodiscovery)

.github/workflows/ci.yml

@@ -18,6 +18,28 @@ jobs:
       - name: Install build tools
         run: sudo apt-get update && sudo apt-get install -y --no-install-recommends cmake build-essential gcovr
 
+      - name: Validate factory flash tool
+        working-directory: Firmware
+        run: |
+          python3 -m py_compile tools/factory_flash.py
+          python3 - <<'PY'
+          import importlib.util
+          from pathlib import Path
+
+          script = Path("tools/factory_flash.py")
+          spec = importlib.util.spec_from_file_location("factory_flash", script)
+          module = importlib.util.module_from_spec(spec)
+          spec.loader.exec_module(module)
+
+          schema = module.read_schema()
+          assert schema["LINKEY_FACTORY_PARTITION_LABEL"] == "factory_data"
+          assert schema["LINKEY_FACTORY_NAMESPACE"] == "linkey"
+          assert schema["LINKEY_FACTORY_KEY_MQTT_PASSWORD"] == "mqtt-password"
+          assert schema["LINKEY_FACTORY_KEY_BLE_POP"] == "ble-pop"
+          assert schema["LINKEY_FACTORY_FALLBACK_MQTT_PASSWORD"] == "mqtt-password"
+          assert schema["LINKEY_FACTORY_FALLBACK_BLE_POP"] == "linkey-pop"
+          PY
+
       - name: Configure
         run: cmake -S Firmware/test/host -B Firmware/test/host/build -DENABLE_COVERAGE=ON
 
@@ -39,21 +61,34 @@ jobs:
           fail_ci_if_error: false
 
   firmware-build:
-    name: ESP-IDF firmware build
+    name: ESP-IDF firmware build (${{ matrix.variant }})
     runs-on: ubuntu-latest
     container: espressif/idf:release-v5.4
+    strategy:
+      fail-fast: false
+      matrix:
+        include:
+          - variant: default
+            build_dir: build
+            sdkconfig_defaults: sdkconfig.defaults
+          - variant: debug-logs
+            build_dir: build-debug
+            sdkconfig_defaults: sdkconfig.defaults;sdkconfig.ci-debug.defaults
     steps:
       - name: Checkout
         uses: actions/checkout@v5
         with:
           submodules: recursive
 
-      - name: Build firmware
+      - name: Build firmware (${{ matrix.variant }})
         shell: bash
         working-directory: Firmware
         run: |
           . $IDF_PATH/export.sh
-          idf.py build
+          idf.py \
+            -B "${{ matrix.build_dir }}" \
+            -DSDKCONFIG_DEFAULTS="${{ matrix.sdkconfig_defaults }}" \
+            build
 
   qemu-emulation:
     name: QEMU emulation (${{ matrix.tariff }})
@@ -90,9 +125,15 @@ jobs:
           . $IDF_PATH/export.sh
           eval "$(python "$IDF_PATH/tools/idf_tools.py" export)"
 
+          MQTT_USERNAME="linkey_ddeeff"
+          MQTT_PASSWORD="mqtt-password"
+          mosquitto_passwd -b -c mosquitto-ci.passwd "$MQTT_USERNAME" "$MQTT_PASSWORD"
+          chmod 0644 mosquitto-ci.passwd
+
           cat > mosquitto-ci.conf <<'EOF'
           per_listener_settings false
-          allow_anonymous true
+          allow_anonymous false
+          password_file mosquitto-ci.passwd
           listener 1884 0.0.0.0
           protocol mqtt
           log_dest stdout
@@ -112,7 +153,7 @@ jobs:
 
           BROKER_READY=0
           for _ in $(seq 1 30); do
-            if mosquitto_pub -h localhost -p 1884 -t ci/probe -m ready >/dev/null 2>&1; then
+            if mosquitto_pub -h localhost -p 1884 -u "$MQTT_USERNAME" -P "$MQTT_PASSWORD" -t ci/probe -m ready >/dev/null 2>&1; then
               BROKER_READY=1
               break
             fi
@@ -124,17 +165,18 @@ jobs:
             exit 1
           fi
 
-          stdbuf -oL mosquitto_sub -h localhost -p 1884 -t '#' -v > "mqtt-${TARIFF_OPTION}.log" 2>&1 &
+          stdbuf -oL mosquitto_sub -h localhost -p 1884 -u "$MQTT_USERNAME" -P "$MQTT_PASSWORD" -t '#' -v > "mqtt-${TARIFF_OPTION}.log" 2>&1 &
           SUB_PID=$!
 
           ./run_qemu_linkey.sh --tariff_option "$TARIFF_OPTION" --build > "qemu-${TARIFF_OPTION}.log" 2>&1 &
           QEMU_PID=$!
+          QEMU_TOPIC_PREFIX="linkey/ddeeff"
 
           deadline=$((SECONDS + 300))
           while [ "$SECONDS" -lt "$deadline" ]; do
-            if grep -Fxq "linkey/status online" "mqtt-${TARIFF_OPTION}.log" \
+            if grep -Fxq "${QEMU_TOPIC_PREFIX}/status online" "mqtt-${TARIFF_OPTION}.log" \
               && grep -Eq '^homeassistant/device/linkey_[0-9a-f]{12}/config ' "mqtt-${TARIFF_OPTION}.log" \
-              && grep -Eq '^linkey/state ' "mqtt-${TARIFF_OPTION}.log"; then
+              && grep -Eq "^${QEMU_TOPIC_PREFIX}/state " "mqtt-${TARIFF_OPTION}.log"; then
               break
             fi
             if ! kill -0 "$QEMU_PID" 2>/dev/null; then
@@ -149,11 +191,11 @@ jobs:
             sleep 2
           done
 
-          mosquitto_pub -h localhost -p 1884 -t linkey/debug/request -m GET_TIC_FRAME
+          mosquitto_pub -h localhost -p 1884 -u "$MQTT_USERNAME" -P "$MQTT_PASSWORD" -t "${QEMU_TOPIC_PREFIX}/debug/request" -m GET_TIC_FRAME
 
           deadline=$((SECONDS + 60))
           while [ "$SECONDS" -lt "$deadline" ]; do
-            if grep -Eq '^linkey/debug/tic_frame ' "mqtt-${TARIFF_OPTION}.log"; then
+            if grep -Eq "^${QEMU_TOPIC_PREFIX}/debug/tic_frame " "mqtt-${TARIFF_OPTION}.log"; then
               break
             fi
             if ! kill -0 "$QEMU_PID" 2>/dev/null; then
@@ -199,6 +241,55 @@ jobs:
             Firmware/mqtt-${{ matrix.tariff }}.log
             Firmware/mosquitto-${{ matrix.tariff }}.log
 
+  qemu-manual-provisioning:
+    name: QEMU manual provisioning trigger
+    runs-on: ubuntu-latest
+    container: espressif/idf:release-v5.4
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v5
+        with:
+          submodules: recursive
+
+      - name: Install QEMU (xtensa)
+        shell: bash
+        run: |
+          . $IDF_PATH/export.sh
+          python "$IDF_PATH/tools/idf_tools.py" install qemu-xtensa
+
+      - name: Run manual provisioning trigger emulation
+        shell: bash
+        working-directory: Firmware
+        run: |
+          . $IDF_PATH/export.sh
+          eval "$(python "$IDF_PATH/tools/idf_tools.py" export)"
+
+          ./run_qemu_linkey.sh \
+            --tariff_option base \
+            --manual-provision-test \
+            --build-only
+
+          timeout 45s ./run_qemu_linkey.sh \
+            --tariff_option base \
+            --manual-provision-test > qemu-manual-provisioning.log 2>&1 || true
+
+          echo "---- qemu-manual-provisioning.log ----"
+          cat qemu-manual-provisioning.log
+
+      - name: Assert manual provisioning trigger
+        shell: bash
+        working-directory: Firmware
+        run: |
+          python3 test/qemu/assert_manual_provisioning.py \
+            --qemu-log qemu-manual-provisioning.log
+
+      - name: Upload manual provisioning QEMU log
+        if: always()
+        uses: actions/upload-artifact@v6
+        with:
+          name: qemu-manual-provisioning-log
+          path: Firmware/qemu-manual-provisioning.log
+
   pcb-drc:
     name: KiCad DRC
     runs-on: ubuntu-latest

.gitignore

@@ -14,13 +14,18 @@ PCB/MCAD files/*.FCBak
 
 # Firmware
 Firmware/build/
+Firmware/build-debug/
+Firmware/build-factory/
 Firmware/build-qemu/
 Firmware/build-qemu-*/
+Firmware/managed_components/
 Firmware/sdkconfig*
 !Firmware/sdkconfig.defaults
+!Firmware/sdkconfig.ci-debug.defaults
 Firmware/.cache/
 Firmware/test/host/build/
-qemu.log
+Firmware/factory/devices/
+*.log
 __pycache__/
 *.pyc
 

Firmware/EMULATION.md

@@ -118,10 +118,10 @@ docker compose up -d mosquitto
 Pour observer les messages publiés par le firmware émulé :
 
 ```bash
-mosquitto_sub -h localhost -p 1884 -t "linkey/#" -v
+mosquitto_sub -h localhost -p 1884 -u linkey_ddeeff -P mqtt-password -t "linkey/#" -v
 ```
 
-Cette commande se connecte au broker local exposé sur le port `1884`, s'abonne à tous les topics sous `linkey/` et affiche chaque message reçu avec son topic.
+Cette commande se connecte au broker local exposé sur le port `1884`, s'abonne à tous les topics sous `linkey/` et affiche chaque message reçu avec son topic. Le broker QEMU refuse les connexions anonymes et attend les identifiants dérivés de la MAC mockée : `linkey_ddeeff` / `mqtt-password`.
 
 L'URI du broker QEMU est définie dans `emulation/sdkconfig.qemu.defaults`.