SDK Integration and Documentation

Ameba FreeRTOS AWS Reference Integrations

The following table provides a mapping of supported Ameba chips to their respective SDK bases and AWS FreeRTOS branches for the FreeRTOS-LTS-202406.xx release cycle.

Chip Model	Ameba Base SDK Branch	mbedtls Version	AWS FreeRTOS Version	AWS FreeRTOS Branch Link
RTL8710C / RTL8720C	RTL8720C SDK	2.28.1	FreeRTOS-LTS-202107.xx	amebaZ2-7.1d-202107.00-LTS
	RTL8720C SDK	3.6.3	FreeRTOS-LTS-202406.xx	FreeRTOS-LTS-202406.xx_mbedtls-v3.6.3
RTL8721D / RTL8722D	RTL872xD SDK	2.28.1	FreeRTOS-LTS-202406.xx	FreeRTOS-LTS-202406.xx
	RTL872xD SDK	3.6.3	FreeRTOS-LTS-202406.xx	FreeRTOS-LTS-202406.xx_mbedtls-v3.6.3
RTL8721Dx	AmebaRTOS release/v1.2	2.28.1	FreeRTOS-LTS-202406.xx	FreeRTOS-LTS-202406.xx
	AmebaRTOS release/v1.2	3.6.3	FreeRTOS-LTS-202406.xx	FreeRTOS-LTS-202406.xx_mbedtls-v3.6.3
	AmebaRTOS release/v1.2	3.6.3	FreeRTOS-LTS-202406.xx	FreeRTOS-LTS-202406.xx_mbedtls-v3.6.3
RTL8726E / RTL8720E / RTL8713E / RTL8710E	AmebaRTOS release/v1.2	3.6.3	FreeRTOS-LTS-202406.xx	FreeRTOS-LTS-202406.xx_mbedtls-v3.6.3
RTL8730E	AmebaRTOS release/v1.2	3.6.3	FreeRTOS-LTS-202406.xx	FreeRTOS-LTS-202406.xx_mbedtls-v3.6.3

Ameba Amazon FreeRTOS Technical Documentation Overview

The following table summarizes the available documentation for building, implementing, and troubleshooting the Ameba AWS FreeRTOS solution.

Guide Type	Description	External GitHub Link
Building Guide	SDK compilation, environment setup, and build configuration.	Ameba AWS Building Guide
Example Guide	Sample applications, demo workflows, and code walkthroughs.	Amazon FreeRTOS Examples
Example Memory Usage Guide	Approximate memory footprints for the Realtek AWS examples (based on the mqtt_mutual_auth demo).	Amazon FreeRTOS Examples
Platform Build Guides	Board-specific setup for RTL8721Dx, RTL8726E, and RTL8730E.	Ameba RTOS General Build
Troubleshooting Guide	Root cause analysis and solutions for common AWS runtime issues.	AWS Troubleshooting Guide

SDK Project Structure

The ameba-amazon-freertos/project directory contains IDE-based test and demonstration projects organized by vendor and their supported hardware platforms.

Build Support:

Broad Support: Most boards support CMake-based build workflows.
Exceptions: Some boards may only support a specific build method. Always refer to the board-specific and AWS FreeRTOS Getting Started Guides for definitive instructions.

Directory Layout:

projects/
├── cmake/                 # CMake configuration and build scripts
│   ├── component/
│   ├── config/
│   ├── flags/
│   ├── <board>/
│   │   └── README.md      # Board-specific setup and build instructions

Note

For boards with specialized configurations, please prioritize the build methods recommended in the corresponding Getting Started Guides.