mirror/btstack
1
0
Fork 0
mirror of https://github.com/bluekitchen/btstack.git synced 2024-12-29 09:26:08 +00:00
Code Issues Packages Projects Releases Wiki Activity
Dual-mode Bluetooth stack, with small memory footprint.
15,828 Commits 41 Branches 23 Tags 223 MiB
C 94.6%
Assembly 2%
C++ 1.1%
Makefile 0.7%
HTML 0.6%
Other 0.8%
f98fd573a1
Go to file
Matthias Ringwald f98fd573a1 example/a2dp_sink_demo: use cod 20404 - headphones
2024-05-16 11:50:26 +02:00
.github/ISSUE_TEMPLATE
3rd-party
chipset chipset/cc2564: add TIInit_11.8.32_4.8.c 2024-05-07 19:54:56 +02:00
doc hci_dump: add hci_dump_btstack_event to log internal events 2024-04-17 12:10:44 +02:00
example example/a2dp_sink_demo: use cod 20404 - headphones 2024-05-16 11:50:26 +02:00
platform hci_transport_h2_libusb: send ISO packets over bulk endpoint 2024-04-17 12:25:32 +02:00
port raspi: avoid warning by adding explicit default 2024-05-06 16:19:16 +02:00
src hci: don't log internal transport events 2024-05-15 16:00:38 +02:00
test btstack_defines: add leaudio meta event and subevent types 2024-05-07 15:41:56 +02:00
tool tool/metrics: add label header to metrics.tsv 2024-05-15 10:11:39 +02:00
.gitignore
CHANGELOG.md changelog: prepare for v1.6.1 2024-04-18 10:36:38 +02:00
LICENSE
README.md

README.md

Welcome to BTstack

BTstack is BlueKitchen's 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.

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.

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.

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.

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.

BTstack is free for non-commercial use. However, for commercial use, tell us a bit about your project to get a quote.

Documentation: HTML, PDF

Third-party libraries (FOSS): List of used libraries and their licenses

Discussion and Community Support: BTstack Google Group

Supported Protocols and Profiles

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).

Profiles: A2DP, AVRCP incl. Browsing (CT+TG) and Cover Art (CT), GAP, GATT, HFP, HID, HSP, IOP, OPP, SPP, PAN, PBAP.

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.

GATT Service Clients:: ANCS, Battery (BAS), Device Information (DID), HID-over-GATT (HOGP) Host, Scan Parameters (SCPP).

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.

In Development: LE Audio and more.

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, 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 ATT, GAP, GATT, IOP, L2CAP, SDP, SM of the Bluetooth Core 5.2 specification.

For information on Apple's MFi/iAP2 and Find My profiles, please contact us directly.

Evaluation Platforms

Embedded Platforms:

Build Status Port Platform
esp32 Espressif ESP32 2.4 GHz Wi-Fi and Bluetooth Dual-Mode combo chip using FreeRTOS
max32630-fthr MAX32630FTHR ARM Cortex M4F Board with onboard Panasonic PAN1326 module containing TI CC2564B Bluetooth controller
msp432p401lp-cc256x TI MSP432P401R LaunchPad with CC2564C Dual-mode Bluetooth® Controller Evaluation Module and EM Adapter BoosterPack with additional 32768Hz quartz oscillator
No build server renesas-ek-ra6m4a-da14531 Renesas EK-RA6M4 with MikroeE BLE Tiny Click board
No build server renesas-tb-s1ja-cc256x Renesas TB-S1JA with with Dual-mode Bluetooth® CC2564 evaluation board and EM Adapter BoosterPack with additional 32768Hz quartz oscillator
samv71-xplained-atwilc3000 SAMV71 Ultra Xplained Ultra evaluation kit with ATWILC3000 SHIELD
stm32-f4discovery-cc2564b STM32 F4 Discovery Board with CC256xEM Bluetooth Adapter Kit for ST and CC2564B Dual-mode Bluetooth® Controller Evaluation Module
stm32-l073rz-nucleo-em9304 EM9304 DVK: STM32 Nucleo development board NUCELO-L73RZ with EM9304 Bluetooth Controller
No build server stm32-wb55xx-nucleo-freertos P-NUCLEO-WB55 kit
wiced-h4 Broadcom/Cypress platforms that support the WICED SDK via H4 UART, e.g. RedBear Duo (BCM43438 A1), Inventek Systems ISM4334x (BCM43438 A1), Inventek Systems ISM4343 (BCM43340)

Other Platforms:

Status Port Platform
No build server freebsd-netgraph FreeBSD port that uses kernel netgraph HCI node
libusb Unix-based system with dedicated USB Bluetooth dongle
No build server libusb-intel Unix-based system with Intel Wireless 8260/8265 Controller
posix-h4 Unix-based system connected to Bluetooth module via H4 over serial port
No build server posix-h4-nxp Unix-based system connected to Cypress controllers via H4 over serial port
No build server posix-h4-da14581 Unix-based system connected to Dialog Semiconductor DA14581 via H4 over serial port
No build server posix-h4-da14585 Unix-based system connected to Dialog Semiconductor DA14585 via H4 over serial port
No build server posix-h4-nxp Unix-based system connected to NXP controllers via H4 over serial port
No build server posix-h4-zephyr Unix-based system connected to Bluetooth module with Zephyr HCI firmware via H4 over serial port
No build server posix-h5 Unix-based system connected to Bluetooth module via H5 over serial port
No build server qt-h4 Unix- or Win32-based Qt application connected to Bluetooth module via H4 over serial port
No build server qt-usb Unix- or Win32-based Qt application with dedicated USB Bluetooth dongle
No build server windows-h4 Win32-based system connected to Bluetooth module via serial port
No build server windows-h4-da14585 Win32-based system connected to Dialog Semiconductor DA14585 via H4 over serial port
No build server windows-winusb Win32-based system with dedicated USB Bluetooth dongle
No build server windows-winusb-intel Win32-based system with Intel Wireless 8260/8265 Controller
No build server raspi Raspberry Pi 3 or Raspberry Pi Zero W with built-in BCM4343 Bluetooth/Wifi Controller
daemon TCP and Unix domain named socket client-server architecture supporting multiple clients
java Java wrapper for daemon
mtk daemon for rooted Android devices, based on Mediatek MT65xx processor, Java and C client-server API
No build server freertos FreeRTOS: Run BTstack on a dedicated thread, not thread-safe.

Supported Chipsets

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
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
Infineon CYW5557x Dual mode + Wifi H4 Yes bcm autobaud-mode needed, see posix-h4-bcm
Infineon PSoC 4 LE H4 n.a. HCI Firmware part of PSoC Creator kit examples
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
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
EM 9301, 9304, 9305 LE SPI n.a. em9301 Custom HCI SPI implementation
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
NXP 88W88997, IW416, IW61x Dual mode + Wifi H4 Yes nxp Requires initial firmware
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

More infos on supported chipsets

Source Tree Overview

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