快速开始

本文介绍了如何快速了解 TuyaOS 网关开发框架 的相关概念和开发流程。

名词解释

概念	说明
类型开发包	类型开发包 是基于 TuyaOS 技术体系专门为不同场景构建的开发框架，您可以基于这些开发框架快速完成物联网产品的开发和商业化。类型开发包由 编译框架、开发环境、示例 DEMO、库文件 和 头文件 组成。更多详情，请参考 类型开发包。
产品开发包	产品开发包 是由涂鸦根据特定类型开发包开发的垂直产品，它提供了完整的产品源代码，以方便您进行二次开发。更多详情，请参考 产品开发。
开发模式	TuyaOS 提供了两种开发模式。 TuyaOS OS 开发：在此模式下，您基于涂鸦的网关模组（详情请参考 开发平台）进行应用开发，无需关注 BSP（Board Support Package）和 TuyaOS 移植适配，这些已包含在 开发环境 中。 TuyaOS SDK 开发：在此模式下，您基于自有硬件独立完成应用、BSP 和 TuyaOS 移植适配。 更多详情，请参考 开发模式。
发行版本	网关开发框架在 类型开发包 的维度提供版本变更。更多详情，请参考 发行版本。

开发流程

开始上手

获取开发包

本小节介绍通过 Tuya Wind IDE 获取开发包的关键流程。

1. 参考 Tuya Wind IDE 安装 IDE。

2. 使用 涂鸦开发者平台 的账号登录。

3. 在 Tuya Wind IDE 的资源中心，搜索您要获取的类型开发包。选择 开发模式 和 类型开发包 后，显示当前类型开发包所有已支持的芯片平台。

   如果您的开发模式是 TuyaOS SDK 模式，并且 Tuya Wind IDE 资源中心上没有您的芯片平台，请联系您的涂鸦客户经理提供芯片平台的交叉编译工具。

   

4. 选择您的芯片平台，单击 Search 查看所有可用的版本，选择最新的版本单击 Request Permission 申请开通权限。

   

5. 等待涂鸦审核。审核通过后，单击 Tuya Wind IDE 主页的 创建开发框架，下载开发包。

   

6. 如果您的开发模式选择 TuyaOS OS 模式，您还可以下载产品开发包。产品开发包的申请权限和下载入口在 开发框架 页面。

   产品开发包会下载到 software/TuyaOS/apps 目录下。

   

目录结构

software/TuyaOS 目录结构及顶层文件简介如下：

名称	说明
apps	应用示例，即产品开发包
build	编译配置目录，存放编译配置文件（您无需关注）。
build_app.sh	编译脚本
docs	Doxygen 接口文档
include	头文件
libs	库文件
Makefile	Makefile 文件
output	编译输出目录，其中生成的程序在 output/<应用工程名称>_<版本号> 路径下。
scripts	编译框架（您无需关注）。
vendor	开发环境。开发环境是执行编译时在线下载到本地的。

跨平台移植

TuyaOS 采用跨平台设计，抽象了一套标准的 TuyaOS Kernel API（TKL）来屏蔽硬件和系统的差异。在进行跨平台移植时，只需对 TKL 进行适配即可。

• TKL 接口定义：software/TuyaOS/vendor/<开发环境>/tuyaos/tuyaos_adapter/include

• TKL 接口示例：software/TuyaOS/vendor/<开发环境>/tuyaos/tuyaos_adapter/src

  只有在使用 TuyaOS SDK 模式时，才需要对 TKL 进行移植适配。在 TuyaOS OS 模式下，涂鸦已经完成了移植适配工作。

对于 Linux 平台的 OS、文件、网络等接口，它们是标准的，涂鸦提供了 TKL 接口的实现示例。

大多数接口可以直接使用，但也存在一小部分接口涉及硬件能力的接口，这些接口在不同的产品、硬件或芯片上可能会有差异。因此，您需要根据实际情况完成接口的适配工作。相关接口的移植适配指南：

• 有线连接
• 无线连接
• 蓝牙连接

IDE 编译

TuyaOS 提供了统一的编译框架，您无需关注复杂的编译规则，直接在 Tuya Wind IDE 上编写应用代码，然后通过 Tuya Wind IDE 编译程序即可。

如果您的开发模式选择 TuyaOS OS 模式，建议直接在产品开发包上进行二次开发。如果您的开发模式选择 TuyaOS SDK 模式，建议在应用示例工程上进行开发。

Tuya Wind IDE 编译步骤：

1. 单击 apps 下要编译的应用工程，然后右击弹出菜单，选择 Build Project。

   

2. 输入版本号（格式为 X.X.X，其中 X 是任意数字）后按回车键，即开始编译。

   

集成编译

通常情况下，涂鸦强烈建议使用 Tuya Wind IDE 开发和编译。但如果您已经拥有自己的编译框架，并希望将开发包作为一个组件集成到您的编译框架中，涂鸦提供了相应的集成编译指南。

本小节重点介绍了集成编译的关键步骤，以帮助您将开发包无缝集成到您的编译框架中：

1. 将 TuyaOS 的 lib 和 include 目录拷贝到您的编译框架中，并编写编译规则以指定 include 路径。同时，编写链接规则以指定 lib 路径并链接相应的库文件。

   链接库文件时，建议使用 -Wl,--start-group <链接库> -Wl,--end-group 选项，避免多个静态库依赖顺序问题。

2. 将 software/TuyaOS/vendor/<开发环境>/tuyaos/tuyaos_adapter 目录拷贝到您的编译框架中，并编写编译规则以指定 tuyaos_adapter/include 路径。接着，编译 tuyaos_adapter/include 和 tuyaos_adapter/src 目录下的所有 .c 文件。

3. 将应用示例目录拷贝到您的编译框架中，并编译其中的所有.c文件。

通过按照上述步骤操作，您可以顺利将开发包集成到您的编译框架中。