CATALOG

芯步的智能墙壁开关3路设备提供标准HTTP API接口,可通过云端或局域网直接下发指令控制每一路照明。以下方案涵盖接口集成、签名计算、指令封装及异常处理等关键环节。

1. 项目概述与准备

本方案的目标是指导开发者将芯步的UNI-KG-3智能墙壁开关(3路) 集成到现有的软件项目(如Web应用、移动App后台或SaaS平台)中。该设备支持独立控制三路照明电路,单路最大负载功率1200W,适用于家庭、办公及商业照明场景

准备工作:

  • 硬件设备:芯步智能墙壁开关3路(UNI-KG-3),确保设备已通电并连接至2.4GHz Wi-Fi网络

  • 平台账号:在芯步官网注册账号并创建“工作台”,获取专属的AppIDAppSecret(开发者密码)

  • 设备ID:在物联网控制台或设备外壳标签上找到目标设备的唯一标识符device

2. 集成认证机制

芯步开放接口采用动态签名鉴权机制,所有HTTP请求均需携带计算生成的签名以确保安全性。

签名生成规则

你需要计算 sign = md5(md5(AppSecret) + ts)

  • ts:当前Unix时间戳(秒)。

  • AppSecret:开发者密码。

代码示例(Python)

3. 核心接口集成(三路独立控制)

集成核心在于通过HTTP POST请求向指定设备下发order指令。根据产品手册,针对三路开关,你可以通过修改参数值精准控制每一路

3.1 接口地址

https://api.thingboot.com/{AppID}/device/control/?sign={sign}&ts={ts}

注意:{AppID}需替换为你工作台的实际ID。

3.2 请求头与数据结构

  • Content-Type: application/json

  • Body结构:

3.3 业务场景指令集

除了基础的开关指令,该设备还支持更丰富的控制模式

功能描述指令示例(order JSON)适用场景
单路独立控制{"power1": 1}只打开客厅灯,关闭卧室灯和阳台灯。
全开/全关{"power1":1, "power2":1, "power3":1}离家模式或回家模式触发。
点动控制(先通后断){"point1": 200}控制门禁或触发脉冲设备,通电200毫秒后自动断开。
状态恢复(先断后通){"reset2": 0}用于复位特定设备逻辑。
锁定状态保持具体指令参考产品手册防止本地按键误操作。

4. 软件项目集成步骤

4.1 封装API调用模块

为了提高开发效率和代码复用性,在项目中封装一个设备服务类。

伪代码逻辑:

  1. 初始化:读取配置中的AppIDAppSecret

  2. 生成签名:调用签名函数生成实时tssign

  3. 构造URL:拼接带参数的请求地址。

  4. 发送请求:将deviceorder以JSON格式发送。

4.2 场景化联动逻辑开发

假设你在开发一个“智能家居中枢”,可以这样调用接口:

  • 第一种场景:离家模式

  • 第二种场景:观影模式

4.3 高级特性:异步消息确认

API返回的HTTP 200仅代表平台已接收指令,并不代表设备真的执行了(例如设备当时离线)。

  • 解决方案:如果你的项目需要强反馈(如“App显示灯真的亮了”),需要开启云端消息推送服务。

  • 机制:订阅平台提供的MQTT主题或Webhook回调。设备成功执行指令后,平台会推送一条包含extra字段(你下单时自定义的唯一标识)的消息到你的服务器

5. 局域网直连与私有化部署(可选)

针对对延迟敏感或要求断网可控的项目,芯步硬件支持局域网HTTP API控制。

  • 实现的方式是:如果你的软件项目(如本地的Home Assistant或定制化PC客户端)与智能开关处于同一局域网段,可以绕过云端,直接向设备的内网IP地址发送HTTP指令。

  • 优势:响应速度达到毫秒级,不依赖外网宽带

6. 异常处理与最佳实践

  1. 签名过期(sign无效):请检查服务器时间是否与标准时间同步(NTP同步),误差过大会导致验证失败。

  2. 指令格式错误:注意区分参数名称。对于三路开关,参数通常是power1power2power3,而非单一的power

  3. 设备离线处理

    • 现象:API返回{"code":200}但灯没亮。

    • 排查:利用平台提供的“设备详情”接口查询设备status。如果是离线状态,需检查现场Wi-Fi信号强度。芯步单路负载不宜低于300W(LED灯),否则可能因取流不足导致设备重启或离线

  4. 负载兼容性问题:该开关最低负载约300W(LED灯)。如果接的是几瓦的小夜灯,可能会出现“鬼火”(关灯后微亮)或掉线。此时请一定要并联包装内附带的电容在灯头两端

7. 总结

通过集成芯步的开放接口,你可以在3小时内完成从注册到代码联调的全过程。核心代码仅仅是一次HTTP调用,但优秀的集成方案应包含:

  1. 灵活的签名缓存机制(避免每次请求都重复计算静态部分)。

  2. 异步闭环控制(结合Webhook确保状态同步)。

  3. 多设备群控优化(利用API一次请求最多控制100台设备的能力,实现全屋灯光统一管理)。