Deploying the Firmware with Linux or macOS#

This document explains how to deploy the software using CMake and Make.

Note

In the commands below <speech_engine> can be either sensory or cyberon, depending on the choice of the speech recognition engine and model.

Building the Host Applications#

This application requires a host application to create the flash data partition. Run the following commands in the root folder to build the host application using your native Toolchain:

Note

Permissions may be required to install the host applications.

cmake -B build_host
cd build_host
make install

The host applications will be installed at /opt/xmos/bin, and may be moved if desired. You may wish to add this directory to your PATH variable.

Building the Firmware#

Run the following commands in the root folder to build the firmware:

cmake -B build --toolchain=xmos_cmake_toolchain/xs3a.cmake
cd build
make example_ffd_<speech_engine>

Running the Firmware#

Before running the firmware, the filesystem and model must be flashed to the data partition.

Within the root of the build folder, run:

make flash_app_example_ffd_<speech_engine>

After this command completes, the application will be running.

After flashing the data partition, the application can be run without reflashing. If changes are made to the data partition components, the application must be reflashed.

From the build folder run:

xrun --xscope example_ffd_<speech_engine>.xe

Debugging the Firmware#

To debug with xgdb, from the build folder run:

xgdb -ex "connect --xscope" -ex "run" example_ffd_<speech_engine>.xe