Dual-mode Bluetooth stack, with small memory footprint.
C Makefile Objective-C C++ Python Java Other
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.

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. A minimal configuration for an SPP server on a MSP430 can run in 32 kB FLASH and only 4 kB of RAM.

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 daemon that connects to a Bluetooth module. Multiple applications can communicate with this daemon over different inter-process communication methods.

BTstack supports the Central and the Peripheral Role of Bluetooth 4.2 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

Discussion and Community Support: BTstack Google Group

Supported Protocols and Profiles

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, GATT.

Beta Stage: HID, HOGP.

In Development: BLE Mesh, AVRCP Browsing and more.

It has been qualified with the Bluetooth SIG (QDID 110883) for GAP, IOP, HFP, HSP, SPP, PAN, A2DP, AVRCP profiles and GATT, SM of the Bluetooth 5 specification. For information on MFi/iAP2 support, please contact us.

Evaluation Platforms

Embedded Platforms:

Build Status Port Platform
esp32 Espressif ESP32 2.4 GHz Wi-Fi and Bluetooth Dual-Mode combo chip using FreeRTOS
ez430-rf2560 EZ430-RF256x Bluetooth Evaluation Tool for MSP430
msp-exp430f5438-cc2564b MSP430F5438 Experimenter Board for MSP430 with Bluetooth CC2564 Module Evaluation Board
msp430f5529lp-cc2564b MSP-EXP430F5529LP LaunchPad with Bluetooth CC2564 Module Evaluation Board and EM Adapter BoosterPack with additional 32768Hz quartz oscillator
No build server max32630-fthr MAX32630FTHR ARM Cortex M4F Board with onboard Panasonic PAN1326 module containing TI CC2564B Bluetooth controller
samv71-xplained-atwilc3000 SAMV71 Ultra Xplained Ultra evaluation kit with ATWILC3000 SHIELD
stm32-f103rb-nucleo STM32 Nucleo development board NUCLEO-F103RB with Bluetooth CC2564 Module Evaluation Board and EM Adapter BoosterPack with additional 32768Hz quartz oscillator
No build Server stm32-f4discovery-cc2564b STM32 F4 Discovery Board with CC256xEM Bluetooth Adapter Kit for ST and CC2564B Dual-mode Bluetooth® Controller Evaluation Module
No build Server stm32-l053rb-em9304 EM9304 DVK: STM32 Nucleo development board NUCELO-L053R with EM9304 Bluetooth Controller
pic32-harmony Microchip's PIC32 Bluetooth Audio Development Kit
wiced-h4 Broadcom platforms that support the WICED SDK via H4 UART, e.g. RedBear Duo with Broadcom BCM43438 A1 or the Inventek Systems ISM4334x with Broadcom BCM43340
No build server wiced-h5 Broadcom platforms that support the WICED SDK via H5 UART

Other Platforms:

Status Port Platform
posix-h4 Unix-based system connected to Bluetooth module 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-h5 Unix-based system connected to Bluetooth module via H5 over serial port
No build server posix-h5-bcm Unix-based system connected to Broadcom/Cypress Bluetooth module via H5 over serial port
libusb Unix-based system with dedicated USB Bluetooth dongle
No build server windows-h4 Win32-based system connected to Bluetooth module via serial port
No build server windows-winusb Win32-based system with dedicated USB Bluetooth dongle
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
ios daemon for iOS jailbreak devices, 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
Cypress CYW20704 Dual mode H4, H5, USB Probably bcm
Dialog Semiconductor DA14581 LE H4, SPI n.a. da14581 Official HCI firmware used
Espressif ESP32 Dual mode VHCI Not yet SoC with Bluetooth and Wifi
EM 9301, 9304 LE SPI n.a. em9301 Custom HCI SPI implementation
Nordic nRF LE H4 n.a. Requires custom HCI firmware
STM STLC2500D Classic H4 No (didn't try) stlc2500d Custom deep sleep management not supported
Toshiba TC35661 Dual mode H4 No (didn't try) tc3566 HCI version not tested.
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