Skip to content

Commit 79069aa

Browse files
Evagan2018Evagan2018
authored
Merge pull request #13 from Evagan2018/main
Added quick start and continuous integration sections. a.o.
2 parents 6b46c3b + 48dc50d commit 79069aa

File tree

1 file changed

+52
-16
lines changed

1 file changed

+52
-16
lines changed

‎README.md‎

Lines changed: 52 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -1,21 +1,57 @@
1+
[![License](https://img.shields.io/github/license/Arm-Examples/Safety-Example-STM32?label)](https://github.com/Arm-Examples/Safety-Example-STM32/blob/main/LICENSE)
12
[![Algorithm Test ST/B-U585I-IOT02A](https://img.shields.io/github/actions/workflow/status/Arm-Examples/SDS-Examples/AlgorithmTest_ST_B-U585I-IOT02A.yaml?logo=arm&logoColor=0091bd&label=Algorithm%20Test%20ST/B-U585I-IOT02A)](./.github/workflows/AlgorithmTest_ST_B-U585I-IOT02A.yaml)
3+
[![AC6 Test build](https://img.shields.io/github/actions/workflow/status/Arm-Examples/SDS-Examples/AC6_test_build.yaml?logo=arm&logoColor=0091bd&label=AC6_Test_build)](https://github.com/Arm-Examples/SDS-Examples/tree/main/.github/workflows/AC6_test_build.yaml)
4+
[![GCC Test build](https://img.shields.io/github/actions/workflow/status/Arm-Examples/SDS-Examples/GCC_test_build.yaml?logo=arm&logoColor=0091bd&label=GCC_Test_build)](https://github.com/Arm-Examples/SDS-Examples/tree/main/.github/workflows/GCC_test_build.yaml)
5+
26

37
# SDS-Examples
48

59
This repository contains examples that show the usage of the [Synchronous Data Streaming (SDS) Framework](https://github.com/ARM-software/SDS-Framework).
610

11+
12+
## Quick Start
13+
14+
1. Install [Keil Studio for VS Code](https://marketplace.visualstudio.com/items?itemName=Arm.keil-studio-pack) from the
15+
VS Code marketplace.
16+
2. Clone this Git repository into a VS Code workspace.
17+
3. Open the [CMSIS View](https://mdk-packs.github.io/vscode-cmsis-solution-docs/userinterface.html#2-main-area-of-the-cmsis-view)
18+
in VS Code and use the ... menu to choose an example via *Select Active Solution from workspace*.
19+
4. The related tools and software packs are downloaded and installed. Review progress with *View - Output - CMSIS Solution*.
20+
5. In the CMSIS view, use the
21+
[Action buttons](https://github.com/ARM-software/vscode-cmsis-csolution?tab=readme-ov-file#action-buttons) to build,
22+
load and debug the example on the hardware.
23+
24+
25+
## Examples description
26+
727
The SDS examples are configured for various Evaluation Boards and use the [MDK-Middleware](https://www.keil.arm.com/packs/mdk-middleware-keil/overview/) for the [SDSIO Interface](https://arm-software.github.io/SDS-Framework/main/sdsio.html). New hardware targets can be added using board layers that provide the required API interfaces.
28+
The examples are configured for [Keil Studio for VS Code](https://www.keil.arm.com/).
29+
Run a blinky example for the related board first to verify tool installation.
30+
> IMPORTANT
31+
>
32+
> - Each example has a local VS Code configuration. Use in VS Code **Open Folder** to open the folder of each project individually.
33+
34+
35+
36+
| Example name | Description |
37+
|--- |--- |
38+
| [Alif/AppKit](./Alif/AppKit/SDS.csolution.yml) | [SDS Application on Alif AppKit board with SDSIO using USB interface](./Alif/AppKit/README.md). [Alif AppKit board](https://www.keil.arm.com/boards/alif-semiconductor-appkit-e7-aiml-gen-2-140e28d/guide/) |
39+
| [Alif/DevKit](./Alif/DevKit/SDS.csolution.yml) | [SDS Application on Alif DevKit board with SDSIO using Ethernet interface](./Alif/DevKit/README.md). [Alif DevKit board](https://www.keil.arm.com/boards/alif-semiconductor-devkit-e7-gen-2-92ef25f/guide/) |
40+
| [ST/B-U585I-IOT02A](./ST/B-U585I-IOT02A/SDS.csolution.yml) | [SDS application on STMicroelectronics B-U585I-IOT02A board with SDSIO using the USB interface](./ST/B-U585I-IOT02A/README.md). [STMicroelectronics B-U585I-IOT02A board](https://www.keil.arm.com/boards/stmicroelectronics-b-u585i-iot02a-revc-c3bc599/features/) |
41+
842

943
## Directory Structure
1044

11-
Directory | Content
12-
:-----------------------------------------|:---------------------------------------------------------
13-
[.ci](./.ci) | Files that are related to the Continuous Integration (CI) tests.
14-
[.github/workflows](./.github/workflows) | [GitHub Actions](#github-actions) scripts for build and execution tests.
15-
[Alif/AppKit](./Alif/AppKit) | SDS Framework deployed to Alif AppKit using USB communication.
16-
[Alif/DevKit](./Alif/DevKit) | SDS Framework deployed to Alif DevKit using Ethernet communication.
17-
[ST/B-U585I-IOT02A](./ST/B-U585I-IOT02A) | SDS Framework deployed to [ST B-U585I-IOT02A](https://www.keil.arm.com/boards/stmicroelectronics-b-u585i-iot02a-revc-c3bc599) using USB communication.
18-
[Jupyter](./Jupyter) | Display SDS Data Files using a Jupyter notebook.
45+
| File/Directory | Content |
46+
|--- |--- |
47+
| [.ci](./.ci) | Files that are related to the Continuous Integration (CI) tests. |
48+
| [.github/workflows](./.github/workflows) | [GitHub Actions](#github-actions) scripts for build and execution tests. |
49+
| [Alif/AppKit](./Alif/AppKit) | SDS Framework deployed to Alif AppKit using USB communication. |
50+
| [Alif/DevKit](./Alif/DevKit) | SDS Framework deployed to Alif DevKit using Ethernet communication. |
51+
| [ST/B-U585I-IOT02A](./ST/B-U585I-IOT02A) | SDS Framework deployed to [ST B-U585I-IOT02A](https://www.keil.arm.com/boards/stmicroelectronics-b-u585i-iot02a-revc-c3bc599) using USB communication. |
52+
| [Jupyter](./Jupyter) | Display SDS data files using a Jupyter notebook. |
53+
54+
1955

2056
## Webinar
2157

@@ -24,17 +60,17 @@ The following webinar shows how to use the SDS framework and the examples in thi
2460
[![Watch the video](SDS_preview.png)](https://armkeil.blob.core.windows.net/developer/Files/videos/KeilStudio/20250916_SDS_Webinar.mp4)
2561

2662

27-
## Using VS Code
63+
## Continuous Integration (CI)
2864

29-
The examples are configured for [Keil Studio for VS Code](https://www.keil.arm.com/). Install [Keil Studio for VS Code](https://marketplace.visualstudio.com/items?itemName=Arm.keil-studio-pack) from the VS Code marketplace and run a blinky example for the related board first to verify tool installation.
65+
The repository uses [GitHub Actions](.github/workflows) to test project build with AC6 and GCC and execute algorithm tests.
66+
Refer to [Understanding GitHub Actions](https://docs.github.com/en/actions/get-started/understand-github-actions) and [Arm FVPs](https://arm-software.github.io/AVH/main/infrastructure/html/avh_gh_actions.html) documentation for more information.
3067

31-
## GitHub Actions
68+
| <div style="width:150px"> CI Workflow </div> | Description |
69+
|--- |--- |
70+
| [AC6_test_build](./.github/workflows/AC6_test_build.yaml) | 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. |
71+
| [GCC_test_build](./.github/workflows/GCC_test_build.yaml) | Use GCC build tools to create binaries for different configuration of targets, build types, and boards. After successful generation these are stored as artifacts. |
72+
| [AlgorithmTest_ST_B-U585I-IOT02A](./.github/workflows/AlgorithmTest_ST_B-U585I-IOT02A.yaml) | 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. |
3273

33-
The repository uses [GitHub Actions](.github/workflows) to test project build with AC6 and GCC and execute algorithm tests.
34-
Refer to [Understanding GitHub Actions](https://docs.github.com/en/actions/get-started/understand-github-actions) and [Arm Virtual Hardware](https://arm-software.github.io/AVH/main/infrastructure/html/avh_gh_actions.html) documentation for more information.
35-
> IMPORTANT
36-
>
37-
> - Each example has a local VS Code configuration. Use in VS Code **Open Folder** to open the folder of each project individually.
3874

3975
## Issues or Questions
4076

0 commit comments

Comments
 (0)