Home

Awesome

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, <a href="mailto:contact@bluekitchen-gmbh.com">tell us</a> 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 <a href="mailto:contact@bluekitchen-gmbh.com">contact us directly</a>.

Evaluation Platforms

Embedded Platforms:

Build StatusPortPlatform
<img src="https://buildbot.bluekitchen-gmbh.com/btstack/badges/port-esp32-master.svg">esp32Espressif ESP32 2.4 GHz Wi-Fi and Bluetooth Dual-Mode combo chip using FreeRTOS
<img src="https://buildbot.bluekitchen-gmbh.com/btstack/badges/port-max32630-fthr-master.svg">max32630-fthrMAX32630FTHR ARM Cortex M4F Board with onboard Panasonic PAN1326 module containing TI CC2564B Bluetooth controller
<img src="https://buildbot.bluekitchen-gmbh.com/btstack/badges/port-msp432p401lp-cc256x-master.svg">msp432p401lp-cc256xTI MSP432P401R LaunchPad with CC2564C Dual-mode Bluetooth® Controller Evaluation Module and EM Adapter BoosterPack with additional 32768Hz quartz oscillator
No build serverrrenesas-ek-ra6m4a-da14531Renesas EK-RA6M4 with MikroeE BLE Tiny Click board
No build serverrenesas-tb-s1ja-cc256xRenesas TB-S1JA with with Dual-mode Bluetooth® CC2564 evaluation board and EM Adapter BoosterPack with additional 32768Hz quartz oscillator
<img src="https://buildbot.bluekitchen-gmbh.com/btstack/badges/port-samv71-xplained-atwilc3000-master.svg">samv71-xplained-atwilc3000SAMV71 Ultra Xplained Ultra evaluation kit with ATWILC3000 SHIELD
<img src="https://buildbot.bluekitchen-gmbh.com/btstack/badges/port-stm32-f4discovery-cc256x-master.svg">stm32-f4discovery-cc2564bSTM32 F4 Discovery Board with CC256xEM Bluetooth Adapter Kit for ST and CC2564B Dual-mode Bluetooth® Controller Evaluation Module
<img src="https://buildbot.bluekitchen-gmbh.com/btstack/badges/port-stm32-l073rz-nucleo-em9304-master.svg">stm32-l073rz-nucleo-em9304EM9304 DVK: STM32 Nucleo development board NUCELO-L73RZ with EM9304 Bluetooth Controller
No build serverstm32-wb55xx-nucleo-freertosP-NUCLEO-WB55 kit
<img src="https://buildbot.bluekitchen-gmbh.com/btstack/badges/port-wiced-h4-master.svg">wiced-h4Broadcom/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:

StatusPortPlatform
No build serverfreebsd-netgraphFreeBSD port that uses kernel netgraph HCI node
<img src="https://buildbot.bluekitchen-gmbh.com/btstack/badges/port-libusb-master.svg">libusbUnix-based system with dedicated USB Bluetooth dongle
No build serverlibusb-intelUnix-based system with Intel Wireless 8260/8265 Controller
<img src="https://buildbot.bluekitchen-gmbh.com/btstack/badges/port-posix-h4-master.svg">posix-h4Unix-based system connected to Bluetooth module via H4 over serial port
No build serverposix-h4-nxpUnix-based system connected to Cypress controllers via H4 over serial port
No build serverposix-h4-da14581Unix-based system connected to Dialog Semiconductor DA14581 via H4 over serial port
No build serverposix-h4-da14585Unix-based system connected to Dialog Semiconductor DA14585 via H4 over serial port
No build serverposix-h4-nxpUnix-based system connected to NXP controllers via H4 over serial port
No build serverposix-h4-zephyrUnix-based system connected to Bluetooth module with Zephyr HCI firmware via H4 over serial port
No build serverposix-h5Unix-based system connected to Bluetooth module via H5 over serial port
No build serverqt-h4Unix- or Win32-based Qt application connected to Bluetooth module via H4 over serial port
No build serverqt-usbUnix- or Win32-based Qt application with dedicated USB Bluetooth dongle
No build serverwindows-h4Win32-based system connected to Bluetooth module via serial port
No build serverwindows-h4-da14585Win32-based system connected to Dialog Semiconductor DA14585 via H4 over serial port
No build serverwindows-winusbWin32-based system with dedicated USB Bluetooth dongle
No build serverwindows-winusb-intelWin32-based system with Intel Wireless 8260/8265 Controller
No build serverraspiRaspberry 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-master.svg">daemonTCP and Unix domain named socket client-server architecture supporting multiple clients
<img src="https://buildbot.bluekitchen-gmbh.com/btstack/badges/java-master.svg">javaJava wrapper for daemon
<img src="https://buildbot.bluekitchen-gmbh.com/btstack/badges/port-mtk-master.svg">mtkdaemon for rooted Android devices, based on Mediatek MT65xx processor, Java and C client-server API
No build serverfreertosFreeRTOS: Run BTstack on a dedicated thread, not thread-safe.

