xref: /btstack/README.md (revision b3d63497f11cd0e7f47a05dc10ebcf23a8cdc4b6) 
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 a different Bluetooth HCI transport layers (e.g., HCI H4 UART and
9H5 the "Tree-Wire" protocol, HCI H2 USB). 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.2 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.
23It has been qualified with the the Bluetooth SIG for GAP, IOP, HFP, HSP, SPP, PAN profiles and
24GATT, SM of the Bluetooth 4.2 LE Central and Peripheral roles (QD ID 25340).
25
26## Documentation
27- [HTML](http://bluekitchen-gmbh.com/btstack/v1.0)
28- [PDF](http://bluekitchen-gmbh.com/btstack_v1.0.pdf)
29
30## Supported Protocols
31* L2CAP
32* RFCOMM
33* SDP
34* BNEP
35* ATT
36* SM
37
38
39## Supported Profiles
40* GAP
41* IOP
42* HFP
43* HSP
44* SPP
45* PAN
46* GATT
47
48Coming next: HID, HOGP, A2DP, and more.
49
50## Evaluation Platforms
51
52#### Embedded Platforms:
53Status               | Platform
54--------------       | ------
55![buildstatus](http://buildbot.bluekitchen-gmbh.com/btstack/badge.png?builder=port-ez430-rf2560-develop) | [EZ430-RF256x Bluetooth Evaluation Tool for MSP430](http://www.ti.com/tool/ez430-rf256x)
56![buildstatus](http://buildbot.bluekitchen-gmbh.com/btstack/badge.png?builder=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)
57![buildstatus](http://buildbot.bluekitchen-gmbh.com/btstack/badge.png?builder=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
58![buildstatus](http://buildbot.bluekitchen-gmbh.com/btstack/badge.png?builder=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
59![buildstatus](http://buildbot.bluekitchen-gmbh.com/btstack/badge.png?builder=port-pic32-harmony-develop) | [Microchip's PIC32 Bluetooth Audio Development Kit](http://www.microchip.com/Developmenttools/ProductDetails.aspx?PartNO=DV320032)
60![buildstatus](http://buildbot.bluekitchen-gmbh.com/btstack/badge.png?builder=port-wiced-develop) | [RedBear Duo](https://github.com/redbear/WICED-SDK) with Broadcom BCM43438 A1
61
62
63#### Other Platforms:
64Status               | Platform
65--------------       | ------
66![buildstatus](http://buildbot.bluekitchen-gmbh.com/btstack/badge.png?builder=port-posix-h4-develop)| posix: Unix-based system talking to Bluetooth module via serial port
67![buildstatus](http://buildbot.bluekitchen-gmbh.com/btstack/badge.png?builder=port-libusb-develop)| libusb: Unix-based system talking via USB Bluetooth dongle
68![buildstatus](http://buildbot.bluekitchen-gmbh.com/btstack/badge.png?builder=port-daemon-develop)| daemon: TCP and Unix domain named socket client-server architecture supporting multiple clients
69![buildstatus](http://buildbot.bluekitchen-gmbh.com/btstack/badge.png?builder=java-develop)| java: Java wrapper for daemon
70![buildstatus](http://buildbot.bluekitchen-gmbh.com/btstack/badge.png?builder=port-ios-develop)| iOS: daemon for iOS jailbreak devices, C client-server API
71![buildstatus](http://buildbot.bluekitchen-gmbh.com/btstack/badge.png?builder=port-mtk-develop)| mtk: daemon for rooted Android devices, based on Mediatek MT65xx processor, Java and C client-server API
72![buildstatus](http://buildbot.bluekitchen-gmbh.com/btstack/badge.png?builder=port-wiced-develop) | wiced: Broadcom platforms that support the WICED SDK
73
74## Supported Chipsets
75Chipsets             | Status
76--------------       | ------
77TI CC256x, WL183x    | complete incl. eHCIll support and SCO-over-HCI (chipset/cc256x)
78CSR 8x10, 8x11       | H4 only (chipset-csr), SCO-over-HCI missing (chipset/csr)
79STM STLC2500D        | working, no support for custom deep sleep management (chipset/stlc2500d)
80TC35661              | working, BLE patches missing (chipset/tc3566x)
81EM 9301 (LE-only)    | working, used on Arduino Shield (chipset/em9301)
82CSR USB Dongles      | complete, incl. SCO-over-HCI
83Broadcom USB Dongles | complete, SCO-over-HCI not missing
84Broadcom BCM43438    | complete. UART baudrate limited to 3 mbps, SCO-over-HCI not missing
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
98## Discussion and Community Support
99[BTstack Google Group](http://groups.google.com/group/btstack-dev)
100