Cross-platform .NET framework for talking to connected devices such as USB, Serial Port and Hid devices
Don't waste your time with the obscurities of connecting to devices and learning their protocol. I've done this plenty of times and I can fast track you to building an app or getting something to work.
is live on Nuget.org! Take a look at the 4.0 project to see new features and fixes. Version 4 has public interface changes. You will need to read through the documentation to upgrade from version 3 to version 4.
- You can do USB control transfer from an Android host.
- Cancellation tokens are fixed for Hid devices
This framework provides a common Task async programming interface across platforms and device types. This allows for dependency injection to use different types of devices on any platform with the same code. The supported device types are Hid, Serial Port, and USB.
This project needs funding. Please sponsor me here so that I can contribute more time to improving this framework.
| Coin | Address |
|---|---|
| Bitcoin | 33LrG1p81kdzNUHoCnsYGj6EHRprTKWu3U |
| Ethereum | 0x7ba0ea9975ac0efb5319886a287dcf5eecd3038e |
| Litecoin | MVAbLaNPq7meGXvZMU4TwypUsDEuU6stpY |
This project also needs unit tests, bug fixes and work towards more platforms. Please read this.
This framework uses the MIT license. I won't sue you, or your business if you use this for free. If you are developing software for free, I don't expect you to sponsor me. However, if your business makes more than USD 100,000 per year and your software depends on Device.Net, I expect your business to make a serious contribution via sponsorship.
Device communication is fragmented across platforms and device types. If you need to use three different device types across Android, UWP and .NET, you would otherwise need nine different APIs. Device.Net puts a standard layer across all these so that you can share code across all platforms and device types. You don't need to use Windows APIs or learn about Android's API directly. If the device manufacturer decides to switch from USB to Hid, the code remains the same. Write once; run everywhere.
-
Join the conversation on Discord
-
Check out my blog for articles
| Platform | Hid | USB | Serial Port | Bluetooth |
|---|---|---|---|---|
| .NET Framework | Yes | Yes | Yes | No |
| .NET Core | Yes | Yes | Yes | No |
| Android | Yes | Yes | No | No |
| UWP | Yes | Yes | No | No |
| Linux, MacOS* | No | (Via LibUsbDotNet) | No | No |
| WebAssembly | No | No | No | No |
Note: Bluetooth, Linux, and macOS, WebAssembly (via WebUsb) support are on the radar. If you can sponsor this project, you might be able to help get there faster.
SerialPort.Net and Device.Net.LibUsb are still in alpha mode. You must use the prerelease version
using Device.Net;
using Hid.Net.Windows;
using Microsoft.Extensions.Logging;
using System.Linq;
using System.Reactive.Linq;
using System.Threading.Tasks;
using Usb.Net.Windows;
namespace Usb.Net.WindowsSample
{
internal class Program
{
private static async Task Main()
{
//Create logger factory that will pick up all logs and output them in the debug output window
var loggerFactory = LoggerFactory.Create((builder) =>
{
_ = builder.AddDebug().SetMinimumLevel(LogLevel.Trace);
});
//----------------------
// This is Windows specific code. You can replace this with your platform of choice or put this part in the composition root of your app
//Register the factory for creating Hid devices.
var hidFactory =
new FilterDeviceDefinition(vendorId: 0x534C, productId: 0x0001, label: "Trezor One Firmware 1.6.x", usagePage: 65280)
.CreateWindowsHidDeviceFactory(loggerFactory);
//Register the factory for creating Usb devices.
var usbFactory =
new FilterDeviceDefinition(vendorId: 0x1209, productId: 0x53C1, label: "Trezor One Firmware 1.7.x")
.CreateWindowsUsbDeviceFactory(loggerFactory);
//----------------------
//Join the factories together so that it picks up either the Hid or USB device
var factories = hidFactory.Aggregate(usbFactory);
//Get connected device definitions
var deviceDefinitions = (await factories.GetConnectedDeviceDefinitionsAsync().ConfigureAwait(false)).ToList();
if (deviceDefinitions.Count == 0)
{
//No devices were found
return;
}
//Get the device from its definition
var trezorDevice = await hidFactory.GetDeviceAsync(deviceDefinitions.First()).ConfigureAwait(false);
//Initialize the device
await trezorDevice.InitializeAsync().ConfigureAwait(false);
//Create the request buffer
var buffer = new byte[65];
buffer[0] = 0x00;
buffer[1] = 0x3f;
buffer[2] = 0x23;
buffer[3] = 0x23;
//Write and read the data to the device
var readBuffer = await trezorDevice.WriteAndReadAsync(buffer).ConfigureAwait(false);
}
}
}Human Interface Device Wikipedia Page - Good for understanding the difference between the meaning of the two terms: USB and Hid.
USB human interface device class Wikipedia Page - as above
USB Wikipedia Page - as above
Jax Axelson's USB Page - General C# USB Programming