一、HTTP API 接口规范
- 接口鉴权
使用smartassistant接口,需将用户凭证smart-assistant-token,放在http请求的header中。格式如下:
"smart-assistant-token":"xxx"
2. 返回标准数据结构
smartassistant接口均返回JSON格式数据,格式如下:
{
"status":0, // 状态码
"reason":"", // 状态码描述
"data":{} // 所有业务数据返回都包含在data对象中
}
3. 错误码列表
二、设备类插件实现
开发前先阅读插件设计概要:插件系统设计技术概要
使用 plugin-sdk(code:/pkg/plugin/sdk) 可以忽略不重要的逻辑,快速实现插件
插件实现
1) 获取sdk
go get github.com/zhiting-tech/smartassistant
2) 定义设备
sdk中提供了预定义的设备模型,使用模型可以方便SA有效进行管理和控制
设备物模型设计如下:
light_bulb灯泡