Skip to content

Commit 83d1a3a

Browse files
authored
Merge pull request #7 from emqx/txl_doc
feat(access_guide): 快速接入指南重写
2 parents d05becf + 8fa6a1c commit 83d1a3a

23 files changed

Lines changed: 284 additions & 239 deletions

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@
2626

2727
- 如果您已经有物理设备,则可以使用设备接入 **ActorCloud** 来完成本教程;
2828

29-
- 如果您没有物理设备,可以通过使用 [MQTT 客户端](https://developer.emqx.io/sdk_tools?category=MQTT_Clients)[在线测试中心](https://console.actorcloud.io/mqtt_client)利用软件环境来模拟一个接入设备,查看[设备接入指南](./access_guide/device.md)
29+
- 如果您没有物理设备,可以通过使用 [MQTT 客户端](https://developer.emqx.io/sdk_tools?category=MQTT_Clients)[在线测试中心](https://console.actorcloud.io/mqtt_client)利用软件环境来模拟一个接入设备,查看[设备快速接入指南](./access_guide/notice.md)
3030

3131

3232

SUMMARY.md

Lines changed: 5 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -3,13 +3,7 @@
33
## 快速入门
44
* [概览](README.md)
55
* [ActorCloud 入门](introduction.md)
6-
* [设备快速接入指南](access_guide/access_guide.md)
7-
* [设备注册](access_guide/device.md)
8-
* [设备证书](access_guide/certs.md)
9-
* [MQTT 设备接入](access_guide/mqtt.md)
10-
* [CoAP 设备接入](access_guide/coap.md)
11-
* [设备控制](access_guide/control.md)
12-
* [REST API](access_guide/rest.md)
6+
* [设备快速接入指南](access_guide/notice.md)
137
* [产品商城](products_mall/products_mall.md)
148
* [基础服务](products_mall/badic_sevice.md)
159
* [增值服务](products_mall/badic_sevice.md#增值服务)
@@ -22,8 +16,8 @@
2216
* [仪表盘](data_visualization/dashboard.md)
2317

2418
## 设备管理
25-
2619
* [产品管理](device/product.md)
20+
* [创建产品](device/product_create.md)
2721
* [属性列表](device/product.md#属性列表)
2822
* [功能点](device/product.md#功能点)
2923
* [数据流](device/product.md#数据流)
@@ -33,7 +27,7 @@
3327
* [代理订阅](device/product.md#代理订阅)
3428
* [应用模板](device/product.md#应用模板)
3529
* [资源定义](device/product.md#资源定义)
36-
30+
* [设备注册](device/device_create.md)
3731
* [设备列表](device/device.md#设备列表)
3832
* [设备信息](device/device.md#设备信息)
3933
* [网关管理](device/device.md#网关管理)
@@ -65,8 +59,8 @@
6559
* [历史告警](alert/alert.md#历史告警)
6660

6761
## 测试中心
68-
* [MQTT 客户端](test_center/mqtt.md#mqtt-客户端)
69-
* [CoAP 客户端](test_center/mqtt.md#coap-客户端)
62+
* [MQTT 客户端](test_center/mqtt.md)
63+
* [CoAP 客户端](test_center/coap.md)
7064

7165
## 应用管理
7266
* [应用列表](application/application.md#应用列表)

access_guide/access_guide.md

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -2,9 +2,8 @@
22

33
该教程提供简要的设备接入流程:
44

5-
* [设备注册](device.md)
5+
* [快速接入指南](notice.md)
66
* [设备证书](certs.md)
7-
* [MQTT 设备接入](mqtt.md)
8-
* [CoAP 设备接入](coap.md)
97
* [设备控制](control.md)
10-
* [REST API](rest.md)
8+
* [REST API](rest.md)
9+

access_guide/mqtt.md

Lines changed: 0 additions & 199 deletions
This file was deleted.

access_guide/notice.md

Lines changed: 73 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,73 @@
1+
# 快速接入指南
2+
3+
设备快速接入指南将通过实例,指导开发者使用actorcloud将设备快速接入MQTT,完成数据上报基本操作。
4+
5+
## 案例概述
6+
7+
本案例以空调上报温度和模式(制冷,制热)数据为例,帮助开发者快速接入 MQTT 协议设备。
8+
9+
## 接入步骤
10+
11+
1. #### 新建产品
12+
13+
选择 设备管理->产品管理->新建,创建一个名为"**空调**"的产品,云端协议选择"**MQTT**",产品类型选择"**设备**",点击"完成",添加产品成功。
14+
15+
![](../assets/example_product_create.png)
16+
17+
新建产品详细操作请参考[创建产品](/device/product_create.md)
18+
19+
2. #### 新建功能点
20+
21+
选择 设备管理-> 产品管理,产品列表页找到上一步创建的产品“**空调**”,点击名称,进入产品详情页面,选择“**功能点**”选项卡,点击右上角“新建”。
22+
23+
创建一个功能点“**模式**”,输入功能点标识(必填,不可重复)“**mode**”,数据类型选择“**数值**”,数据传输类型选择“**可上报可下发**”,枚举值添加“**制冷**”“**制热**”两个值,点击“完成”,新建功能点成功。
24+
25+
![](../assets/example_datapoint_create_1.png)
26+
27+
再创建一个功能点“**温度**”,输入功能点标识“**temperature**”,数据类型选择“**数值**”,数据传输类型选择“**可上报可下发**”,点击“完成”,新建功能点成功。
28+
29+
![](../assets/example_datapoint_create_2.png)
30+
31+
功能点详细介绍请参考[功能点](/device/product.md#功能点)
32+
33+
3. #### 新建数据流
34+
35+
选择“**数据流**”选项卡,点击右上角“新建”。
36+
37+
数据流名称填入“**空调状态**”,数据格式选择“**JSON**”,流类型选择“**设备数据上报**”,数据流主题填入“**mode_temp**”,功能点选择上一步创建好的两个功能点“**模式**”“**温度**”,点击完成,成功添加数据流。
38+
39+
![](../assets/example_stream_create.png)
40+
41+
数据流详细介绍请参考[数据流](/device/product.md#数据流)
42+
43+
4. #### 新建设备
44+
45+
选择 设备管理->新建,新建一个名为"**空调设备**"的设备,所属产品选择第一步创建的产品"**空调**",设备类型选择"**终端**",上联系统选择"****",点击"下一步",认证信息页面点击"完成",添加设备成功。
46+
47+
![](../assets/example_device_create.png)
48+
49+
新建设备详细操作请参考[创建设备](/device/device_create.md)
50+
51+
5. #### 模拟设备上报数据
52+
53+
选择 测试中心->MQTT客户端,选择上一步创建好的设备“**空调设备**”,点击启动设备,以模拟设备接入 ActorCloud。
54+
55+
![](../assets/example_mqtt_run.png)
56+
57+
在“上报数据”选项卡,输入上面创建的数据流主题“**mode_temp**”,消息字段输入JSON数据“**{"mode":1,"temperature":25}**”(制冷25度),点击“上报数据”,上报成功,右侧“已上报数据”选项卡可看到上报数据。
58+
59+
![](../assets/example_mqtt_report.png)
60+
61+
MQTT客户端详细操作请参考[MQTT客户端](/test_center/mqtt.md#mqtt-客户端)
62+
63+
6. #### 查看设备上报数据
64+
65+
设备事件:进入设备管理,找到上面创建的设备“**空调设备**”,点击设备名称进入设备详情页,选择"设备事件"选项卡,可以看到刚刚上报的数据信息。设备事件详细参考[设备事件](/device/device.html#设备事件)
66+
67+
![](../assets/example_device_event.png)
68+
69+
原始数据:选择"原始数据"选项卡,可以看到被解析出来的上报数据。原始数据详细参考[原始数据](/device/device.html#原始数据)
70+
71+
![](../assets/example_device_data.png)
72+
73+
211 KB
Loading
197 KB
Loading

assets/example_device_create.png

159 KB
Loading

assets/example_device_data.png

188 KB
Loading

assets/example_device_event.png

510 KB
Loading

0 commit comments

Comments
 (0)