Jelajahi Sumber

[add]add notes in readme

yangjie 4 tahun lalu
induk
melakukan
c4ecb23f97
1 mengubah file dengan 19 tambahan dan 19 penghapusan
  1. 19 19
      README.md

+ 19 - 19
README.md

@@ -2,7 +2,9 @@
 
 ## 1.  BSAL 软件包介绍
 
-BSAL (Bluetooth Stack Abstract Layer)软件包是由 RT-Thread 针对不同 蓝牙协议栈接口实现的,目前支持的 协议栈有:nimble,realtek等协议栈 。
+BSAL (Bluetooth Stack Abstract Layer)软件包是由 RT-Thread 针对不同 蓝牙协议栈接口实现的,目前支持的 协议栈有:nimble,realtek 等协议栈。
+
+> 提示:目前支持芯片为 Realtek 和 Nordic,若在其他芯片上使用该软件包,编译将通不过。
 
 ### 1.1 背景介绍
 
@@ -10,23 +12,23 @@ Bluetooth Stack Abstract Layer 蓝牙协议栈抽象层。用于适配各家协
 
 主要在协议栈基础之上封装一层抽象层接口。
 
-# 2. BSAL 使用说明
+## 2. BSAL 使用说明
 
 BSAL 配置如下图所示:
 
 ![img](./doc/figures/menuconfig.png)
 
-选择需要生成的角色(默认选择Peripheral即可):
+选择需要生成的角色(默认选择 Peripheral 即可):
 
-- Peripheral role:       
+- Peripheral role:
 - Central role
 - Broadcaster role
 - Observer role
 
-选择不同的示例可以实现不同的APP功能:
+选择不同的示例可以实现不同的 APP 功能:
 
-- Battery service     单battery servcie 测试sample
-- battery and blufi service  两个profile servic(blufi 配网, bas)测试sample
+- Battery service     单 battery servcie 测试 sample
+- battery and blufi service  两个 profile servic(blufi 配网, bas)测试 sample
 
 再选择对应的协议栈:
 
@@ -34,33 +36,31 @@ BSAL 配置如下图所示:
 - realtek  (realtek 协议栈适配层)
 - empty_stack   (移植协议栈模板)
 
-# 3. BSAL 依赖
+## 3. BSAL 依赖
 
-BSAL 依赖对应的协议栈,比如nimble,需要先有nimble+RTT的sample工程,首先确保可以跑对应协议栈的原生的sample。再试着添加BSAL层跑sample
+BSAL 依赖对应的协议栈,比如 nimble,需要先有 nimble+RTT  sample 工程,首先确保可以跑对应协议栈的原生的 sample。再试着添加 BSAL 层跑 sample
 
-每个sample对应一个cmd:
+每个 sample 对应一个 cmd:
 
 - battery service: bsal_bas_app
 - battery and blufi service: bsal_bas_blufi_app
 
-输入对应的cmd即可
+输入对应的 cmd 即可
 
-# 4. 测试验证工具
+## 4. 测试验证工具
 
-输入cmd bsal_bas_blufi_app 启动sample
+输入 cmd bsal_bas_blufi_app 启动 sample
 
-手机下载nRF Connect 工具(apple使用lightblue)
+手机下载 nRF Connect 工具(apple 使用 lightblue)
 
 [nRF Connect](https://github.com/NordicSemiconductor/Android-nRF-Connect/releases)
 
-搜索广播看到如下界面
+搜索广播看到如下界面
 
 ![image-20200618164034578](./doc/figures/adv.png)
 
-点击connect连接上之后:
+点击 connect 连接上之后:
 
 ![image-20200618164126725](./doc/figures/srv_table.png)
 
-可以看到battery service和0xffff配网blufi service
-
-说明sample运行成功。
+可以看到 battery service 和 0xffff 配网 blufi service,说明 sample 运行成功。