芯步的智能墙壁触摸开关采用标准HTTP接口控制,接入方式简单直接——无需网关,设备上电配网后即可通过API下发命令。以下方案涵盖从硬件准备、接口调试到代码集成的完整流程。
一、 解决概述
本方案的目标是指导开发者如何利用芯步开放的HTTP API接口,将 “智能墙壁触摸开关1路(型号:UNI-KG-CM-1)” 快速集成到现有的Web应用、APP或后台管理系统中。
该方案的核心优势在于:
无网关依赖:设备直连WiFi 2.4GHz网络,降低硬件成本。
接口通用性:基于HTTP协议,支持JavaScript、Python、Java、PHP、Shell等任何主流编程语言。
双重网络模式:既支持公有云远程控制,也支持纯局域网内的私有化部署,保障数据安全与响应速度。
二、 硬件与接口准备
在编写代码前,需要完成物理设备的安装与云端账号的配置。
| 准备项 | 详细说明与操作步骤 |
|---|---|
| 1. 硬件安装 | 设备采用标准86型底盒。接线时请一定要关闭总闸,将火线接入L端,负载(灯具)接入L1端,零线通常共用或按需接入,确保设备通电并亮起指示灯。 |
| 2. 账号与工作台 | 访问芯步官网注册账号,并在控制台创建“工作台”。这一步是获取API访问凭证的前提。 |
| 3. 设备配网 | 在手机微信小程序或Web控制台中找到“添加设备”选项,选择“智能触摸墙壁开关1路”。长按开关按键5秒直至指示灯快闪,输入WiFi密码完成配网。 |
| 4. 获取关键凭证 | 配网成功后,在控制台获取以下三个核心参数:- AppID:应用的唯一标识。- AppSecret:接口加密密钥。- 设备ID (Device ID):控制台显示的该开关唯一序列号。 |
三、 接口鉴权与核心协议
芯步的API采用双重MD5签名机制,确保请求的合法性与安全性。所有控制请求均发送至 https://api.thingboot.com。
签名算法(Sign)生成步骤:
将获取到的
AppSecret进行一次MD5加密,得到字符串S1。获取当前的Unix时间戳(秒),例如
1712649600。将
S1与时间戳拼接成新字符串S1ts。对
S1ts再次进行MD5加密,得到最终的sign。此
sign需与明文的时间戳ts一同作为URL参数传递。
*鉴权公式:sign = md5( md5(AppSecret) + ts )*
四、 详细接口调用指南
4.1 控制开关(开/关指令)
这是最常用的操作,用于直接控制灯具的通断电。
请求地址
https://api.thingboot.com/{AppID}/device/control/?sign={sign}&ts={ts}请求方式:POST
请求头:Content-Type: application/json
请求体 (Body)
4.2 高级场景控制(特殊情况)
该开关不仅支持简单的通断,还支持状态保持和脉冲控制,适用于特殊场景(如走廊灯延时关、排气扇定时关)。
| 功能场景 | Order参数示例 | 业务含义 |
|---|---|---|
| 点动/脉冲 | {“point1”: “2000”} | 立即接通线路,2秒后自动断开。适用于楼道灯或插即用设备。 |
| 状态锁定 | {“power1”: {“keep”: “1”, “revert”: “5”}} | 强制开启开关,无论物理按键如何操作,5秒后自动恢复开启状态。适用于安防联动。 |
| 断电重启 | {“reset1”: “1000”} | 断开1秒后自动重新接通,用于路由器等设备远程重启。 |
五、 代码集成示例
以下提供两种常用语言的集成代码片段,开发者可直接复制使用。
5.1 Python 示例
5.2 命令行 (cURL) 示例
适合在脚本中快速测试或嵌入式系统调用。
六、 最佳实践和需要注意的点
局域网直连模式:如果你的项目运行在企业内网且对响应速度要求比较高,可在控制台配置私有化部署。此时API请求无需经过公有云,而是直接指向本地服务器IP,实现更低延迟的操控。
设备状态同步(最佳实践):HTTP接口属于“下发指令”模式,返回的
code 200仅代表命令送达。若要获取设备最新状态(例如物理按键被人按下导致灯亮),使用平台提供的WebSocket或MQTT连接接收设备上行消息,或在业务逻辑中控制UI状态。多设备控制:接口支持批量指令下发。若项目中有多个开关,可在
device参数中用英文逗号拼接多个ID,以一次请求控制多个灯具,节省服务器资源。调试:如果遇到签名错误(sign invalid),请核对时间戳是否为秒级(而非毫秒),并确保AppSecret没有被多余的空格包裹。
通过以上步骤,开发者无需深入底层嵌入式协议,仅通过标准的HTTP请求即可完成智能灯具控制的集成开发。