xref: /btstack/README.md (revision 2d04a09a69f613efe06b79a1590fde15b7c8f869)
1*2d04a09aSmilamikica# Welcome to BTstack
2*2d04a09aSmilamikica
3*2d04a09aSmilamikicaBTstack is BlueKitchen's implementation of the official Bluetooth stack. It is well suited for small, resource-constraint devices
4*2d04a09aSmilamikicasuch as 8 or 16 bit embedded systems as it is highly configurable and comes with an ultra small memory footprint.
5*2d04a09aSmilamikicaA minimal configuration for an SPP server on a MSP430 can run in 32 kB FLASH and only 4 kB of RAM.
6*2d04a09aSmilamikica
7*2d04a09aSmilamikicaIt connects to the Bluetooth modules via different Bluetooth HCI transport layers (e.g., HCI H4 UART and
8*2d04a09aSmilamikicaH5 the "Tree-Wire" protocol). The various platforms can be easily targeted by providing the necessary
9*2d04a09aSmilamikicaUART, CPU, and CLOCK implementations.
10*2d04a09aSmilamikica
11*2d04a09aSmilamikicaOn smaller embedded systems, a minimal run loop implementation allows to use BTstack without a Real Time OS (RTOS).
12*2d04a09aSmilamikicaIf a RTOS is already provided, BTstack can be integrated and run as a single thread.
13*2d04a09aSmilamikica
14*2d04a09aSmilamikicaOn larger systems, BTstack provides a daemon that connects to a Bluetooth module.
15*2d04a09aSmilamikicaMultiple applications can communicate with this daemon over different inter-process communication methods.
16*2d04a09aSmilamikica
17*2d04a09aSmilamikicaBTstack supports both, the Central and the Peripheral Role of Bluetooth 4.0 Low Energy specification.
18*2d04a09aSmilamikicaIt can be configures as both a single mode or a dual mode stack.
19*2d04a09aSmilamikica
20*2d04a09aSmilamikicaFor starters, download the [BTstack Manual v1.1](http://bluekitchen-gmbh.com/docs/btstack-gettingstarted-1.1.pdf)
21*2d04a09aSmilamikicaand look for an Architecture overview and the Getting started example for MSP430.
22*2d04a09aSmilamikica
23*2d04a09aSmilamikicaBTstack is free for non-commercial use. For commercial use, <a href="mailto:[email protected]">tell us</a?=>
24*2d04a09aSmilamikicaa bit about your project to get a quote.
25*2d04a09aSmilamikicaThe Serial Port Profile (SPP) and the Bluetooth 4.0 Low Energy Peripheral role (LE Peripheral) have been qualified with
26*2d04a09aSmilamikicathe Bluetooth SIG (QD ID 54558). This summer, we plan to qualify for Bluetooth Core 4.2,
27*2d04a09aSmilamikicatogether with LE Central, PAN/BNEP and HSP.
28*2d04a09aSmilamikica
29*2d04a09aSmilamikica## Supported Protocols
30*2d04a09aSmilamikica* L2CAP
31*2d04a09aSmilamikica* RFCOMM
32*2d04a09aSmilamikica* SDP
33*2d04a09aSmilamikica* BNEP
34*2d04a09aSmilamikica* ATT
35*2d04a09aSmilamikica* SM
36*2d04a09aSmilamikica
37*2d04a09aSmilamikica## Supported Profiles
38*2d04a09aSmilamikica* GAP
39*2d04a09aSmilamikica* IOP
40*2d04a09aSmilamikica* SPP
41*2d04a09aSmilamikica* PAN
42*2d04a09aSmilamikica* GATT
43*2d04a09aSmilamikica* Coming soon: HSP, HFP, and more.
44