xref: /btstack/README.md (revision 0776193fa3b52cbe4b233504a5ca992f3585d54b) 
1# Welcome to BTstack
2
3BTstack is [BlueKitchen's](http://bluekitchen-gmbh.com) implementation of the official Bluetooth stack.
4It is well suited for small, resource-constraint devices
5such as 8 or 16 bit embedded systems as it is highly configurable and comes with an ultra small memory footprint.
6A minimal configuration for an SPP server on a MSP430 can run in 32 kB FLASH and only 4 kB of RAM.
7
8It connects to the Bluetooth modules via different Bluetooth HCI transport layers (e.g., HCI H4 UART and
9H5 the "Tree-Wire" protocol). The various platforms can be easily targeted by providing the necessary
10UART, CPU, and CLOCK implementations.
11
12On smaller embedded systems, a minimal run loop implementation allows to use BTstack without a Real Time OS (RTOS).
13If a RTOS is already provided, BTstack can be integrated and run as a single thread.
14
15On larger systems, BTstack provides a daemon that connects to a Bluetooth module.
16Multiple applications can communicate with this daemon over different inter-process communication methods.
17
18BTstack supports both, the Central and the Peripheral Role of Bluetooth 4.0 Low Energy specification.
19It can be configures as both a single mode or a dual mode stack.
20
21BTstack is free for non-commercial use. For commercial use, <a href="mailto:[email protected]">tell us</a>
22a bit about your project to get a quote.
23The Serial Port Profile (SPP) and the Bluetooth 4.0 Low Energy Peripheral role (LE Peripheral) have been qualified with
24the Bluetooth SIG (QD ID 54558). This summer, we plan to qualify for Bluetooth Core 4.2,
25together with LE Central, PAN/BNEP and HSP.
26
27## Documentation
28For starters, check the BTstack Manual:
29- [PDF](https://github.com/bluekitchen/btstack/raw/master/docs/manual/btstack-manual.pdf)
30- [HTML](http://bluekitchen-gmbh.com/btstack/)
31
32## Supported Protocols
33* L2CAP
34* RFCOMM
35* SDP
36* BNEP
37* ATT
38* SM
39
40
41## Supported Profiles
42* GAP
43* IOP
44* SPP
45* PAN
46* GATT
47
48Coming soon: HSP, HFP, and more.
49
50## Evaluation Platforms
51
52#### Embedded Platforms:
53Status               | Platform
54--------------       | ------
55![buildstatus](http://buildbot.bluekitchen-gmbh.com/btstack/badges/badge.png?builder=platform-ez430-rf2560) | [EZ430-RF256x Bluetooth Evaluation Tool for MSP430](http://www.ti.com/tool/ez430-rf256x)
56![buildstatus](http://buildbot.bluekitchen-gmbh.com/btstack/badges/badge.png?builder=platform-msp-exp430f5438-cc2564b) | [MSP430F5438 Experimenter Board for MSP430](http://www.ti.com/tool/msp-exp430f5438) with [Bluetooth CC2564 Module Evaluation Board](http://www.ti.com/tool/cc2564modnem)
57![buildstatus](http://buildbot.bluekitchen-gmbh.com/btstack/badges/badge.png?builder=platform-msp430f5229lp-cc2564b) | [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
58![buildstatus](http://buildbot.bluekitchen-gmbh.com/btstack/badges/badge.png?builder=platform-stm32-f103rb-nucleo) | [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
59![buildstatus](http://buildbot.bluekitchen-gmbh.com/btstack/badges/badge.png?builder=platform-pic32-harmony) | [Microchip's PIC32 Bluetooth Audio Development Kit](http://www.microchip.com/Developmenttools/ProductDetails.aspx?PartNO=DV320032)
60
61
62#### Other Platforms:
63Status               | Platform
64--------------       | ------
65![buildstatus](http://buildbot.bluekitchen-gmbh.com/btstack/badges/badge.png?builder=platform-posix-stlc2500d)| posix: Unix-based system talking to Bluetooth module via serial port
66![buildstatus](http://buildbot.bluekitchen-gmbh.com/btstack/badges/badge.png?builder=platform-libusb)| libusb: Unix-based system talking via USB Bluetooth dongle
67![buildstatus](http://buildbot.bluekitchen-gmbh.com/btstack/badges/badge.png?builder=platform-daemon)| daemon: TCP and Unix domain named socket client-server architecture supporting multiple clients
68![buildstatus](http://buildbot.bluekitchen-gmbh.com/btstack/badges/badge.png?builder=java)| java: Java wrapper for daemon
69![buildstatus](http://buildbot.bluekitchen-gmbh.com/btstack/badges/badge.png?builder=platform-ios)| iOS: daemon for iOS jailbreak devices, C client-server API
70![buildstatus](http://buildbot.bluekitchen-gmbh.com/btstack/badges/badge.png?builder=platform-mtk)| mtk: daemon for rooted Android devices, based on Mediatek MT65xx processor, Java and C client-server API
71
72
73## Supported Chipsets
74Chipsets             | Status
75--------------       | ------
76TI CC256x, WL183x    | complete incl. eHCIll support (chipset-cc256x)
77CSR 8811, 8510       | H4 only (chipset-csr)
78STM STLC2500D        | working, no support for custom deep sleep management (chipset-stlc2500d)
79EM 9301              | experimental use on Arduino Shield (chipset-em9301)
80CSR USB Dongles      | complete
81Broadcom USB Dongles | complete
82
83## Discussion and Community Support
84[BTstack Google Group](http://groups.google.com/group/btstack-dev)
85