搭建 CLI 开发环境

视频资源

概述

Ameba SDK 支持两种开发环境：基于 CLI 和基于 VS code 插件 的环境。使用 VS code 插件 进行开发时，会自动检查并搭建开发环境，详细信息请参考 VS Code 插件使用指南。

Ameba SDK 的开发环境由两个部分组成：

软件包：包括 cmake, ninja 等必备工具
交叉编译工具链：SDK 支持自动安装

本章介绍如何在 Windows 平台和 Linux 平台搭建 CLI 开发环境：

Windows 平台：以 Windows 10 64-bit 为例
Linux 平台：以 Ubuntu 22.04 x86_64 为例

安装软件包

所需的软件及其版本要求如下表所示：

软件	版本
cmake	3.20 及以上
ninja	1.10.1 及以上
make	3.82 及以上
ccache	4.5.1 及以上
Python3	建议 3.10 及以上
wget	推荐最新版
7zip	推荐最新版

如果用户手动将以上软件安装到操作系统，可能会污染原有的软件环境，或者产生版本兼容问题。

为此，Realtek 提供了一个 软件包合集 ，包含了所需的软件工具，支持在独立环境中运行。

配置软件包后，Ameba SDK 开发环境将被隔离在当前终端中。该终端之外的软件环境不受任何影响，同时也避免了软件版本兼容性问题。

下面将分别介绍在 Linux 和 Windows 中配置软件环境的详细步骤。

下载压缩包并解压至 /opt/rtk-toolchain 文件夹下

mkdir /opt/rtk-toolchain
cd /opt/rtk-toolchain
wget https://github.com/Ameba-AIoT/ameba-toolchain/releases/download/prebuilts-v1.0.3/prebuilts-linux-1.0.3.tar.gz
tar -xzf prebuilts-linux-1.0.3.tar.gz

如果下载遇到问题，可尝试使用 aliyun 地址：

wget https://rs-wn.oss-cn-shanghai.aliyuncs.com/prebuilts-linux-1.0.3.tar.gz

备注

压缩包需要解压到默认的 /opt/rtk-toolchain 路径下。如需更改默认路径，请参考更改工具链安装路径。

预安装 Python（Linux 下不提供 Python 的免安装版本）
```
sudo apt install python3 python3-pip python3-venv
```
备注
- 运行 python --version 检查 Python 版本，建议大于 3.10。
- 如果提示 pip 版本落后，建议通过 pip install --upgrade pip 命令更新版本。
- 如果主机中存在多个 Python 版本，可以使用命令 update-alternatives --install /usr/bin/python python /usr/bin/python3.x 1 选择特定 Python 版本，x 代表期望的版本号。
- 如果报错 command 'python' not found，尝试运行 ln -s /usr/bin/python3 /usr/bin/python 解决问题。

安装依赖库

sudo apt install libssl-dev libncurses-dev

进入 SDK 根目录，运行 ameba.sh 脚本，自动配置环境变量。

source ameba.sh

PIP CHECK... All packages are installed correctly!
========================================================
|  First choose IC platform: cd [IC]_gcc_project
|  Configure command: menuconfig.py
|  Build command: build.py
========================================================
(.venv)

备注

每次重启终端后，都需要执行 source ameba.sh 命令设置环境变量。

在 C 盘下新建 C:\rtk-toolchain 文件夹
下载压缩包并解压至 C:\rtk-toolchain 文件夹下
下载路径

中国大陆地区用户建议使用 aliyun 链接。
从 GitHub 下载

从 aliyun 下载
备注

压缩包需要解压到默认的 C:\rtk-toolchain 路径下。如需更改安装路径，请参考更改工具链安装路径。

进入 SDK 根目录，双击运行根目录下的 ameba.bat，将自动配置环境变量，后续请继续在此窗口运行命令。

PIP CHECK... All packages are installed correctly!
========================================================
|  First choose IC platform: cd [IC]_gcc_project
|  Configure command: menuconfig.py
|  Build command: build.py
========================================================
(.venv) C:\sdk>

备注

如果用户想在 Windows 下使用 Git Bash 或 MSYS2 等类 Unix 的命令行环境，请在 SDK 根目录下打开新终端后运行 source ameba.sh。

小技巧

此方式依赖 Python 虚拟环境。若出现 Python 系统错误，如提示找不到 dll 动态库等，请尝试手动删除 SDK 根目录下的 .venv 文件夹并运行 ameba.bat 脚本，将自动重新安装 Python 虚拟环境。

自动安装工具链

交叉编译工具链的安装和更新是自动完成的。

首次编译某个 SOC 项目时，所需的工具链会被自动安装到如下默认路径：

Linux：/opt/rtk-toolchain
Windows：C:\rtk-toolchain

需要注意的是，不同的 MCU 可能使用不同版本的工具链。之后每次执行编译时，都会自动检查并更新。

如果弹出报错信息，请根据报错信息修复问题并尝试重新编译。

安装完成后，在 rtk-toolchain 路径下将有以下文件：

|--- prebuilts-[win/linux]-1.x.x
|
|--- asdk-1x.3.1-xxxx     # for ARM
|
|--- [vsdk-10.3.1-xxxx]   # for RISC-V (if required)

备注

如果已有下载好的工具链压缩包，可以将压缩包移动到安装路径后，再次执行 build.py。
如果报错 Download Failed, 请检查网络连接。如果问题仍然存在，请参考更换下载源。
如果报错 Create Toolchain Dir Failed. May Not Have Permission，请尝试手动创建文件夹。如果问题仍然存在，请参考更改安装路径。

备用下载源

工具链压缩包默认托管在 GitHub 上，系统默认从 GitHub 下载工具链压缩包。如果下载遇到问题，或者下载速度缓慢，请尝试通过以下命令更换下载源：

build.py -D USE_ALIYUN_URL=True

执行此命令后，将会从 aliyun 下载工具链，然后开始编译。

自定义安装路径

如果不希望工具链被安装在上述的默认路径，通过设置环境变量 RTK_TOOLCHAIN_DIR 可以自定义安装路径，设置方法如下：

打开 ~/.bashrc 文件，在其末尾添加：
export RTK_TOOLCHAIN_DIR="/path/to/your/toolchain/dir"
运行以下命令使环境变量立即生效：
source ~/.bashrc
在设置 > 高级系统设置 > 环境变量选项中新建变量：

变量名为 RTK_TOOLCHAIN_DIR

变量值为用户希望的安装路径

重启终端使环境变量生效。

修改安装路径后，请将 Realtek 软件包解压到该目录；交叉编译工具链将在执行编译时被自动安装到该目录。