Add AWS IoT Device Advisor validation to keyword-detection application

.github/workflows/build.yaml

@@ -1,4 +1,4 @@
-# Copyright (c) 2023 Arm Limited and/or its affiliates
+# Copyright (c) 2023-2024 Arm Limited and/or its affiliates
 # <[email protected]>
 # SPDX-License-Identifier: MIT
 
@@ -20,6 +20,14 @@ on:
 jobs:
   ubuntu:
     runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        application: [keyword-detection, speech-recognition]
+        audio: [ROM, VSI]
+        inference: [ETHOS, SOFTWARE]
+        exclude:
+          - application: speech-recognition
+            inference: SOFTWARE
     steps:
       - name: Checkout project
         uses: actions/checkout@v3
@@ -29,6 +37,7 @@ jobs:
       - name: Install python 3
         uses: actions/setup-python@v3
         with:
+          python-version: '3.10'
           architecture:   x64
         env:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
@@ -37,7 +46,7 @@ jobs:
         run: |
           pip install cmake ninja imgtool cffi intelhex cbor2 cbor jinja2 PyYaml pyelftools
           sudo apt-get -y update
-          sudo apt-get -y install srecord
+          sudo apt-get -y install srecord libsndfile1-dev
       - name: Install GNU Arm toolchain
         shell: bash
         run: |
@@ -53,25 +62,31 @@ jobs:
           export IOT_OTA_CLIENT_CERT="dummy_certificate"
           export IOT_OTA_CLIENT_PRIV="dummy_priv_key"
           export IOT_OTA_CLIENT_PUB="dummy_pub_key"
-          ./tools/ci/generate_credentials.sh -f -p applications/aws_iot_example/configs/aws_configs
+          export APP_UNDERSCORED=$(echo ${{ matrix.application }} | tr '-' '_')
+          ./tools/ci/generate_credentials.sh -f -p applications/${APP_UNDERSCORED}/configs/aws_configs
           git config --global user.email "[email protected]"
           git config --global user.name "ci"
-      - name: Build the project
+      - name: Build ${{ matrix.application }} application
         shell: bash
         run: |
           export PATH=$HOME/arm-gnu-toolchain-13.2.Rel1-x86_64-arm-none-eabi/bin:$PATH
-          ./tools/scripts/build.sh aws-iot-example --toolchain GNU --certificate_path $PWD/certificate.pem  --private_key_path $PWD/private_key.pem
+          ./tools/scripts/build.sh ${{ matrix.application }} \
+          --inference ${{ matrix.inference }} \
+          --audio ${{ matrix.audio }} \
+          --toolchain GNU \
+          --certificate_path $PWD/certificate.pem  \
+          --private_key_path $PWD/private_key.pem
       - name: Copy artifacts
         shell: bash
         run: |
-          tar -czf gnu_build.tar.gz \
-          build/aws-iot-example_merged.elf \
-          build/aws-iot-example-update_signed.bin \
+          tar -czf ${{ matrix.application }}_gnu_build.tar.gz \
+          build/${{ matrix.application }}_merged.elf \
+          build/${{ matrix.application }}-update_signed.bin \
           build/update-signature.txt
       - name: Upload Build Artifacts
         uses: actions/upload-artifact@v3
         with:
           name: FRI-build-logs
           path: |
-            ${{ github.workspace }}/gnu_build.tar.gz
+            ${{ github.workspace }}/${{ matrix.application }}_gnu_build.tar.gz
           retention-days: 5

.gitlab-ci.yml

@@ -106,7 +106,7 @@ build-applications:
     matrix:
        -
          << : *pipeline_config_non_ml_applications
-         APP: [blinky, aws-iot-example]
+         APP: [blinky]
        -
          << : *pipeline_config_ml_applications
          APP: [keyword-detection]
@@ -177,9 +177,6 @@ test-applications:
       fi
   parallel:
     matrix:
-       -
-         << : *pipeline_config_non_ml_applications
-         APP: [aws-iot-example]
        -
          << : *pipeline_config_ml_applications
          APP: [keyword-detection]

README.md

@@ -61,17 +61,16 @@ This reference integration contains following two examples:
 
 * [Blinky example](docs/blinky.md)
     * Demonstrates FreeRTOS kernel and TF-M integration
-* [AWS IoT example](docs/aws_iot_example.md)
-    * Demonstrates [secure connectivity](#secure-tls-connection) to AWS IoT core using [Mbed TLS](#mbed-tls),
-      [PKCS#11 PSA Shim](#pkcs11-psa-shim) and [coreMQTT-agent](https://docs.aws.amazon.com/freertos/latest/userguide/coremqtt-agent.html)
-      library. In addition, [secure OTA](#secure-ota-updates) using [OTA agent](https://freertos.org/ota/index.html)
-      and [AWS OTA PAL PSA implementation](#aws-ota-pal-psa-implementation).
 * [Keyword Detection](docs/keyword_detection.md)
     * Demonstrates detecting keywords from an audio source using Machine Learning.
-      It also has all the features of the AWS IoT example.
-* [Speech Recognition](docs/keyword_detection.md)
+* [Speech Recognition](docs/speech_recognition.md)
     * Demonstrates detecting sentences from an audio source using Machine Learning.
-      It also has all the features of the AWS IoT example.
+
+The Keyword-Detection and Speech-Recognition applications demonstrate [secure connectivity](#secure-tls-connection)
+to AWS IoT core using [Mbed TLS](#mbed-tls), [PKCS#11 PSA Shim](#pkcs11-psa-shim) and
+[coreMQTT-agent](https://docs.aws.amazon.com/freertos/latest/userguide/coremqtt-agent.html) libraries.
+In addition, [secure OTA](#secure-ota-updates) using [OTA agent](https://freertos.org/ota/index.html)
+and [AWS OTA PAL PSA implementation](#aws-ota-pal-psa-implementation) can be performed to update the binary running on the device.
 
 ### Secure TLS Connection