Skip to content

Commit

Permalink
[doc] update rst
Browse files Browse the repository at this point in the history
  • Loading branch information
sakumisue committed Aug 18, 2023
1 parent 2e2354a commit de40c1e
Show file tree
Hide file tree
Showing 71 changed files with 483 additions and 396 deletions.
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -83,7 +83,7 @@ Note:**√** means supported ; **×** means not supported; **○** means suppo

## Command Line Development

Before compiling with the command line, you need to select the corresponding toolchain according to your operating system, configure it to the system environment variables, and install the **make** or **ninja**, then you can do the following. For the details, you can visit [BouffaloSDK Environment Setup](https://bl-mcu-sdk.readthedocs.io/zh_CN/latest/get_started/index.html).
Before compiling with the command line, you need to select the corresponding toolchain according to your operating system, configure it to the system environment variables, and install the **make** or **ninja**, then you can do the following. For the details, you can visit [BouffaloSDK Environment Setup](https://bl-mcu-sdk.readthedocs.io/zh_CN/latest/get_started/get_started.html).

- Go to the demo directory where you want to compile and there are `main.c` and `Makefile` files in that directory
- Just execute the following command, take **BL616** as an example
Expand Down Expand Up @@ -113,7 +113,7 @@ TODO

## Debug

Only supports debug with CKLink currently. See [BouffaloSDK Debug Guide](https://bl-mcu-sdk.readthedocs.io/zh_CN/latest/get_started/debug.html).
Only supports debug with CKLink currently. See [BouffaloSDK Debug Guide](https://bl-mcu-sdk.readthedocs.io/zh_CN/latest/get_started/eclipse.html).

## Firmware Download

Expand Down
4 changes: 2 additions & 2 deletions README_zh.md
Original file line number Diff line number Diff line change
Expand Up @@ -83,7 +83,7 @@

## 命令行编译

在进行命令行编译之前,需要根据你的操作系统,选择对应的工具链,并配置到系统环境变量,并安装了 **make** 或者 **ninja** 工具,然后才能进行下面操作。更详细的搭建过程,参考 [BouffaloSDK 环境搭建](https://bl-mcu-sdk.readthedocs.io/zh_CN/latest/get_started/index.html).
在进行命令行编译之前,需要根据你的操作系统,选择对应的工具链,并配置到系统环境变量,并安装了 **make** 或者 **ninja** 工具,然后才能进行下面操作。更详细的搭建过程,参考 [BouffaloSDK 环境搭建](https://bl-mcu-sdk.readthedocs.io/zh_CN/latest/get_started/get_started.html).

- 进入要编译的 demo 目录,且该目录下有 `main.c``Makefile` 文件
- 执行下面命令即可,以 **BL616** 为例
Expand Down Expand Up @@ -118,7 +118,7 @@ TODO

## 调试

当前仅支持使用 CKLink 调试。详细参考 [BouffaloSDK 调试指南](https://bl-mcu-sdk.readthedocs.io/zh_CN/latest/get_started/debug.html)
当前仅支持使用 CKLink 调试。详细参考 [BouffaloSDK 调试指南](https://bl-mcu-sdk.readthedocs.io/zh_CN/latest/get_started/eclipse.html)

## 固件烧录

Expand Down
Binary file added docs/zh/api_reference/img/wifi_cli1.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/zh/api_reference/img/wifi_cli2.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/zh/api_reference/img/wifi_cli3.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/zh/api_reference/img/wifi_cli4.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
2 changes: 0 additions & 2 deletions docs/zh/api_reference/wifi.rst

This file was deleted.

48 changes: 48 additions & 0 deletions docs/zh/api_reference/wifi6.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,48 @@
.. _wifi6_api:

WIFI6
=============

CLI 命令
-------------

wifi_sta_connect
^^^^^^^^^^^^^^^^^^^^

用于连接 AP,连接成功后,会打印出分配的 ip 地址

- 第一个参数表示 ssid
- 第二个参数表示 pwd

例如:

.. figure:: img/wifi_cli1.png
:alt:

.. figure:: img/wifi_cli2.png
:alt:

wifi_scan
^^^^^^^^^^^^^^^^^^^^

用于扫描 AP ,不需要跟参数

例如:

.. figure:: img/wifi_cli3.png
:alt:

ping
^^^^^^^^^^^^^^^^^^^^

用于 ping 网络

- 第一个参数填写 ip 地址或者域名地址

例如:

.. figure:: img/wifi_cli4.png
:alt:

Functions
----------------
65 changes: 0 additions & 65 deletions docs/zh/get_started/debug.rst

This file was deleted.

22 changes: 18 additions & 4 deletions docs/zh/get_started/eclipse.rst
Original file line number Diff line number Diff line change
Expand Up @@ -8,13 +8,13 @@ Build and Debug with Eclipse
环境搭建
-------------

- 首先下载 `Eclipse <https://www.eclipse.org/downloads/packages>`_ , 选择 **Eclipse IDE for C/C++ Developers** , 并根据你的电脑版本进行下载。
- 安装 GCC 工具链,cmake, make 和 ninja 流程参考 :ref:`get_started`

- 下载 `Eclipse <https://www.eclipse.org/downloads/packages>`_ , 选择 **Eclipse IDE for C/C++ Developers** , 并根据你的电脑版本进行下载。

.. figure:: img/eclipse1.png
:alt:

- 其余步骤参考 :ref:`windows_cmd`

- 解压 Eclipse 并双击打开 `Eclipse.exe`

.. figure:: img/eclipse2.png
Expand Down Expand Up @@ -51,7 +51,21 @@ Build and Debug with Eclipse
调试
-------------

- 如果没有安装 cklink,请参考 :ref:`debug` 章节进行安装,确保 cklink 工作正常并且成功 jtag 成功连接
- 从 T-HEAD 官网下载最新版本 `CKLink 驱动 <https://occ.t-head.cn/community/download?id=4103855596351066112>`_

- 将下载的 CKLink 安装包解压,并双击 `Setup` ,一路 next 即可,安装完成以后,桌面会有一个 `T-HeadDebugServer` 图标

.. figure:: img/cklink1.png
:alt:

.. figure:: img/cklink2.png
:alt:

- 将板子的 JTAG 引脚和 CKLink 调试器连接以后,点击 **三角** 按钮,如果变成 **圆圈**,则表示 JTAG 连接成功。如果失败,则需要检查 JTAG 线序是否正确。

.. figure:: img/cklink3.png
:alt:

- 完成上述步骤以后,如果是在 **flash 上调试,需要先将编译的 bin 文件烧录到芯片中并复位** ,然后才能够进行下面的调试环节。

- 在 Eclipse 中 点击 `debug` 图标,并点击 `Debug Configurations`
Expand Down
Loading

0 comments on commit de40c1e

Please sign in to comment.