README.md (1eb391795a807513401dd7402af32408963b253b) | README.md (60b111ade428173903c416e8d39b56ecb77f671e) |
---|---|
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. --- 22 unchanged lines hidden (view full) --- 31**Profiles** GAP, IOP, HFP, HSP, SPP, PAN, GATT. 32 33**Coming next** A2DP, AVRCP, HID, HOGP, BLE Mesh, and more. 34 35It has been qualified with the the Bluetooth SIG for GAP, IOP, HFP, HSP, SPP, PAN profiles and 36GATT, SM of the Bluetooth 4.2 LE Central and Peripheral roles (QD ID 25340). For information on MFi/iAP2 support, please <a href="mailto:[email protected]">contact us</a>. 37 38 | 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. --- 22 unchanged lines hidden (view full) --- 31**Profiles** GAP, IOP, HFP, HSP, SPP, PAN, GATT. 32 33**Coming next** A2DP, AVRCP, HID, HOGP, BLE Mesh, and more. 34 35It has been qualified with the the Bluetooth SIG for GAP, IOP, HFP, HSP, SPP, PAN profiles and 36GATT, SM of the Bluetooth 4.2 LE Central and Peripheral roles (QD ID 25340). For information on MFi/iAP2 support, please <a href="mailto:[email protected]">contact us</a>. 37 38 |
39 40 | |
41## Evaluation Platforms 42 43#### Embedded Platforms: | 39## Evaluation Platforms 40 41#### Embedded Platforms: |
44Status | Platform 45-------------- | ------ 46[<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) 47[<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) 48[<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 49[<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 50No build server | [STM32 F4 Discovery Board](http://www.st.com/en/evaluation-tools/stm32f4discovery.html) with [CC256xEM Bluetooth Adatper Kit for ST](https://store.ti.com/CC256XEM-STADAPT-CC256xEM-Bluetooth-Adapter-Kit-P45158.aspx) and [CC2564B Dual-mode Bluetooth® Controller Evaluation Module](https://store.ti.com/cc2564modnem.aspx) 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-h4-master">](https://buildbot.bluekitchen-gmbh.com/btstack/builders/port-wiced-h4-master) | [RedBear Duo](https://github.com/redbear/WICED-SDK) with Broadcom BCM43438 A1 53No build server | [STM32 F4 Discovery Board](http://www.st.com/en/evaluation-tools/stm32f4discovery.html) with [CC256xEM Bluetooth Adatper Kit for ST](https://store.ti.com/CC256XEM-STADAPT-CC256xEM-Bluetooth-Adapter-Kit-P45158.aspx) and [CC2564B Dual-mode Bluetooth® Controller Evaluation Module](https://store.ti.com/cc2564modnem.aspx) 54No build server | EM9304 DVK consisting of an STM32 Nucleo L053R board with an EM9304 in an Arduino form-factor 55[<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) 56[<img src="http://buildbot.bluekitchen-gmbh.com/btstack/badge.png?builder=port-wiced-h4-develop">](https://buildbot.bluekitchen-gmbh.com/btstack/builders/port-wiced-h4-develop) | [RedBear Duo](https://github.com/redbear/WICED-SDK) with Broadcom BCM43438 A1 | 42Build Status | Port | Platform 43---------------------| -----| ------ 44No build server | [esp32](https://github.com/bluekitchen/btstack/tree/develop/port/esp32) | [Espressif ESP32](http://www.espressif.com/products/hardware/esp32/overview) 2.4 GHz Wi-Fi and Bluetooth Dual-Mode combo chip using [FreeRTOS](http://www.freertos.org) 45[<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-rf2560](https://github.com/bluekitchen/btstack/tree/develop/port/ez430-rf2560) | [EZ430-RF256x Bluetooth Evaluation Tool for MSP430](http://www.ti.com/tool/ez430-rf256x) 46[<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) | [msp-exp430f5438-cc2564b](https://github.com/bluekitchen/btstack/tree/develop/port/msp-exp430f5438-cc2564b) |[MSP430F5438 Experimenter Board for MSP430](http://www.ti.com/tool/msp-exp430f5438) with [Bluetooth CC2564 Module Evaluation Board](http://www.ti.com/tool/cc2564modnem) 47[<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) | [msp430f5529lp-cc2564b](https://github.com/bluekitchen/btstack/tree/develop/port/msp430f5229lp-cc2564b) | [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 48No build server | [max32630-fthr](https://github.com/bluekitchen/btstack/tree/develop/port/max32630-fthr) | [MAX32630FTHR ARM Cortex M4F Board](https://www.maximintegrated.com/en/products/digital/microcontrollers/MAX32630FTHR.html) with onboard [Panasonic PAN1326 module](https://na.industrial.panasonic.com/products/wireless-connectivity/bluetooth/multi-mode/series/pan13261316-series/CS467) containing [TI CC2564B Bluetooth controller](http://www.ti.com/product/cc2564) 49[<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-f103rb-nucleo](https://github.com/bluekitchen/btstack/tree/develop/port/stm32-f103rb-nucleo) | [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 50No build Server | [stm32-f4discovery-cc2564b](https://github.com/bluekitchen/btstack/tree/develop/port/stm32-f4discovery-cc256x) | [STM32 F4 Discovery Board](http://www.st.com/en/evaluation-tools/stm32f4discovery.html) with [CC256xEM Bluetooth Adapter Kit for ST](https://store.ti.com/CC256XEM-STADAPT-CC256xEM-Bluetooth-Adapter-Kit-P45158.aspx) and [CC2564B Dual-mode Bluetooth® Controller Evaluation Module](https://store.ti.com/cc2564modnem.aspx) 51No build Server | [stm32-l053rb-em9304](https://github.com/bluekitchen/btstack/tree/develop/port/stm32-l053rb-em9304) | EM9304 DVK: [STM32 Nucleo development board NUCELO-L053R](http://www.st.com/en/evaluation-tools/nucleo-l053r8.html) with [EM9304 Bluetooth Controller](http://www.emmicroelectronic.com/products/wireless-rf/standard-protocols/em9304) 52[<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) | [pic32-harmony](https://github.com/bluekitchen/btstack/tree/develop/port/pic32-harmony) | [Microchip's PIC32 Bluetooth Audio Development Kit](http://www.microchip.com/Developmenttools/ProductDetails.aspx?PartNO=DV320032) 53[<img src="http://buildbot.bluekitchen-gmbh.com/btstack/badge.png?builder=port-wiced-h4-develop">](https://buildbot.bluekitchen-gmbh.com/btstack/builders/port-wiced-h4-develop) | [wiced-h4](https://github.com/bluekitchen/btstack/tree/develop/port/wiced-h4) | Broadcom platforms that support the WICED SDK via H4 UART, e.g. [RedBear Duo](https://github.com/redbear/WICED-SDK) with Broadcom BCM43438 A1 54No build server | [wiced-h5](https://github.com/bluekitchen/btstack/tree/develop/port/wiced-h5) | Broadcom platforms that support the WICED SDK via H5 UART |
57 58#### Other Platforms: | 55 56#### Other Platforms: |
59Status | Platform 60-------------- | ------ 61[<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 62No build server | posix-h4-da14581: Unix-based system connected to Dialog Semiconductor DA14581 via H4 over serial port 63No build server | posix-h5: Unix-based system connected to Bluetooth module via H5 over serial port 64[<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 65No build server | windows-h4: Win32-based system connected to Bluetooth module via serial port 66No build server | windows-winusb: Win32-based system with dedicated USB Bluetooth dongle 67No build server | [FreeRTOS](http://www.freertos.org): Run BTstack on a dedicated thread, not thread-safe. 68[<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 69[<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 70[<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 71[<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 72[<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 | 57Status | Port | Platform 58-------------------| ------|--------- 59[<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](https://github.com/bluekitchen/btstack/tree/develop/port/posix-h4) | Unix-based system connected to Bluetooth module via H4 over serial port 60No build server | [posix-h4-da14581](https://github.com/bluekitchen/btstack/tree/develop/port/posix-h4-da14581) | Unix-based system connected to Dialog Semiconductor DA14581 via H4 over serial port 61No build server | [posix-h5](https://github.com/bluekitchen/btstack/tree/develop/port/posix-h5) | Unix-based system connected to Bluetooth module via H5 over serial port 62No build server | [posix-h5-bcm](https://github.com/bluekitchen/btstack/tree/develop/port/posix-h5) | Unix-based system connected to Broadcom/Cypress Bluetooth module via H5 over serial port 63[<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](https://github.com/bluekitchen/btstack/tree/develop/port/libusb) | Unix-based system with dedicated USB Bluetooth dongle 64No build server | [windows-h4](https://github.com/bluekitchen/btstack/tree/develop/port/windows-h4) | Win32-based system connected to Bluetooth module via serial port 65No build server | [windows-winusb](https://github.com/bluekitchen/btstack/tree/develop/port/windows-winusb) | Win32-based system with dedicated USB Bluetooth dongle 66[<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](https://github.com/bluekitchen/btstack/tree/develop/port/daemon) | TCP and Unix domain named socket client-server architecture supporting multiple clients 67[<img src="http://buildbot.bluekitchen-gmbh.com/btstack/badge.png?builder=java-develop">](https://buildbot.bluekitchen-gmbh.com/btstack/builders/java-develop) | [java](https://github.com/bluekitchen/btstack/tree/develop/platform/daemon/binding/java) | Java wrapper for daemon 68[<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](https://github.com/bluekitchen/btstack/tree/develop/port/mtk) | daemon for rooted Android devices, based on Mediatek MT65xx processor, Java and C client-server API 69[<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](https://github.com/bluekitchen/btstack/tree/develop/port/ios) | daemon for iOS jailbreak devices, C client-server API 70No build server | [freertos](https://github.com/bluekitchen/btstack/tree/develop/platform/freertos) | [FreeRTOS](http://www.freertos.org): Run BTstack on a dedicated thread, not thread-safe. |
73 74## Supported Chipsets 75 76Chipset | Type | HCI Transport | SCO over HCI (2) | BTstack folder | Comment 77---------------------------- |-----------| ----------------|------------------|----------------|--------- 78Broadcom UART | Dual mode | H4, H5 | Probably | bcm | Max UART baudrate 2 mbps 79Broadcom USB Dongles | Dual mode | USB | Yes | bcm | 80CSR UART | Dual mode | H4, H5, BCSP | No (didn't work) | csr | 81CSR USB Dongles | Dual mode | USB | Yes | csr | 82Dialog Semiconductor DA14581 | LE | H4, SPI | n.a. | da14581 | Official HCI firmware used 83EM 9301, 9304 | LE | SPI | n.a. | em9301 | Custom HCI SPI implementation 84Nordic nRF | LE | H4 | n.a. | | Requires custom HCI firmware 85STM STLC2500D | Classic | H4 | No (didn't try) | stlc2500d | Custom deep sleep management not supported 86Toshiba TC35661 | Dual mode | H4 | No (didn't try) | tc3566 | HCI version not tested. 87TI CC256x, WL183x | Dual mode | H4, H5, eHCILL | Yes | cc256x | Also WL185x, WL187x, and WL189x 88 | 71 72## Supported Chipsets 73 74Chipset | Type | HCI Transport | SCO over HCI (2) | BTstack folder | Comment 75---------------------------- |-----------| ----------------|------------------|----------------|--------- 76Broadcom UART | Dual mode | H4, H5 | Probably | bcm | Max UART baudrate 2 mbps 77Broadcom USB Dongles | Dual mode | USB | Yes | bcm | 78CSR UART | Dual mode | H4, H5, BCSP | No (didn't work) | csr | 79CSR USB Dongles | Dual mode | USB | Yes | csr | 80Dialog Semiconductor DA14581 | LE | H4, SPI | n.a. | da14581 | Official HCI firmware used 81EM 9301, 9304 | LE | SPI | n.a. | em9301 | Custom HCI SPI implementation 82Nordic nRF | LE | H4 | n.a. | | Requires custom HCI firmware 83STM STLC2500D | Classic | H4 | No (didn't try) | stlc2500d | Custom deep sleep management not supported 84Toshiba TC35661 | Dual mode | H4 | No (didn't try) | tc3566 | HCI version not tested. 85TI CC256x, WL183x | Dual mode | H4, H5, eHCILL | Yes | cc256x | Also WL185x, WL187x, and WL189x 86 |
89[More infos on supported chipsets](https://bluekitchen-gmbh.com/btstack/chipsets/) | 87[More infos on supported chipsets](https://bluekitchen-gmbh.com/btstack/develop/chipsets/) |
90 91## Source Tree Overview 92Path | Description 93--------------------|--------------- 94chipset | Support for individual Bluetooth chipsets 95doc | Sources for BTstack documentation 96example | Example applications available for all ports 97platform | Support for special OSs and/or MCU architectures 98port | Complete port for a MCU + Chipset combinations 99src | Bluetooth stack implementation 100test | Unit and PTS tests 101tool | Helper tools for BTstack | 88 89## Source Tree Overview 90Path | Description 91--------------------|--------------- 92chipset | Support for individual Bluetooth chipsets 93doc | Sources for BTstack documentation 94example | Example applications available for all ports 95platform | Support for special OSs and/or MCU architectures 96port | Complete port for a MCU + Chipset combinations 97src | Bluetooth stack implementation 98test | Unit and PTS tests 99tool | Helper tools for BTstack |