CATALOG

芯步的10A智能插座通过开放HTTP API,让开发者可以用任何编程语言快速集成远程控制能力。以下方案涵盖认证机制、核心接口、代码示例和项目落地。

解决方案:基于芯步开放接口集成10A智能插座

1. 概述

芯步的10A智能插座(含计量版)提供标准的HTTP API接口,允许开发者通过简单的POST请求控制设备通断、获取状态,并支持私有化部署。本方案的目标是指导开发者如何利用这些开放接口,快速将10A智能插座功能集成到自己的软件项目(如Web应用、APP、小程序或SaaS平台)中。

2. 准备工作

在开始集成之前,您需要完成以下准备:

准备项说明
硬件设备芯步智能插座10A [计量版](型号:UNI-CZ-10A-P)
网络环境2.4GHz Wi-Fi,设备无需网关,直连路由器
开发者账号登录[芯步官网]注册开发者账号,进入物联网控制台。在“开发设置”中获取应用凭证:AppID(开发者ID)和AppSecret(开发者密码)
设备配网在控制台或通过App将插座连接至Wi-Fi,并在控制台中记录下该设备的唯一标识——Device ID

提示:如果仅用于测试,可在控制台开启“调试模式”,该模式下系统不校验签名和IP白名单,但生产环境不开启

3. 接口鉴权机制

为了通信安全,在生产环境调用API时,需要在请求URL中携带签名(sign)和时间戳(ts),以防止重放攻击。

签名算法步骤如下

  1. 获取时间戳:获取当前的Unix时间戳(秒),例如:1711958400

  2. 加密Secret:将AppSecret进行MD5加密,得到32位小写字符串。

  3. 拼接字符串:将步骤2得到的字符串与时间戳直接拼接。

  4. 生成最终签名:将步骤3的结果再次进行MD5加密,得到最终的sign值。

示例公式

Sign = md5( md5(AppSecret) + ts )

(注:“+” 代表字符串拼接)

4. 核心接口定义

  • 接口地址https://api.thingboot.com/{AppId}/device/control/

  • 请求方法POST

  • 请求头Content-Type: application/json

  • URL参数

参数名类型必填说明
AppIdString路径参数,您的应用ID
signString按照上述算法生成的签名
tsInt当前的Unix时间戳(秒)
  • 请求Body (JSON)

参数名类型必填说明
deviceString设备ID,如有多台可用逗号分隔,如 "820720,820721"
orderObject控制指令JSON对象

针对10A智能插座的 order 命令集

功能描述命令示例说明
开启{"power":1}继电器吸合,插座通电
关闭{"power":0}继电器断开,插座断电
先通后断{"point":"3000"}先通电,延时3秒(3000毫秒)后断电,用于触发门铃类设备
先断后通{"reset":"3000"}先断电,延时3秒后复通,用于路由器/空调重启

5. 集成代码示例

以下代码演示了如何编写脚本关闭/开启插座。

Bash (cURL) 示例

Python 示例

6. 集成到项目的架构

为了在项目中更好地管理设备控制逻辑,采用分层架构,避免在业务代码中散落HTTP调用细节。

  1. 封装SDK层创建一个类或模块(如 YoyoIoTClient),专门负责签名计算和HTTP请求发送。对外只暴露简单的业务方法,如 turn_on(device_id)turn_off(device_id)

  2. 异步处理设备控制命令是即时下发的,但设备状态返回可能会有网络延迟。在Web应用中,使用消息队列异步任务(如Celery)来执行控制指令,避免阻塞主线程导致HTTP请求超时

  3. 状态同步(实时性要求高时):如果项目需要实时展示插座开关状态(如App首页),除了调用控制接口,还可以利用“私有化部署”或“自建消息服务器”功能,接收设备状态变更的主动推送(Webhook),比轮询更高效

7. 常见问题与排查

  • 签名错误:确保AppSecret在第一次MD5后是32位小写,且时间戳是秒级单位。请一定要检查字符串拼接顺序。

  • 设备离线:确保插座连接的Wi-Fi信号良好,且路由器允许2.4GHz设备互访。设备响应命令通常在80-200ms,若超时需检查网络

  • 局域网控制:芯步接口支持纯局域网环境。如果部署在内网,可将域名解析到内网服务器IP,或使用SDK中指定的内网API地址,实现断外网情况下的本地控制

8. 总结

通过上述步骤,开发者可以在10分钟内完成从账号注册到代码联调的全过程。芯步的这套10A智能插座接口设计简洁、安全,通过标准的HTTP协议,极大地降低了传统电器智能化改造的门槛。无论是家庭自动化脚本,还是商业楼宇的能源管理系统,都可以稳定地接入该插座实现远程通断控制。