Skip to content

Commit abdd207

Browse files
author
donghu-jiang
committed
添加explorer/hub SDK接口说明文档
Change-Id: I9a65467666c70b74093d61a1cbb0eaf19b7d7564
1 parent fb18818 commit abdd207

File tree

2 files changed

+170
-0
lines changed

2 files changed

+170
-0
lines changed

‎explorer/doc/SDK接口说明.md‎

Lines changed: 83 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,83 @@
1+
* [API接口说明](#API接口说明)
2+
* [MQTT接口](#MQTT接口)
3+
* [网关接口](#网关接口)
4+
* [数据模板接口](#设备影子接口)
5+
* [动态注册接口](#动态注册接口)
6+
* [OTA接口](#OTA接口)
7+
* [LOG接口](#LOG接口)
8+
9+
# API接口说明
10+
## MQTT接口
11+
12+
| 接口名称 | 接口描述 |
13+
| :-: | :-: |
14+
| connect | MQTT连接 |
15+
| disconnect | 断开MQTT连接 |
16+
| subscribe | MQTT订阅 |
17+
| unsubscribe | MQTT取消订阅 |
18+
| publish | MQTT发布消息 |
19+
| registerMqttCallback | 注册MQTT回调函数 |
20+
| registerUserCallback | 注册用户回调函数 |
21+
| isMqttConnected | MQTT是否正常连接 |
22+
| getConnectState | 获取MQTT连接状态 |
23+
| setReconnectInterval | 设置MQTT重连尝试间隔 |
24+
| setMessageTimout | 设置消息发送超时时间 |
25+
| setKeepaliveInterval | 设置MQTT保活间隔 |
26+
27+
## 网关接口
28+
| 接口名称 | 接口描述 |
29+
| :-: | :-: |
30+
| gatewayInit | 网关初始化 |
31+
| isSubdevStatusOnline | 判断子设备是否在线 |
32+
| updateSubdevStatus | 更新子设备在线状态 |
33+
| gatewaySubdevGetConfigList | 获取配置文件中子设备列表 |
34+
| gatewaySubdevOnline | 代理子设备上线 |
35+
| gatewaySubdevOffline | 代理子设备下线 |
36+
| gatewaySubdevBind | 绑定子设备 |
37+
| gatewaySubdevUnbind | 解绑子设备 |
38+
| gatewaySubdevSubscribe | 子设备订阅 |
39+
40+
## 数据模板接口
41+
| 接口名称 | 接口描述 |
42+
| :-: | :-: |
43+
| templateInit | 数据模板初始化 |
44+
| getEventsList | 获取设备event列表 |
45+
| getActionList | 获取设备action列表 |
46+
| getPropertyList | 获取设备property列表 |
47+
| templateSetup | 解析数据模板 |
48+
| templateEventPost | events上报 |
49+
| templateJsonConstructReportArray | 构建上报的json结构 |
50+
| templateReportSysInfo | 设备信息上报 |
51+
| templateControlReply | 控制消息应答 |
52+
| templateActionReply | action消息应答 |
53+
| templateGetStatus | 获取设备最新状态 |
54+
| templateReport | 设备属性上报 |
55+
| clearControl | 清除控制 |
56+
| templateDeinit | 数据模板销毁 |
57+
58+
## 动态注册接口
59+
| 接口名称 | 接口描述 |
60+
| :-: | :-: |
61+
| dynregDevice | 获取设备动态注册的信息 |
62+
63+
## OTA接口
64+
| 接口名称 | 接口描述 |
65+
| :-: | :-: |
66+
| otaInit | OTA初始化 |
67+
| otaIsFetching | 判断是否正在下载 |
68+
| otaIsFetchFinished | 判断是否下载完成 |
69+
| otaReportUpgradeSuccess | 上报升级成功消息 |
70+
| otaReportUpgradeFail | 上报升级失败消息 |
71+
| otaIoctlNumber | 获取下载固件大小等int类型信息 |
72+
| otaIoctlString | 获取下载固件md5等string类型信息 |
73+
| otaResetMd5 | 重置md5信息 |
74+
| otaMd5Update | 更新md5信息 |
75+
| httpInit | 初始化http |
76+
| otaReportVersion | 上报当前固件版本信息 |
77+
| otaDownloadStart | 开始固件下载 |
78+
| otaFetchYield | 读取固件 |
79+
80+
## LOG接口
81+
| 接口名称 | 接口描述 |
82+
| :-: | :-: |
83+
| logInit | 日志初始化 |

‎hub/doc/SDK接口说明.md‎

Lines changed: 87 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,87 @@
1+
* [API接口说明](#API接口说明)
2+
* [MQTT接口](#MQTT接口)
3+
* [网关接口](#网关接口)
4+
* [设备影子接口](#设备影子接口)
5+
* [RRPC接口](#RRPC接口)
6+
* [广播接口](#广播接口)
7+
* [动态注册接口](#动态注册接口)
8+
* [OTA接口](#OTA接口)
9+
* [LOG接口](#LOG接口)
10+
11+
# API接口说明
12+
## MQTT接口
13+
| 接口名称 | 接口描述 |
14+
| :-: | :-: |
15+
| connect | MQTT连接 |
16+
| disconnect | 断开MQTT连接 |
17+
| subscribe | MQTT订阅 |
18+
| unsubscribe | MQTT取消订阅 |
19+
| publish | MQTT发布消息 |
20+
| registerMqttCallback | 注册MQTT回调函数 |
21+
| registerUserCallback | 注册用户回调函数 |
22+
| isMqttConnected | MQTT是否正常连接 |
23+
| getConnectState | 获取MQTT连接状态 |
24+
| setReconnectInterval | 设置MQTT重连尝试间隔 |
25+
| setMessageTimout | 设置消息发送超时时间 |
26+
| setKeepaliveInterval | 设置MQTT保活间隔 |
27+
28+
## 网关接口
29+
| 接口名称 | 接口描述 |
30+
| :-: | :-: |
31+
| gatewayInit | 网关初始化 |
32+
| isSubdevStatusOnline | 判断子设备是否在线 |
33+
| updateSubdevStatus | 更新子设备在线状态 |
34+
| gatewaySubdevGetConfigList | 获取配置文件中子设备列表 |
35+
| gatewaySubdevOnline | 代理子设备上线 |
36+
| gatewaySubdevOffline | 代理子设备下线 |
37+
| gatewaySubdevBind | 绑定子设备 |
38+
| gatewaySubdevUnbind | 解绑子设备 |
39+
| gatewaySubdevGetBindList | 获取绑定的子设备列表 |
40+
| gatewaySubdevSubscribe | 子设备订阅 |
41+
42+
## 设备影子接口
43+
| 接口名称 | 接口描述 |
44+
| :-: | :-: |
45+
| shadowInit | 设备影子初始化 |
46+
| getShadow | 获取设备影子 |
47+
| shadowJsonConstructDesireAllNull | 构建json结构 |
48+
| shadowUpdate | 更新设备影子 |
49+
| shadowJsonConstructReport | 构建上报的json结构 |
50+
51+
## RRPC接口
52+
| 接口名称 | 接口描述 |
53+
| :-: | :-: |
54+
| rrpcInit | RRPC初始化 |
55+
| rrpcReply | 消息回复 |
56+
57+
## 广播接口
58+
| 接口名称 | 接口描述 |
59+
| :-: | :-: |
60+
| broadcastInit | 广播初始化 |
61+
62+
## 动态注册接口
63+
| 接口名称 | 接口描述 |
64+
| :-: | :-: |
65+
| dynregDevice | 获取设备动态注册的信息 |
66+
67+
## OTA接口
68+
| 接口名称 | 接口描述 |
69+
| :-: | :-: |
70+
| otaInit | OTA初始化 |
71+
| otaIsFetching | 判断是否正在下载 |
72+
| otaIsFetchFinished | 判断是否下载完成 |
73+
| otaReportUpgradeSuccess | 上报升级成功消息 |
74+
| otaReportUpgradeFail | 上报升级失败消息 |
75+
| otaIoctlNumber | 获取下载固件大小等int类型信息 |
76+
| otaIoctlString | 获取下载固件md5等string类型信息 |
77+
| otaResetMd5 | 重置md5信息 |
78+
| otaMd5Update | 更新md5信息 |
79+
| httpInit | 初始化http |
80+
| otaReportVersion | 上报当前固件版本信息 |
81+
| otaDownloadStart | 开始固件下载 |
82+
| otaFetchYield | 读取固件 |
83+
84+
## LOG接口
85+
| 接口名称 | 接口描述 |
86+
| :-: | :-: |
87+
| logInit | 日志初始化 |

0 commit comments

Comments
 (0)