QUICK START

Requirements

  • XTC Tools 15.0.6 or higher

  • A clone of the xcore_sdk, with its submodules initialised

  • CMake 3.20 or higher

  • Python 3.7 or higher

Building

The following instructions show how to build Avona and run one of the example applications. This procedure is currently supported on MacOS and Linux only.

  1. Enter the clone of Avona and initialise submodules
    cd sw_avona
git submodule update --init --recursive
  2. Create a build directory
    mkdir build
cd build
  3. Run cmake to setup the build environment for the XMOS toolchain
    cmake -S.. -DCMAKE_TOOLCHAIN_FILE=../xmos_cmake_toolchain/xs3a.cmake
  4. Running make will then build the Avona libraries and example applications
    make
  5. Install dependencies
    cd ../examples/bare-metal/aec_1_thread
pip install -e ../shared_src/xscope_fileio
  6. Run the single-threaded AEC example
    python ../shared_src/python/run_xcoreai.py ../../../build/examples/bare-metal/aec_1_thread/bin/avona_example_bare_metal_aec_1_thread.xe --input ../shared_src/test_streams/aec_example_input.wav

See Example Applications for full details about the example applications.