Update doc for LoRaWAN demo

doc/16.TencentOS_tiny_LoRaWAN_Getting_Started_Guide.md

@@ -231,50 +231,50 @@ TencentOS_tiny\doc\05.TencentOS_tiny_SDK_documentation.md
 ### 4.1 控制台操作 LoRa 节点
 
 #### 创建项目和产品
-
 1. 登录 [物联网开发平台控制台](https://console.cloud.tencent.com/iotexplorer)，选择【新建项目】。
-2. 在新建项目页面，填写项目基本信息。
+2. 在新建项目页面，填写项目基本信息后，单击【保存】
-    - 项目名称：输入“LoRa温湿度传感器演示”或其他名称。
+    - 项目名称：输入“LoRa 温湿度传感器演示”或其他名称。
     - 项目描述：按照实际需求填写项目描述。
 3. 项目新建成功后，即可新建产品。
 
 #### 新建产品
-
 1. 进入该项目的产品列表页面，单击【新建产品】。
 2. 在新建产品页面，填写产品基本信息。
-    - 产品名称输入“LoRa温湿度传感器”或其他产品名称。
+    - 产品名称：输入“温湿度传感器”或其他产品名称。
-    - 产品类型选择“温湿度传感器”。
+    - 产品类型：选择“温湿度传感器”。
-    - 认证方式选择“密钥认证”。
+    - 认证方式：选择“密钥认证”。
-    - 通信方式选择“LoRaWAN”。
+    - 通信方式：选择“LoRaWAN”。
-
+![](./image/LoRaWAN/explorer_guide_1_1_product_creat_ths_new.png)
-![](./image/LoRaWAN/explorer_guide_1_1_product_creat_ths.png)
+3. 产品新建成功后，您可在产品列表页查看“LoRa 温湿度传感器”。
-
-产品新建成功后，您可在产品列表页查看到“LoRa温湿度传感器”。
 
 #### 创建数据模板
 
-选择“温湿度传感器”类型后，自定义产品功能。
+单击产品名称，进入产品配置页，在【自定义功能】配置项下，单击【新建功能】，自定义产品功能。
-
+![](./image/LoRaWAN/explorer_guide_1_2_product_define_list_new.png)
-![](./image/LoRaWAN/explorer_guide_1_2_product_define_list.png)
 
 #### 配置 LoRaWAN 参数
 
 在设备开发页面中，按需调整 LoRaWAN 参数配置。本示例中使用默认的 OTAA 配置。
-
 ![](./image/LoRaWAN/explorer_guide_1_3_lorawan_profile.png)
 
 #### 设备数据解析
+在设备开发页面中，按需调整设备数据解析。由于 LoRa 类资源有限设备不适合直接传输 JSON 格式数据，使用“设备数据解析”可以将设备原始数据转化为产品 JSON 数据。
 
-在设备开发页面中，按需调整 设备数据解析。由于 LoRa 类资源有限设备不适合直接传输 JSON 格式数据，使用“设备数据解析”可以将设备原始数据转化为产品JSON数据。
+##### 设备数据协议
+在本示例中，设备上行数据共4字节：
+- 第1字节：温度。
+- 第2字节：相对湿度。
+- 第3、4字节：表示上报周期（单位秒）。
+- 设备下行数据为2字节：上报周期（单位秒）。
 
-**设备数据协议**
+##### 数据解析脚本
+上行数据解析的脚本主函数为 RawToProtocol，其带有 fPort、bytes 两个入参：
+- fPort：设备上报的 LoRaWAN 协议数据的 FPort 字段。
+- bytes：设备上报的 LoRaWAN 协议数据的 FRMPayload 字段。
 
-在本示例中，设备上行数据共4字节: 第1字节为温度，第2字节为相对湿度，第3、4字节表示上报周期(单位秒)；设备下行数据为2字节：上报周期(单位秒)。
+脚本主函数的出参为产品数据模版协议格式的对象。
-
-**数据解析脚本**
-
-在上行数据解析部分，javascript示例代码如下：
 
+在上行数据解析部分，javascript 示例代码如下：
 ```javascript
 function RawToProtocol(fPort, bytes) {
     var data = {
@@ -289,8 +289,13 @@ function RawToProtocol(fPort, bytes) {
 }
 ```
 
-在下行数据解析部分，javascript示例代码如下：
+下行数据解析的脚本主函数为 ProtocolToRaw，其入参为产品数据模版协议格式的对象，其出参为至少3个字节的数组：
 
+- 第1字节：下发给设备的 LoRaWAN 协议数据的 FPort 字段。
+- 第2字节：bytes 为下发给设备的 LoRaWAN 协议数据的 MType（0表示 Unconfirmed Data Down，1表示 Confirmed Data Down）。
+- 第3字节：开始为下发给设备的 LoRaWAN 协议数据的 FRMPayload 字段。
+
+在下行数据解析部分，javascript 示例代码如下：
 ```javascript
 function ProtocolToRaw(obj) {
     var data = new Array();
@@ -304,56 +309,51 @@ function ProtocolToRaw(obj) {
 
 ![](./image/LoRaWAN/explorer_guide_1_4_product_script.png)
 
-**脚本模拟测试**
+##### 脚本模拟测试
+您也可使用数据解析页面下方的模拟调试工具，如需开发更多的功能，请使用以下模拟脚本。
 
-这里也可以使用数据解析页面下方的模拟调试工具，如果开发更多的功能，这个模拟脚本将会提供很大帮助。
+- 上行消息
 
-1. 上行消息
+设备原始数据为 0x113DB80B，我们将其转化为数组，即上行模拟数据为：[17,69,30,0]，填入设备上行数据的编辑框中。单击【运行】，即可在模拟调试界面右侧查看结果。
-
-设备原始数据为 0x113DB80B，我们将其转化为数组，即上行模拟数据为：[17,69,30,0]，填入设备上行数据的编辑框中。
-点击运行，即可在模拟调试界面右侧看到结果。
 
 ![](./image/LoRaWAN/explorer_guide_1_4_product_script_up_test.png)
 
-2. 下行消息
+- 下行消息
 
 模拟测试数据如下，将其填入设备下行数据的编辑框中：
 
 ```json
 {
-  "params": {
+	"params": {
-    "period": 15
+		"period": 15
-  }
+	}
 }
 ```
 
 ![](./image/LoRaWAN/explorer_guide_1_4_product_script_down_test.png)
 
-
 #### 创建测试设备
 
 在设备调试页面中，单击【新建设备】，设备名为 dev001。
 
-DevEUI 等信息可从LoRa节点开发板背面贴纸上获取。
+DevEUI 等信息可从 LoRa 节点开发板背面贴纸上获取。
 
-![](./image/LoRaWAN/explorer_guide_1_5_dev_creat_otaa.png)
+![](./image/LoRaWAN/explorer_guide_1_5_dev_creat_otaa_new.png)
 
 ### 4.2 控制台操作 LoRa 网关
 
-1. 登录 [物联网开发平台控制台](https://console.cloud.tencent.com/iotexplorer)，选择上面章节 “控制台操作 LoRa 节点” 中对应的项目。
+1. 登录 [物联网开发平台控制台](https://console.cloud.tencent.com/iotexplorer)，选择上文 “控制台操作 LoRa 节点” 中对应的项目。
-2. 在左侧工具列表中选择“服务中心”中的“LoRa网关管理”，并在“LoRa网关管理”页面中选择“新建网关”。
+2. 在左侧工具列表中，选择【服务中心】>【LoRa 网关管理】。
-   
+3. 进入 LoRa 网关管理页面，选择【添加网关】。
 ![](./image/LoRaWAN/explorer_guide_3_1_gateway_icon.png)
 
-3. 在新建网关页面，填写网关基本信息。
+4. 在新建网关页面，填写网关基本信息。
-    - 网关名称，本示例中填写 GW1。
+    - 网关名称：本示例中填写 GW1。
-    - GwEUI，为网关唯一ID。本例中根据 ST NUCLEO LoRa GW 背部的 MAC 地址，将6字节mac地址的中间补足0xffff。  
+    - GwEUI：为网关唯一ID。本例中根据 ST NUCLEO LoRa GW 背部的 MAC 地址，将6字节 MAC 地址的中间补足0xffff。  
 ![](./image/LoRaWAN/explorer_guide_3_2_gateway_mac.png)
-    - 是否公开。选择“是”，表示社区开发者可在社区网络中看到该网关，并可通过这个网关进行LoRa节点接入。我们鼓励开发者们公开自己的网关，尽可能帮助到其他开发者。选择“否”，则只有用户自己才能看到该网关。
+    - 是否公开：选择“是”，表示社区开发者可在社区网络查看该网关，并可通过这个网关进行 LoRa 节点接入；选择“否”，则仅用户自己能查看该网关。
-
+![](./image/LoRaWAN/explorer_guide_3_3_gateway_creat_new.png)
-![](./image/LoRaWAN/explorer_guide_3_3_gateway_creat.png)
+5. 网关新建成功后，您可在网关列表页查看“GW1”。
-
-4. 网关新建成功后，您可在网关列表页查看到“GW1”。
 
 ![](./image/LoRaWAN/explorer_guide_3_4_gateway_list.png)
 
@@ -363,86 +363,33 @@ DevEUI 等信息可从LoRa节点开发板背面贴纸上获取。
 
 整个系统搭建需要由LRWAN_GS_LF1网关（网关模组和 STM32F746 Nucleo核心板）、5V适配器和电脑组成。
 
-先使用5V适配器通过USB线连接到 LRWAN_GS_LF1 网关的网关模组上的 Micro USB 接口，给整个网关供电。
+1. 先使用 5V 适配器通过 USB 线连接到 LRWAN_GS_LF1 网关的网关模组上的 Micro USB 接口，给整个网关供电。
-Nucleo 核心板上的 Micro USB 口(非以太网口那边的 Micro USB 口)通过USB线连接到PC端，可以实现虚拟串口的功能。
+2. Nucleo 核心板上的 Micro USB 口（非以太网口那边的 Micro USB 口），通过 USB 线连接到 PC 端，可以实现虚拟串口的功能。
-
+3. 网关开发板通过网线连接到上一级路由器的 LAN 口，从而可以实现 DHCP 的方式连接以太网。
-网关开发板通过网线连接到上一级路由器的LAN口，从而可以实现DHCP的方式连接以太网。
 ![](./image/LoRaWAN/explorer_guide_4_1_gateway_connect.png)
 
 #### 串口准备
 
-上一步硬件连接好之后，打开PC上的设备管理器，可以看到网关所对应的串口(请保证安装了 stlink 驱动)。
+1. 硬件连接成功后，打开 PC 上的设备管理器，即可查看网关所对应的串口（请确保已安装 stlink 驱动）。
 
 ![](./image/LoRaWAN/explorer_guide_4_2_gateway_comm.png)
 
-打开串口工具，做好相应配置后，打开串口。
+2. 打开串口工具，做好相应配置后，打开串口。
    - 端口号。本例中为 COM5。
    - 波特率。本例中为 115200。
 
-![](./image/LoRaWAN/explorer_guide_4_3_gateway_comm_set.png)
+![](./image/LoRaWAN/explorer_guide_4_3_gateway_comm_set_new.png)
 
-当您第一次使用该网关时，串口会打印以下默认配置信息：
-
-```
-    _/_/_/    _/_/_/    _/_/_/  _/_/_/  _/      _/    _/_/_/  _/    _/  _/_/_/
-   _/    _/    _/    _/          _/    _/_/    _/  _/        _/    _/  _/     
-  _/_/_/      _/      _/_/      _/    _/  _/  _/  _/  _/_/  _/_/_/_/  _/_/_/  
- _/    _/    _/          _/    _/    _/    _/_/  _/    _/  _/    _/  _/       
-_/    _/  _/_/_/  _/_/_/    _/_/_/  _/      _/    _/_/_/  _/    _/  _/        
-
-Powered by RisingHF & STMicroelectronics
--------------------------------------------------------------------------------
-           VERSION: 2.1.7, Nov  6 2018
-               LOG: OFF
-           AT ECHO: ON
-          BAUDRATE: 115200bps
-           MACADDR: 00:80:E1:01:55:42
-          ETHERNET: DHCP
-              DNS1: 114.114.114.114
-              DNS2: 8.8.8.8
-        NTP SERVER: 1.ubuntu.pool.ntp.org
-       EUI PADDING: {3, FF}, {4, FF}
-        GATEWAY ID: 0080E1FFFF015542
-           LORAWAN: Public
-    LORAWAN SERVER: cn1.loriot.io
-   UPLINK UDP PORT: 1780
- DOWNLINK UDP PORT: 1780
-          CHANNEL0: 471500000, A, SF7/SF12, BW125KHz    (LORA_MULTI_SF)
-          CHANNEL1: 471700000, A, SF7/SF12, BW125KHz    (LORA_MULTI_SF)
-          CHANNEL2: 471900000, A, SF7/SF12, BW125KHz    (LORA_MULTI_SF)
-          CHANNEL3: 472100000, A, SF7/SF12, BW125KHz    (LORA_MULTI_SF)
-          CHANNEL4: 472300000, B, SF7/SF12, BW125KHz    (LORA_MULTI_SF)
-          CHANNEL5: 472500000, B, SF7/SF12, BW125KHz    (LORA_MULTI_SF)
-          CHANNEL6: 472700000, B, SF7/SF12, BW125KHz    (LORA_MULTI_SF)
-          CHANNEL7: 472900000, B, SF7/SF12, BW125KHz    (LORA_MULTI_SF)
-          CHANNEL8: OFF                                 (LORA_STANDARD)
-          CHANNEL9: OFF                                 (FSK)
--------------------------------------------------------------------------------
-Concentrator starting...
-Concentrator Radio A type SX1255
-Concentrator Radio B type SX1255
-Concentrator started (2926ms)
-ST LoRa GW V2
-Ethernet starting...
-Ethernet started
-DHCP IP: 192.168.3.249
-Downlink UDP Connected
-Uplink UDP Connected
-```
 
 #### 配置修改
 
 请按照如下步骤完成相关配置：
-1） 按照上图完成硬件连接和系统搭建。  
+1. 按照上图完成硬件连接和系统搭建。  
-2） 配置服务器地址。本示例中设置的是腾讯云物联网开发平台的LoRa服务器地址(接入域名：loragw.things.qcloud.com，接入端口：1700)。  
+2. 配置服务器地址。本示例中设置的是腾讯云物联网开发平台的 LoRa 服务器地址（接入域名：`loragw.things.qcloud.com`，接入端口：1700）。 
-
 ```
 AT+PKTFWD=loragw.things.qcloud.com,1700,1700  
 ```
-
+3. 配置频率计划。调整频点信息到486.3MHz - 487.7 MHz，指令修改如下（需要逐条发送）：
-3） 配置频率计划。  
-这里我们调整频点信息到 486.3 ~ 487.7 MHz，指令修改如下，需要逐条来发送：
-
 ```
 AT+CH=0,486.3,A
 AT+CH=1,486.5,A
@@ -455,98 +402,69 @@ AT+CH=7,487.7,B
 AT+CH=8,OFF
 AT+CH=9,OFF
 ```
-
+示例截图如下所示：
-4） 其他指令。  
-    a.	通过“AT+log=on”打开网关日志。  
-    b.	通过“AT+EUI”查询网关的ID。  
-
 ![](./image/LoRaWAN/explorer_guide_4_4_gateway_config.png)
+4. 其他指令。  
+ - 通过“AT+log=on”打开网关日志。  
+ - 通过“AT+EUI”查询网关的 ID。  
+
 
 #### 运行
 
 通过 AT+Reset 即可复位网关，开始服务器连接。
 
 从串口日志查看：
-
 ```
 LORAWAN SERVER: loragw.things.qcloud.com 
 ```
 表明服务器地址修改成功。
-
 ```
 Ethernet started
 DHCP IP: 192.168.3.249
 Downlink UDP Connected
 Uplink UDP Connected
 ```
-表明网关DHCP入网成功，网络连接正常。
+表明网关 DHCP 入网成功，网络连接正常。
 
-### 4.4 LoRa节点实物操作
-
-LoRa节点采用 ST NUCLEO LoRa Sensor 开发板。
 
+### 4.4 LoRa 节点实物操作
 #### 编译及下载
 
-Step 1. 打开 TencentOS tiny提供的 LoRaWAN例程
+##### Step 1. 下载 LoRaWAN 例程
-
+1. 请下载 TencentOS tiny 官方开源仓 [下载源码](https://github.com/Tencent/TencentOS-tiny) 。
-TencentOS tiny官方开源仓下载源码，地址为：https://github.com/Tencent/TencentOS-tiny
+2. 进入`<TencentOS-tiny\board\NUCLEO_STM32L073RZ\KEIL\lorawan>`目录，打开 TencentOS_tiny.uvprojx 工程。
-
+3. 示例工程包含 STM32L073 外设驱动、TencentOS tiny 内核、AT 框架、RHF76 LoRaWAN 模组驱动、LoRaWAN 示例案例。
-进入 <TencentOS-tiny\board\NUCLEO_STM32L073RZ\KEIL\lorawan> 目录，打开TencentOS_tiny.uvprojx工程：
-
-![](./image/LoRaWAN/explorer_guide_2_1_node_project.png)
-
-Step 2. 示例工程代码简介
-
-示例工程包含STM32L073 外设驱动、TencentOS tiny内核、AT框架、RHF76 LoRaWAN模组驱动、LoRaWAN 示例案例，如下图所示：
- 
-![](./image/LoRaWAN/explorer_guide_2_2_node_source_new.png)
-
-TencentOS tiny提供的LoRaWAN API函数在lora_module_wrapper.h 头文件中声明，用户调用rhf76_lora_init(HAL_UART_PORT_1);函数进行模组初始化，然后调用tos_lora_module_join入网，入网成功后即可使用tos_lora_module_send 函数向LoRaWAN网关和服务器发送数据了。
-
-如果用户需要处理服务器下发的数据，调用tos_lora_module_recv_register(void* mcps_indication)函数注册一个回调，用于处理下行数据即可。
-
-Step 3. 代码修改
-
-首先修改 \examples\LoRaWAN\lora_demo.c
 
+##### Step 2. 代码修改
+1. 请先修改`\examples\LoRaWAN\lora_demo.c.`。
 ```c
 tos_lora_module_join_otaa("8cf957200000f806", "8cf957200000f8061b39aaaaad204a72");
 ```
-
+填入节点相应的 DevEUI 和 AppKEY，可从 LoRa 节点开发板背面贴纸上获取。
-这里填入节点相应的 DevEUI 和 AppKEY，可从LoRa节点开发板背面贴纸上获取。
+2. 修改`\devices\rhf76_lora\RHF76.h`。
-
-
-接着修改 \devices\rhf76_lora\RHF76.h
-
 ```c
 #define RHF76_ATCMD_SET_CHANNEL                 "at+ch=num,0-7\r\n"
 ```
-
+由于本示例中计划使用80 - 87信道，因此调整为：
-由于本示例中计划使用 80~87 信道，因此调整为：
-
 ```c
 #define RHF76_ATCMD_SET_CHANNEL                 "at+ch=num,80-87\r\n"
 ```
 
-Step 4. 编译
+##### Step 3. 编译
+单击 MDK 工具栏【Rebuild All】，编译整个工程。
 
-点击 MDK 工具栏上的 “Rebuild All”，编译整个工程。
 
-Step 5. 下载
+##### Step 4. 下载
-
+单击 MDK 工具栏【Download】，下载编译好的固件。
-点击 MDK 工具栏上的 “Download”，下载编译好的固件。
 
 #### 查看运行结果
 
-节点下载好固件之后，会自动重启运行，从串口可以看到设备的运行日志。
+1. 节点下载好固件后，会自动重启运行，从串口即可查看设备的运行日志。
-
+![](./image/LoRaWAN/explorer_guide_2_node_run_new.png)
-![](./image/LoRaWAN/explorer_guide_2_node_run.png)
+2. 当您看到串口打印如下日志，即说明 LoRa 节点已经通过网关成功入网。
-
-当看到串口打印如下日志，即说明 LoRa 节点已经通过网关成功入网。
-
 ```
 --->+JOIN: Network joined
---->+JOIN: NetID 000000 DevAddr 01:4E:F6:1D
+--->+JOIN: NetID 000035 DevAddr 6B:CC:9B:5D
 ```
 
 ### 4.5 查看设备状态
@@ -554,42 +472,31 @@ Step 5. 下载
 1. 保持 LoRa 节点和 LoRa 网关 为运行状态。
 2. 进入【控制台】>【产品开发】>【设备调试】，可查看到设备 "dev001" 。
 3. 单击【调试】，可进入设备详情页。
-
+![](./image/LoRaWAN/explorer_guide_5_1_dev_status_new.png)
-![](./image/LoRaWAN/explorer_guide_5_1_dev_status.png)
-
 4. 单击【设备属性】，可查询设备上报到开发平台的最新数据及历史数据。
-
+ - 设备属性的最新值：会显示设备上报的最新数据。
-- 设备属性的最新值：会显示设备上报的最新数据
+ - 设备属性的更新时间：显示数据的更新时间。
-- 设备属性的更新时间：显示数据的更新时间
+![](./image/LoRaWAN/explorer_guide_5_1_dev_property_new_new.png)
-
-![](./image/LoRaWAN/explorer_guide_5_1_dev_property_new.png)
-
 5. 单击【查看】，可查看某个属性的历史上报数据。
 
 ### 4.6 查看设备通信日志
 
-1. 单击【设备日志】，可查询该设备某段时间范围的所有上下行数据。
+单击【设备日志】，可查询该设备某段时间范围的所有上下行数据。
-
+ - 上行：上行指设备端上报到开发平台的数据。
-上行：上行指设备端上报到开发平台的数据。
+ - 下行：下行指从开发平台下发到设备的数据。
-下行：下行指从开发平台下发到设备的数据。
+![](./image/LoRaWAN/explorer_guide_5_1_dev_log_new_new.png)
-
-![](./image/LoRaWAN/explorer_guide_5_1_dev_log_new.png)
 
 ### 4.7 在线调试
 
 1. 当 LoRa 节点 成功连接到物联网开发平台后，您可在控制台【设备调试】列表，单击【调试】，进入在线调试。
 2. 将“上报周期”设置为15秒，单击【发送】。
-
 ![](./image/LoRaWAN/explorer_guide_6_1_debug.png)
+3. 查看 LoRa 节点的串口日志，可查看已成功接收到下发的数据。
+ >?
+ - 由于本示例中 LoRa 节点是 LoRaWAN Class A 类设备，这类设备不会立即下发数据，需要在有数据上行后，服务器才会向该设备下行数据。
+ - 因此在 LoRa 节点上报数据之后，才能查看下发的周期调整命令。
 
-3. 查看 LoRa 节点的串口日志，可查看到成功接收到下发的数据。
+LoRa 节点的串口会显示如下日志，表示成功下发了指令到设备端。
-
-由于本示例中 LoRa 节点 是 LoRaWAN Class A 类设备，这类设备不会立即下发数据，需要在有数据上行后，服务器才会向该设备下行数据。
-
-因此在 LoRa 节点上报数据之后，才能看到下发的周期调整命令。
-
-4. LoRa 节点的串口会显示如下日志，表示成功下发了指令到设备端。
-
 ```
 rhf76_incoming_data_process 4: 0F00
 len: 2
@@ -597,4 +504,3 @@ data[0]: 15
 data[1]: 0
 report_period: 15
 ```
-