1**_Note: Major API Changes. For older projects, you may use the [v0.9 branch](https://github.com/bluekitchen/btstack/tree/v0.9). 2Please see [Migration notes](https://github.com/bluekitchen/btstack/blob/master/doc/manual/docs/appendix/migration.md)_** 3 4# Welcome to BTstack 5 6BTstack is [BlueKitchen's](http://bluekitchen-gmbh.com) implementation of the official Bluetooth stack. 7It is well suited for small, resource-constraint devices 8such as 8 or 16 bit embedded systems as it is highly configurable and comes with an ultra small memory footprint. 9A minimal configuration for an SPP server on a MSP430 can run in 32 kB FLASH and only 4 kB of RAM. 10 11Targeting 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. 12 13On smaller embedded systems, a minimal run loop implementation allows to use BTstack without a Real Time OS (RTOS). 14If a RTOS is already provided, BTstack can be integrated and run as a single thread. 15 16On larger systems, BTstack provides a daemon that connects to a Bluetooth module. 17Multiple applications can communicate with this daemon over different inter-process communication methods. 18 19BTstack supports the Central and the Peripheral Role of Bluetooth 4.2 Low Energy specification incl. LE Secure Connections, LE Data Channels, and LE Data Lenght Extension. It can be configured to run as either single-mode stack or a dual-mode stack. 20 21BTstack is free for non-commercial use. However, for commercial use, <a href="mailto:[email protected]">tell us</a> a bit about your project to get a quote. 22 23**Documentation:** [HTML](http://bluekitchen-gmbh.com/btstack/develop/), [PDF](http://bluekitchen-gmbh.com/btstack_develop.pdf) 24 25**Discussion and Community Support:** [BTstack Google Group](http://groups.google.com/group/btstack-dev) 26 27### Supported Protocols and Profiles 28 29**Protocols:** L2CAP, RFCOMM, SDP, BNEP, ATT, SM (incl. LE Secure Connections). 30 31**Profiles** GAP, IOP, HFP, HSP, SPP, PAN, GATT. 32 33**Coming next** A2DP, AVRCP, HID, HOGP, BLE Mesh, and more. 34 35It has been qualified with the the Bluetooth SIG for GAP, IOP, HFP, HSP, SPP, PAN profiles and 36GATT, SM of the Bluetooth 4.2 LE Central and Peripheral roles (QD ID 25340). For information on MFi/iAP2 support, please <a href="mailto:[email protected]">contact us</a>. 37 38 39 40 41## Evaluation Platforms 42 43#### Embedded Platforms: 44Status | Platform 45-------------- | ------ 46[<img src="http://buildbot.bluekitchen-gmbh.com/btstack/badge.png?builder=port-ez430-rf2560-develop">](https://buildbot.bluekitchen-gmbh.com/btstack/builders/port-ez430-rf2560-develop) | [EZ430-RF256x Bluetooth Evaluation Tool for MSP430](http://www.ti.com/tool/ez430-rf256x) 47[<img src="http://buildbot.bluekitchen-gmbh.com/btstack/badge.png?builder=port-msp-exp430f5438-cc2564b-develop">](https://buildbot.bluekitchen-gmbh.com/btstack/builders/port-msp-exp430f5438-cc2564b-develop) | [MSP430F5438 Experimenter Board for MSP430](http://www.ti.com/tool/msp-exp430f5438) with [Bluetooth CC2564 Module Evaluation Board](http://www.ti.com/tool/cc2564modnem) 48[<img src="http://buildbot.bluekitchen-gmbh.com/btstack/badge.png?builder=port-msp430f5229lp-cc2564b-develop">](https://buildbot.bluekitchen-gmbh.com/btstack/builders/port-msp430f5229lp-cc2564b-develop) | [MSP-EXP430F5529LP LaunchPad](http://www.ti.com/ww/en/launchpad/launchpads-msp430-msp-exp430f5529lp.html#tabs) with [Bluetooth CC2564 Module Evaluation Board](http://www.ti.com/tool/cc2564modnem) and [EM Adapter BoosterPack](http://www.ti.com/tool/boost-ccemadapter) with additional 32768Hz quartz oscillator 49[<img src="http://buildbot.bluekitchen-gmbh.com/btstack/badge.png?builder=port-stm32-f103rb-nucleo-develop">](https://buildbot.bluekitchen-gmbh.com/btstack/builders/port-stm32-f103rb-nucleo-develop) | [STM32 Nucleo development board NUCLEO-F103RB](http://www.st.com/web/catalog/tools/FM116/SC959/SS1532/LN1847/PF259875) with [Bluetooth CC2564 Module Evaluation Board](http://www.ti.com/tool/cc2564modnem) and [EM Adapter BoosterPack](http://www.ti.com/tool/boost-ccemadapter) with additional 32768Hz quartz oscillator 50No build Server | [STM32 F4 Discovery Board](http://www.st.com/en/evaluation-tools/stm32f4discovery.html) with [CC256xEM Bluetooth Adatper 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) 51No build Server | EM9304 DVK consisting of an STM32 Nucleo L053R board with an EM9304 in an Arduino form-factor 52[<img src="http://buildbot.bluekitchen-gmbh.com/btstack/badge.png?builder=port-pic32-harmony-develop">](https://buildbot.bluekitchen-gmbh.com/btstack/builders/port-pic32-harmony-develop) | [Microchip's PIC32 Bluetooth Audio Development Kit](http://www.microchip.com/Developmenttools/ProductDetails.aspx?PartNO=DV320032) 53[<img src="http://buildbot.bluekitchen-gmbh.com/btstack/badge.png?builder=port-wiced-h4-develop">](https://buildbot.bluekitchen-gmbh.com/btstack/builders/port-wiced-h4-develop) | [RedBear Duo](https://github.com/redbear/WICED-SDK) with Broadcom BCM43438 A1 54 55 56#### Other Platforms: 57Status | Platform 58-------------- | ------ 59[<img src="http://buildbot.bluekitchen-gmbh.com/btstack/badge.png?builder=port-posix-h4-develop">](https://buildbot.bluekitchen-gmbh.com/btstack/builders/port-posix-h4-develop) | posix-h4: Unix-based system connected to Bluetooth module via H4 over serial port 60.. | posix-h4-da14581: Unix-based system connected to Dialog Semiconductor DA14581 via H4 over serial port 61.. | posix-h5: Unix-based system connected to Bluetooth module via H5 over serial port 62[<img src="http://buildbot.bluekitchen-gmbh.com/btstack/badge.png?builder=port-libusb-develop">](https://buildbot.bluekitchen-gmbh.com/btstack/builders/port-libusb-develop) | libusb: Unix-based system with dedicated USB Bluetooth dongle 63.. | windows-h4: Win32-based system connected to Bluetooth module via serial port 64.. | windows-winusb: Win32-based system with dedicated USB Bluetooth dongle 65.. | [FreeRTOS](http://www.freertos.org): Run BTstack on a dedicated thread, not thread-safe. 66[<img src="http://buildbot.bluekitchen-gmbh.com/btstack/badge.png?builder=port-daemon-develop">](https://buildbot.bluekitchen-gmbh.com/btstack/builders/port-daemon-develop) | daemon: TCP and Unix domain named socket client-server architecture supporting multiple clients 67[<img src="http://buildbot.bluekitchen-gmbh.com/btstack/badge.png?builder=java-develop">](https://buildbot.bluekitchen-gmbh.com/btstack/builders/java-develop) | java: Java wrapper for daemon 68[<img src="http://buildbot.bluekitchen-gmbh.com/btstack/badge.png?builder=port-ios-develop">](https://buildbot.bluekitchen-gmbh.com/btstack/builders/port-ios-develop) | iOS: daemon for iOS jailbreak devices, C client-server API 69[<img src="http://buildbot.bluekitchen-gmbh.com/btstack/badge.png?builder=port-mtk-develop">](https://buildbot.bluekitchen-gmbh.com/btstack/builders/port-mtk-develop) | mtk: daemon for rooted Android devices, based on Mediatek MT65xx processor, Java and C client-server API 70[<img src="http://buildbot.bluekitchen-gmbh.com/btstack/badge.png?builder=port-wiced-h4-develop">](https://buildbot.bluekitchen-gmbh.com/btstack/builders/port-wiced-develop) | wiced: Broadcom platforms that support the WICED SDK 71## Supported Chipsets 72 73Chipset | Type | HCI Transport | SCO over HCI (2) | BTstack folder | Comment 74---------------------------- |-----------| ----------------|------------------|----------------|--------- 75Broadcom UART | Dual mode | H4, H5 | Probably | bcm | Max UART baudrate 2 mbps 76Broadcom USB Dongles | Dual mode | USB | Yes | bcm | 77CSR UART | Dual mode | H4, H5, BCSP | No (didn't work) | csr | 78CSR USB Dongles | Dual mode | USB | Yes | csr | 79Dialog Semiconductor DA14581 | LE | H4, SPI | n.a. | da14581 | Official HCI firmware used 80EM 9301, 9304 | LE | SPI | n.a. | em9301 | Custom HCI SPI implementation 81Nordic nRF | LE | H4 | n.a. | | Requires custom HCI firmware 82STM STLC2500D | Classic | H4 | No (didn't try) | stlc2500d | Custom deep sleep management not supported 83Toshiba TC35661 | Dual mode | H4 | No (didn't try) | tc3566 | HCI version not tested. 84TI CC256x, WL183x | Dual mode | H4, H5, eHCILL | Yes | cc256x | Also WL185x, WL187x, and WL189x 85 86[More infos on supported chipsets](https://bluekitchen-gmbh.com/btstack/develop/chipsets/) 87 88## Source Tree Overview 89Path | Description 90--------------------|--------------- 91chipset | Support for individual Bluetooth chipsets 92doc | Sources for BTstack documentation 93example | Example applications available for all ports 94platform | Support for special OSs and/or MCU architectures 95port | Complete port for a MCU + Chipset combinations 96src | Bluetooth stack implementation 97test | Unit and PTS tests 98tool | Helper tools for BTstack 99
