SDK 下载

概述

Realtek Ameba-IoT SoC 的 FreeRTOS SDK 分为基础 SDK 和 扩展 XDK，目前已同步托管至 GitHub 与 Gitee ，方便国内外用户下载和访问。

基础 SDK 集成了 Wi-Fi、蓝牙（BT）等基础功能，可作为开发的基础平台。

扩展 XDK 提供更多功能，支持诸如 AI 语音、TensorFlow Lite（tflite）、GUI 与音频处理等高阶功能模块，进一步满足多样化的应用需求。

下载方法

GitHub:

SDK 托管于 GitHub：https://github.com/Ameba-AIoT/ameba-rtos，XDK 在独立的 git 仓库维护，并作为子模块被基础 SDK 包含。

  • 基础 SDK clone 方法：

    git clone --depth=5 https://github.com/Ameba-AIoT/ameba-rtos.git

  • XDK clone 方法：

    git clone --recursive --depth=5 --shallow-submodules https://github.com/Ameba-AIoT/ameba-rtos.git

备注

--depth 参数表示指定浅克隆的深度， --depth=5 表示只拉取最近 5 次提交，--shallow-submodules 参数表示浅克隆子模块。 克隆时设定 --depth 可以显著提升拉取速度，如需查看全部提交历史，请在仓库目录中执行：

git fetch --unshallow

版本简介

ameba-rtos 的 GitHub 仓库将持续更新， 其中 master 分支主要用于新特性的开发，更新频率更高。 如需用于量产或追求稳定性，建议选择稳定分支或已发布的正式版本。

SDK 分支及特性

目前 SDK 包含以下两类分支：

分支

特性

master 分支

  • 主要用于开发新特性的分支，更新频率高

  • 会增加新 IC 的支持

release 分支

  • 稳定分支，主要用于 Bug 修复及少量新特性，更新频率低

  • 分支创建后，当前分支支持的 IC list 不再更新

  • 如 release/v1.1

每个分支均有对应的文档版本，详细文档可访问 SDK 文档 页面，请根据实际分支选择。

SDK 发布版本及特性

我们将定期针对各个分支进行人工以及自动化验证，当完成所有的验证测试和修复以后，会正式发布正式版本。

完整发布列表与发布说明请参见 发布说明 页面。

版本管理规范

ameba-rtos SDK 采用 主版本.次版本.补丁版本（MAJOR.MINOR.PATCH） 的版本号格式。其中，

  • 主版本（MAJOR）： 有重大的更新，且不兼容旧 API 时递增

  • 次版本（MINOR）： 有新增特性，或者修复 bug ，且兼容旧 API 时递增

  • 补丁版本（PATCH）： 仅修复已知的 bug 时递增

版本查看有以下两种方式：

  • 各分支目录下的 component/soc/common/include/ameba_rtos_version.h 文件中定义了当前 SDK 的版本号。

  • 也可以通过 AT 指令 AT+GMR 查询当前版本。

支持期限

ameba-rtos 的每个正式版本支持期限为 24 个月。支持期限满后，版本停止更新维护，将不再提供支持。

分支更新

分支更新操作步骤如下：

  1. 切换到 ameba-rtos 的根目录：

cd ameba-rtos

  1. 更新当前分支到最新：

git pull

  1. （仅 XDK）更新子模块：

git submodule update --remote

发布版本的更新与切换

请定期访问 发布说明 页面，获取最新发布信息。 升级或切换发布版本建议操作如下：

  1. 切换到 ameba-rtos 的根目录：

cd ameba-rtos

  1. 更新所有远程分支与标签信息：

git fetch

如果是浅克隆的仓库， 请执行：

git fetch --tags

  1. 查看所有发布版本：

git tag

  1. 本地切换到指定发布版本：

git checkout vX.Y.Z