芯步设备固件 SDK

面向开发者的企业级免费 SDK —— 开箱即用,零学习成本,ESP Arduino / ESP-IDF 双版本开放

SDK 简介

芯步设备固件 SDK 是一套面向开发者的企业级免费固件开发框架,开箱即用、零学习成本。SDK 深度封装设备连接、状态管理、命令执行、OTA 升级等核心能力,开发者无需从零实现通信协议,也无需额外学习新的开发范式,即可基于熟悉的开发环境快速、高质量地完成产品固件开发,并接入芯步开放平台与私有化平台。SDK 的 ESP Arduino 与 ESP-IDF 两个版本均免费向开发者开放,每个开发者账号每年还享有 100 台设备免费接入额度,几乎覆盖一个开发团队一年的样机量;仅在产品进入量产阶段时才向工厂收取平台接入费。

核心功能

设备连接

一键接入芯步云平台或私有化平台,支持稳定长连接与断线重连。

状态上报

标准化设备状态、事件与数据上报接口,云端实时感知设备运行。

命令执行

接收并解析云端下发的控制命令,支持同步与异步执行模式。

OTA 升级

内置安全可靠的固件 OTA 升级能力,支持差分与整包升级策略。

SDK模块一览表

模块 访问方式 功能说明 备注
Core 核心 device.* 系统初始化与主循环、产品信息设置、系统信息/版本/ID 查询、工作模式、时区与时间戳、重启、延时与节拍、系统回调(状态变化 / 进度 / 调试日志) —
Config 配置 device.Config 设备配置项的注册、读取、保存、重置、清空,配置变化回调;与控制台"配置"卡片联动 —
Order 命令 device.Order 接收平台下发的命令(回调),并对命令进行应答 —
Event 事件 device.Event 设备属性设置与防抖、属性变化回调、事件上报 —
Message 消息 device.Message 向平台/其他设备发布消息(order / event / state / config 等主题,支持指定 mid 与目标设备号) —
State 状态 device.State 状态数据上报、定期上报(平台轮询取数回调 onFetch) —
Timer 定时器 device.Timer 软件定时器:按间隔毫秒数与次数(或无限循环)注册回调 —
Peripheral 外设 device.Peripheral 外设预初始化/初始化回调;设备 LED 与系统 LED(常亮/熄灭/翻转/闪烁);设备按钮与系统按钮(消抖、长按菜单) —
Network 网络 device.Network WiFi(多组配置、增删改查、连接/断开)、有线以太网(W5500)、GSM/4G(ML307)、网络信息查询 以太网需 TBD_ETHER;GSM 需 TBD_GSM;芯片选择接口仅 ESP-IDF 版
BLE 蓝牙 (编译期启用) BLE 配网(wifi_provisioning,TBC- 热点、PoP 校验)与 BLE 控制(NimBLE GATT:命令写入 / 事件通知 / 配置读写) 仅 ESP-IDF 版,需 TBD_BLE
Bridge 桥接 device.Bridge UART / SPI 字节管道:收发原始数据、格式化发送、接收/错误回调、统计信息 可用 NO_BRIDGE 宏裁剪
Utils / JSON 工具 全局函数 JSONVar / JSON(parse / stringify / typeof)、字符串工具(拼接 / 填充 / 查找 / 分割 / 十六进制转换)、md5、随机数、tb_millis() / mill_elapsed() —

SDK 优势

开箱即用,零学习成本

沿用开发者熟悉的 Arduino / ESP-IDF 开发方式,无需学习新的框架即可上手;屏蔽底层协议与通信细节,聚焦业务逻辑,显著缩短研发周期。

代码质量稳

经过真实量产项目验证的固件框架,稳定性与兼容性更有保障。

迁移成本低

统一接口设计,Arduino 与 ESP-IDF 双版本 API 保持一致,后续向 STM32、Linux 等平台迁移时成本同样可控。

系统加载流程

阶段 系统行为 该时机提供的接口机制 调用时机要求
setup 之前 开发者代码阶段,系统尚未初始化 ✦ 注册类接口全部在此调用:setProduct() 设置产品信息、onDebug() 调试回调、onSystemProgress() 进度回调、onSystemStateChange() 状态回调、onInitPre() / onInit() 外设回调、onOrder() / onConfig() / onFetch() / onAttributeChange() 业务回调,以及网络参数预设(WiFi 配置、setGSMChip() / setEthernetChip() / setGSMSerialPort() / setEthernetPin()) 必须在 device.setup() 前
0% → 10% 外设预初始化(扫描系统按钮状态) ✦ 触发 onInitPre() 回调:最早的开发者代码执行点,可在此注册 GPIO 外设(setDeviceLed() / setDeviceBtn()) SDK 内部触发
10% → 20% 系统信息初始化(NVS/ROM 读取,工厂配置从 SPIFFS 导入) ✦ onSystemProgress() 持续汇报进度与阶段描述;onDebug() 输出内部日志 SDK 内部触发
20% → 30% WiFi 驱动初始化、扫描工程热点(safe / factory / test / debug / config) —(内部阶段) —
30% → 40% 外设初始化(按注册信息点亮 LED、接管系统 LED/按钮) ✦ 触发 onInit() 回调:外设注册生效后的开发者初始化点 SDK 内部触发
40% → 60% 网络连接(按优先级尝试 WiFi / 以太网 / GSM,工程热点优先) —(内部阶段,结果通过系统状态体现) —
60% → 90% 私有化网关 / 私有化 Broker 初始化(未启用时跳过) —(内部阶段) —
90% → 100% NTP 对时初始化 —(内部阶段) —
100% 完成 系统启动完成,随后自动进行平台注册(reg)、连接 MQTT Broker、订阅下行主题 ✦ onSystemStateChange() 通知系统状态变迁(启动 / 联网 / 上线 / 离线等) SDK 内部触发
loop 运行期 device.loop() 主循环:MQTT 消息分发、定时器调度、外设轮询(10ms)、状态定期上报、OTA 等 ✦ 业务接口全部可用:onOrder() 收命令 → replyMessage() / publishMessage() 应答;reportEvent() / reportState() 上报;onConfig() 配置变化;onFetch() 平台取数;onAttributeChange() 属性变化;addTimer() 定时任务;按钮回调(setDeviceBtn() 注册);Bridge.handle() 桥接收发(UART 模式需在 loop 中周期调用) 每次循环调用 device.loop()

平台支持路线图

ESP Arduino

已支持,可直接下载使用,覆盖 ESP8266 / ESP32 等主流模组。

更多平台

STM32、Linux 等平台正在规划中,敬请期待。

获取芯步设备固件 SDK

双版本 SDK 免费开放,访问 GitHub 仓库查看源码、示例与文档

ESP Arduino SDK ESP-IDF SDK(测试版)