General Tools

Most ports use a regular Makefile to build the examples.

On Unix-based systems, git, make, and Python are usually installed. If not, use the system’s packet manager to install them.

On Windows, there is no packet manager, but it's easy to download and install all requires development packets quickly by hand. You'll need:

  • Python for Windows. When using the official installer, please confirm adding Python to the Windows Path.
  • MSYS2 is used to provide the bash shell and most standard POSIX command line tools.
  • MinGW64 GCC for Windows 64 & 32 bits incl. make. To install with MSYS2: pacman -S mingw-w64-x86_64-gcc
  • git is used to download BTstack source code. To install with MSYS2: pacman -S git
  • winpty a wrapper to allow for console input when running in MSYS2: To install with MSYS2: pacman -S winpty

Getting BTstack from GitHub

Use git to clone the latest version:

git clone https://github.com/bluekitchen/btstack.git

Alternatively, you can download it as a ZIP archive from BTstack’s page on GitHub.

Compiling the examples and loading firmware

This step is platform specific. To compile and run the examples, you need to download and install the platform specific toolchain and a flash tool. For TI’s CC256x chipsets, you also need the correct init script, or “Service Pack” in TI nomenclature. Assuming that these are provided, go to folder btstack/port/$PLATFORM$ in command prompt and run make. If all the paths are correct, it will generate several firmware files. These firmware files can be loaded onto the device using platform specific flash programmer. For the PIC32-Harmony platform, a project file for the MPLAB X IDE is provided, too.

Run the Example

As a first test, we recommend the SPP Counter example. During the startup, for TI chipsets, the init script is transferred, and the Bluetooth stack brought up. After that, the development board is discoverable as “BTstack SPP Counter” and provides a single virtual serial port. When you connect to it, you’ll receive a counter value as text every second.

Platform specifics

In the following, we provide more information on specific platform setups, toolchains, programmers, and init scripts.

libusb

The quickest way to try BTstack is on a Linux or OS X system with an additional USB Bluetooth module. The Makefile port/libusb in requires pkg-config and libusb-1.0 or higher to be installed.

On Linux, it’s usually necessary to run the examples as root as the kernel needs to detach from the USB module.

On OS X, it’s necessary to tell the OS to only use the internal Bluetooth. For this, execute:

sudo nvram bluetoothHostControllerSwitchBehavior=never

Windows-WinUSB

Although libusb basically works with the POSIX Run Loop on Windows, we recommend to use the Windows-WinUSB port that uses a native run loop and the native WinUSB API to access a USB Bluetooth dongle.

For libusb or WinUSB, you need to install a special device driver to make the USB dongle accessible to user space. It works like this:

  • Start Zadig
  • Select Options -> “List all devices”
  • Select USB Bluetooth dongle in the big pull down list
  • Select WinUSB (libusb) in the right pull pull down list
  • Select “Replace Driver”

When running the examples in the MSYS2 shell, the console input (via btstack_stdin_support) doesn't work. It works in the older MSYS and also the regular CMD.exe environment. Another option is to install WinPTY and then start the example via WinPTY like this:

$ winpty ./hfp_hf_demo.exe

Texas Instruments MSP430-based boards

Compiler Setup. The MSP430 port of BTstack is developed using the Long Term Support (LTS) version of mspgcc. General information about it and installation instructions are provided on the MSPGCC Wiki. On Windows, you need to download and extract mspgcc to C:\mspgcc. Add C:\mspgcc\bin folder to the Windows Path in Environment variable as explained here.

Loading Firmware. To load firmware files onto the MSP430 MCU for the MSP-EXP430F5438 Experimenter board, you need a programmer like the MSP430 MSP-FET430UIF debugger or something similar. The eZ430-RF2560 and MSP430F5529LP contain a basic debugger. Now, you can use one of following software tools:

MSP430Flasher.exe -n MSP430F5438A -w "BINARY_FILE_NAME.hex" -v -g -z [VCC]
  • MSPDebug: An example session with the MSP-FET430UIF connected on OS X is given in following listing:
mspdebug -j -d /dev/tty.FET430UIFfd130 uif
... 
prog blink.hex
run

Texas Instruments CC256x-based chipsets

CC256x Init Scripts. In order to use the CC256x chipset on the PAN13xx modules and others, an initialization script must be obtained. Due to licensing restrictions, this initialization script must be obtained separately as follows:

  • Download the BTS file for your CC256x-based module.

  • Copy the included .bts file into

  • In chipset/cc256x, run the Python script:

./convert_bts_init_scripts.py

The common code for all CC256x chipsets is provided by btstack_chipset_cc256x.c. During the setup, btstack_chipset_cc256x_instance function is used to get a btstack_control_t instance and passed to hci_init function.

Note: Depending on the CC256x-based module you’re using, you’ll need to update the reference in the Makefile to match the downloaded file.

Update: For the latest revision of the CC256x chipsets, the CC2560B and CC2564B, TI decided to split the init script into a main part and the BLE part. The conversion script has been updated to detect bluetooth_init_cc256x_1.2.bts and adds BLE_init_cc256x_1.2.bts if present and merges them into a single .c file.

Update 2: In May 2015, TI renamed the init scripts to match the naming scheme previously used on Linux systems. The conversion script has been updated to also detect initscripts_TIInit_6.7.16_bt_spec_4.1.bts and integrates initscripts_TIInit_6.7.16_ble_add-on.bts if present.

MSP-EXP430F5438 + CC256x Platform

Hardware Setup. We assume that a PAN1315, PAN1317, or PAN1323 module is plugged into RF1 and RF2 of the MSP-EXP430F5438 board and the “RF3 Adapter board” is used or at least simulated. See User Guide.

STM32F103RB Nucleo + CC256x Platform

To try BTstack on this platform, you’ll need a simple adaptor board. For details, please read the documentation in platforms/stm32-f103rb-nucleo/README.md.

PIC32 Bluetooth Audio Development Kit

The PIC32 Bluetooth Audio Development Kit comes with the CSR8811-based BTM805 Bluetooth module. In the port, the UART on the DAC daughter board was used for the debug output. Please remove the DAC board and connect a 3.3V USB-2-UART converter to GND and TX to get the debug output.

In platforms/pic32-harmony, a project file for the MPLAB X IDE is provided as well as a regular Makefile. Both assume that the MPLAB XC32 compiler is installed. The project is set to use -Os optimization which will cause warnings if you only have the Free version. It will still compile a working example. For this platform, we only provide the SPP and LE Counter example directly. Other examples can be run by replacing the spp_and_le_counter.c file with one of the other example files.