搭建环境

更新时间:2023-01-29 07:32:07下载pdf

本文主要介绍如何搭建涂鸦 Zigbee 模组 SDK 开发环境。

安装编译工具

  • Keil:前往 Keil 官网 下载 Keil uVision5(5.26.2)。(奉加微平台使用)

  • IAR:前往 IAR 官网 下载 IAR Embedded Workbench IDE(IAR for Arm)。

    必须使用 ARM 8.40.1 或更高版本正版 IAR,强烈建议使用 8.40.1 版本。(芯科平台使用)。

  • Python:涂鸦 Zigbee SDK 应用工程编译依赖于 Python 脚本,需要先安装 Python3.8.X 版本。

    Zigbee SDK 基于 Windows 环境下开发,故安装 Python 也是在 Windows 下进行安装。

    前往 Python 官网 下载 3.6~3.8 版本进行安装,并将 Python3.8 的路径添加到 PATH 变量。确保勾选 Add Python 3.8 to PATH,然后单击 Install Now

    搭建环境

    如果自定义安装,还需要安装 pip,确保版本为 20.x 以上。前提是 Python 环境正常。

    安装配置完成后,建议重启电脑,重启后可以 WIN+R 打开电脑的运行窗口,输入 cmd 指令,然后命令行输入 python -V。如果显示 Python 版本,证明环境变量配置成功。

    搭建环境

安装 Tuya Wind IDE

Tuya Wind IDE 是面向 TuyaOS 开发者提供的一站式集成开发环境,目标是让开发者基于 IDE 可以自助完成 SDK 获取、调试、编译、烧录授权等完整的嵌入式开发流程。开发者只需要下载 Visual Studio Code 并安装 Tuya Wind IDE 插件,即可快速进行 SDK 开发,可运行于 Linux、Windows、MacOS 等操作系统。

  1. 前往 Visual Studio Code 官网,下载最新版本并进行安装。安装完成后,在插件栏搜索 tuya,找到 Tuya Wind IDE 并进行安装。

    安装插件的前提是 Python 环境正确安装,否则检测不到 Python 环境,导致无法安装 IDE 插件。

    搭建环境

  2. IDE 插件安装完成后,单击右侧栏的如下图标,单击 开始 进入 Tuya Home,使用 Tuya IoT 开发平台账号登录。若没有账号,可前往 涂鸦 IoT 开发平台 进行账号注册。

    搭建环境

  3. 当 Tuya Tind IDE 插件安装完成后,若打开 Tuya Home 时界面是空白,没有登录入口,则需要配置一下 Visual Studio Code 的端口,IDE 在本地的后端启用 8320 端口。

    搭建环境

获取开发框架与产品开发包

开发框架为涂鸦封装原厂 SDK 后给业务层框架代码;产品开发包为涂鸦产品 demo,包含电工、传感、照明等各品类 demo。

获取开发框架

  1. 在 Vscode 下登录 Tuya Wind IDE 账号,然后选择 新建开发框架 进行开发包选择。

    搭建环境

  2. 根据芯片选择到合适的开发包后点击确认并开始拉取,拉取完成即可进行相关功能的开发。

    搭建环境

开发框架说明

TuyaOS Zigbee 子设备开发包适用于开发符合 Zigbee 3.0 标准的智能产品。该开发包在芯片原厂 SDK 基础上进行了二次抽象,屏蔽了复杂的 Zigbee 技术细节,融入了涂鸦特色功能,方便您快速入门。主要包含原厂 vendor SDK、涂鸦特色功能 libs 库、硬件接口、网络接口、 组件、工具等部分,并在 APP 下提供若干品类的示例代码,来展示各种接口的使用和 Zigbee 设备接入涂鸦体系的基本开发规范。

开发框架目录结构

.
├─ hardware
│  ├─ chip_manual
│  └─ module_manual
├─ pc
│  └─ tools
├─ TuyaOS
│  ├─apps
│  │  └─tuyaos_demo_zg_light2
│  ├─components
│  ├─docs
│  ├─include
│  │  ├─adapter
│  │  ├─base
│  │  └─components
│  ├─libs
│  ├─scripts
│  ├─tools
│  └─vendor
└─ tuya.json
目录名称 作用
hardware 包含硬件模组相关资料
pc 包含原厂 pc 工具
apps 包含有 demo 代码,新建项目只需进行新建文件夹并在文件夹下添加相关代码即可
components 包含涂鸦开发的各类开源组件,用户添加组件需要新建目录即可,然后将组件代码放在此文件夹下
doc 包含相关说明文档
include 包含 TuyaOS 子设备开发包各类 API 文件
lib 包含 TuyaOS 子设备开发包依赖的库文件
scripts 包含相关脚本文件
tools 包含应用在构建和编译过程中所用到的相关工具和脚本
vendor 包含涂鸦优化过后的芯片原厂 SDK

产品开发包简介

开发者可以通过以下方式获取产品开发包,拉取产品开发包会直接插入至 apps 文件下。

搭建环境

拉取的 demo 文件目录如下图所示:

搭建环境

目录名称 作用
components 包含涂鸦开发的各类开源组件,如 battery 电池组件、led blink 闪灯组件等
include 包含各种头文件,如配置文件 xx_app_config.h
src 包含各种应用回调 c 文件