modified: docs/workshop/hangzhou/README.md

modified: docs/workshop/hangzhou/codec_plugin_online.md modified: docs/workshop/hangzhou/connect_nb_oc.md modified: docs/workshop/hangzhou/nbdevice_simulation.md modified: docs/workshop/hangzhou/onelight_demo.md modified: docs/workshop/hangzhou/onelight_demo_openCPU.md modified: docs/workshop/hangzhou/openCPU_setup.md modified: docs/workshop/hangzhou/profile_online.md
AndersonGhost · Jan 14, 2019 · 6f5973d · 6f5973d
1 parent 542bfba
commit 6f5973d
Show file tree

Hide file tree

Showing 8 changed files with 85 additions and 64 deletions.
diff --git a/docs/workshop/hangzhou/README.md b/docs/workshop/hangzhou/README.md
@@ -2,4 +2,13 @@
 
 本次杭州站的主题，是基于OpenCPU方案开发端到端的物联网应用。文档旨在帮助开发者了解profile、编解码插件、使用NB对接OceanConnect平台、运行LiteOS OneLight demo，OpenCPU环境搭建以及如何在该环境上运行OneLight Demo的一整套流程。文档中涉及的安装包都在开发环境工具包中给出。安装时请尽量安装到默认路径，否则可能需要开发者手动添加环境变量。
 
-2019年1月11日在杭州举办的Workshop，将有现场手把手教学体验OpenCPU方案的机会，欢迎大家来现场交流！ 
+2019年1月11日在杭州举办的Workshop，将有现场手把手教学体验OpenCPU方案的机会，欢迎大家来现场交流！ 
+
+操作步骤如下：  
+1. [制作Profile](./profile_online.md) 
+2. [制作编解码插件](./codec_plugin_online.md)  
+3. [在线模拟NB-IoT设备](./nbdevice_simulation.md)  
+4. [使用NB-IoT对接OceanConnect平台](./connect_nb_oc.md)  
+5. [运行LiteOS OneLight Demo](./onelight_demo.md)  
+6. [搭建OpenCPU开发环境](./openCPU_setup.md)  
+7. [运行LiteOS OneLight Demo（基于OpenCPU开发板）](./onelight_demo_openCPU.md)  
diff --git a/docs/workshop/hangzhou/codec_plugin_online.md b/docs/workshop/hangzhou/codec_plugin_online.md
@@ -1,5 +1,5 @@
 
-# 在线制作编解码插件
+# 制作编解码插件
 
 [[toc]]
 
@@ -13,54 +13,59 @@
 
 ## 新手指引
 
-![](./pic/codec_plugin2.png)
-![](./pic/codec_plugin3.png)
-![](./pic/codec_plugin4.png)
-![](./pic/codec_plugin5.png)
-![](./pic/codec_plugin6.png)
-![](./pic/codec_plugin7.png)
+![](./pic/codec_plugin2.png)  
+
+![](./pic/codec_plugin3.png)  
+
+![](./pic/codec_plugin4.png)  
+
+![](./pic/codec_plugin5.png)  
+
+![](./pic/codec_plugin6.png)  
+
+![](./pic/codec_plugin7.png)  
 
 ## 新增消息
 
-![](./pic/codec_plugin8.png)
+![](./pic/codec_plugin8.png)  
 
 ## 数据上报
 
-![](./pic/codec_plugin9.png)
+![](./pic/codec_plugin9.png) 
 
-![](./pic/codec_plugin10.png)
+![](./pic/codec_plugin10.png)  
 
-![](./pic/codec_plugin11.png)
+![](./pic/codec_plugin11.png)  
 
 
 ## 数据上报映射Profile
 
-![](./pic/codec_plugin12.png)
-![](./pic/codec_plugin13.png)
+![](./pic/codec_plugin12.png)  
+
+![](./pic/codec_plugin13.png)  
 
 ## 命令下发
 
-![](./pic/codec_plugin14.png)
+![](./pic/codec_plugin14.png)  
+
 ![](./pic/codec_plugin15.png)
 
-![](./pic/codec_plugin16.png)
+![](./pic/codec_plugin16.png)  
 
 ## 命令下发映射Profile
 
-![](./pic/codec_plugin17.png)
-
+![](./pic/codec_plugin17.png)  
 
 ## 保存插件
 
-![](./pic/codec_plugin18.png)
-
+![](./pic/codec_plugin18.png)  
 
 ## 部署插件
 
