Changelog

SDK

v1.3.0 - 2023-12-20

Added
  • Added Connection Priority example application to demonstrate the use of the connection priority feature of the SPARK Wireless Core.

  • Added missing steps in Getting started for the Linux environment.

Changed
  • Updated BSP-validator tool and related documentation with dual radio support option.

  • Updated the compiled definition location of SWC_RADIO_COUNT to establish a single and global definition across nested CMakeLists.txt files.

  • Updated all audio applications (except Audio Mixer) with the new Mute on Underflow processing stage.

  • Updated sac_src_cmsis configuration structure to with divider and multiplier parameters.

  • Updated Wireless Core to include the new Pairing Module.

  • Updated Pairing Basic application to reflect the new Pairing Module changes.

  • Updated Pairing Gaming Hub application to reflect the new Pairing Module changes.

  • Updated EVK BSP for RTOS support.

Fixed
  • Fixed virtual environment setup not working on Windows when AutoRun registry contains an invalid path.

  • Adjusted memory allocation for the dual radio version of Hello-World.

  • Fixed the dongle “unpair” behavior when no headset device is paired in the Pairing Gaming Hub application.

Removed
  • Removed sac_src_cmsis_ctrl function from the sac_src_cmsis interface initialization.

Table 21: Version of components used in this SDK release

Component

Version

Audio Core

v0.9.0

Wireless Core

v0.9.0

Ranging Core

v0.4.0

EVK BSP

v0.8.1

SPARK Drivers

v0.6.0

SPARK Libraries

v0.6.0

v1.2.1 - 2023-10-18

Changed
  • Improved the frequency calibration of the 1020 transceiver.

Table 22: Version of components used in this SDK release

Component

Version

Audio Core

v0.8.0

Wireless Core

v0.8.1

Ranging Core

v0.4.0

EVK BSP

v0.8.0

SPARK Drivers

v0.6.0

SPARK Libraries

v0.6.0

v1.2.0 - 2023-05-31

Added
  • Added new development environment using VS Code, CMake & micromamba virtual environment.

  • Added BSP Validator tool application to help validate custom BSP implementation, complementary to the Porting Guide.

  • Added Ranging Core with its new Core and API documentation.

  • Added Ranging example application to demonstrate the use of the new Ranging Core through its API (SRAC API), with application documentation.

  • Added the use of uwb_regulation pairing parameter in the Pairing Basic and Pairing Gaming Hub applications.

  • Added Fragmentation example application to demonstrate the use of the fragmentation feature of the SPARK Wireless Core.

  • Added new Wireless Core API functions. See Wireless Core Changelog for more details.

  • Added bsp interface iface_validator for the BSP Validator tool.

Changed
  • Updated Getting started section to reflect the new development environment.

  • Updated Development Environment section to reflect the new development environment.

  • Updated Structure Overview section to reflect the new development environment.

  • Updated Porting Guide section to reflect the changes in the Wireless Core API.

  • Updated Audio Fallback processing stage. See Audio Core Changelog for more details.

  • Updated all audio applications for Audio Core changes. See the Audio Core Changelog for more details.

  • Updated all applications for Wireless Core changes. See the Wireless Core Changelog for more details.

  • Updated all applications interface for the EVK BSP changes. See the EVK BSP Changelog for more details.

  • Updated Audio User Data example application to uses an application-defined audio processing stage.

  • Updated the Audio Mixer application to use the pre-configured beacon settings provided by the SWC API.

  • Updated the Pairing Gaming Hub example application and simplify it.

  • Updated RX queue size for the Pairing Gaming Hub application from 1 to 2 to respect the Wireless Core API requirements.

  • Updated application level timers in various example applications.

  • Renamed watchdog timer in pairing interface to pairing timer.

Fixed
  • Fixed swc_connection_get_payload_buffer function usage in the Hello World example application.

  • Fixed the SWC interface’s quarter ms timer where the timer implementation was at 1 ms instead of 250 us.

