xref: /btstack/port/windows-h4/README.md (revision e3ba22907f903f11cd12321c31e7936b8dd1157e)
1# BTstack Port for Windows Systems with Bluetooth Controller connected via Serial Port
2
3The Windows-H4 port uses the native run loop and allows to use Bluetooth Controllers connected via Serial Port.
4
5Make sure to manually reset the Bluetooth Controller before starting any of the examples.
6
7The port provides both a regular Makefile as well as a CMake build file. It uses native Win32 APIs for file access and does not require the Cygwin or mingw64 build/runtine. All examples can also be build with Visual Studio 2022 (e.g. Community Edition).
8
9## Visual Studio 2022
10
11Visual Studio can directly open the provided `port/windows-windows-h4/CMakeLists.txt` and allows to compile and run all examples.
12
13## mingw64
14
15It can also be compiles with a regular Unix-style toolchain like [mingw-w64](https://www.mingw-w64.org).
16mingw64-w64 is based on [MinGW](https://en.wikipedia.org/wiki/MinGW), which '...provides a complete Open Source programming tool set which is suitable for the development of native MS-Windows applications, and which do not depend on any 3rd-party C-Runtime DLLs.'
17
18We've used the Msys2 package available from the [downloads page](https://www.mingw-w64.org/downloads/) on Windows 10, 64-bit and use the MSYS2 MinGW 64-bit start menu item to compile 64-bit binaries.
19
20In the MSYS2 shell, you can install everything with pacman:
21
22    $ pacman -S git
23    $ pacman -S cmake
24    $ pacman -S make
25    $ pacman -S mingw-w64-x86_64-toolchain
26    $ pacman -S mingw-w64-x86_64-portaudio
27    $ pacman -S python
28    $ pacman -S winpty
29
30### Compilation with CMake
31
32With mingw64-w64 installed, just go to the port/windows-h4 directory and use CMake as usual
33
34    $ cd port/windows-h4
35    $ mkdir build
36    $ cd build
37    $ cmake ..
38    $ make
39
40Note: When compiling with msys2-32 bit and/or the 32-bit toolchain, compilation fails
41as `conio.h` seems to be mission. Please use msys2-64 bit with the 64-bit toolchain for now.
42
43## Console Output
44
45When 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:
46
47    $ winpty ./gatt_counter.exe
48
49The packet log will be written to hci_dump.pklg
50
51