Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/nefarius/Nefarius.Drivers.WinUSB

WinUSB .NET wrapper library
https://github.com/nefarius/Nefarius.Drivers.WinUSB

Last synced: about 2 months ago
JSON representation

WinUSB .NET wrapper library

Host: GitHub
URL: https://github.com/nefarius/Nefarius.Drivers.WinUSB
Owner: nefarius
License: other
Created: 2022-04-23T22:08:38.000Z (over 2 years ago)
Default Branch: master
Last Pushed: 2024-07-29T23:27:49.000Z (about 2 months ago)
Last Synced: 2024-07-30T17:48:13.460Z (about 2 months ago)
Language: C#
Homepage: https://discord.nefarius.at
Size: 734 KB
Stars: 10
Watchers: 2
Forks: 4
Open Issues: 1
Metadata Files:
- Readme: README.md
- Changelog: Changelog.md
- License: license.txt

Awesome Lists containing this project

README

        # Nefarius.Drivers.WinUSB

> *This is a fork of the fantastic [`MadWizard.WinUSBNet`](https://github.com/snikeguo/winusbnet) project by Thomas Bleeker and contributors.*

[![Build status](https://ci.appveyor.com/api/projects/status/rqfsoto1qpd0456f?svg=true)](https://ci.appveyor.com/project/nefarius/nefarius-drivers-winusb) ![.NET 4.7.2](https://img.shields.io/badge/.NET-4.7.2-blue)  ![.NET 4.8](https://img.shields.io/badge/.NET-4.8-blue) ![.NET 6.0](https://img.shields.io/badge/.NET-6.0-blue) [![NuGet](https://img.shields.io/nuget/dt/Nefarius.Drivers.WinUSB)](https://www.nuget.org/packages/Nefarius.Drivers.WinUSB/)

Managed wrapper for the [WinUSB APIs](https://learn.microsoft.com/en-us/windows-hardware/drivers/usbcon/winusb) on Microsoft Windows.

## Changes of this fork

- Replaced P/Invoke code with [source generators](https://github.com/microsoft/CsWin32)

- Changed namespace to `Nefarius.Drivers.WinUSB` to avoid conflicts with the origin library

- Removed device notification listener as my other lib [`Nefarius.Utilities.DeviceManagement`](https://github.com/nefarius/Nefarius.Utilities.DeviceManagement) provides a drop-in replacement without depending on WinForms or WPF

- Added `USBDevice::GetSingleDeviceByPath` to allow opening a WinUSB device via device path (symbolic link)

## Documentation

[Link to API docs](docs/index.md).

### Generating documentation

- `dotnet build -c:Release`

- `dotnet tool install -g XMLDoc2Markdown`

- `xmldoc2md .\bin\net6.0-windows\Nefarius.Drivers.WinUSB.dll .\docs\`

## TO-DOs

- Migrate all buffers to Spans where possible

- Migrate the old asynchronous APIs to `async`/`await` and Tasks

## Features

> *Taken verbatim from [the source repository](https://github.com/snikeguo/winusbnet/blob/master/README.md).*

- MIT licensed with C# source code available (free for both personal and commercial use)

- CLS compliant library (usable from all .NET languages such as C#, VB.NET and C++.NET)

- Synchronous and asynchronous data transfers

- Support for 32-bit and 64-bit Windows versions

- Support for multiple interfaces and endpoints

- Intellisense documentation

## Related documentation

- [Library reference online](http://madwizard-thomas.github.io/winusbnet/docs/)

- [Online wiki with short howto](https://github.com/madwizard-thomas/winusbnet/wiki)

- [WinUSB overview](https://docs.microsoft.com/en-us/windows-hardware/drivers/usbcon/winusb)

- [How to Access a USB Device by Using WinUSB Functions](https://learn.microsoft.com/en-us/windows-hardware/drivers/usbcon/using-winusb-api-to-communicate-with-a-usb-device)

- [Jan Axelson's page on WinUSB](http://janaxelson.com/winusb.htm)