Removed
  • Removed STM32CudeIDE projects. They are now replaced by the CMake build system.

Table 23: Version of components used in this SDK release

Component

Version

Audio Core

v0.8.0

Wireless Core

v0.8.0

Ranging Core

v0.4.0

EVK BSP

v0.8.0

SPARK Drivers

v0.6.0

SPARK Libraries

v0.6.0

v1.1.0 - 2022-11-30

Added
  • Statistics printed every second in Audio High Resolution, Audio Compression, Audio 4-Channel, Audio Mixer, Audio Streaming and Audio User Data.

  • Build configuration for dual radio in the Hello-World STM32CubeIDE project. Note that the dual radio feature requires a custom board with two SPARK transceivers.

Changed
  • Enable clear channel assessment (CCA) in the Audio Compression application.

  • Audio processing is now handled in a low priority timer’s interrupt service routine in Audio High Resolution, Audio Compression, Audio 4-Channel, Audio Mixer, Audio Streaming and Audio User Data to make sure the statistics computing and printing (which occur in background) do not interfere with it.

  • Update all applications for Wireless Core changes. See Wireless Core changelog for more details.

  • Update all audio applications for Audio Core changes. See Audio Core changelog for more details.

  • Code for pairing has moved from app/common/ to the Wireless Core core/wireless/pairing/.

Removed
  • Common code folder app/common/.

  • Deprecated audio interface function iface_audio_critical_section_init(). Critical section functions are now set through iface_sac_hal_init().

Fixed
  • Coding style issues.

Table 24: Version of components used in this SDK release

Component

Version

Audio Core

v0.7.0

Wireless Core

v0.7.0

EVK BSP

v0.7.0

SPARK Drivers

v0.6.0

SPARK Libraries

v0.6.0

v1.0.1 - 2022-06-16

Changed
  • CMSIS DSP library only includes required source files for the SDK applications.

  • Update ARQ setting name retry_count to try_count in all applications using the Wireless Core ARQ feature.

Fixed
  • Fixed random occurrences of audio channel inversion on audio applications startup.

Table 25: Version of components used in this SDK release

Component

Version

Audio Core

v0.6.0

Wireless Core

v0.6.1

EVK BSP

v0.6.1

SPARK Drivers

v0.5.0

SPARK Libraries

v0.5.0

v1.0.0 - 2022-05-27

Changed
  • STM32CubeIDE version used is now 1.9.0.

  • Tweaked Wireless Core configuration for all applications.

  • Updated all applications for newer Wireless Core changes.

  • Updated all applications for newer Audio Core changes.

  • Wireless Core audio endpoints implementation now use the updated Wireless Core API.

  • Audio High Resolution application is now using 24-bit samples.

  • Updated audio endpoint functions to support audio payload sizes up to 65535 bytes.

  • Updated Hello-World and Star Network interface implementation following USB functions name change.

  • Audio Compression application now uses the new audio fallback mode.

Removed
  • Blinky application.

  • Ranging application.

  • Ranging Core.

Fixed
  • Fixed the iface_set_watchdog_timer_limit() parameter name. The timer limit is in us resolution and not ms.

Table 26: Version of components used in this SDK release

Component

Version

Audio Core

v0.6.0

Wireless Core

v0.6.0

EVK BSP

v0.6.0

SPARK Drivers

v0.5.0

SPARK Libraries

v0.5.0

v0.12.0 - 2022-03-03

Added
  • Interface layer to help porting applications to different boards.

Changed
  • Moved most of the code in app/common/ to bsp/interface/.

  • Updated audio applications to account for Audio Core audio_protocol_cfg_t changes.

  • Updated all applications to use the new interface layer.

  • Adjusted output power for most applications.

Removed
  • Removed DESTINATION_ADDRESS and LOCAL_ADDRESS from Ranging application’s STM32CubeIDE project as these are already defined in the source code.

