xref: /btstack/port/windows-winusb/README.md (revision 34fd36da1820bede7fdeb1f09f53c180688c8c25)
1*34fd36daSMatthias 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
53cda7aedSMatthias Ringwald## Access to Bluetooth USB Dongle with Zadig
63cda7aedSMatthias 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:
103cda7aedSMatthias 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
183cda7aedSMatthias Ringwald## Toolchain
193cda7aedSMatthias Ringwald
203c7822d8SMatthias 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](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.'
213cda7aedSMatthias Ringwald
22b5674ee2SMatthias RingwaldWe've used the Msys2 package available from the [downloads page](https://mingw-w64.org/doku.php/download) on Windows 10, 64-bit and use the MSYS2 MinGW 64-bit start menu item to compile 64-bit binaries.
233cda7aedSMatthias Ringwald
24b5674ee2SMatthias RingwaldIn the MSYS2 shell, you can install everything with pacman:
253cda7aedSMatthias Ringwald
263cda7aedSMatthias Ringwald    $ pacman -S git
27b5674ee2SMatthias Ringwald    $ pacman -S make
28b5674ee2SMatthias Ringwald    $ pacman -S mingw-w64-x86_64-toolchain
293cda7aedSMatthias Ringwald    $ pacman -S python
305b53c16eSMatthias Ringwald    $ pacman -S winpty
313cda7aedSMatthias Ringwald
323cda7aedSMatthias Ringwald## Compilation
333cda7aedSMatthias Ringwald
345b53c16eSMatthias RingwaldWith mingw64-w64 installed, just go to the port/windows-winusb directory and run make
353cda7aedSMatthias Ringwald
363cda7aedSMatthias Ringwald    $ cd btstack/port/windows-winusb
373cda7aedSMatthias Ringwald    $ make
383cda7aedSMatthias Ringwald
390af1bfd9SMatthias RingwaldNote: When compiling with msys2-32 bit and/or the 32-bit toolchain, compilation fails
400af1bfd9SMatthias Ringwaldas `conio.h` seems to be mission. Please use msys2-64 bit with the 64-bit toolchain for now.
410af1bfd9SMatthias Ringwald
423cda7aedSMatthias Ringwald## Console Output
433cda7aedSMatthias Ringwald
44a1a1af71SMatthias 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:
45a1a1af71SMatthias Ringwald
463cda7aedSMatthias Ringwald    $ winpty ./spp_and_le_counter.exe
47a1a1af71SMatthias Ringwald
48