diff --git a/docs/Application_guide/zh/cloud/AliyunCloud.md b/docs/Application_guide/zh/cloud/AliyunCloud.md new file mode 100644 index 0000000000000000000000000000000000000000..417bc762840d9a60e807beb78fb1de67820734de --- /dev/null +++ b/docs/Application_guide/zh/cloud/AliyunCloud.md @@ -0,0 +1,240 @@ +# 阿里云应用指导文档 + +## 1. 功能简介 + +基于MQTT协议连接到阿里云物联网平台，设备快速连云，支持“一机一密和“一型一密”两种认证方式。 + +## 2. 应用场景说明 + +通过阿里云物联网平台对同一产品下的设备进行管理，处理设备事件，完成消息转发，OTA升级等应用功能。 + +## 3. 功能应用流程 + +### 3.1. 阿里云物联网平台 + +详细文档请查看：https://help.aliyun.com/document_detail/145493.html + +#### 3.1.1.名称解释 + +连接三元组：三元组指的是ProductKey（产品标识）DeviceName（设备名）DeviceSecret（设备密钥），是设备与物联网平台建立连接时的认证信息。 + +一机一密：每个设备烧录其唯一的设备证书（ProductKey、DeviceName 和 DeviceSecret），当设备与物联网平台建立连接时，物联网平台对其携带的设备证书信息进行认证。 + +一型一密：同一产品下所有设备可以烧录相同产品证书（即 ProductKey 和 ProductSecret ），设备发送激活请求时，物联网平台进行产品身份确认，认证通过，下发该设备对应的 DeviceSecret + +#### 3.1.2.平台地址 + +- 阿里云：https://www.aliyun.com + + ![aliyun_1](../media/cloud/aliyun_1.png) + + 注册个人或者企业账号进行账号登录 + +#### 3.1.3.创建实例 + +- 进入物联网平台 + + ![aliyun_2.png](../media/cloud/aliyun_3.png) + +- 选择实例，根据需求选择，试用选择公共实例即可 + + ![image-20230322101737405](../media/cloud/aliyun_2.png) + +- 实例概览 + + ![image-20230322102046889](../media/cloud/aliyun_4.png) + +#### 3.1.4.创建产品 + +- 点击实例进行产品创建 + + ![image-20230322102235862](../media/cloud/aliyun_5.png) + +- 按需填写产品创建信息 + + ![image-20230322102434008](../media/cloud/aliyun_6.png) + +- 产品列表展示 + + ![image-20230322102516271](../media/cloud/aliyun_7.png) + +#### 3.1.5.查看产品信息 + +- 产品信息包含ProductKey 和 ProductSecret + + ![image-20230322144045597](../media/cloud/aliyun_14.png) + +#### 3.1.6.创建设备 + +- 选择产品进行设备创建 + + ![image-20230322102731999](../media/cloud/aliyun_8.png) + +- 添加设备 + + ![image-20230322102805164](../media/cloud/aliyun_9.png) + +- 手动编辑设备信息 + + ![image-20230322102932866](../media/cloud/aliyun_10.png) + +- 设备创建完成后处于未激活状态 + + ![image-20230322103049475](../media/cloud/aliyun_11.png) + +#### 3.1.7.查看设备信息 + +- 查看设备信息，设备信息包含ProductKey（产品标识）DeviceName（设备名）DeviceSecret（设备密钥） + + ![image-20230322103634903](../media/cloud/aliyun_13.png) + +### 3.2. QuecPython连接阿里云 + +QuecPython 官网地址：https://python.quectel.com + +#### 3.2.1.开发环境搭建 + +- 驱动安装 + + 驱动下载地址：https://python.quectel.com/download + + 选择对应平台的USB驱动进行安装 + + ![image-20230322110809659](../media/cloud/aliyun_15.png) + +- QPYcom 图形化工具下载 + + 应用调试基于此工具，下载地址：https://python.quectel.com/download + + ![image-20230322111017197](../media/cloud/aliyun_16.png) + +- 模组固件下载 + + 根据所用的模组型号选择固件下载后烧录，此文档调试选择EC600N CNLE进行演示。 + + ![image-20230322111312207](../media/cloud/aliyun_17.png) + +#### 3.2.2.设备调试 + +- 打开电脑设备管理器，查看端口 + + ![image-20230322114434665](../media/cloud/aliyun_18.png) + +- 选择 Quectel USB MI05 COM Port串口，使用QPYcom工具打开该串口 + + ![image-20230322114711697](../media/cloud/aliyun_19.png) + +- 查询SIM卡状态和拨号状态 + + API 使用以及说明查阅Wiki文档：https://python.quectel.com/wiki/#/ + + ```python + >>> import sim + >>> sim.getStatus() # 返回1表示SIM状态正常 + 1 + >>> import dataCall + >>> dataCall.getInfo(1,2) # 成功返回拨号信息 + (1, 0, [1, 0, '10.145.246.10', '211.138.180.2', '211.138.180.3'], [1, 0, '::', '::', '::']) + >>> + ``` + +#### 3.2.3.设备连云 + +阿里云API 使用以及说明查阅Wiki文档：https://python.quectel.com/wiki/#/zh-cn/api/QuecPythonThirdlib + +- 导入阿里云API + + ```python + >>> from aLiYun import aLiYun + ``` + +- 创建aliyun连接对象 + + ```python + >>> from aLiYun import aLiYun + + >>> productKey = "a1YoiRfLSbV" + >>> DeviceName = "QuecPyhon_Dev" + >>> DeviceSecret = "a86aadbbe78de7b8248adfc09e458bb9" + >>> productSecre = None + >>> + >>> ali_obj = aLiYun(productKey, productSecre, DeviceName, DeviceSecret) + ``` + +- 注册事件回调函数 + + ```python + >>> def event_callback(topic, data): + ... print("aliyun callback recv: {}".format(data)) + ... + ... + ... + >>> ali_obj.setCallback(event_callback) + ``` + +- 设置连接参数并连接平台,state为0时表示连接成功,连接成功后调用start方法 + + ```python + >>> clientID = "Quecpython" + >>> clean_session = False + >>> keepAlive = 300 + >>> reconn = True + + >>> state = ali_obj.setMqtt(clientID, clean_session=False, keepAlive=300,reconn=True) + >>> state + 0 + >>> ali_obj.start() + ``` + + 云端查看设备状态，由创建时未激活状态变成在线状态 + + ![image-20230322133745959](media/cloud/AliyunCloud/aliyun_20.png) + +#### 3.2.4.订阅Topic + +- 根据平台订阅规则选择操作权限为订阅的Topic + + /a1YoiRfLSbV/${deviceName}/user/get：$ {deviceName}替换成我们的设备名称即可,例如"/a1YoiRfLSbV/QuecPyhon_Dev/user/get" + + ![image-20230322134239010](../media/cloud/aliyun_21.png) + + ```python + >>> ali_obj.subscribe("/a1YoiRfLSbV/QuecPyhon_Dev/user/get") + 0 + >>> + ``` + +#### 3.2.5.数据上行 + +- 发布主题消息到平台，Topic选择操作权限为发布的进行数据上报 + + ```python + >>> ali_obj.publish("/a1YoiRfLSbV/QuecPyhon_Dev/user/update", "Hello, Aliyun!") + True + >>> + ``` + + 云端查看设备上行消息 + + ![image-20230322135259133](../media/cloud/aliyun_23.png) + + ![image-20230322135342205](../media/cloud/aliyun_24.png) + +#### 3.2.6.数据下行 + +- 找到设备订阅的Topic，选择发布消息 + + ![image-20230322135552300](../media/cloud/aliyun_25.png) + + ![image-20230322135630333](../media/cloud/aliyun_26.png) + + 设备查看平台下行数据,通过我们注册的回调函数接收数据 + + ![image-20230322135957158](../media/cloud/aliyun_27.png) + +## 4. 注意事项 + +- 设备进行云连接时需确认网络状态，例如SIM卡是否能够注网，设备是否拨号成功 +- 确保所用模组包含阿里云连接API可供使用 +- Topic注意操作权限 + diff --git a/docs/Application_guide/zh/media/cloud/aliyun_1.png b/docs/Application_guide/zh/media/cloud/aliyun_1.png new file mode 100644 index 0000000000000000000000000000000000000000..e3ceac49f4f5410524c2c0e6a158fae6dcb6a8e6 Binary files /dev/null and b/docs/Application_guide/zh/media/cloud/aliyun_1.png differ diff --git a/docs/Application_guide/zh/media/cloud/aliyun_10.png b/docs/Application_guide/zh/media/cloud/aliyun_10.png new file mode 100644 index 0000000000000000000000000000000000000000..428c26ac9bc9850e016014d3264ed12dcf52e8f6 Binary files /dev/null and b/docs/Application_guide/zh/media/cloud/aliyun_10.png differ diff --git a/docs/Application_guide/zh/media/cloud/aliyun_11.png b/docs/Application_guide/zh/media/cloud/aliyun_11.png new file mode 100644 index 0000000000000000000000000000000000000000..9235374d3f46893e343fac56dd252ddbcb98319c Binary files /dev/null and b/docs/Application_guide/zh/media/cloud/aliyun_11.png differ diff --git a/docs/Application_guide/zh/media/cloud/aliyun_12.png b/docs/Application_guide/zh/media/cloud/aliyun_12.png new file mode 100644 index 0000000000000000000000000000000000000000..9235374d3f46893e343fac56dd252ddbcb98319c Binary files /dev/null and b/docs/Application_guide/zh/media/cloud/aliyun_12.png differ diff --git a/docs/Application_guide/zh/media/cloud/aliyun_13.png b/docs/Application_guide/zh/media/cloud/aliyun_13.png new file mode 100644 index 0000000000000000000000000000000000000000..25de8c1e7afccc7d94f26df9f0ebbe949dd5ac9c Binary files /dev/null and b/docs/Application_guide/zh/media/cloud/aliyun_13.png differ diff --git a/docs/Application_guide/zh/media/cloud/aliyun_14.png b/docs/Application_guide/zh/media/cloud/aliyun_14.png new file mode 100644 index 0000000000000000000000000000000000000000..11a8d78f7600fb8e57a3f33ac29ddd06b4d790e3 Binary files /dev/null and b/docs/Application_guide/zh/media/cloud/aliyun_14.png differ diff --git a/docs/Application_guide/zh/media/cloud/aliyun_15.png b/docs/Application_guide/zh/media/cloud/aliyun_15.png new file mode 100644 index 0000000000000000000000000000000000000000..dc600798e1d06096caac590befcbf2476e844d45 Binary files /dev/null and b/docs/Application_guide/zh/media/cloud/aliyun_15.png differ diff --git a/docs/Application_guide/zh/media/cloud/aliyun_16.png b/docs/Application_guide/zh/media/cloud/aliyun_16.png new file mode 100644 index 0000000000000000000000000000000000000000..ed9d8f600f44ddb8e3e94c2102b02a1cf5a7878e Binary files /dev/null and b/docs/Application_guide/zh/media/cloud/aliyun_16.png differ diff --git a/docs/Application_guide/zh/media/cloud/aliyun_17.png b/docs/Application_guide/zh/media/cloud/aliyun_17.png new file mode 100644 index 0000000000000000000000000000000000000000..1bb34cc23f107c924d425750b9cf96641adacf72 Binary files /dev/null and b/docs/Application_guide/zh/media/cloud/aliyun_17.png differ diff --git a/docs/Application_guide/zh/media/cloud/aliyun_18.png b/docs/Application_guide/zh/media/cloud/aliyun_18.png new file mode 100644 index 0000000000000000000000000000000000000000..2e242ed4f8be545ddf5d12436851b14fbaec32b9 Binary files /dev/null and b/docs/Application_guide/zh/media/cloud/aliyun_18.png differ diff --git a/docs/Application_guide/zh/media/cloud/aliyun_19.png b/docs/Application_guide/zh/media/cloud/aliyun_19.png new file mode 100644 index 0000000000000000000000000000000000000000..f3b2f5d49defae53a04338295a4ed39d6c13556c Binary files /dev/null and b/docs/Application_guide/zh/media/cloud/aliyun_19.png differ diff --git a/docs/Application_guide/zh/media/cloud/aliyun_2.png b/docs/Application_guide/zh/media/cloud/aliyun_2.png new file mode 100644 index 0000000000000000000000000000000000000000..1eb54084768a424f3c1b87b80c8e8ca45dc282ca Binary files /dev/null and b/docs/Application_guide/zh/media/cloud/aliyun_2.png differ diff --git a/docs/Application_guide/zh/media/cloud/aliyun_20.png b/docs/Application_guide/zh/media/cloud/aliyun_20.png new file mode 100644 index 0000000000000000000000000000000000000000..ed8bd04bd7eab1d75e633ae297e19143fa233901 Binary files /dev/null and b/docs/Application_guide/zh/media/cloud/aliyun_20.png differ diff --git a/docs/Application_guide/zh/media/cloud/aliyun_21.png b/docs/Application_guide/zh/media/cloud/aliyun_21.png new file mode 100644 index 0000000000000000000000000000000000000000..cd56f038eb1be4f69839948a3f73f1f12d163f4f Binary files /dev/null and b/docs/Application_guide/zh/media/cloud/aliyun_21.png differ diff --git a/docs/Application_guide/zh/media/cloud/aliyun_22.png b/docs/Application_guide/zh/media/cloud/aliyun_22.png new file mode 100644 index 0000000000000000000000000000000000000000..cd56f038eb1be4f69839948a3f73f1f12d163f4f Binary files /dev/null and b/docs/Application_guide/zh/media/cloud/aliyun_22.png differ diff --git a/docs/Application_guide/zh/media/cloud/aliyun_23.png b/docs/Application_guide/zh/media/cloud/aliyun_23.png new file mode 100644 index 0000000000000000000000000000000000000000..7ad84103121a31b476cd7cfc5c17c789cb9fc5ae Binary files /dev/null and b/docs/Application_guide/zh/media/cloud/aliyun_23.png differ diff --git a/docs/Application_guide/zh/media/cloud/aliyun_24.png b/docs/Application_guide/zh/media/cloud/aliyun_24.png new file mode 100644 index 0000000000000000000000000000000000000000..4da3274e7d36478efec548f2c03d5d56d32019a7 Binary files /dev/null and b/docs/Application_guide/zh/media/cloud/aliyun_24.png differ diff --git a/docs/Application_guide/zh/media/cloud/aliyun_25.png b/docs/Application_guide/zh/media/cloud/aliyun_25.png new file mode 100644 index 0000000000000000000000000000000000000000..3aaeac5135a12400360e564fd36aa6b588f11587 Binary files /dev/null and b/docs/Application_guide/zh/media/cloud/aliyun_25.png differ diff --git a/docs/Application_guide/zh/media/cloud/aliyun_26.png b/docs/Application_guide/zh/media/cloud/aliyun_26.png new file mode 100644 index 0000000000000000000000000000000000000000..91d4a08aa3a1df2cb715afa68306d6d95c2fce91 Binary files /dev/null and b/docs/Application_guide/zh/media/cloud/aliyun_26.png differ diff --git a/docs/Application_guide/zh/media/cloud/aliyun_27.png b/docs/Application_guide/zh/media/cloud/aliyun_27.png new file mode 100644 index 0000000000000000000000000000000000000000..e221f7cfc7128c9e4a88ea8db2775195372d3301 Binary files /dev/null and b/docs/Application_guide/zh/media/cloud/aliyun_27.png differ diff --git a/docs/Application_guide/zh/media/cloud/aliyun_3.png b/docs/Application_guide/zh/media/cloud/aliyun_3.png new file mode 100644 index 0000000000000000000000000000000000000000..daed4119d1b5723ba3806fd4c3ea9f42fbbc3a3c Binary files /dev/null and b/docs/Application_guide/zh/media/cloud/aliyun_3.png differ diff --git a/docs/Application_guide/zh/media/cloud/aliyun_4.png b/docs/Application_guide/zh/media/cloud/aliyun_4.png new file mode 100644 index 0000000000000000000000000000000000000000..6b348c77591d9800977880fc4242f3f69336a934 Binary files /dev/null and b/docs/Application_guide/zh/media/cloud/aliyun_4.png differ diff --git a/docs/Application_guide/zh/media/cloud/aliyun_5.png b/docs/Application_guide/zh/media/cloud/aliyun_5.png new file mode 100644 index 0000000000000000000000000000000000000000..5401fcc90366a172f62fa1e595addaed5bfc0b8f Binary files /dev/null and b/docs/Application_guide/zh/media/cloud/aliyun_5.png differ diff --git a/docs/Application_guide/zh/media/cloud/aliyun_6.png b/docs/Application_guide/zh/media/cloud/aliyun_6.png new file mode 100644 index 0000000000000000000000000000000000000000..ab74e76f2c6aadf254f2d9cbfdaf05842ec54a2d Binary files /dev/null and b/docs/Application_guide/zh/media/cloud/aliyun_6.png differ diff --git a/docs/Application_guide/zh/media/cloud/aliyun_7.png b/docs/Application_guide/zh/media/cloud/aliyun_7.png new file mode 100644 index 0000000000000000000000000000000000000000..ea5bbf6604d2221deadaa6e601b5d67c781dc3cf Binary files /dev/null and b/docs/Application_guide/zh/media/cloud/aliyun_7.png differ diff --git a/docs/Application_guide/zh/media/cloud/aliyun_8.png b/docs/Application_guide/zh/media/cloud/aliyun_8.png new file mode 100644 index 0000000000000000000000000000000000000000..cea6401f83e296e88a487c4fdbdf6f3f8e0977a9 Binary files /dev/null and b/docs/Application_guide/zh/media/cloud/aliyun_8.png differ diff --git a/docs/Application_guide/zh/media/cloud/aliyun_9.png b/docs/Application_guide/zh/media/cloud/aliyun_9.png new file mode 100644 index 0000000000000000000000000000000000000000..c78c2d310ec8f336ab0fe669d6b4ae1cd70f802f Binary files /dev/null and b/docs/Application_guide/zh/media/cloud/aliyun_9.png differ