xref: /btstack/port/windows-winusb/README.md (revision 3cda7aede81b55796a1111163e9d0f8a57ca5e4e)
1c7558746SMatthias Ringwald# BTstack port for Windows Systems using the WinUSB Driver
2a1a1af71SMatthias Ringwald
3c7558746SMatthias RingwaldThe Windows-WinUSB port uses the native run loop and WinUSB API to access a USB Bluetooth dongle.
4a1a1af71SMatthias Ringwald
5*3cda7aedSMatthias Ringwald## Access to Bluetooth USB Dongle with Zadig
6*3cda7aedSMatthias Ringwald
7a1a1af71SMatthias RingwaldTo allow libusb or WinUSB to access an USB Bluetooth dongle, you need to install a special device driver to make it accessible to user space processes.
8a1a1af71SMatthias Ringwald
9a1a1af71SMatthias RingwaldIt works like this:
10*3cda7aedSMatthias Ringwald
11c7558746SMatthias Ringwald-  Download [Zadig](http://zadig.akeo.ie)
12c7558746SMatthias Ringwald-  Start Zadig
13a1a1af71SMatthias Ringwald-  Select Options -> “List all devices”
14a1a1af71SMatthias Ringwald-  Select USB Bluetooth dongle in the big pull down list
15a1a1af71SMatthias Ringwald-  Select WinUSB (libusb) in the right pull pull down list
16a1a1af71SMatthias Ringwald-  Select “Replace Driver”
17a1a1af71SMatthias Ringwald
18*3cda7aedSMatthias Ringwald## Toolchain
19*3cda7aedSMatthias Ringwald
20*3cda7aedSMatthias RingwaldThe port requires a Unix-like toolchain. We successfully used [mingw-w64](https://mingw-w64.org/doku.php) to compile and run the examples. mingw64-w64 is based on [MingW](mingw.org) which has a good summary 'MinGW 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.'
21*3cda7aedSMatthias Ringwald
22*3cda7aedSMatthias RingwaldWe've used the Msys2 package available from their [downloads page](https://mingw-w64.org/doku.php/download) on Windows 10, 64-bit and use the MSYS2 MinGW 32-bit start menu item to compile 32-bit binaries that run on both 32/64-bit systems.
23*3cda7aedSMatthias Ringwald
24*3cda7aedSMatthias RingwaldIN the MSYS2 shell, you can install git, winpty, and python with pacman:
25*3cda7aedSMatthias Ringwald
26*3cda7aedSMatthias Ringwald    $ pacman -S git
27*3cda7aedSMatthias Ringwald    $ pacman -S winpty
28*3cda7aedSMatthias Ringwald    $ pacman -S python
29*3cda7aedSMatthias Ringwald
30*3cda7aedSMatthias Ringwald## Compilation
31*3cda7aedSMatthias Ringwald
32*3cda7aedSMatthias RingwaldWith mingw64 installed, just go to the port/windows-winusb directory and run make
33*3cda7aedSMatthias Ringwald
34*3cda7aedSMatthias Ringwald    $ cd btstack/port/windows-winusb
35*3cda7aedSMatthias Ringwald    $ make
36*3cda7aedSMatthias Ringwald
37*3cda7aedSMatthias Ringwald## Console Output
38*3cda7aedSMatthias Ringwald
39a1a1af71SMatthias RingwaldWhen 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:
40a1a1af71SMatthias Ringwald
41*3cda7aedSMatthias Ringwald    $ winpty ./spp_and_le_counter.exe
42a1a1af71SMatthias Ringwald
43