xref: /btstack/README.md (revision df25739fc3ea5a0a90f0f5925e6461d653697d2e) 
1**_Note: Major API Changes. For older projects, you may use the [v0.9 branch](https://github.com/bluekitchen/btstack/tree/v0.9)_**
2
3# Welcome to BTstack
4
5BTstack is [BlueKitchen's](http://bluekitchen-gmbh.com) implementation of the official Bluetooth stack.
6It is well suited for small, resource-constraint devices
7such as 8 or 16 bit embedded systems as it is highly configurable and comes with an ultra small memory footprint.
8A minimal configuration for an SPP server on a MSP430 can run in 32 kB FLASH and only 4 kB of RAM.
9
10It connects to the Bluetooth modules via a different Bluetooth HCI transport layers (e.g., HCI H4 UART and
11H5 the "Tree-Wire" protocol, HCI H2 USB). Various platforms can be easily targeted by providing the necessary
12UART, CPU, and CLOCK implementations.
13
14On smaller embedded systems, a minimal run loop implementation allows to use BTstack without a Real Time OS (RTOS).
15If a RTOS is already provided, BTstack can be integrated and run as a single thread.
16
17On larger systems, BTstack provides a daemon that connects to a Bluetooth module.
18Multiple applications can communicate with this daemon over different inter-process communication methods.
19
20BTstack supports both, the Central and the Peripheral Role of Bluetooth 4.2 Low Energy specification.
21It can be configures as both a single mode or a dual mode stack.
22
23BTstack is free for non-commercial use. For commercial use, <a href="mailto:[email protected]">tell us</a>
24a bit about your project to get a quote.
25It has been qualified with the the Bluetooth SIG for GAP, IOP, HFP, HSP, SPP, PAN profiles and
26GATT, SM of the Bluetooth 4.2 LE Central and Peripheral roles (QD ID 25340).
27
28## Documentation
29- [HTML](http://bluekitchen-gmbh.com/btstack/v1.0)
30- [PDF](http://bluekitchen-gmbh.com/btstack_v1.0.pdf)
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* HFP
45* HSP
46* SPP
47* PAN
48* GATT
49
50Coming next: HID, HOGP, A2DP, and more.
51
52## Evaluation Platforms
53
54#### Embedded Platforms:
55Status               | Platform
56--------------       | ------
57![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)
58![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)
59![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
60![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
61![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)
62![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
63
64
65#### Other Platforms:
66Status               | Platform
67--------------       | ------
68![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
69![buildstatus](http://buildbot.bluekitchen-gmbh.com/btstack/badge.png?builder=port-libusb-develop)| libusb: Unix-based system talking via USB Bluetooth dongle
70![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
71![buildstatus](http://buildbot.bluekitchen-gmbh.com/btstack/badge.png?builder=java-develop)| java: Java wrapper for daemon
72![buildstatus](http://buildbot.bluekitchen-gmbh.com/btstack/badge.png?builder=port-ios-develop)| iOS: daemon for iOS jailbreak devices, C client-server API
73![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
74![buildstatus](http://buildbot.bluekitchen-gmbh.com/btstack/badge.png?builder=port-wiced-develop) | wiced: Broadcom platforms that support the WICED SDK
75
76## Supported Chipsets
77Chipsets             | Status
78--------------       | ------
79TI CC256x, WL183x    | complete incl. eHCIll support and SCO-over-HCI (chipset/cc256x)
80CSR 8x10, 8x11       | H4 only (chipset-csr), SCO-over-HCI missing (chipset/csr)
81STM STLC2500D        | working, no support for custom deep sleep management (chipset/stlc2500d)
82TC35661              | working, BLE patches missing (chipset/tc3566x)
83EM 9301 (LE-only)    | working, used on Arduino Shield (chipset/em9301)
84CSR USB Dongles      | complete, incl. SCO-over-HCI
85Broadcom USB Dongles | complete, SCO-over-HCI not missing
86Broadcom BCM43438    | complete. UART baudrate limited to 3 mbps, SCO-over-HCI not missing
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
100## Discussion and Community Support
101[BTstack Google Group](http://groups.google.com/group/btstack-dev)
102