Merge pull request #339 from xmos/release/v2.2.0

Release v2.2.0 to main

.github/workflows/ci.yml

@@ -38,8 +38,6 @@ on:
 env:
   TMP_SOURCES_DIR: ${{ github.workspace }}/tmp/src
   RELEASE_SOURCES_DIR: ${{ github.workspace }}/release/src
-  RELEASE_DOCS_DIR: ${{ github.workspace }}/release/docs
-  RELEASE_PDF_DOCS_DIR: ${{ github.workspace }}/release/docs/pdf
 
 jobs:
   event_configuration:
@@ -49,7 +47,6 @@ jobs:
       is_release: ${{ steps.run_type.outputs.IS_RELEASE }}
       examples_artifact_name: ${{ steps.artifact_names.outputs.EXAMPLES_ARTIFACT_NAME }}
       src_artifact_name: ${{ steps.artifact_names.outputs.SOURCES_ARTIFACT_NAME }}
-      docs_artifact_name: ${{ steps.artifact_names.outputs.DOCS_ARTIFACT_NAME }}
     steps:
       - name: Determine workflow run type
         id: run_type
@@ -78,11 +75,9 @@ jobs:
             fi
             echo "EXAMPLES_ARTIFACT_NAME=XM-014871-SM_xcore_voice_example_apps_$version" >> $GITHUB_OUTPUT
             echo "SOURCES_ARTIFACT_NAME=XM-014872-SM_xcore_voice_sources_$version" >> $GITHUB_OUTPUT
-            echo "DOCS_ARTIFACT_NAME=XM-014785-PC_xcore_voice_docs_$version" >> $GITHUB_OUTPUT
           else
             echo "EXAMPLES_ARTIFACT_NAME=xcore_voice_example_apps" >> $GITHUB_OUTPUT
             echo "SOURCES_ARTIFACT_NAME=xcore_voice_sources" >> $GITHUB_OUTPUT
-            echo "DOCS_ARTIFACT_NAME=xcore_voice_docs" >> $GITHUB_OUTPUT
           fi
 
   build_apps:
@@ -93,50 +88,6 @@ jobs:
       is_release: ${{ needs.event_configuration.outputs.is_release }}
       examples_artifact_name: ${{ needs.event_configuration.outputs.examples_artifact_name }}
 
