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. 20It can be configured to run as either single-mode stack or a dual-mode stack. 21 22BTstack 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. 23 24**Documentation:** [HTML](http://bluekitchen-gmbh.com/btstack/develop/), [PDF](http://bluekitchen-gmbh.com/btstack_develop.pdf) 25 26**Discussion and Community Support:** [BTstack Google Group](http://groups.google.com/group/btstack-dev) 27 28### Supported Protocols and Profiles 29 30**Protocols:** L2CAP, RFCOMM, SDP, BNEP, ATT, SM (incl. LE Secure Connections). 31 32**Profiles** GAP, IOP, HFP, HSP, SPP, PAN, GATT. 33 34**Coming next** A2DP, AVRCP, HID, HOGP, BLE Mesh, and more. 35 36It has been qualified with the the Bluetooth SIG for GAP, IOP, HFP, HSP, SPP, PAN profiles and 37GATT, 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>. 38 39 40 41 42## Evaluation Platforms 43 44#### Embedded Platforms: 45Status | Platform 46-------------- | ------ 47[<img src="http://buildbot.bluekitchen-gmbh.com/btstack/badge.png?builder=port-ez430-rf2560-master">](https://buildbot.bluekitchen-gmbh.com/btstack/builders/port-ez430-rf2560-master) | [EZ430-RF256x Bluetooth Evaluation Tool for MSP430](http://www.ti.com/tool/ez430-rf256x) 48[<img src="http://buildbot.bluekitchen-gmbh.com/btstack/badge.png?builder=port-msp-exp430f5438-cc2564b-master">](https://buildbot.bluekitchen-gmbh.com/btstack/builders/port-msp-exp430f5438-cc2564b-master) | [MSP430F5438 Experimenter Board for MSP430](http://www.ti.com/tool/msp-exp430f5438) with [Bluetooth CC2564 Module Evaluation Board](http://www.ti.com/tool/cc2564modnem) 49[<img src="http://buildbot.bluekitchen-gmbh.com/btstack/badge.png?builder=port-msp430f5229lp-cc2564b-master">](https://buildbot.bluekitchen-gmbh.com/btstack/builders/port-msp430f5229lp-cc2564b-master) | [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 50[<img src="http://buildbot.bluekitchen-gmbh.com/btstack/badge.png?builder=port-stm32-f103rb-nucleo-master">](https://buildbot.bluekitchen-gmbh.com/btstack/builders/port-stm32-f103rb-nucleo-master) | [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 51[<img src="http://buildbot.bluekitchen-gmbh.com/btstack/badge.png?builder=port-pic32-harmony-master">](https://buildbot.bluekitchen-gmbh.com/btstack/builders/port-pic32-harmony-master) | [Microchip's PIC32 Bluetooth Audio Development Kit](http://www.microchip.com/Developmenttools/ProductDetails.aspx?PartNO=DV320032) 52[<img src="http://buildbot.bluekitchen-gmbh.com/btstack/badge.png?builder=port-wiced-master">](https://buildbot.bluekitchen-gmbh.com/btstack/builders/port-wiced-master) | [RedBear Duo](https://github.com/redbear/WICED-SDK) with Broadcom BCM43438 A1 53 54#### Other Platforms: 55Status | Platform 56-------------- | ------ 57[<img src="http://buildbot.bluekitchen-gmbh.com/btstack/badge.png?builder=port-posix-h4-master">](https://buildbot.bluekitchen-gmbh.com/btstack/builders/port-posix-h4-master) | posix-h4: Unix-based system talking to Bluetooth module via serial port 58No build server | posix-h4-da14581: Unix-based system connected to Dialog Semiconductor DA14581 via H4 over serial port 59No build server | posix-h5: Unix-based system connected to Bluetooth module via H5 over serial port 60[<img src="http://buildbot.bluekitchen-gmbh.com/btstack/badge.png?builder=port-libusb-master">](https://buildbot.bluekitchen-gmbh.com/btstack/builders/port-libusb-master) | libusb: Unix-based system talking via USB Bluetooth dongle 61No build server | windows-h4: Win32-based system connected to Bluetooth module via serial port 62No build server | windows-winusb: Win32-based system with dedicated USB Bluetooth dongle 63[<img src="http://buildbot.bluekitchen-gmbh.com/btstack/badge.png?builder=port-daemon-master">](https://buildbot.bluekitchen-gmbh.com/btstack/builders/port-daemon-master) | daemon: TCP and Unix domain named socket client-server architecture supporting multiple clients 64[<img src="http://buildbot.bluekitchen-gmbh.com/btstack/badge.png?builder=java-master">](https://buildbot.bluekitchen-gmbh.com/btstack/builders/java-master) | java: Java wrapper for daemon 65[<img src="http://buildbot.bluekitchen-gmbh.com/btstack/badge.png?builder=port-ios-master">](https://buildbot.bluekitchen-gmbh.com/btstack/builders/port-ios-master) | iOS: daemon for iOS jailbreak devices, C client-server API 66[<img src="http://buildbot.bluekitchen-gmbh.com/btstack/badge.png?builder=port-mtk-master">](https://buildbot.bluekitchen-gmbh.com/btstack/builders/port-mtk-master) | mtk: daemon for rooted Android devices, based on Mediatek MT65xx processor, Java and C client-server API 67[<img src="http://buildbot.bluekitchen-gmbh.com/btstack/badge.png?builder=port-wiced-master">](https://buildbot.bluekitchen-gmbh.com/btstack/builders/port-wiced-master) | wiced: Broadcom platforms that support the WICED SDK 68 69## Supported Chipsets 70 71Chipset | Type | HCI Transport | SCO over HCI (2) | BTstack folder | Comment 72---------------------------- |-----------| ----------------|------------------|----------------|--------- 73Broadcom UART | Dual mode | H4, H5 | Probably | bcm | Max UART baudrate 2 mbps 74Broadcom USB Dongles | Dual mode | USB | Yes | bcm | 75CSR UART | Dual mode | H4, H5 | No (didn't work) | csr | 76CSR USB Dongles | Dual mode | USB | Yes | csr | 77Dialog Semiconductor DA14581 | LE | H4, SPI | n.a. | da14581 | Official HCI firmware used 78EM 9301 | LE | SPI | n.a. | em9301 | Custom HCI SPI implementation 79Nordic nRF | LE | H4 | n.a. | | Requires custom HCI firmware 80STM STLC2500D | Classic | H4 | No (didn't try) | stlc2500d | Custom deep sleep management not supported 81Toshiba TC35661 | Dual mode | H4 | No (didn't try) | tc3566 | HCI version not tested. 82TI CC256x, WL183x | Dual mode | H4, H5, eHCILL | Yes | cc256x | Also WL185x, WL187x, and WL189x 83 84[More infos on supported chipsets](https://bluekitchen-gmbh.com/btstack/chipsets/) 85 86## Source Tree Overview 87Path | Description 88--------------------|--------------- 89chipset | Support for individual Bluetooth chipsets 90doc | Sources for BTstack documentation 91example | Example applications available for all ports 92platform | Support for special OSs and/or MCU architectures 93port | Complete port for a MCU + Chipset combinations 94src | Bluetooth stack implementation 95test | Unit and PTS tests 96tool | Helper tools for BTstack 97
