针对芯步智能包间控制器Mini(4路)的开放API,本文将给出完整的HTTP接口对接方案,涵盖设备接线绑定、签名计算、单路/批量控制、场景联动(如点单自动通电、时间到断电)及常见问题。
1. 解决概述
智能包间控制器Mini 的核心优势在于其开放的 HTTP API 接口,允许开发者通过发送 HTTPS POST 请求,实现对包间内4路电路(照明、麻将机、门锁、空调)的独立通断控制,并且支持局域网和公网两种模式 。
适用场景:共享棋牌室、茶室、剧本杀包间、自习室。前置条件
硬件:已通电并连接至Wi-Fi的智能包间控制器Mini。
凭证:在芯步控制台获取 AppID 和 AppSecret(开发者密码)。
网络:服务器或客户端能访问
api.thingboot.com(公网)或设备同局域网IP(私有化模式)。
2. 接口鉴权与签名机制
为了防止接口被恶意调用,所有API请求均需携带动态签名(Sign)。签名算法规则如下:
AppSecret:开发者密钥(需保密,服务端存储)。
ts :当前Unix时间戳(秒),用于防止请求重放。
Sign 计算步骤 :
将 AppSecret 进行第一次 MD5 加密,得到
encoded_secret = md5(AppSecret)。将
encoded_secret与时间戳ts拼接,得到encoded_secret + ts。对上一步结果再次进行 MD5 加密,即得到
Sign。
公式 :
Sign = md5( md5(AppSecret) + ts)
注意:时间戳 ts 与服务器时间误差不可过大,否则会鉴权失败。
3. 硬件接线指南与控制规划
在编写代码前,需先规划好物理线路。Mini设备提供了4路独立的继电器,每一路均可通过对应的命令字段控制 。
| 线路编号 | 命令字段 | 推荐负载类型 | 最大功率 (阻性) | 典型场景应用 |
|---|---|---|---|---|
| 线路 1 | power1 | 照明/换气扇 | 3500W | 客人进门自动开灯,离店自动关灯 |
| 线路 2 | power2 | 麻将机/按摩椅 | 3500W | 扫码付费后自动通电,倒计时结束断电 |
| 线路 3 | power3 | 电磁锁 (门禁) | 2200W | 远程开门、订单生效期间门常开/不锁 |
| 线路 4 | power4 | 空调 (2匹内) | 6600W | 预约时间段提前开启,退房统一关闭 |
| TTS语音 | play:gbk:16 | - | - | 用户远程开门或下单时播报“欢迎光临” |
4. 核心API接口实现
所有控制请求的URL结构如下 :POST https://api.thingboot.com/{AppID}/device/control/?sign={Sign}&ts={Timestamp}
请求头(Headers)Content-Type: application/json
请求体(Body)
以下是针对Mini设备的4路控制及联动场景的具体order参数示例:
4.1 单路独立控制
场景: 用户点击手机界面上的“打开麻将机”按钮。
同理,控制空调(第4路)使用{"power4": 1};控制门锁(第3路)使用{"power3": 1}(注意:对于门锁,通常通电开锁,1秒后需自动断电以保护线圈,参考5.2节)。
4.2 批量控制(全开/全关)
场景: 客人退房,保洁一键打扫模式。
4.3 高级联动:点单与倒计时
场景: 用户扫码下单购买了2小时的包间使用权。通过order可以直接实现先通电,等待2小时后自动断电,无需在本地维护定时器。
第一步:开电并启动倒计时的逻辑(复位/先断后通)假设当前设备是断电状态(或者上一用户遗留了通电状态),使用reset指令可以强制先断开指定线路,等待100毫秒,再重新接通,并利用delay属性实现自动关机。
4.4 门禁控制(点动模式)
场景: 用户在门外点击“远程开门”。门锁(电磁锁)不能长时间通电,否则会烧毁线圈。使用point(先通后断)实现“点击开门”。
4.5 TTS语音播报联动
场景: 用户下单成功或超时前5分钟,设备本地喇叭发出提醒。
注:gbk表示编码格式,16为音量或参数,具体请根据产品手册微调 。
5. 代码实现示例(核心逻辑)
以下伪代码演示了如何构建签名并发送“关灯”指令。
6. 私有化部署(局域网直连)
如果您的场景运行在纯内网环境(如工厂、局域网机房),或者希望降低延迟/不依赖外网,芯步Mini设备支持私有化部署模式。
在此模式下,您无需通过公网API域名,而是直接向设备的本地IP地址发送HTTP请求。
获取设备IP:设备连接Wi-Fi后,会在控制台显示局域网IP(如
192.168.1.100)。请求地址:替换为
http://[设备IP]/control(具体路径请查阅设备进阶手册)。优势:零延迟,数据不外传。
7. 常见问题与排错
签名错误(401)
检查时间戳是否为秒级(10位数字,非毫秒)。
检查MD5流程:必须是
md5( md5(Secret) + ts ),注意括号嵌套顺序 。
设备离线
Mini仅支持2.4G Wi-Fi,不支持5G。
确认Wi-Fi密码未变更,且无漫游认证拦截(如商场Portal认证)。设备支持设定5组备用Wi-Fi,会择优连接 。
控制延迟高
如果设备数量不多,开启 私有化部署模式,绕过云服务器中转,直接在局域网内通信。
空调无法启动
检查接线:第4路为30A专用接口,若空调匹数大于2匹(制冷量>5000W),可能因感性负载启动电流过大导致跳闸,加装交流接触器 。
总结
通过芯步的开放接口,开发者仅需关注 签名计算 与 Order命令字 两个核心环节,即可快速实现包间内所有电器的远程集控。这套方案不仅支持公网SaaS平台,也支持局域网内网穿透,是实现无人值守共享空间的技术支撑。