mirror/btstack
1
0
Fork 0
mirror of https://github.com/bluekitchen/btstack.git synced 2024-12-28 15:20:39 +00:00
Code Issues Packages Projects Releases Wiki Activity
8aa34dc6e0
btstack/README.md

127 lines
26 KiB
Markdown
Raw Normal View History

Create README.md
2015-03-27 15:21:51 +00:00
# Welcome to BTstack
readme: add qt-usb port, use https for our sites and some others
2020-03-02 08:59:54 +00:00
BTstack is [BlueKitchen's](https://bluekitchen-gmbh.com) implementation of the official Bluetooth stack.
da14581: add to main readme
2017-03-30 19:56:50 +00:00
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.
Create README.md
2015-03-27 15:21:51 +00:00
Update README.md following suggestions from https://github.com/bluekitchen/btstack/pull/26
2017-02-27 10:13:29 +00:00
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.
Create README.md
2015-03-27 15:21:51 +00:00
da14581: add to main readme
2017-03-30 19:56:50 +00:00
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.
Create README.md
2015-03-27 15:21:51 +00:00
readme: copywriting
2018-09-28 08:09:23 +00:00
On larger systems, BTstack provides a server that connects to a Bluetooth module.
Multiple applications can communicate with this server over different inter-process communication methods. As sockets are used for client/server communication, it's easy to interact via higher-level level languages, e.g. there's already a Java binding for use in desktop environments.
Create README.md
2015-03-27 15:21:51 +00:00
README: support Bluetooth 5
2018-10-18 10:48:58 +00:00
BTstack supports the Central and the Peripheral Role of Bluetooth 5 Low Energy specification incl. LE Secure Connections, LE Data Channels, and LE Data Length Extension. It can be configured to run as either single-mode stack or a dual-mode stack.
Create README.md
2015-03-27 15:21:51 +00:00
Update README.md following suggestions from https://github.com/bluekitchen/btstack/pull/26
2017-02-27 10:13:29 +00:00
BTstack is free for non-commercial use. However, for commercial use, <a href="mailto:contact@bluekitchen-gmbh.com">tell us</a> a bit about your project to get a quote.
readme: add qt-usb port, use https for our sites and some others
2020-03-02 08:59:54 +00:00
**Documentation:** [HTML](https://bluekitchen-gmbh.com/btstack/develop/), [PDF](https://bluekitchen-gmbh.com/btstack_develop.pdf)
Update README.md
2017-02-27 10:15:06 +00:00
readme: fix spelling and url
2019-08-30 12:22:39 +00:00
**Third-party libraries (FOSS):** [List of used libraries and their licenses](https://github.com/bluekitchen/btstack/blob/develop/3rd-party/README.md)
3rd-party: document third-party libraries and their license type
2019-08-30 08:47:08 +00:00
readme: add qt-usb port, use https for our sites and some others
2020-03-02 08:59:54 +00:00
**Discussion and Community Support:** [BTstack Google Group](https://groups.google.com/group/btstack-dev)
Update README.md
2017-02-27 10:15:06 +00:00
3rd-party: document third-party libraries and their license type
2019-08-30 08:47:08 +00:00
Update README.md
2017-02-27 10:15:06 +00:00
### Supported Protocols and Profiles
Create README.md
2015-03-27 15:21:51 +00:00
readme: update bluetooth sig listing info
2021-05-25 13:31:39 +00:00
**Protocols:** L2CAP (incl. Enhanced Retransmission Mode and LE Data Channels), RFCOMM, SDP, BNEP, AVDTP, AVCTP, ATT, SM (incl. LE Secure Connections and Cross-transport key derivation).
Update README.md
2015-05-04 22:24:43 +00:00
readme: mention opp and cover art
2023-05-05 13:00:30 +00:00
**Profiles:** A2DP, AVRCP incl. Browsing (CT+TG) and Cover Art (CT), GAP, GATT, HFP, HID, HSP, IOP, OPP, SPP, PAN, PBAP.
update chipset table, profiles and protocols more compact
2016-11-19 21:32:44 +00:00
readme: add BMS and TPS
2021-09-19 14:12:50 +00:00
**GATT Service Servers:** Battery (BAS), Bond Management (BMS), Cycling Power (CPS), Cycling Speed and Cadence (CSCS), Device Information (DID), Heart Rate (HRS), HID over GATT (HIDS) Device , Mesh Provisioning, Mesh Proxy, Nordic SPP, Scan Parameters (SCPS), TX Power (TPS), u-Blox SPP.
doc: add Battery Client and Device Information Client
2021-03-05 17:30:20 +00:00
readme: update bluetooth sig listing info
2021-05-25 13:31:39 +00:00
**GATT Service Clients:**: ANCS, Battery (BAS), Device Information (DID), HID-over-GATT (HOGP) Host, Scan Parameters (SCPP).
Update info on GATT services
2020-03-02 09:48:42 +00:00
readme: update some product links and use https
2020-09-16 09:35:27 +00:00
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).
Update info on GATT services
2020-03-02 09:48:42 +00:00
readme: mention le audio
2021-12-09 14:32:32 +00:00
**In Development:** LE Audio and more.
update chipset table, profiles and protocols more compact
2016-11-19 21:32:44 +00:00
changelog: add tested br/edr protocols
2021-09-15 08:13:52 +00:00
It has been qualified with the Bluetooth SIG (QDID 166433) for A2DP 1.3.2, AVCTP 1.4, AVDTP 1.3, AVRCP 1.6.2, DID 1.3, GAVDP 1.3, HFP 1.8, HSP 1.2, PAN 1.0, PBAP Client 1.2, RFCOMM 1.2, SPP 1.2 BR/EDR protocol/profiles,
readme: mention le audio
2021-12-09 14:32:32 +00:00
BAS 1.0, CPP 1.1, CPS 1.1, CSCP 1.0, CSCS 1.0, DIS 1.1, HIDS 1.0, HOGP 1.0, HRP 1.0, HRS 1.0, SCPP 1.0, SCPS 1.0 GATT profiles as well as and GAP, GATT, IOP, SM of the Bluetooth Core 5.2 specification.
For information on Apple's MFi/iAP2 and Find My profiles, please <a href="mailto:contact@bluekitchen-gmbh.com">contact us directly</a>.
update chipset table, profiles and protocols more compact
2016-11-19 21:32:44 +00:00
Supported -> Evaluation Plaforms
2015-04-27 16:37:44 +00:00
## Evaluation Platforms
changed link to manual
2015-04-10 09:33:16 +00:00
#### Embedded Platforms:
esp32: update readme and chipset documentation
2022-06-08 10:02:36 +00:00
| Build Status | Port | Platform |
|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| [<img src="https://buildbot.bluekitchen-gmbh.com/btstack/badges/port-esp32-develop.svg">](https://buildbot.bluekitchen-gmbh.com/btstack/#/builders/port-esp32-develop) | [esp32](https://github.com/bluekitchen/btstack/tree/develop/port/esp32) | [Espressif ESP32](https://www.espressif.com/products/hardware/esp32/overview) 2.4 GHz Wi-Fi and Bluetooth Dual-Mode combo chip using [FreeRTOS](https://www.freertos.org) |
| [<img src="https://buildbot.bluekitchen-gmbh.com/btstack/badges/port-max32630-fthr-develop.svg">](https://buildbot.bluekitchen-gmbh.com/btstack/#/builders/port-max32630-fthr) | [max32630-fthr](https://github.com/bluekitchen/btstack/tree/develop/port/max32630-fthr) | [MAX32630FTHR ARM Cortex M4F Board](https://www.maximintegrated.com/en/products/digital/microcontrollers/MAX32630FTHR.html) with onboard [Panasonic PAN1326 module](https://na.industrial.panasonic.com/products/wireless-connectivity/bluetooth/multi-mode/series/pan13261316-series/CS467) containing [TI CC2564B Bluetooth controller](https://www.ti.com/product/cc2564) |
| [<img src="https://buildbot.bluekitchen-gmbh.com/btstack/badges/port-msp432p401lp-cc256x-develop.svg">](https://buildbot.bluekitchen-gmbh.com/btstack/#/builders/port-msp432p401lp-cc256x-develop) | [msp432p401lp-cc256x](https://github.com/bluekitchen/btstack/tree/develop/port/msp432p401lp-cc256x) | [TI MSP432P401R LaunchPad](https://www.ti.com/tool/MSP-EXP432P401R) with [CC2564C Dual-mode Bluetooth® Controller Evaluation Module](https://store.ti.com/CC256XCQFN-EM-CC2564C-Dual-Mode-Bluetooth-Controller-Evaluation-Module-P51277.aspx) and [EM Adapter BoosterPack](https://www.ti.com/tool/boost-ccemadapter) with additional 32768Hz quartz oscillator |
port for renesas ra6m4a eval kit with DA14531 BLE HCI Controller
2023-01-11 16:30:31 +00:00
| No build server | [rrenesas-ek-ra6m4a-da14531](https://github.com/bluekitchen/btstack/tree/develop/port/rrenesas-ek-ra6m4a-da14531) | [Renesas EK-RA6M4](https://www.renesas.com/us/en/products/microcontrollers-microprocessors/ra-cortex-m-mcus/ek-ra6m4-evaluation-kit-ra6m4-mcu-group) with [MikroeE BLE Tiny Click board](https://www.mikroe.com/ble-tiny-click) |
| No build server | [renesas-tb-s1ja-cc256x](https://github.com/bluekitchen/btstack/tree/develop/port/renesas-tb-s1ja-cc256x) | [Renesas TB-S1JA](https://www.renesas.com/eu/en/products/synergy/hardware/kits/tb-s1ja.html) with with [Dual-mode Bluetooth® CC2564 evaluation board](https://www.ti.com/tool/CC256XQFNEM) and [EM Adapter BoosterPack](https://www.ti.com/tool/boost-ccemadapter) with additional 32768Hz quartz oscillator |
esp32: update readme and chipset documentation
2022-06-08 10:02:36 +00:00
| [<img src="https://buildbot.bluekitchen-gmbh.com/btstack/badges/port-samv71-xplained-atwilc3000-develop.svg">](https://buildbot.bluekitchen-gmbh.com/btstack/#/builders/port-samv71-xplained-atwilc3000-develop) | [samv71-xplained-atwilc3000](https://github.com/bluekitchen/btstack/tree/develop/port/samv71-xplained-atwilc3000) | [SAMV71 Ultra Xplained Ultra](https://www.microchip.com/DevelopmentTools/ProductDetails/PartNO/ATSAMV71-XULT) evaluation kit with [ATWILC3000 SHIELD](https://www.microchip.com/DevelopmentTools/ProductDetails/ATWILC3000-SHLD) |
| [<img src="https://buildbot.bluekitchen-gmbh.com/btstack/badges/port-stm32-f4discovery-cc256x-develop.svg">](https://buildbot.bluekitchen-gmbh.com/btstack/#/builders/port-stm32-f4discovery-cc256x-develop) | [stm32-f4discovery-cc2564b](https://github.com/bluekitchen/btstack/tree/develop/port/stm32-f4discovery-cc256x) | [STM32 F4 Discovery Board](https://www.st.com/en/evaluation-tools/stm32f4discovery.html) with [CC256xEM Bluetooth Adapter Kit for ST](https://store.ti.com/CC256XEM-STADAPT-CC256xEM-Bluetooth-Adapter-Kit-P45158.aspx) and [CC2564B Dual-mode Bluetooth® Controller Evaluation Module](https://store.ti.com/cc2564modnem.aspx) |
| [<img src="https://buildbot.bluekitchen-gmbh.com/btstack/badges/port-stm32-l073rz-nucleo-em9304-develop.svg">](https://buildbot.bluekitchen-gmbh.com/btstack/#/builders/port-stm32-l073rz-nucleo-em9304) | [stm32-l073rz-nucleo-em9304](https://github.com/bluekitchen/btstack/tree/develop/port/stm32-l073rz-nucleo-em9304) | EM9304 DVK: [STM32 Nucleo development board NUCELO-L73RZ](https://www.st.com/en/evaluation-tools/nucleo-l073rz.html) with [EM9304 Bluetooth Controller](https://www.emmicroelectronic.com/product/standard-protocols/em9304) |
| No build server | [stm32-wb55xx-nucleo-freertos](https://github.com/bluekitchen/btstack/tree/develop/port/stm32-wb55xx-nucleo-freertos) | [P-NUCLEO-WB55 kit](https://www.st.com/en/evaluation-tools/p-nucleo-wb55.html) |
| [<img src="https://buildbot.bluekitchen-gmbh.com/btstack/badges/port-wiced-h4-develop.svg">](https://buildbot.bluekitchen-gmbh.com/btstack/#/builders/port-wiced-h4-develop) | [wiced-h4](https://github.com/bluekitchen/btstack/tree/develop/port/wiced-h4) | Broadcom/Cypress platforms that support the WICED SDK via H4 UART, e.g. [RedBear Duo](https://www.seeedstudio.com/RedBear-DUO-Wi-Fi-BLE-IoT-Board-p-2635.html) (BCM43438 A1), [Inventek Systems ISM4334x](https://www.inventeksys.com/wifi/wifi-modules/ism4343-wmb-l151/) (BCM43438 A1), [Inventek Systems ISM4343](https://www.inventeksys.com/products-page/wifi-modules/serial-wifi/ism43341-m4g-l44-cu-embedded-serial-to-wifi-ble-nfc-module/) (BCM43340) |
readme: add MSP432P401R-CC2564C port
2021-01-01 21:48:18 +00:00
changed link to manual
2015-04-10 09:33:16 +00:00
#### Other Platforms:
esp32: update readme and chipset documentation
2022-06-08 10:02:36 +00:00
| Status | Port | Platform |
|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------|
| [<img src="https://buildbot.bluekitchen-gmbh.com/btstack/badges/port-libusb-develop.svg">](https://buildbot.bluekitchen-gmbh.com/btstack/#/builders/port-libusb-develop) | [libusb](https://github.com/bluekitchen/btstack/tree/develop/port/libusb) | Unix-based system with dedicated USB Bluetooth dongle |
| No build server | [libusb-intel](https://github.com/bluekitchen/btstack/tree/develop/port/libusb-intel) | Unix-based system with Intel Wireless 8260/8265 Controller |
| [<img src="https://buildbot.bluekitchen-gmbh.com/btstack/badges/port-posix-h4-develop.svg">](https://buildbot.bluekitchen-gmbh.com/btstack/#/builders/port-posix-h4-develop) | [posix-h4](https://github.com/bluekitchen/btstack/tree/develop/port/posix-h4) | Unix-based system connected to Bluetooth module via H4 over serial port |
| No build server | [posix-h4-da14581](https://github.com/bluekitchen/btstack/tree/develop/port/posix-h4-da14581) | Unix-based system connected to Dialog Semiconductor DA14581 via H4 over serial port |
| No build server | [posix-h4-da14585](https://github.com/bluekitchen/btstack/tree/develop/port/posix-h4-da14585) | Unix-based system connected to Dialog Semiconductor DA14585 via H4 over serial port |
chipset: general update, add NXP, EM9305
2023-04-05 12:18:50 +00:00
| No build server | [posix-h4-nxp](https://github.com/bluekitchen/btstack/tree/develop/port/posix-h4-nxp) | Unix-based system connected to NXP controllers via H4 over serial port |
| No build server | [posix-h4-zephyr](https://github.com/bluekitchen/btstack/tree/develop/port/posix-h4-zephyr) | Unix-based system connected to Bluetooth module with Zephyr HCI firmware via H4 over serial port |
esp32: update readme and chipset documentation
2022-06-08 10:02:36 +00:00
| No build server | [posix-h5](https://github.com/bluekitchen/btstack/tree/develop/port/posix-h5) | Unix-based system connected to Bluetooth module via H5 over serial port |
| No build server | [qt-h4](https://github.com/bluekitchen/btstack/tree/develop/port/qt-h4) | Unix- or Win32-based [Qt application](https://qt.io) connected to Bluetooth module via H4 over serial port |
| No build server | [qt-usb](https://github.com/bluekitchen/btstack/tree/develop/port/qt-usb) | Unix- or Win32-based [Qt application](https://qt.io) with dedicated USB Bluetooth dongle |
| No build server | [windows-h4](https://github.com/bluekitchen/btstack/tree/develop/port/windows-h4) | Win32-based system connected to Bluetooth module via serial port |
| No build server | [windows-h4-da14585](https://github.com/bluekitchen/btstack/tree/develop/port/windows-h4-da14585) | Win32-based system connected to Dialog Semiconductor DA14585 via H4 over serial port |
| No build server | [windows-winusb](https://github.com/bluekitchen/btstack/tree/develop/port/windows-winusb) | Win32-based system with dedicated USB Bluetooth dongle |
| No build server | [windows-winusb-intel](https://github.com/bluekitchen/btstack/tree/develop/port/windows-winusb-intel) | Win32-based system with Intel Wireless 8260/8265 Controller |
| No build server | [raspi](https://github.com/bluekitchen/btstack/tree/develop/port/raspi) | Raspberry Pi 3 or Raspberry Pi Zero W with built-in BCM4343 Bluetooth/Wifi Controller |
| [<img src="https://buildbot.bluekitchen-gmbh.com/btstack/badges/port-daemon-develop.svg">](https://buildbot.bluekitchen-gmbh.com/btstack/#/builders/port-daemon-develop) | [daemon](https://github.com/bluekitchen/btstack/tree/develop/port/daemon) | TCP and Unix domain named socket client-server architecture supporting multiple clients |
| [<img src="https://buildbot.bluekitchen-gmbh.com/btstack/badges/java-develop.svg">](https://buildbot.bluekitchen-gmbh.com/btstack/#/builders/java-develop) | [java](https://github.com/bluekitchen/btstack/tree/develop/platform/daemon/binding/java) | Java wrapper for daemon |
| [<img src="https://buildbot.bluekitchen-gmbh.com/btstack/badges/port-mtk-develop.svg">](https://buildbot.bluekitchen-gmbh.com/btstack/#/builders/port-mtk-develop) | [mtk](https://github.com/bluekitchen/btstack/tree/develop/port/mtk) | daemon for rooted Android devices, based on Mediatek MT65xx processor, Java and C client-server API |
| No build server | [freertos](https://github.com/bluekitchen/btstack/tree/develop/platform/freertos) | [FreeRTOS](https://www.freertos.org): Run BTstack on a dedicated thread, not thread-safe. |
README: update evaluation platforms, add link to port folder
2017-07-19 20:22:02 +00:00
manual moved to git
2015-04-10 08:48:53 +00:00
## Supported Chipsets
update chipset table, profiles and protocols more compact
2016-11-19 21:32:44 +00:00
esp32: update readme and chipset documentation
2022-06-08 10:02:36 +00:00
| Chipset | Type | HCI Transport | SCO over HCI | BTstack folder | Comment |
|--------------------------------------|------------------|----------------|------------------|----------------|------------------------------------------------|
| Atmel ATWILC3000 | LE | H4 | n.a. | atwilc3000 | Firmware size: 60 kB |
| Broadcom UART | Dual mode | H4, H5 | Probably | bcm | Max UART baudrate 2 mbps |
| Broadcom USB Dongles | Dual mode | USB | Yes | bcm | |
| CSR UART | Dual mode | H4, H5, BCSP | No (didn't work) | csr | |
| CSR USB Dongles | Dual mode | USB | Yes | csr | |
chipset: general update, add NXP, EM9305
2023-04-05 12:18:50 +00:00
| Infineon CYW207xx | Dual mode | H4, H5, USB | Probably | bcm | |
| Infineon CYW20819 | Dual mode | H4, H5, USB | Probably | bcm | Keep CTS high during power cycle |
| Infineon CYW43xxx | Dual mode + Wifi | H4, H5 | Don't know | bcm | Bluetooth + Wifi Combo Controller |
chipset: add CYW5557x
2023-04-06 10:30:34 +00:00
| Infineon CYW5557x | Dual mode + Wifi | H4 | Yes | bcm | autobaud-mode needed, see posix-h4-bcm |
chipset: general update, add NXP, EM9305
2023-04-05 12:18:50 +00:00
| Infineon PSoC 4 | LE | H4 | n.a. | | HCI Firmware part of PSoC Creator kit examples |
esp32: update readme and chipset documentation
2022-06-08 10:02:36 +00:00
| Dialog Semiconductor DA145xx | LE | H4, SPI | n.a. | da14581 | Official HCI firmware used |
| Dialog Semiconductor DA1469x | LE | H4, SPI | n.a | | HCI Firmware part of DA1469x SDK |
readme: mentions H4 for ESP32
2022-09-16 09:15:32 +00:00
| Espressif ESP32 | Dual mode + Wifi | VHCI, H4 | Yes | | SoC with Bluetooth and Wifi |
| Espressif ESP32-S3, ESP32-C3 | LE + Wifi | VHCI, H4 | Yes | | SoC with Bluetooth and Wifi |
chipset: general update, add NXP, EM9305
2023-04-05 12:18:50 +00:00
| EM 9301, 9304, 9305 | LE | SPI | n.a. | em9301 | Custom HCI SPI implementation |
esp32: update readme and chipset documentation
2022-06-08 10:02:36 +00:00
| Intel Dual Wireless 3165, 8260, 8265 | Dual mode | USB | Probably | intel | Firmware size: 400 kB |
| Nordic nRF | LE | H4 | n.a. | | Requires custom HCI firmware |
chipset: add IW416
2023-04-08 11:41:14 +00:00
| NXP 88W88997, IW416 | Dual mode + Wifi | H4 | Yes | nxp | Requires initial firmware |
esp32: update readme and chipset documentation
2022-06-08 10:02:36 +00:00
| Realtek RTL8822CS | Dual mode + Wifi | H5 | Yes | | Requires initial firmware and config |
| Realtek USB Dongles | Dual mode + Wifi | USB | Yes | realtek | Requires initial firmware and config |
| Renesas RX23W | LE | H4 | n.a. | | HCI Firmware part of BTTS |
| STM STLC2500D | Classic | H4 | No (didn't try) | stlc2500d | Custom deep sleep management not supported |
| STM32-WB5x | LE | VHCI | n.a. | | SoC with multi-protocol Radio co-processor |
| Toshiba TC35661 | Dual mode | H4 | No | tc3566 | |
| TI CC256x, WL183x | Dual mode | H4, H5, eHCILL | Yes | cc256x | Also WL185x, WL187x, and WL189x |
update chipset table, profiles and protocols more compact
2016-11-19 21:32:44 +00:00
[More infos on supported chipsets](https://bluekitchen-gmbh.com/btstack/develop/chipsets/)
describe tree structure
2015-11-13 09:31:44 +00:00
## Source Tree Overview
esp32: update readme and chipset documentation
2022-06-08 10:02:36 +00:00
| Path | Description |
|----------|--------------------------------------------------|
| chipset | Support for individual Bluetooth chipsets |
| doc | Sources for BTstack documentation |
| example | Example applications available for all ports |
| platform | Support for special OSs and/or MCU architectures |
| port | Complete port for a MCU + Chipset combinations |
| src | Bluetooth stack implementation |
| test | Unit and PTS tests |
| tool | Helper tools for BTstack |
Reference in New Issue Copy Permalink