-  build_docs:
-    name: Build documentation
-    needs: event_configuration
-    uses: ./.github/workflows/docs.yml
-    with:
-      docs_artifact_name: ${{ needs.event_configuration.outputs.docs_artifact_name }}
-
-  # NOTE:
-  # The jobs below only run on releases.
-
-  release_docs:
-    name: Release documentation
-    needs: [event_configuration, build_docs]
-    runs-on: ubuntu-latest
-    if: needs.event_configuration.outputs.is_release == 'true'
-    steps:
-      - name: Checkout
-        uses: actions/checkout@v3
-        with:
-          submodules: recursive
-
-      - name: Download documentation artifacts
-        uses: actions/download-artifact@v3
-        with:
-          name: ${{ needs.event_configuration.outputs.docs_artifact_name }}
-          path: ${{ env.RELEASE_DOCS_DIR }}
-
-      - name: Rename xcore voice PDFs
-        run: |
-          cd ${{ env.RELEASE_PDF_DOCS_DIR }}
-          mv programming_guide.pdf xcore_voice_programming_guide.pdf
-          mv quick_start_guide.pdf xcore_voice_quick_start_guide.pdf
-
-      - name: Build other modules' PDFs
-        run: |
-          bash tools/ci/build_pdfs.sh
-          cp dist_pdfs/* ${{ env.RELEASE_PDF_DOCS_DIR }}
-
-      - name: Upload documentation
-        uses: actions/upload-artifact@v3
-        with:
-          name: ${{ needs.event_configuration.outputs.docs_artifact_name }}
-          path: ${{ env.RELEASE_DOCS_DIR }}
-
   release_sources:
     name: Release sources
     needs: event_configuration

.gitignore

@@ -40,6 +40,7 @@
 *.swmem
 *.bin
 *.fs
+*.swp
 
 # Test cruft
 **/.pytest_cache/*
@@ -70,3 +71,4 @@ build/
 # ai_tools
 tools/ai/ai_tools
 *xcore_sdk_venv/*
+examples/mic_aggregator/src/par_decimator

.gitmodules

@@ -29,3 +29,6 @@
 	path = modules/inferencing/lib_tflite_micro
 	url = [email protected]:xmos/lib_tflite_micro.git
 	ignore = dirty
+[submodule "modules/xua"]
+	path = modules/xua
+	url = [email protected]:xmos/lib_xua.git

.xmos_ignore_source_check

@@ -0,0 +1,4 @@
+/sensory/lib
+/thirdparty/
+/ThirdParty/
+/Cyberon/

CHANGELOG.rst

@@ -1,31 +1,62 @@
 XCORE-VOICE change log
 ======================
 
+2.2.0
+-----
+
+  * CHANGED: Updated submodule fwk_io to version 3.3.0 from 3.1.0.
+  * CHANGED: Updated submodule fwk_core to version 1.0.2 from 1.0.0.
+  * CHANGED: Updated submodule fwk_rtos to version 3.0.5 from 3.0.3.
+  * CHANGED: Updated submodule fwk_voice to version 0.7.0 from 0.6.0.
+  * CHANGED: Updated submodule lib_qspi_fast_read to version 1.0.2 from 1.0.1.
+  * CHANGED: Updated submodule lib_src to version 2.4.0 from 2.2.0.
+  * CHANGED: Updated submodule xscope_fileio to version 1.1.2 from 1.1.1.
+  * ADDED: Support for Microsoft OS 2.0 Descriptors for FFVA and ASRC examples
+    so the DFU interface automatically shows up as a WinUSB interface on
+    Windows.
+  * ADDED: FFD example with Cyberon speech recognition engine and model
+    (DSpotter v2.2.18.0).
+
+2.1.0
+-----
+
+  * ADDED: Mic aggregator app that bridges between 16 mics and TDM16 slave or
+    USB Audio
+  * ADDED: Asynchronous Sampling Rate Converter (ASRC) example application
+  * ADDED: lib_xua 3.5.1 as submodule to support Mic aggregator app
+  * CHANGED: Updated submodule fwk_io on to version 3.1.0 from version 3.0.1 to
+    add support for TDM16 slave tx and 16ch mic_array
+
 2.0.0
 -----
 
-  * ADDED: All speech recognition example deigns now use Sensory TrulyHandsfree speech recognition library.  
-  * ADDED: Low-power far-field dictionary (low-power FFD) example design using wakeword to exit standby mode.  
-  * ADDED: Mandarin model to far-field dictionary (low-power FFD) example design demonstration.
-  * ADDED: Support for fast flash library which increases flash reading throughput by as much as 70%.
+  * ADDED: All speech recognition example deigns now use Sensory TrulyHandsfree
+    speech recognition library.
+  * ADDED: Low-power far-field dictionary (low-power FFD) example design using
+    wakeword to exit standby mode.
+  * ADDED: Mandarin model to far-field dictionary (low-power FFD) example design
+    demonstration.
+  * ADDED: Support for fast flash library which increases flash reading
+    throughput by as much as 70%.
   * MOVED: Audio pipelines relocated to modules to allow easier re-use.
   * FIXED: Example designs now indicate when evaluation period has expired.
-  * FIXED: Numerous minor bug fixes.  
+  * FIXED: Numerous minor bug fixes.
 
 1.0.0
 -----
 
-  * ADDED: Improved documentation 
+  * ADDED: Improved documentation
   * ADDED: Speech recognition porting example design
   * FIXED: USB PIDs changed to 0x4000 for FFVA and 0x4001 for FFD
   * FIXED: Speech recognition model no longer in the filesystem
   * FIXED: Several Linux USB audio bugs
   * REMOVED: audiomux example design
 
-0.21.0-beta.0
--------------
+0.21.0
+------
 
-  * ADDED: Improved Interference Cancellation using Voice-to-Noise Ratio estimator  
+  * ADDED: Improved Interference Cancellation using Voice-to-Noise Ratio
+    estimator
   * ADDED: Low-power mode to far-field dictionary example design
   * ADDED: USB DFU to far-field voice assistant example design
   * ADDED: Optional AEC fixed-delay to far-field voice assistant example design
@@ -45,9 +76,11 @@ XCORE-VOICE change log
 
   * ADDED: Audio playback to FFD application
   * ADDED: First draft of documentation
-  * KNOWN ISSUE: USB audio device is not recognized on Windows  (This does not effect FFD)
+  * KNOWN ISSUE: USB audio device is not recognized on Windows  (This does not
+    effect FFD)
 
 0.10.0
 ------
 
   * ADDED: FFD demo using OLED display
+