-![](./pic/codec_plugin19.png)
-
+![](./pic/codec_plugin19.png)  
 
 ## 完成在线制作编解码插件
 
-![](./pic/codec_plugin20.png)
-![](./pic/codec_plugin21.png)
+![](./pic/codec_plugin20.png)  
+
+![](./pic/codec_plugin21.png)  
diff --git a/docs/workshop/hangzhou/connect_nb_oc.md b/docs/workshop/hangzhou/connect_nb_oc.md
@@ -66,7 +66,10 @@ AT指令详细内容，请参阅NB模块用户手册。
 
 ![1](./pic/connect_nboc6.png)
 
-- 登陆网盘，下载串口调试软件 Serial debugging assistant 。链接：https://pan.baidu.com/s/1qdbxR2MlUxfDI01bX4q27g     密码：dbfe
+- 登陆网盘，下载串口调试软件 Serial debugging assistant 。  
+
+链接：[下载 Serial debugging assistant](https://pan.baidu.com/s/1qdbxR2MlUxfDI01bX4q27g)  
+密码：dbfe  
 
 ![1](./pic/connect_nboc7.png)
 
@@ -281,8 +284,9 @@ OK
 ### NB-IoT与OceanConnect云平台联合调试
 
 #### 命令23 发：AT+NMGS=5,2020333435  
-::: tip 说明
-上报数据：345。  
+
+::: tip 说明  
+上报数据：345。    
 :::  
 
 - 此时可以在OceanConnect平台，查看真实NB设备，已经上线ONLINE。点击设备，进去查看历史数据。

diff --git a/docs/workshop/hangzhou/nbdevice_simulation.md b/docs/workshop/hangzhou/nbdevice_simulation.md
@@ -1,4 +1,4 @@
-# 在线模拟NB设备
+# 在线模拟NB-IoT设备
 
 [[toc]]
 

diff --git a/docs/workshop/hangzhou/onelight_demo.md b/docs/workshop/hangzhou/onelight_demo.md
@@ -1,15 +1,16 @@
-# 运行LiteOS onelight demo
+# 运行LiteOS OneLight Demo
 
 [[toc]]
 
 
 ## 获取源代码
 
-	链接：https://pan.baidu.com/s/1qdbxR2MlUxfDI01bX4q27g
-	密码：dbfe
-	::: warning 注意
-    下载源代码后，需安装MDK523，安装STLINK驱动，安装CH340驱动等。  
-    :::  
+链接：[下载源码包](https://pan.baidu.com/s/1qdbxR2MlUxfDI01bX4q27g)  
+密码：dbfe  
+
+::: warning 注意  
+下载源代码后，需安装MDK523，安装STLINK驱动，安装CH340驱动等。    
+:::  
 
 ## Huawei LiteOS目录介绍
 
@@ -86,7 +87,7 @@
 
 ## 打开MDK523项目
 
-- 进入targets\STM32L431CBxx_EVB_L1_Light\MDK-ARM，打开STM32L431CBxx.uvprojx
+- 进入 `targets\STM32L431CBxx_EVB_L1_Light\MDK-ARM`，打开 `STM32L431CBxx.uvprojx`  
 
 ![](./pic/onelight_demo2.png)
 
@@ -98,7 +99,7 @@
 
 ![](./pic/onelight_demo4.png)
 
-- 【注意】下面的工程设置参数。
+- 【注意】请参照下面的工程设置参数。
 
 ![](./pic/onelight_demo5.png)
 
@@ -126,9 +127,9 @@
 
 ![](./pic/onelight_demo15.png)
 
-::: warning 注意
+::: warning 注意  
 此时串口调试助手，已经开始打印输出的LOG信息。串口波特率要选择115200，因为串口日志是通过USART1来打印的，而程序中将USART1的波特率设为了115200。对应的数据可以在OC平台上查看。  
-:::  
+:::   
 
 ![](./pic/onelight_demo16.png)
 

diff --git a/docs/workshop/hangzhou/onelight_demo_openCPU.md b/docs/workshop/hangzhou/onelight_demo_openCPU.md
@@ -1,15 +1,16 @@
-# 在openCPU开发板上运行LiteOS onelight demo
+# 运行LiteOS OneLight Demo（基于OpenCPU开发板）
 
 [[toc]]
 
 
 ## 获取源代码
 
-	链接：https://pan.baidu.com/s/1qdbxR2MlUxfDI01bX4q27g
-	密码：dbfe
-	::: warning 注意
-    运行前需要安装运行环境，详见openCPU开发环境安装指导。  
-    :::  
+链接：[下载源码包](https://pan.baidu.com/s/1qdbxR2MlUxfDI01bX4q27g)  
+密码：dbfe    
+
+::: warning 注意
+运行前需要安装运行环境，详见openCPU开发环境安装指导。  
+:::  
 
 ## 开发板硬件连接
 

diff --git a/docs/workshop/hangzhou/openCPU_setup.md b/docs/workshop/hangzhou/openCPU_setup.md
@@ -1,8 +1,8 @@
-# openCPU开发环境安装指导
+# 搭建OpenCPU开发环境
 
 本文档旨在帮助开发者配置openCPU开发环境。文档中涉及的安装包都在开发环境工具包中给出。安装时请尽量安装到默认路径，否则可能需要开发者手动添加环境变量。
 ## 安装GCC Compiler
-GCC Compiler安装包为gcc-arm-none-eabi-4_9-2015q2-20150609-win32.exe。打开安装程序，按照默认安装即可。
+GCC Compiler安装包为`gcc-arm-none-eabi-4_9-2015q2-20150609-win32.exe`。打开安装程序，按照默认安装即可。
 
 ![1](./pic/opencpu_setup_1.png)
 
@@ -12,7 +12,9 @@ GCC Compiler安装包为gcc-arm-none-eabi-4_9-2015q2-20150609-win32.exe。打开
 
 ![4](./pic/opencpu_setup_4.png)
 
-注意，在最后一步中，需要勾选add path to environment variable。否则需要手动将GCC Compiler安装路径添加到系统环境变量，如下图所示。
+::: warning 注意
+在最后一步中，需要勾选add path to environment variable。否则需要手动将GCC Compiler安装路径添加到系统环境变量，如下图所示。  
+:::  
 
 ![5](./pic/opencpu_setup_5.png)
 
@@ -31,7 +33,7 @@ Scons构建工具通过Python2.7编写，其它Python版本可能不兼容。因
 
 ![10](./pic/opencpu_setup_10.png)
 
-至此完成了Python2.7的安装。但是，默认情况下Python脚本无法访问Windows系统API库，因此需要安装pywin32库。开发者可以通过开发环境工具包中的pywin32-220.win32-py2.7.exe来安装。
+至此完成了Python2.7的安装。但是，默认情况下Python脚本无法访问Windows系统API库，因此需要安装pywin32库。开发者可以通过开发环境工具包中的`pywin32-220.win32-py2.7.exe`来安装。
 
 ![11](./pic/opencpu_setup_11.png)
 
@@ -41,7 +43,7 @@ Scons构建工具通过Python2.7编写，其它Python版本可能不兼容。因
 
 ![14](./pic/opencpu_setup_14.png)
 
-现在，开发者可以通过开发环境工具包中的scons-2.4.0-setup.exe来安装Scons，安装过程与pywin32类似。
+现在，开发者可以通过开发环境工具包中的 `scons-2.4.0-setup.exe` 来安装 Scons，安装过程与 pywin32 类似。
 
 ![15](./pic/opencpu_setup_15.png)
 
@@ -53,7 +55,7 @@ Scons构建工具通过Python2.7编写，其它Python版本可能不兼容。因
 
 ## 安装Microsoft .NET Framework
 
-开发者可通过开发环境工具包中NDP452-KB2901907-x86-x64-AllOS-ENU.exe安装。按照默认安装即可。
+开发者可通过开发环境工具包中`NDP452-KB2901907-x86-x64-AllOS-ENU.exe`安装。按照默认安装即可。
 
 ![19](./pic/opencpu_setup_19.png)
 
@@ -62,7 +64,7 @@ Scons构建工具通过Python2.7编写，其它Python版本可能不兼容。因
 ![21](./pic/opencpu_setup_21.png)
 
 ## 安装UEMonitor-3.22.0.14
-通过开发环境工具包中提供的UEMonitor-3.22.0.14.msi进行安装。类似于串口调试工具，开发者可以通过该软件观察串口日志。
+通过开发环境工具包中提供的 `UEMonitor-3.22.0.14.msi` 进行安装。类似于串口调试工具，开发者可以通过该软件观察串口日志。
 
 ![22](./pic/opencpu_setup_22.png)
 
@@ -72,23 +74,23 @@ Scons构建工具通过Python2.7编写，其它Python版本可能不兼容。因
 
 ## 安装UEUpdaterUI-3.22.0.14
 
-开发者可以通过该软件，从openCPU模组的主串口进行固件升级。安装包为UEUpdaterUI-3.22.0.14.msi。
+开发者可以通过该软件，从openCPU模组的主串口进行固件升级。安装包为 `UEUpdaterUI-3.22.0.14.msi`。
 
 ![25](./pic/opencpu_setup_25.png)
 
 ![26](./pic/opencpu_setup_26.png)
 
 ## 安装UpdatePackage-3.22.0.14
 
-通过UpdatePackage-3.22.0.14.msi进行安装。
+通过 `UpdatePackage-3.22.0.14.msi` 进行安装。
 
 ![27](./pic/opencpu_setup_27.png)
 
 ![28](./pic/opencpu_setup_28.png)
 
 ## 验证开发环境
 
-完成上述环境搭建步骤后，开发者可以通过开发环境工具包中的样例工程来验证开发环境是否搭建成功。比如，打开example目录下的OLED文件夹，打开其中的“命令提示符”，并输入命令```scons_new.bat```：
+完成上述环境搭建步骤后，开发者可以通过开发环境工具包中的样例工程来验证开发环境是否搭建成功。比如，打开example目录下的OLED文件夹，打开其中的“命令提示符”，并输入命令 `scons_new.bat`：
 
 ![33](./pic/opencpu_setup_33.png)
 
@@ -98,7 +100,7 @@ Scons构建工具通过Python2.7编写，其它Python版本可能不兼容。因
 
 ![31](./pic/opencpu_setup_31.png)
 
-并且在工程目录下，会生成new.fwpkg文件。该文件就是openCPU方案需要烧录到模组中的firmware package。
+并且在工程目录下，会生成 `new.fwpkg` 文件。该文件就是 openCPU 方案需要烧录到模组中的 firmware package。
 
 ![32](./pic/opencpu_setup_32.png)
 
@@ -108,17 +110,17 @@ Scons构建工具通过Python2.7编写，其它Python版本可能不兼容。因
 
 ### 报 arm-none-eabi-gcc 错误
 
-打开“命令提示符”，并输入命令```scons_new.bat```，出现```No such file or directory```的错误：
+打开“命令提示符”，并输入命令 `scons_new.bat`，出现 `No such file or directory` 的错误：
 
 ![34](./pic/opencpu_setup_34.png)
 
 解决方案：
 1. 查看系统环境变量是否正确配置。
 
-2. 查找电脑中是否有文件与Compiler-GCC(GNU Tools ARM Embedded)重名。若有请将其删除。
+2. 查找电脑中是否有文件与 Compiler-GCC(GNU Tools ARM Embedded) 重名。若有请将其删除。
 
 ### 路径有误
-若开发者在安装过程中修改了默认的安装路径，需要在scons_new.bat中的路径做相应的修改。
+若开发者在安装过程中修改了默认的安装路径，需要在 `scons_new.bat` 中的路径做相应的修改。
 
 ![35](./pic/opencpu_setup_35.png)
 
@@ -127,6 +129,5 @@ Scons构建工具通过Python2.7编写，其它Python版本可能不兼容。因
 
 ![36](./pic/opencpu_setup_36.png)
 
-解决方案：
-
-* 使用全英文路径。
+解决方案：  
+使用全英文路径。  
diff --git a/docs/workshop/hangzhou/profile_online.md b/docs/workshop/hangzhou/profile_online.md
@@ -1,11 +1,11 @@
-# 制作profile
+# 制作Profile
 
 [[toc]]
 
 
 ## 登陆OceanConnect平台
 
-	浏览器：chrome 【推荐】
+浏览器：chrome （推荐）  
 
 
 ![](./pic/profile_online1.png)
@@ -33,7 +33,7 @@
 ![](./pic/profile_online7.png)
 
 - 系统弹出设置产品信息界面，填写各项参数后，点击“创建”。
-- 设备型号、厂商ID、厂商名称，可以自行定义，但请保证唯一性。可以参赛序号为后缀，例如：HuaweiOneLight***。
+- 设备型号、厂商ID、厂商名称，可以自行定义，但请保证唯一性。可以参赛序号为后缀，例如：HuaweiOneLightxxx（xxx为数字序号）。
 - 厂商ID由系统自动填充，无需手动填写。
 
 ![](./pic/profile_online8.png)