supperthomas 5 лет назад
Родитель
Сommit
1bf31a47f2
2 измененных файлов с 99 добавлено и 10 удалено
  1. 50 10
      README.md
  2. 49 0
      README_zh.md

+ 50 - 10
README.md

@@ -1,20 +1,60 @@
-# Welcome to RTT_BTstack
+# RT-Thread_BTstack
 
-1. 基于原版btstack适配RTT
+[中文页](README_zh.md) |
 
-2. 该软件包不能**商用**,如果需要**商用**需要联系BTSTACK获取license,本软件包作者未被授权商用,不负责任商用后的责任。
+## 1. Introduce
 
-3. 需要把文件BCM43430A1.hcd放到文件系统中去。
+BTstack is [BlueKitchen's](https://bluekitchen-gmbh.com) implementation of the official Bluetooth stack.
+It is well suited for small, resource-constraint devices
+such as 8 or 16 bit embedded systems as it is highly configurable and comes with an ultra small memory footprint.
 
-4. 程序烧入之后,输入命令bt_stack_port_main可以启动蓝牙
+Targeting a variety of platforms is as simple as providing the necessary UART, CPU, and CLOCK implementations. BTstack is currently capable of connecting to Bluetooth-modules via: (H2) HCI USB, (H4) HCI UART + TI's eHCILL, and (H5) HCI Three-Wire UART.
 
-5. 看到如下的log,说明蓝牙已经起来了
+On smaller embedded systems, a minimal run loop implementation allows to use BTstack without a Real Time OS (RTOS).
+If a RTOS is already provided, BTstack can be integrated and run as a single thread.
 
-![imag](./doc/figure/readme_1.png)
+## 2. Supported Protocols and Profiles
 
-   6.此时用手机nrf connect软件可以搜索到该设备。
+**Protocols:** L2CAP (incl. LE Data Channels), RFCOMM, SDP, BNEP, AVDTP, AVCTP, ATT, SM (incl. LE Secure Connections).
 
-   7.连上该设备之后,打开notification,可以看到gatt_counter计数器在增加。
+**Profiles:** GAP, IOP, HFP, HSP, SPP, PAN, A2DP, AVRCP incl. Browsing, GATT.
 
-   ![image-imag](./doc/figure/readme_2.png)
+**GATT Services:** Battery, Cycling Power, Cycling Speed and Cadence, Device Information, Heart Rate, HID over GATT (HOG), Mesh Provisioning, Mesh Proxy, Nordic SPP, u-Blox SPP. 
+
+GATT Services are in general easy to implement and require short development time. For more GATT Services please contact us, or follow the [implementation guidelines](https://bluekitchen-gmbh.com/btstack/profiles/#gatt-generic-attribute-profile).  
+
+It has been qualified with the Bluetooth SIG (QDID 110883) for GAP 1.1, IOP, HFP 1.7, HSP 1.2, SPP 1.2, PAN 1.0, A2DP 1.3, AVRCP 1.6 profiles and
+GATT, SM of the Bluetooth Core 5.0 specification. For information on MFi/iAP2 support, please <a href="mailto:contact@bluekitchen-gmbh.com">contact us</a>.
+
+### 3. License statement
+
+This package contains a snapshot of the BTstack Bluetooth Stack by BlueKitchen GmbH.
+It is free for non-commercial use. For commercial use, please contact BlueKitchen at contact@bluekitchen-gmbh.com。
+
+## 4. Attention
+
+​        On RT-thread system,only support AP6212 currently(base ART-H750 board)。We will support other control in future.
+
+## 5. Contents
+
+The Contents is similar to btstack except the flod of rtt_adapter.
+
+```
+BTstack
+   ├───chipset                   /* Bluetooth control adapter */
+   │   ├───bcm                   /* Bluetooth control AP6212(BCM) adapter */
+   ├───docs                      /* Markdown about*/
+   ├───example                   /* bt stack exampl about*/
+   ├───platform
+   │   ├───posix                 /* btstack posix api  */
+   ├───port
+   │   ├───posix-h4-bcm          /* btstack posix port  */
+   ├───rtt_adapter               /* the different code about the example */
+   └───src                       /* btstack source code */
+```
+
+## 6. Package connect
+
+- Master:supperthomas(78900636@qq.com)
+- github address:https://github.com/supperthomas/RTT_PACKAGE_BTSTACK
 

+ 49 - 0
README_zh.md

@@ -0,0 +1,49 @@
+# RT-Thread_BTstack
+
+## 1. 介绍
+
+BTstack 软件包是RT-Thread 基于 [btstack](https://github.com/bluekitchen/btstack) 开源蓝牙协议栈的适配,该协议栈支持多种蓝牙卡片,非常适合用于小型嵌入式蓝牙设备,支持几乎所有的主流的蓝牙卡片,支持无RTOS操作。
+
+## 2. 主要支持的Profile和Protocol
+
+**Protocols:** L2CAP (incl. LE Data Channels), RFCOMM, SDP, BNEP, AVDTP, AVCTP, ATT, SM (incl. LE Secure Connections).
+
+**Profiles:** GAP, IOP, HFP, HSP, SPP, PAN, A2DP, AVRCP incl. Browsing, GATT.
+
+**GATT Services:** Battery, Cycling Power, Cycling Speed and Cadence, Device Information, Heart Rate, HID over GATT (HOG), Mesh Provisioning, Mesh Proxy, Nordic SPP, u-Blox SPP. 
+
+GATT Services are in general easy to implement and require short development time. For more GATT Services please contact us, or follow the [implementation guidelines](https://bluekitchen-gmbh.com/btstack/profiles/#gatt-generic-attribute-profile).  
+
+### 3. 许可声明
+
+BTstack 非商业用途是免费的。但是,对于商业用途,<a href="mailto:contact@bluekitchen-gmbh.com">请联系BTstack官方</a>关于你的项目以获得商业合作。
+
+## 4. 注意事项
+
+​        BTstack支持很多蓝牙卡片,目前在RT-thread系统上,只支持AP6212卡片(基于ART-H750开发板),后续会支持更多蓝牙卡片。
+
+## 5. 目录结构
+
+本目录基本参考 [btstack](https://github.com/bluekitchen/btstack)的目录创建,适配的代码放在rtt_adapter上面,其余代码基本和源BTstack代码一致,如需更新可以自行从github上更新
+
+```
+BTstack
+   ├───chipset                   /* Bluetooth control adapter */
+   │   ├───bcm                   /* Bluetooth control AP6212(BCM) adapter */
+   ├───docs                      /* Markdown about*/
+   ├───example                   /* bt stack exampl about*/
+   ├───platform
+   │   ├───posix                 /* btstack posix api  */
+   ├───port
+   │   ├───posix-h4-bcm          /* btstack posix port  */
+   ├───rtt_adapter               /* the different code about the example */
+   └───src                       /* btstack source code */
+```
+
+## 6. 联系方式 & 感谢
+
+- 维护:supperthomas
+- 主页:https://github.com/supperthomas/RTT_PACKAGE_BTSTACK
+
+
+