Structure Overview

This section describes the file structure of the SDK package.

sdk_spark_vx.y.z/
├───app/
│   ├───common/
|   └───example/
├───bsp/
│   └───evk/
├───core/
│   ├───audio/
│   ├───ranging/
│   └───wireless/
├───driver
│   └───spark/
├───lib/
│   ├───spark/
│   └───third-party/
├───EULA.txt
└───SPARK SDK Documentation.html

app/

Contains all application examples (example/) and shared code (common/) they can use as needed. Each example comes with its own ready to use STM32CubeIDE project.

bsp/

Contains the BSP of the EVK board (evk/). The provided BSP contains source code to initialize and use the STM32G473 peripherals such as the SPI, UART and timers as well as the on-board devices such as the SPARK transceiver and audio codec. Custom boards can be supported by adding their own BSP.

core/

Contains SPARK core libraries which are the Wireless Core (wireless/), the Audio Core (audio/) and the Ranging Core (ranging/).

driver/

Contains drivers for other integrated circuits like the MAX98091 audio codec used by the EVK board. Those written by SPARK are located inside the spark/ sub-folder. If third-party drivers are to be used, they will be inside a third-party/ sub-folder.

lib/

Contains various libraries used by applications, core libraries or the BSP. Those written by SPARK are located inside the spark/ sub-folder and third-party ones are located inside the third-party/ sub-folder. Third-party libraries used are covered by permissive open-source licenses.

EULA.txt

The End User License Agreement that covers the use of the SPARK SDK.

SPARK SDK Documentation.html

A shortcut to the SPARK SDK documentation website.