ThingBoot Device Drivers for ESP-IDF

本仓库是 ThingBoot Device SDK (ESP-IDF 版) 的驱动示例集合，面向需要在项目中使用 ThingBoot 的开发者。

注意：这里只包含已发布的驱动代码。如果你想参与编写或提交新的驱动，请访问驱动开发仓库。

仓库内容

每个子目录对应一个独立、完整、可直接编译的 ESP-IDF 驱动工程：

• relay/：继电器 / 开关 / 插座 / 通断器 / 断路器驱动示例

当前 IDF 版 SDK 正在移植中（已实现 getVersion()），驱动中依赖 SDK 业务接口 （命令、配置、外设、定时器等）的部分以 TODO 标注，将随 SDK 接口完善逐步接入。 驱动的硬件控制逻辑（GPIO、计时、状态保持等）已完整可用。

快速使用

方式一：仓库根目录编译（多驱动切换）

仓库根目录带有 platformio.ini，每个驱动一个 env，直接用 PlatformIO 打开仓库根目录即可：

pio run -e relay      # 编译 relay 驱动
pio run -e sht3x      # 编译 sht3x 驱动（如有）

新增驱动时，在根 platformio.ini 复制一个 env 并修改 custom_driver 即可。

方式二：单独编译某个驱动

每个驱动都是完整的 ESP-IDF 工程，可独立摘出使用。SDK 依赖通过 IDF 组件管理器自动从 GitHub 拉取：

cd relay
idf.py build

或使用 PlatformIO：

cd relay
pio run

方式三：集成到自己的工程

1. 确保你的工程已接入 thingboot-device-esp-idf-sdk。
2. 将对应驱动的 main/ 下的驱动文件（如 include/relay.h）复制到你的工程。
3. 根据你的硬件修改驱动代码中的引脚、数量等配置（通常集中在 include/ 下的头文件中）。
4. 编译并烧录到设备。

注意事项

• 本仓库所有驱动代码均免费且开源（Apache-2.0），可直接参考或集成到你的固件中。
• 如果某个驱动依赖了第三方库，请在使用时遵循该第三方库的许可协议，本项目不承担相关责任。
• 驱动代码中的产品 ID、密钥、引脚等示例信息仅供参考，正式上线前请替换为你自己的 ThingBoot 产品信息。

License

Apache License 2.0