Login/Register
Developing an HID input device driver for a BLE GATT device on Windows 10
Asked Answered
c++windows-10bluetooth-lowenergydriverhid
T

3

14

(This is a crosspost from the MSDN forums since there hasn't been any response there for quite some time and I thought I would get better answers here.)

I have a BLE device containing a custom GATT service, of which I cannot modify the firmware. I want to listen for the GATT characteristic events from that service, and make Windows consume them as HID reports to make Windows recognize it as another device. How would I go about doing this?

I conducted some research, and found the information below:

My question is, what approach is needed here to create this driver?

  • Do I need to create two drivers (a virtual HID driver and a GATT Profile driver), and then somehow connect them to each other?
  • Do I need to make the Bluetooth LE API calls from the virtual HID driver?
  • Do I need to create a GATT Profile driver that makes HID calls?
  • Or something else entirely?

Are GATT Profile drivers even still allowed on Windows 10, since it seems it is not allowed to create filter drivers for BthLeEnum?

Update

I really appreciate that Alain took the time to answer the question and therefore I marked his answer as answer to the question; however for me the question is not completely answered yet. Seeing that the question already got more than 10 votes, I think it deserves a more extensive answer. Points that could be improved / added are:

  • the argumentation behind the advice (e.g. why UMDF minidriver instead of VHF driver, why to use UWP bluetooth APIs requiring to use cppwinrt instead of simply using the C++ Bluetooth functions that I found in my research, what about writing a GATT Profile driver, etc.). Without that argumentation I won't learn much from the advice.
  • answers to my subquestions
  • examples of using cppwinrt code from a driver and whether it is possible to access those APIs there. Are there any limitations to that (since the code will not be running from an appx)? Cppwinrt is pitched here as something new, but I can't find any documentation of using cppwinrt in the context of a driver.
  • some reflection on my own research - the current answer doesn't touch upon what points I found are good or not. This reflection would help me to understand the topic better.

Update 2

I suppose that Alain recommended a UMDF HID minidriver over VHF because VHF requires writing a KMDF driver. UMDF has the benefits of easier debugging (can be debugged on local pc), less security (and signing) restrictions and no risk of bugchecking a machine when there is a bug in the driver.

Update 3

In order to make it possible to create a client application that injects RadialController events (rather than having to write a driver which is a very high barrier for private developers), I posted a request for it on Feedback Hub. Please consider voting for it if you think that is worth supporting.

Tallyho answered 19/8, 2017 at 16:10 Comment(1)
Did you manage to get this working? – Cobden
T
2

The best approach to this would be to create a UMDF HID driver (https://learn.microsoft.com/en-us/windows-hardware/drivers/wdf/creating-umdf-hid-minidrivers) that installs on the bthleenum device node that is created for the device's custom service and use the new Bluetooth LE UWP apis (https://learn.microsoft.com/en-us/uwp/api/windows.devices.bluetooth.genericattributeprofile).

There is some ambiguity about the use of UWP Apis from non store application, but this is incorrect. These Apis are usable in pretty much every conditions. In case you need help setting up your project, here is a C++/UWP sample that can help you get started.

I hope this helps! Alain

Thacker answered 31/8, 2017 at 13:37 Comment(6)
thank you! Do you mean that the GATT / bthleenum device node "appearance event" should trigger the installation of that UMDF HID driver? Is there any further interaction between those drivers / driver nodes? E.g. can that UMDF HID driver somehow consume the custom service and characteristics directly from the GATT / bthleenum device node, or does it need to start "from scratch" by making calls like GattDeviceService.FromIdAsync etc? – Tallyho
also, could you please explain why you recommended writing a HID minidriver instead of using the Virtual Hid Framework? – Tallyho
As for "that installs on the bthleenum device node" - can you please explain more on that? Should I register for device interface notifications? Should I add something extra in the .inf file? – Tallyho
Also, could you please comment on whether your advice conflicts with this policy? – Tallyho
A device node will be created for your custom service. The idea is to create an inf that will match against that device node so your UMDF driver will install on it. Once installed, you will need to use GattDeviceServce.FromIdAsync to instantiate and use. – Thacker
Hi Alain, do you by any chance have any examples of this you could share in 2020? – Cobden
B
0

In regards to the BLE GATT Profile driver samples in WDK 8.0, you can compile with VS2017 / WDK10 by following the steps here

I was able to compile the WpdHealthHeartRateService.

Bellay answered 18/3, 2019 at 23:52 Comment(2)
Interesting, doesn’t that conflict the BthLeEnum compatibility rule I mentioned? (Not allowed to create filter drivers on BrhLeEnum) – Tallyho
I'm not sure about the compatibility rule mentioned however I can confirm not only does the project compile but it also runs successfully on Windows 10. – Bellay
T
0

I got this working as a Proof of Concept, but not reliably. Developing Windows drivers turned out to be too steep of a learning curve for the time I have available to invest in this.

Besides, as a private person I would never be able to distribute this to other people since drivers need to go through a signing and publishing process.

For the sake of knowledge exchange:

Tallyho answered 20/11, 2020 at 10:10 Comment(0)

© 2022 - 2024 — McMap. All rights reserved.