소스 검색

[完善] 调整图片大小 | 完善文档

tangweikang 6 년 전
부모
커밋
f56b1f16d2
3개의 변경된 파일15개의 추가작업 그리고 15개의 파일을 삭제
  1. 15 15
      README.md
  2. BIN
      docs/figures/http_ota.png
  3. BIN
      docs/figures/ymodem_ota.png

+ 15 - 15
README.md

@@ -2,10 +2,10 @@
 
 ## 1、介绍
 
-本软件包是用于 OTA 升级的固件下载器,该下载器提供多种固件下载方式。开发者可以根据自己的需求灵活选择升级方式,每种升级方式都只需调用一次相应的函数或者执行一次相应的命令就可实现。下面是目前支持的方式。
+本软件包是用于 OTA 升级的固件下载器,该下载器提供多种固件下载方式。开发者可以根据自己的需求灵活选择升级方式,每种升级方式都只需调用一次函数或者命令就可实现,目前支持的下载方式如下所示:
 
  - HTTP/HTTPS 协议下载固件
- - YMODEM 协议下载固件
+ - Ymodem 协议下载固件
 
 ### 1.1 许可证
 
@@ -14,8 +14,8 @@ OTA Downloader package 遵循 Apache2.0 许可,详见 `LICENSE` 文件。
 ### 1.2 依赖
 
 - RT-Thread 3.0+
-- fal 软件包支持
-- YMODEM 下载方式依赖于 ymodem 组件
+- FAL 软件包支持
+- Ymodem 下载方式依赖于 Ymodem 组件
 - HTTP/HTTPS 下载方式依赖于 webclient 软件包
 
 ## 2、如何打开 OTA Downloader
@@ -26,19 +26,19 @@ OTA Downloader package 遵循 Apache2.0 许可,详见 `LICENSE` 文件。
 RT-Thread online packages
     IoT - internet of things  --->
         [*]  The firmware downloader which using on RT-Thread OTA component  --->
-            [*]  Enable ota downloader debug
-            [*]  Enable HTTP OTA
-                (http://xxx/xxx/rtthread.rbl) http ota url
-            [*]  Enable YMODEM OTA
+            [*]  Enable OTA downloader debug
+            [*]  Enable HTTP/HTTPS OTA
+                (http://xxx/xxx/rtthread.rbl) HTTP OTA URL
+            [*]  Enable Ymodem OTA
 ```
 
 软件包选项的详细说明如下图:
 
 | 选项 | 说明 |
 |-|-|
-| Enable ota downloader debug | 使能固件下载器 debug 模式 |
-| Enable HTTP OTA | 使能 HTTP/HTTPS 协议下载固件功能 |
-| Enable YMODEM OTA | 使能 YMODEM 协议下载固件功能 |
+| Enable OTA downloader debug | 使能固件下载器 debug 模式 |
+| Enable HTTP/HTTPS OTA | 使能 HTTP/HTTPS 协议下载固件功能 |
+| Enable Ymodem OTA | 使能 Ymodem 协议下载固件功能 |
 
 选择完自己需要的选项后使用 RT-Thread 的包管理器自动更新,或者使用 `pkgs --update` 命令更新包到 BSP 中。
 
@@ -50,11 +50,11 @@ RT-Thread online packages
 | 功能 | 函数调用 | 执行命令 |
 |---|---|---|
 | 使用 HTTP/HTTPS 协议固件升级 | `void http_ota(uint8_t argc, char **argv)` | `http_ota` |
-| 使用 YMODEM 协议固件升级 | `void ymodem_ota(uint8_t argc, char **argv)` | `ymodem_ota` |
+| 使用 Ymodem 协议固件升级 | `void ymodem_ota(uint8_t argc, char **argv)` | `ymodem_ota` |
 
-### 3.1 YMODEM 协议固件升级命令行演示
+### 3.1 Ymodem 协议固件升级命令行演示
 
-推荐使用支持 YMODEM 协议的 Xshell 。在终端输入 `ymodem_ota` 命令后,鼠标右键然后在菜单栏找到用 YMODEM 发送选项发送文件。具体步骤如下图:
+推荐使用支持 Ymodem 协议的 Xshell 。在终端输入 `ymodem_ota` 命令后,鼠标右键然后在菜单栏找到用 YMODEM 发送选项发送文件。具体步骤如下图:
 
 ![ymodem_ota](docs/figures/ymodem_ota.png)
 
@@ -67,7 +67,7 @@ RT-Thread online packages
 ## 4、注意事项
 
  1. 确保 FAL 中有 downloader 分区。
- 2. YMODEM 协议升级固件时,请使用支持 YMODEM 协议的工具。
+ 2. Ymodem 协议升级固件时,请使用支持 Ymodem 协议的工具。
  3. HTTP/HTTPS 协议升级固件时,需确保远端链接地址可用。
 
 ## 5、参考资料

BIN
docs/figures/http_ota.png


BIN
docs/figures/ymodem_ota.png