xref: /btstack/README.md (revision bac2979a30d414ca7ccf9c7127f8a0761e4a1ba8)
12d04a09aSmilamikica# Welcome to BTstack
22d04a09aSmilamikica
3*bac2979aSMilanka RingwaldBTstack is [BlueKitchen's](http://bluekitchen-gmbh.com) implementation of the official Bluetooth stack.
4*bac2979aSMilanka RingwaldIt is well suited for small, resource-constraint devices
52d04a09aSmilamikicasuch as 8 or 16 bit embedded systems as it is highly configurable and comes with an ultra small memory footprint.
62d04a09aSmilamikicaA minimal configuration for an SPP server on a MSP430 can run in 32 kB FLASH and only 4 kB of RAM.
72d04a09aSmilamikica
82d04a09aSmilamikicaIt connects to the Bluetooth modules via different Bluetooth HCI transport layers (e.g., HCI H4 UART and
92d04a09aSmilamikicaH5 the "Tree-Wire" protocol). The various platforms can be easily targeted by providing the necessary
102d04a09aSmilamikicaUART, CPU, and CLOCK implementations.
112d04a09aSmilamikica
122d04a09aSmilamikicaOn smaller embedded systems, a minimal run loop implementation allows to use BTstack without a Real Time OS (RTOS).
132d04a09aSmilamikicaIf a RTOS is already provided, BTstack can be integrated and run as a single thread.
142d04a09aSmilamikica
152d04a09aSmilamikicaOn larger systems, BTstack provides a daemon that connects to a Bluetooth module.
162d04a09aSmilamikicaMultiple applications can communicate with this daemon over different inter-process communication methods.
172d04a09aSmilamikica
182d04a09aSmilamikicaBTstack supports both, the Central and the Peripheral Role of Bluetooth 4.0 Low Energy specification.
192d04a09aSmilamikicaIt can be configures as both a single mode or a dual mode stack.
202d04a09aSmilamikica
21*bac2979aSMilanka RingwaldFor starters, download the [BTstack Manual](https://github.com/bluekitchen/btstack/blob/master/docs/manual/btstack-manual.pdf)
222d04a09aSmilamikicaand look for an Architecture overview and the Getting started example for MSP430.
232d04a09aSmilamikica
242d04a09aSmilamikicaBTstack is free for non-commercial use. For commercial use, <a href="mailto:[email protected]">tell us</a?=>
252d04a09aSmilamikicaa bit about your project to get a quote.
262d04a09aSmilamikicaThe Serial Port Profile (SPP) and the Bluetooth 4.0 Low Energy Peripheral role (LE Peripheral) have been qualified with
272d04a09aSmilamikicathe Bluetooth SIG (QD ID 54558). This summer, we plan to qualify for Bluetooth Core 4.2,
282d04a09aSmilamikicatogether with LE Central, PAN/BNEP and HSP.
292d04a09aSmilamikica
302d04a09aSmilamikica## Supported Protocols
312d04a09aSmilamikica* L2CAP
322d04a09aSmilamikica* RFCOMM
332d04a09aSmilamikica* SDP
342d04a09aSmilamikica* BNEP
352d04a09aSmilamikica* ATT
362d04a09aSmilamikica* SM
372d04a09aSmilamikica
38*bac2979aSMilanka Ringwald
392d04a09aSmilamikica## Supported Profiles
402d04a09aSmilamikica* GAP
412d04a09aSmilamikica* IOP
422d04a09aSmilamikica* SPP
432d04a09aSmilamikica* PAN
442d04a09aSmilamikica* GATT
45*bac2979aSMilanka Ringwald
46*bac2979aSMilanka RingwaldComing soon: HSP, HFP, and more.
47*bac2979aSMilanka Ringwald
48*bac2979aSMilanka Ringwald## Supported Platforms
49*bac2979aSMilanka RingwaldEmbedded Platforms      |
50*bac2979aSMilanka Ringwald----------------------- |
51*bac2979aSMilanka Ringwaldez430-rf2560            |
52*bac2979aSMilanka Ringwaldmsp-exp430f5438-cc2564b |
53*bac2979aSMilanka Ringwaldmsp430f5229lp-cc2564b   |
54*bac2979aSMilanka Ringwaldstm32-f103rb-nucleo     |
55*bac2979aSMilanka Ringwaldpic32-harmony           |
56*bac2979aSMilanka Ringwald
57*bac2979aSMilanka RingwaldOther Platforms         |
58*bac2979aSMilanka Ringwald----------------------- |
59*bac2979aSMilanka Ringwaldposix                   |
60*bac2979aSMilanka Ringwaldlibusb                  |
61*bac2979aSMilanka RingwaldiOS                     |
62*bac2979aSMilanka Ringwaldmtk                     |
63*bac2979aSMilanka Ringwaldjava                    |
64*bac2979aSMilanka Ringwald
65*bac2979aSMilanka Ringwald## Supported Chipsets
66*bac2979aSMilanka RingwaldChipsets             | Status
67*bac2979aSMilanka Ringwald--------------       | ------
68*bac2979aSMilanka RingwaldTI CC256x            | complete, incl. eHCIll support
69*bac2979aSMilanka RingwaldCSR 8811, 8510       | H4 only
70*bac2979aSMilanka RingwaldEM 9301              | experimental use on Arduino Shield
71*bac2979aSMilanka RingwaldCSR USB Dongles      | complete
72*bac2979aSMilanka RingwaldBroadcom USB Dongles | complete
73*bac2979aSMilanka Ringwald
74