概述
IOT平台协议套件,以飞企IOT平台为模板,提供标准的北向接口,适配了不同品牌的IOT平台。用于物联相关的业务应用开发。
协议定义
飞企互联IOT平台为基础模板定义套件协议
产品列表(通用)
暂无
设备列表(通用)
- URL
/iot/device/list
- 请求参数
名称 | 版本 | 必填 | 类型 | 默认值 | 备注 |
---|---|---|---|---|---|
pageIndex | 1 | true | string | 页数 | |
pageSize | 1 | true | string | 每页数量 | |
productId | 1 | false | string | 产品标识 | |
name | 1 | false | string | 模糊查询字段(名称、标识) |
- 返回参数
名称 | 版本 | 必填 | 类型 | 备注 |
---|---|---|---|---|
data | 1 | false | object | 返回内容 |
— deviceId | 1 | false | string | 设备标识 |
— deviceName | 1 | false | string | 设备名称 |
— productId | 1 | false | string | 产品标识 |
— state | 1 | false | string | 设备状态(0离线 1在线) |
— createTime | 1 | false | string | 创建时间 |
— activeTime | 1 | false | string | 激活时间 |
msg | 1 | true | string | 说明 |
code | 1 | true | string | 参照状态码 |
- 注
属性列表(通用)
- URL
/iot/device/attribute/value
- 请求参数
名称 | 版本 | 必填 | 类型 | 默认值 | 备注 |
---|---|---|---|---|---|
deviceId | 1 | false | string | 设备标识 | |
productId | 1 | true | string | 产品标识 |
- 返回参数
名称 | 版本 | 必填 | 类型 | 备注 |
---|---|---|---|---|
data | 1 | false | object | 返回内容 |
— propertyId | 1 | false | string | 属性标识 |
— propertyValue | 1 | false | string | 属性值 |
msg | 1 | true | string | 说明 |
code | 1 | true | string | 参照状态码 |
- 注
功能控制(通用)
- URL
/iot/device/function
- 请求参数
名称 | 版本 | 必填 | 类型 | 默认值 | 备注 |
---|---|---|---|---|---|
functionParam | 1 | true | string | 功能控制参数 | |
functionId | 1 | true | string | 功能标识 | |
deviceId | 1 | true | string | 设备标识 | |
productId | 1 | true | string | 产品标识 |
- 返回参数
名称 | 版本 | 必填 | 类型 | 备注 |
---|---|---|---|---|
msg | 1 | true | string | 说明 |
code | 1 | true | string | 参照状态码 |
- 注
通用接口参数组装实例
功能控制实例
- 物联产品:飞企继电器(8路) 物模型-功能(开关控制)
功能标识:on_off
控制参数:
名称 | 类型 | 备注 |
---|---|---|
port | string | 具体端口属性 |
control | boolean | 控制 1开 0关 |
- 功能控制协议参数组装
{
deviceId:"设备ID",
productId:"产品ID",
functionId:"on_off",
functionParam:{
port:"port01",
control:1
}
}
已实现适配器
文档更新时间: 2022-08-24 16:33 作者:管理员