Supported Chipsets

ChipsetTypeHCI TransportSCO over HCIBTstack folderComment
Atmel ATWILC3000LEH4n.a.atwilc3000Firmware size: 60 kB
Broadcom UARTDual modeH4, H5ProbablybcmMax UART baudrate 2 mbps
Broadcom USB DonglesDual modeUSBYesbcm
CSR UARTDual modeH4, H5, BCSPNo (didn't work)csr
CSR USB DonglesDual modeUSBYescsr
Infineon CYW207xxDual modeH4, H5, USBProbablybcm
Infineon CYW20819Dual modeH4, H5, USBProbablybcmKeep CTS high during power cycle
Infineon CYW43xxxDual mode + WifiH4, H5Don't knowbcmBluetooth + Wifi Combo Controller
Infineon CYW5557xDual mode + WifiH4Yesbcmautobaud-mode needed, see posix-h4-bcm
Infineon PSoC 4LEH4n.a.HCI Firmware part of PSoC Creator kit examples
Dialog Semiconductor DA145xxLEH4, SPIn.a.da14581Official HCI firmware used
Dialog Semiconductor DA1469xLEH4, SPIn.aHCI Firmware part of DA1469x SDK
Espressif ESP32Dual mode + WifiVHCI, H4YesSoC with Bluetooth and Wifi
Espressif ESP32-S3, ESP32-C3LE + WifiVHCI, H4YesSoC with Bluetooth and Wifi
EM 9301, 9304, 9305LESPIn.a.em9301Custom HCI SPI implementation
Intel Dual Wireless 3165, 8260, 8265Dual modeUSBProbablyintelFirmware size: 400 kB
Nordic nRFLEH4n.a.Requires custom HCI firmware
NXP 88W88997, IW416, IW61xDual mode + WifiH4YesnxpRequires initial firmware
Realtek RTL8822CSDual mode + WifiH5YesRequires initial firmware and config
Realtek USB DonglesDual mode + WifiUSBYesrealtekRequires initial firmware and config
Renesas RX23WLEH4n.a.HCI Firmware part of BTTS
STM STLC2500DClassicH4No (didn't try)stlc2500dCustom deep sleep management not supported
STM32-WB5xLEVHCIn.a.SoC with multi-protocol Radio co-processor
Toshiba TC35661Dual modeH4Notc3566
TI CC256x, WL183xDual modeH4, H5, eHCILLYescc256xAlso WL185x, WL187x, and WL189x

More infos on supported chipsets

Source Tree Overview

PathDescription
chipsetSupport for individual Bluetooth chipsets
docSources for BTstack documentation
exampleExample applications available for all ports
platformSupport for special OSs and/or MCU architectures
portComplete port for a MCU + Chipset combinations
srcBluetooth stack implementation
testUnit and PTS tests
toolHelper tools for BTstack