Fixed
  • Fixed an issue that prevented the pairing timeout from occurring in a Node device.

  • Clock drift compensation is now handled correctly in the Audio Core for the Audio 4-Channel application.

  • Audio User Data application needed a hard reset after being programmed for audio to start playing.

  • Audio Compression application could hard fault when starting a debug session in STM32CubeIDE for the first time.

Table 27: Version of components used in this SDK release

Component

Version

Audio Core

v0.5.0

Ranging Core

v0.3.0

Wireless Core

v0.5.0

EVK BSP

v0.5.0

SPARK Drivers

v0.4.0

SPARK Libraries

v0.4.0

v0.11.0 - 2022-02-04

Added
  • Pairing module in common code. This will eventually go under the Wireless Core API.

  • Gaming Hub application example demonstrating multi-device pairing and its documentation.

  • Checks in applications to make sure memory allocated to Cores is exactly the right amount.

  • Extra warning checks have been enabled in STM32CubeIDE projects (-Wextra, -Wshadow=compatible-local, -Werror=implicit-function-declaration)

Changed
  • STM32CubeIDE version used is now 1.8.0.

  • Audio Core WPS endpoint is now in the application common code.

  • All applications have been updated to use the newer Cores, libraries and drivers. See respective Changelogs for details.

  • Blinky and Ranging applications use the new SR API. See notice in source code for how to manage this change for your application based on those.

  • Basic Pairing application now uses the Pairing Module from the common code.

  • All audio applications have been updated to make use of the new EVK BSP’s audio functions and configurations.

  • Common code has been updated to make use of the new EVK BSP’s audio functions and configurations.

  • Third-party libraries warning checks have been disabled in STM32CubeIDE projects (lib/third-party)

  • The Wireless Protocol Stack documentation section has been enhanced.

Table 28: Version of components used in this SDK release

Component

Version

Audio Core

v0.4.0

Ranging Core

v0.3.0

Wireless Core

v0.4.0

EVK BSP

v0.4.0

SPARK Drivers

v0.4.0

SPARK Libraries

v0.4.0

v0.10.0 - 2021-12-13

Added
  • Audio 4-Channel application example.

  • Common code module shared by all applications.

  • MAX98091 audio endpoint replacing the former Audio Core I2S endpoint.

  • Timeout and Node address self-generation features in Pairing Basic application.

Changed
  • Applications now use the common code module.

  • Applications now use the new Wireless Core API.

  • Audio applications now use the MAX98091 audio endpoint.

  • Application code has been split for Coordinator and Node.

  • Pairing Basic application code has been simplified.

Table 29: Version of components used in this SDK release

Component

Version

Audio Core

v0.3.0

Ranging Core

v0.3.0

Wireless Core

v0.3.0

EVK BSP

v0.3.0

SPARK Drivers

v0.3.0

SPARK Libraries

v0.3.0

v0.9.0 - 2021-11-09

Added
  • Audio High Resolution application example and its corresponding documentation.

  • Pairing application example and its corresponding documentation.

  • Changelog section in the SPARK SDK documentation.

  • Creating a new application sub-section in the Development Environment section in the SPARK SDK documentation.

Changed
  • Audio sampling rate from 24 kHz/24 kHz to 48 kHz/16 kHz and timeslots schedule in the Audio Streaming application example.

Table 30: Version of components used in this SDK release

Component

Version

Audio Core

v0.2.0

Ranging Core

v0.2.0

Wireless Core

v0.2.0

EVK BSP

v0.2.0

SPARK Drivers

v0.2.0

SPARK Libraries

v0.2.0

v0.8.0 - 2021-09-30

Added
  • SPARK Audio Core.

  • SPARK Wireless Core.

  • Audio Compression application example.

  • Audio Streaming application example.

  • Audio User Data application example.

  • Star Network application example.

Table 31: Version of components used in this SDK release

Core library

Version

Audio Core

v0.1.0

Ranging Core

v0.1.0

Wireless Core

v0.1.0

EVK BSP

v0.1.0

SPARK Drivers

v0.1.0

SPARK Libraries

v0.1.0

SPARK Cores

Misc