SDK Download

SDK Clone

The SDK is mirrored on GitHub at Ameba-AIoT/ameba-amazon-freertos. This repository provides an open-source solution for Ameba platforms based on the Amazon FreeRTOS ecosystem. The SDK utilizes Git Submodules to manage and include external dependencies.

Note

Downloading the repository as a ZIP file via the GitHub UI will not include the contents of the submodules.

A ZIP download is not a functional Git repository and will prevent subsequent submodule updates.

Cloning the Repository: To ensure all dependencies are included, use the --recurse-submodules flag during the initial clone.

HTTPS:

git clone https://github.com/AmebaAIoT/ameba-amazon-freertos.git --recurse-submodules

SSH:

git clone git@github.com:AmebaAIoT/ameba-amazon-freertos.git --recurse-submodules

Note

The --recurse-submodules parameter automatically initializes and clones all nested submodules after the main repository download completes.

If you have already cloned the repository without this flag, you can fetch the missing dependencies by running the following command from the project root:

git submodule update --init --recursive

Note

For detailed setup and compilation procedures, please refer to the following official guides:

Environment Setup: Ameba RTOS SDK Environment Setup Guide
SDK Building: Ameba AWS FreeRTOS SDK Building Guide
AWS IoT Resources: AWS IoT Account and Resources Configuration Guide

SDK versions

The ameba-amazon-freertos GitHub repository undergoes continuous integration. The master branch serves as the primary development mainline, where new features are introduced and updated frequently.

For mass production (MP) or projects requiring high stability, we strongly recommend using a officially released version.

SDK Branches and Characteristics

The SDK is currently organized into two distinct branch types to suit different development needs:

Branch

Characteristics

release branch

Primary branch for new feature development with a high update frequency.
Includes initial support for the latest Realtek ICs.
Optimized for stability; restricted to critical bug fixes and essential feature parity.
The supported IC list remains frozen once the release branch is established.
Currently supports: RTL8710C/RTL8720C, RTL872xD, RTL8721Dx, RTL8726E/RTL8720E/RTL8713E/RTL8710E and RTL8730E.

Each branch is accompanied by specific documentation. For detailed guidance, please visit the SDK Documentation portal and ensure you select the version corresponding to your active branch.