Step 0: 环境搭建

在你的电脑上搭建 TuyaOpen 所需的工具链、下载仓库，并激活 tos.py——后续配置、构建、烧录每个项目都要用到的命令行工具。

硬件准备

开始前，请准备以下资源：

• 一块 TuyaOpen 支持的开发板或模组
• 一根 USB 数据线
• 一台运行 Windows、Linux 或 macOS 的电脑

安装工具链

选择你的操作系统并安装所需工具。

信息

推荐使用 Ubuntu24/22/20 的 LTS 版本。

安装必要的工具：

sudo apt-get install lcov cmake-curses-gui build-essential ninja-build wget git python3 python3-pip python3-venv libc6-i386 libsystemd-dev

下载并激活 TuyaOpen

克隆 TuyaOpen 仓库。

提示

可适当调整 git 配置以提高克隆性能：

git config --global http.postBuffer 524288000

注意

项目路径中不要使用中文或空格等特殊字符。在 Windows 上，不要将项目放在 C 盘。

# 使用 github
git clone https://github.com/tuya/TuyaOpen.git

# 或者使用 gitee
git clone https://gitee.com/tuya-open/TuyaOpen.git

# 进入项目
cd TuyaOpen

激活 tos.py。

注意

每次重新打开终端后，都需要重新激活 tos.py。

. ./export.sh

运行 tos.py version 和 tos.py check 验证激活是否成功。你应看到类似如下的输出：

❯ tos.py version
[INFO]: Running tos.py ...
[INFO]: v1.3.0

❯ tos.py check
[INFO]: Running tos.py ...
[INFO]: [git] (2.43.0 >= 2.0.0) is ok.
[INFO]: [cmake] (4.0.2 >= 3.28.0) is ok.
[INFO]: [make] (4.3 >= 3.0.0) is ok.
[INFO]: [ninja] (1.11.1 >= 1.6.0) is ok.
[INFO]: Downloading submodules...
[INFO]: [do subprocess]: cd /home/huatuo/work/open/TuyaOpen && git submodule update --init
[INFO]: Download submodules successfully.

若 check 命令失败：

# 工具校验不合格，请安装或升级对应工具

# submodules 下载失败，手动执行 git 命令
git submodule update --init

完成后，退出激活 tos.py。

deactivate

关于 tos.py 更详细的说明方法，可使用命令 tos.py --help 进行查看，或参考 CLI - tos.py 开发工具。

常见问题

tos.py 激活失败

• 如果激活失败，可能是因为没有安装 python3-venv，请安装后重新激活。

  sudo apt-get install python3-venv

• tos.py 激活时会自动创建 ./.venv 目录。如果激活失败，需要删除 ./.venv 目录，并重新激活。