mirror/btstack
1
0
Fork 0
mirror of https://github.com/bluekitchen/btstack.git synced 2024-12-29 09:26:08 +00:00
Code Issues Packages Projects Releases Wiki Activity
6a765b5d8d
btstack/README.md

105 lines
14 KiB
Markdown
Raw Normal View History

Create README.md
2015-03-27 15:21:51 +00:00
# Welcome to BTstack
Merge branch 'develop'
2017-03-23 20:57:13 +00:00
BTstack is [BlueKitchen's](http://bluekitchen-gmbh.com) implementation of the official Bluetooth stack.
It is well suited for small, resource-constraint devices
such as 8 or 16 bit embedded systems as it is highly configurable and comes with an ultra small memory footprint.
Create README.md
2015-03-27 15:21:51 +00:00
A minimal configuration for an SPP server on a MSP430 can run in 32 kB FLASH and only 4 kB of RAM.
Update README.md following suggestions from https://github.com/bluekitchen/btstack/pull/26
2017-02-27 10:13:29 +00:00
Targeting a variety of platforms is as simple as providing the necessary UART, CPU, and CLOCK implementations. BTstack is currently capable of connecting to Bluetooth-modules via: (H2) HCI USB, (H4) HCI UART + TI's eHCILL, and (H5) HCI Three-Wire UART.
Create README.md
2015-03-27 15:21:51 +00:00
Merge branch 'develop'
2017-03-23 20:57:13 +00:00
On smaller embedded systems, a minimal run loop implementation allows to use BTstack without a Real Time OS (RTOS).
If a RTOS is already provided, BTstack can be integrated and run as a single thread.
Create README.md
2015-03-27 15:21:51 +00:00
Merge branch 'develop'
2017-03-23 20:57:13 +00:00
On larger systems, BTstack provides a daemon that connects to a Bluetooth module.
Create README.md
2015-03-27 15:21:51 +00:00
Multiple applications can communicate with this daemon over different inter-process communication methods.
Merge branch 'develop'
2017-07-21 19:57:44 +00:00
BTstack supports the Central and the Peripheral Role of Bluetooth 4.2 Low Energy specification incl. LE Secure Connections, LE Data Channels, and LE Data Length Extension. It can be configured to run as either single-mode stack or a dual-mode stack.
Create README.md
2015-03-27 15:21:51 +00:00
Update README.md following suggestions from https://github.com/bluekitchen/btstack/pull/26
2017-02-27 10:13:29 +00:00
BTstack is free for non-commercial use. However, for commercial use, <a href="mailto:contact@bluekitchen-gmbh.com">tell us</a> a bit about your project to get a quote.
Create README.md
2015-03-27 15:21:51 +00:00
readme: fix link to pdf manual
2018-06-21 05:05:48 +00:00
**Documentation:** [HTML](http://bluekitchen-gmbh.com/btstack/), [PDF](http://bluekitchen-gmbh.com/btstack.pdf)
Update README.md
2015-05-04 22:24:43 +00:00
Update README.md
2017-02-27 10:15:06 +00:00
**Discussion and Community Support:** [BTstack Google Group](http://groups.google.com/group/btstack-dev)
update chipset table, profiles and protocols more compact
2016-11-19 21:32:44 +00:00
Update README.md
2017-02-27 10:15:06 +00:00
### Supported Protocols and Profiles
update chipset table, profiles and protocols more compact
2016-11-19 21:32:44 +00:00
readme: add new bluetooth sig listing
2018-05-01 19:00:56 +00:00
**Protocols:** L2CAP (incl. LE Data Channels), RFCOMM, SDP, BNEP, AVDTP, AVCTP, ATT, SM (incl. LE Secure Connections).
Update README.md
2015-05-04 22:24:43 +00:00
readme: add new bluetooth sig listing
2018-05-01 19:00:56 +00:00
**Profiles:** GAP, IOP, HFP, HSP, SPP, PAN, A2DP, AVRCP, GATT.
update chipset table, profiles and protocols more compact
2016-11-19 21:32:44 +00:00
readme: add new bluetooth sig listing
2018-05-01 19:00:56 +00:00
**Beta Stage:** HID, HOGP.
Update README.md
2017-11-01 10:57:34 +00:00
Update README.md
2017-11-01 10:58:09 +00:00
**In Development:** BLE Mesh, AVRCP Browsing and more.
update chipset table, profiles and protocols more compact
2016-11-19 21:32:44 +00:00
readme: add new bluetooth sig listing
2018-05-01 19:00:56 +00:00
It has been qualified with the Bluetooth SIG (QDID 110883) for GAP, IOP, HFP, HSP, SPP, PAN, A2DP, AVRCP profiles and
GATT, SM of the Bluetooth 5 specification. For information on MFi/iAP2 support, please <a href="mailto:contact@bluekitchen-gmbh.com">contact us</a>.
update chipset table, profiles and protocols more compact
2016-11-19 21:32:44 +00:00
Supported -> Evaluation Plaforms
2015-04-27 16:37:44 +00:00
## Evaluation Platforms
changed link to manual
2015-04-10 09:33:16 +00:00
Merge branch 'develop'
2018-04-27 14:13:29 +00:00
#### Embedded Platforms:
README: update evaluation platforms, add link to port folder
2017-07-19 20:22:02 +00:00
Build Status | Port | Platform
---------------------| -----| ------
Merge branch 'develop'
2018-08-03 19:59:22 +00:00
[<img src="http://buildbot.bluekitchen-gmbh.com/btstack/badges/port-esp32-master.svg">](https://buildbot.bluekitchen-gmbh.com/btstack/#/builders/port-esp32-develop) | [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)
[<img src="http://buildbot.bluekitchen-gmbh.com/btstack/badges/port-ez430-rf2560-master.svg">](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)
[<img src="http://buildbot.bluekitchen-gmbh.com/btstack/badges/port-msp-exp430f5438-cc2564b-master.svg">](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)
[<img src="http://buildbot.bluekitchen-gmbh.com/btstack/badges/port-msp430f5229lp-cc2564b-master.svg">](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
[<img src="http://buildbot.bluekitchen-gmbh.com/btstack/badges/port-max32630-fthr-master.svg">](https://buildbot.bluekitchen-gmbh.com/btstack/#/builders/port-max32630-fthr) | [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)
[<img src="http://buildbot.bluekitchen-gmbh.com/btstack/badges/port-samv71-xplained-atwilc3000-master.svg">](https://buildbot.bluekitchen-gmbh.com/btstack/#/builders/port-samv71-xplained-atwilc3000-develop) | [samv71-xplained-atwilc3000](https://github.com/bluekitchen/btstack/tree/develop/port/samv71-xplained-atwilc3000) | [SAMV71 Ultra Xplained Ultra](http://www.atmel.com/tools/atsamv71-xult.aspx) evaluation kit with [ATWILC3000 SHIELD](http://www.microchip.com/DevelopmentTools/ProductDetails.aspx?PartNO=ATWILC3000-SHLD)
[<img src="http://buildbot.bluekitchen-gmbh.com/btstack/badges/port-stm32-f103rb-nucleo-master.svg">](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
[<img src="http://buildbot.bluekitchen-gmbh.com/btstack/badges/port-stm32-f4discovery-cc2564b-master.svg">](https://buildbot.bluekitchen-gmbh.com/btstack/#/builders/port-stm32-f4discovery-cc2564b) | [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)
[<img src="http://buildbot.bluekitchen-gmbh.com/btstack/badges/port-stm32-l053r8-em9304-master.svg">](https://buildbot.bluekitchen-gmbh.com/btstack/#/builders/port-stm32-l053r8-em9304) | [stm32-l053r8-em9304](https://github.com/bluekitchen/btstack/tree/develop/port/stm32-l053r8-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)
[<img src="http://buildbot.bluekitchen-gmbh.com/btstack/badges/port-pic32-harmony-master.svg">](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)
[<img src="http://buildbot.bluekitchen-gmbh.com/btstack/badges/port-wiced-h4-master.svg">](https://buildbot.bluekitchen-gmbh.com/btstack/#/builders/port-wiced-h4-develop) | [wiced-h4](https://github.com/bluekitchen/btstack/tree/develop/port/wiced-h4) | Broadcom/Cypress platforms that support the WICED SDK via H4 UART, e.g. [RedBear Duo](https://redbear.cc/product/wifi-ble/redbear-duo.html) (BCM43438 A1), [Inventek Systems ISM4334x](https://www.inventeksys.com/wifi/wifi-modules/ism4343-wmb-l151/) (BCM43438 A1), [Inventek Systems ISM4343](https://www.inventeksys.com/products-page/wifi-modules/serial-wifi/ism43341-m4g-l44-cu-embedded-serial-to-wifi-ble-nfc-module/) (BCM43340)
wiced: update docu
2017-11-09 10:11:22 +00:00
No build server | [wiced-h5](https://github.com/bluekitchen/btstack/tree/develop/port/wiced-h5) | Broadcom platforms that support the WICED SDK via H5 UART, see wiced-h4
changed link to manual
2015-04-10 09:33:16 +00:00
#### Other Platforms:
README: update evaluation platforms, add link to port folder
2017-07-19 20:22:02 +00:00
Status | Port | Platform
-------------------| ------|---------
Merge branch 'develop'
2018-08-03 19:59:22 +00:00
[<img src="http://buildbot.bluekitchen-gmbh.com/btstack/badges/port-posix-h4-master.svg">](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
da14581: add posix port for DA14585 and list in chipsets and ports
2018-07-08 14:25:01 +00:00
No 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
No build server | [posix-h4-da14585](https://github.com/bluekitchen/btstack/tree/develop/port/posix-h4-da14585) | Unix-based system connected to Dialog Semiconductor DA14585 via H4 over serial port
README: update evaluation platforms, add link to port folder
2017-07-19 20:22:02 +00:00
No 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
No 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
Merge branch 'develop'
2018-08-03 19:59:22 +00:00
[<img src="http://buildbot.bluekitchen-gmbh.com/btstack/badges/port-libusb-master.svg">](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
README: update evaluation platforms, add link to port folder
2017-07-19 20:22:02 +00:00
No build server | [windows-h4](https://github.com/bluekitchen/btstack/tree/develop/port/windows-h4) | Win32-based system connected to Bluetooth module via serial port
No build server | [windows-winusb](https://github.com/bluekitchen/btstack/tree/develop/port/windows-winusb) | Win32-based system with dedicated USB Bluetooth dongle
raspi: use H4 for Raspberry Pi Zero W with Hardware UART / Flow Control
2018-07-29 20:40:30 +00:00
No build server | [raspi](https://github.com/bluekitchen/btstack/tree/develop/port/raspi) | Raspberry Pi 3 or Raspberry Pi Zero W with built-in BCM4343 Bluetooth/Wifi Controller
Merge branch 'develop'
2018-08-03 19:59:22 +00:00
[<img src="http://buildbot.bluekitchen-gmbh.com/btstack/badges/port-daemon-master.svg">](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
[<img src="http://buildbot.bluekitchen-gmbh.com/btstack/badges/java-master.svg">](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
[<img src="http://buildbot.bluekitchen-gmbh.com/btstack/badges/port-mtk-master.svg">](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
[<img src="http://buildbot.bluekitchen-gmbh.com/btstack/badges/port-ios-master.svg">](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
README: update evaluation platforms, add link to port folder
2017-07-19 20:22:02 +00:00
No 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.
manual moved to git
2015-04-10 08:48:53 +00:00
## Supported Chipsets
update chipset table, profiles and protocols more compact
2016-11-19 21:32:44 +00:00
chipset: add CYW20704, clean ups
2018-04-05 08:18:13 +00:00
Chipset | Type | HCI Transport | SCO over HCI | BTstack folder | Comment
da14581: add to main readme
2017-03-30 19:56:50 +00:00
---------------------------- |-----------| ----------------|------------------|----------------|---------
readme: drop v0.9 warning, update atwilc3000 firmware size and make LE-only
2018-04-03 19:34:31 +00:00
Atmel ATWILC3000 | LE | H4 | n.a. | atwilc3000 | Firmware size: 60 kB
da14581: add to main readme
2017-03-30 19:56:50 +00:00
Broadcom UART | Dual mode | H4, H5 | Probably | bcm | Max UART baudrate 2 mbps
Broadcom USB Dongles | Dual mode | USB | Yes | bcm |
h5: add hci_transport_h5_enable_bcsp_mode() to use BCSP with CSR chipsets
2017-04-07 10:39:16 +00:00
CSR UART | Dual mode | H4, H5, BCSP | No (didn't work) | csr |
da14581: add to main readme
2017-03-30 19:56:50 +00:00
CSR USB Dongles | Dual mode | USB | Yes | csr |
chipset: add CYW20704, clean ups
2018-04-05 08:18:13 +00:00
Cypress CYW20704 | Dual mode | H4, H5, USB | Probably | bcm |
da14581: add posix port for DA14585 and list in chipsets and ports
2018-07-08 14:25:01 +00:00
Dialog Semiconductor DA14581, DA14585 | LE | H4, SPI | n.a. | da14581 | Official HCI firmware used
chipset: add CYW20704, clean ups
2018-04-05 08:18:13 +00:00
Espressif ESP32 | Dual mode | VHCI | Not yet | | SoC with Bluetooth and Wifi
README: add EM9304, FreeRTOS, EM9304DVK
2017-07-10 14:03:14 +00:00
EM 9301, 9304 | LE | SPI | n.a. | em9301 | Custom HCI SPI implementation
da14581: add to main readme
2017-03-30 19:56:50 +00:00
Nordic nRF | LE | H4 | n.a. | | Requires custom HCI firmware
STM STLC2500D | Classic | H4 | No (didn't try) | stlc2500d | Custom deep sleep management not supported
chipset: tc35661 does not support SCO-over-HCI
2018-06-14 13:13:37 +00:00
Toshiba TC35661 | Dual mode | H4 | No | tc3566 |
da14581: add to main readme
2017-03-30 19:56:50 +00:00
TI CC256x, WL183x | Dual mode | H4, H5, eHCILL | Yes | cc256x | Also WL185x, WL187x, and WL189x
update chipset table, profiles and protocols more compact
2016-11-19 21:32:44 +00:00
Merge branch 'develop'
2016-11-19 21:33:59 +00:00
[More infos on supported chipsets](https://bluekitchen-gmbh.com/btstack/chipsets/)
describe tree structure
2015-11-13 09:31:44 +00:00
## Source Tree Overview
Path | Description
--------------------|---------------
chipset | Support for individual Bluetooth chipsets
doc | Sources for BTstack documentation
doc: add section about files to include in project
2016-03-28 20:39:01 +00:00
example | Example applications available for all ports
describe tree structure
2015-11-13 09:31:44 +00:00
platform | Support for special OSs and/or MCU architectures
add preliminary info on RedBear Duo, Wiced port, support for Broadcom chipsets
2016-01-06 20:01:55 +00:00
port | Complete port for a MCU + Chipset combinations
describe tree structure
2015-11-13 09:31:44 +00:00
src | Bluetooth stack implementation
test | Unit and PTS tests
tool | Helper tools for BTstack
Reference in New Issue Copy Permalink