README.md (ee0ea9ae0334f720f9296460675816e0e15e7ebe) README.md (daa2e90cf24e5bf3332f97f7b7b6cedf00b32a36)
1**_Note: Major API Changes. For older projects, you may use the [v0.9 branch](https://github.com/bluekitchen/btstack/tree/v0.9).
2Please see [Migration notes](https://github.com/bluekitchen/btstack/blob/master/doc/manual/docs/appendix/migration.md)_**
3
4# Welcome to BTstack
5
6BTstack is [BlueKitchen's](http://bluekitchen-gmbh.com) implementation of the official Bluetooth stack.
7It is well suited for small, resource-constraint devices
8such as 8 or 16 bit embedded systems as it is highly configurable and comes with an ultra small memory footprint.

--- 30 unchanged lines hidden (view full) ---

39
40
41
42## Evaluation Platforms
43
44#### Embedded Platforms:
45Status | Platform
46-------------- | ------
1**_Note: Major API Changes. For older projects, you may use the [v0.9 branch](https://github.com/bluekitchen/btstack/tree/v0.9).
2Please see [Migration notes](https://github.com/bluekitchen/btstack/blob/master/doc/manual/docs/appendix/migration.md)_**
3
4# Welcome to BTstack
5
6BTstack is [BlueKitchen's](http://bluekitchen-gmbh.com) implementation of the official Bluetooth stack.
7It is well suited for small, resource-constraint devices
8such as 8 or 16 bit embedded systems as it is highly configurable and comes with an ultra small memory footprint.

--- 30 unchanged lines hidden (view full) ---

39
40
41
42## Evaluation Platforms
43
44#### Embedded Platforms:
45Status | Platform
46-------------- | ------
47[<img src="http://buildbot.bluekitchen-gmbh.com/btstack/badge.png?builder=port-ez430-rf2560-master">](https://buildbot.bluekitchen-gmbh.com/btstack/builders/port-ez430-rf2560-master) | [EZ430-RF256x Bluetooth Evaluation Tool for MSP430](http://www.ti.com/tool/ez430-rf256x)
48[<img src="http://buildbot.bluekitchen-gmbh.com/btstack/badge.png?builder=port-msp-exp430f5438-cc2564b-master">](https://buildbot.bluekitchen-gmbh.com/btstack/builders/port-msp-exp430f5438-cc2564b-master) | [MSP430F5438 Experimenter Board for MSP430](http://www.ti.com/tool/msp-exp430f5438) with [Bluetooth CC2564 Module Evaluation Board](http://www.ti.com/tool/cc2564modnem)
49[<img src="http://buildbot.bluekitchen-gmbh.com/btstack/badge.png?builder=port-msp430f5229lp-cc2564b-master">](https://buildbot.bluekitchen-gmbh.com/btstack/builders/port-msp430f5229lp-cc2564b-master) | [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
50[<img src="http://buildbot.bluekitchen-gmbh.com/btstack/badge.png?builder=port-stm32-f103rb-nucleo-master">](https://buildbot.bluekitchen-gmbh.com/btstack/builders/port-stm32-f103rb-nucleo-master) | [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
51[<img src="http://buildbot.bluekitchen-gmbh.com/btstack/badge.png?builder=port-pic32-harmony-master">](https://buildbot.bluekitchen-gmbh.com/btstack/builders/port-pic32-harmony-master) | [Microchip's PIC32 Bluetooth Audio Development Kit](http://www.microchip.com/Developmenttools/ProductDetails.aspx?PartNO=DV320032)
52[<img src="http://buildbot.bluekitchen-gmbh.com/btstack/badge.png?builder=port-wiced-master">](https://buildbot.bluekitchen-gmbh.com/btstack/builders/port-wiced-master) | [RedBear Duo](https://github.com/redbear/WICED-SDK) with Broadcom BCM43438 A1
47[<img src="http://buildbot.bluekitchen-gmbh.com/btstack/badge.png?builder=port-ez430-rf2560-develop">](https://buildbot.bluekitchen-gmbh.com/btstack/builders/port-ez430-rf2560-develop) | [EZ430-RF256x Bluetooth Evaluation Tool for MSP430](http://www.ti.com/tool/ez430-rf256x)
48[<img src="http://buildbot.bluekitchen-gmbh.com/btstack/badge.png?builder=port-msp-exp430f5438-cc2564b-develop">](https://buildbot.bluekitchen-gmbh.com/btstack/builders/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)
49[<img src="http://buildbot.bluekitchen-gmbh.com/btstack/badge.png?builder=port-msp430f5229lp-cc2564b-develop">](https://buildbot.bluekitchen-gmbh.com/btstack/builders/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
50[<img src="http://buildbot.bluekitchen-gmbh.com/btstack/badge.png?builder=port-stm32-f103rb-nucleo-develop">](https://buildbot.bluekitchen-gmbh.com/btstack/builders/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
51[<img src="http://buildbot.bluekitchen-gmbh.com/btstack/badge.png?builder=port-pic32-harmony-develop">](https://buildbot.bluekitchen-gmbh.com/btstack/builders/port-pic32-harmony-develop) | [Microchip's PIC32 Bluetooth Audio Development Kit](http://www.microchip.com/Developmenttools/ProductDetails.aspx?PartNO=DV320032)
52[<img src="http://buildbot.bluekitchen-gmbh.com/btstack/badge.png?builder=port-wiced-develop">](https://buildbot.bluekitchen-gmbh.com/btstack/builders/port-wiced-develop) | [RedBear Duo](https://github.com/redbear/WICED-SDK) with Broadcom BCM43438 A1
53
53
54
54#### Other Platforms:
55Status | Platform
56-------------- | ------
55#### Other Platforms:
56Status | Platform
57-------------- | ------
57[<img src="http://buildbot.bluekitchen-gmbh.com/btstack/badge.png?builder=port-posix-h4-master">](https://buildbot.bluekitchen-gmbh.com/btstack/builders/port-posix-h4-master) | posix-h4: Unix-based system talking to Bluetooth module via serial port
58No build server | posix-h4-da14581: Unix-based system connected to Dialog Semiconductor DA14581 via H4 over serial port
59No build server | posix-h5: Unix-based system connected to Bluetooth module via H5 over serial port
60[<img src="http://buildbot.bluekitchen-gmbh.com/btstack/badge.png?builder=port-libusb-master">](https://buildbot.bluekitchen-gmbh.com/btstack/builders/port-libusb-master) | libusb: Unix-based system talking via USB Bluetooth dongle
61No build server | windows-h4: Win32-based system connected to Bluetooth module via serial port
62No build server | windows-winusb: Win32-based system with dedicated USB Bluetooth dongle
63[<img src="http://buildbot.bluekitchen-gmbh.com/btstack/badge.png?builder=port-daemon-master">](https://buildbot.bluekitchen-gmbh.com/btstack/builders/port-daemon-master) | daemon: TCP and Unix domain named socket client-server architecture supporting multiple clients
64[<img src="http://buildbot.bluekitchen-gmbh.com/btstack/badge.png?builder=java-master">](https://buildbot.bluekitchen-gmbh.com/btstack/builders/java-master) | java: Java wrapper for daemon
65[<img src="http://buildbot.bluekitchen-gmbh.com/btstack/badge.png?builder=port-ios-master">](https://buildbot.bluekitchen-gmbh.com/btstack/builders/port-ios-master) | iOS: daemon for iOS jailbreak devices, C client-server API
66[<img src="http://buildbot.bluekitchen-gmbh.com/btstack/badge.png?builder=port-mtk-master">](https://buildbot.bluekitchen-gmbh.com/btstack/builders/port-mtk-master) | mtk: daemon for rooted Android devices, based on Mediatek MT65xx processor, Java and C client-server API
67[<img src="http://buildbot.bluekitchen-gmbh.com/btstack/badge.png?builder=port-wiced-master">](https://buildbot.bluekitchen-gmbh.com/btstack/builders/port-wiced-master) | wiced: Broadcom platforms that support the WICED SDK
58[<img src="http://buildbot.bluekitchen-gmbh.com/btstack/badge.png?builder=port-posix-h4-develop">](https://buildbot.bluekitchen-gmbh.com/btstack/builders/port-posix-h4-develop) | posix-h4: Unix-based system connected to Bluetooth module via H4 over serial port
59.. | posix-h4-da14581: Unix-based system connected to Dialog Semiconductor DA14581 via H4 over serial port
60.. | posix-h5: Unix-based system connected to Bluetooth module via H5 over serial port
61[<img src="http://buildbot.bluekitchen-gmbh.com/btstack/badge.png?builder=port-libusb-develop">](https://buildbot.bluekitchen-gmbh.com/btstack/builders/port-libusb-develop) | libusb: Unix-based system with dedicated USB Bluetooth dongle
62.. | windows-h4: Win32-based system connected to Bluetooth module via serial port
63.. | windows-winusb: Win32-based system with dedicated USB Bluetooth dongle
64[<img src="http://buildbot.bluekitchen-gmbh.com/btstack/badge.png?builder=port-daemon-develop">](https://buildbot.bluekitchen-gmbh.com/btstack/builders/port-daemon-develop) | daemon: TCP and Unix domain named socket client-server architecture supporting multiple clients
65[<img src="http://buildbot.bluekitchen-gmbh.com/btstack/badge.png?builder=java-develop">](https://buildbot.bluekitchen-gmbh.com/btstack/builders/java-develop) | java: Java wrapper for daemon
66[<img src="http://buildbot.bluekitchen-gmbh.com/btstack/badge.png?builder=port-ios-develop">](https://buildbot.bluekitchen-gmbh.com/btstack/builders/port-ios-develop) | iOS: daemon for iOS jailbreak devices, C client-server API
67[<img src="http://buildbot.bluekitchen-gmbh.com/btstack/badge.png?builder=port-mtk-develop">](https://buildbot.bluekitchen-gmbh.com/btstack/builders/port-mtk-develop) | mtk: daemon for rooted Android devices, based on Mediatek MT65xx processor, Java and C client-server API
68[<img src="http://buildbot.bluekitchen-gmbh.com/btstack/badge.png?builder=port-wiced-develop">](https://buildbot.bluekitchen-gmbh.com/btstack/builders/port-wiced-develop) | wiced: Broadcom platforms that support the WICED SDK
68
69## Supported Chipsets
70
71Chipset | Type | HCI Transport | SCO over HCI (2) | BTstack folder | Comment
72---------------------------- |-----------| ----------------|------------------|----------------|---------
73Broadcom UART | Dual mode | H4, H5 | Probably | bcm | Max UART baudrate 2 mbps
74Broadcom USB Dongles | Dual mode | USB | Yes | bcm |
69
70## Supported Chipsets
71
72Chipset | Type | HCI Transport | SCO over HCI (2) | BTstack folder | Comment
73---------------------------- |-----------| ----------------|------------------|----------------|---------
74Broadcom UART | Dual mode | H4, H5 | Probably | bcm | Max UART baudrate 2 mbps
75Broadcom USB Dongles | Dual mode | USB | Yes | bcm |
75CSR UART | Dual mode | H4, H5 | No (didn't work) | csr |
76CSR UART | Dual mode | H4, H5, BCSP | No (didn't work) | csr |
76CSR USB Dongles | Dual mode | USB | Yes | csr |
77Dialog Semiconductor DA14581 | LE | H4, SPI | n.a. | da14581 | Official HCI firmware used
78EM 9301 | LE | SPI | n.a. | em9301 | Custom HCI SPI implementation
79Nordic nRF | LE | H4 | n.a. | | Requires custom HCI firmware
80STM STLC2500D | Classic | H4 | No (didn't try) | stlc2500d | Custom deep sleep management not supported
81Toshiba TC35661 | Dual mode | H4 | No (didn't try) | tc3566 | HCI version not tested.
82TI CC256x, WL183x | Dual mode | H4, H5, eHCILL | Yes | cc256x | Also WL185x, WL187x, and WL189x
83
77CSR USB Dongles | Dual mode | USB | Yes | csr |
78Dialog Semiconductor DA14581 | LE | H4, SPI | n.a. | da14581 | Official HCI firmware used
79EM 9301 | LE | SPI | n.a. | em9301 | Custom HCI SPI implementation
80Nordic nRF | LE | H4 | n.a. | | Requires custom HCI firmware
81STM STLC2500D | Classic | H4 | No (didn't try) | stlc2500d | Custom deep sleep management not supported
82Toshiba TC35661 | Dual mode | H4 | No (didn't try) | tc3566 | HCI version not tested.
83TI CC256x, WL183x | Dual mode | H4, H5, eHCILL | Yes | cc256x | Also WL185x, WL187x, and WL189x
84
84[More infos on supported chipsets](https://bluekitchen-gmbh.com/btstack/chipsets/)
85[More infos on supported chipsets](https://bluekitchen-gmbh.com/btstack/develop/chipsets/)
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
86
87## Source Tree Overview
88Path | Description
89--------------------|---------------
90chipset | Support for individual Bluetooth chipsets
91doc | Sources for BTstack documentation
92example | Example applications available for all ports
93platform | Support for special OSs and/or MCU architectures
94port | Complete port for a MCU + Chipset combinations
95src | Bluetooth stack implementation
96test | Unit and PTS tests
97tool | Helper tools for BTstack