SDS-Examples

This repository contains examples that show the usage of the Synchronous Data Streaming (SDS) Framework.

Quick Start

1. Install Keil Studio for VS Code from the VS Code marketplace.
2. Clone this Git repository into a VS Code workspace.
3. Open the CMSIS View in VS Code and use the ... menu to choose an example via Select Active Solution from workspace.
4. The related tools and software packs are downloaded and installed. Review progress with View - Output - CMSIS Solution.
5. In the CMSIS view, use the Action buttons to build, load and debug the example on the hardware.

Examples description

The SDS examples are configured for various Evaluation Boards and use the MDK-Middleware for the SDSIO Interface. New hardware targets can be added using board layers that provide the required API interfaces. The examples are configured for Keil Studio for VS Code. Run a blinky example for the related board first to verify tool installation.

IMPORTANT

• Each example has a local VS Code configuration. Use in VS Code Open Folder to open the folder of each project individually.

Example name	Description
Alif/AppKit	SDS Application on Alif AppKit board with SDSIO using USB interface. Alif AppKit board
Alif/DevKit	SDS Application on Alif DevKit board with SDSIO using Ethernet interface. Alif DevKit board
ST/B-U585I-IOT02A	SDS application on STMicroelectronics B-U585I-IOT02A board with SDSIO using the USB interface. STMicroelectronics B-U585I-IOT02A board

Directory Structure

File/Directory	Content
.ci	Files that are related to the Continuous Integration (CI) tests.
.github/workflows	GitHub Actions scripts for build and execution tests.
Alif/AppKit	SDS Framework deployed to Alif AppKit using USB communication.
Alif/DevKit	SDS Framework deployed to Alif DevKit using Ethernet communication.
ST/B-U585I-IOT02A	SDS Framework deployed to ST B-U585I-IOT02A using USB communication.
Jupyter	Display SDS data files using a Jupyter notebook.

Webinar

The following webinar shows how to use the SDS framework and the examples in this repository:

Continuous Integration (CI)

The repository uses GitHub Actions to test project build with AC6 and GCC and execute algorithm tests. Refer to Understanding GitHub Actions and Arm FVPs documentation for more information.

CI Workflow	Description
AC6_test_build	Use Arm Compiler for Embedded (AC6) to create binaries for different configuration of targets, build types, and boards. After successful generation these are stored as artifacts.
GCC_test_build	Use GCC build tools to create binaries for different configuration of targets, build types, and boards. After successful generation these are stored as artifacts.
AlgorithmTest_ST_B-U585I-IOT02A	Build the binary of a motion detection algorithm and execute a regression test by using an FVP model and prerecorded SDS files. Regressions are stored as artifacts.

Issues or Questions

Raise questions or issues for these examples on the repository github.com/ARM-software/SDS-Framework.