Nefarius.Utilities.DeviceManagement
5.0.0
Prefix Reserved
dotnet add package Nefarius.Utilities.DeviceManagement --version 5.0.0
NuGet\Install-Package Nefarius.Utilities.DeviceManagement -Version 5.0.0
<PackageReference Include="Nefarius.Utilities.DeviceManagement" Version="5.0.0" />
paket add Nefarius.Utilities.DeviceManagement --version 5.0.0
#r "nuget: Nefarius.Utilities.DeviceManagement, 5.0.0"
// Install Nefarius.Utilities.DeviceManagement as a Cake Addin #addin nuget:?package=Nefarius.Utilities.DeviceManagement&version=5.0.0 // Install Nefarius.Utilities.DeviceManagement as a Cake Tool #tool nuget:?package=Nefarius.Utilities.DeviceManagement&version=5.0.0
Nefarius.Utilities.DeviceManagement
Managed wrappers around SetupAPI, Cfgmgr32, NewDev and DrvStore Windows APIs.
Features
- Listen for device plugin and unplug events without depending on WinForms or WPF
- Enumerate and remove elements from the Driver Store
- Convert various notations (Symlink to Instance ID etc.)
- Get and set various unified device properties
- Enumerate devices (present and absent)
- Hot-swap device function drivers
- Add/Remove/Clear class filters
- Power-cycle USB hub ports
- Install/update drivers
- Uninstall devices
Documentation
Generating documentation
dotnet build -c:Release
dotnet tool install --global Nefarius.Tools.XMLDoc2Markdown
xmldoc2md .\bin\netstandard2.0\Nefarius.Utilities.DeviceManagement.dll .\docs\
Examples
Some usage examples of the core library features are presented below.
Enumerate all USB devices
The Devcon
utility class offers helper methods to find devices.
var instance = 0;
// enumerate all devices that export the GUID_DEVINTERFACE_USB_DEVICE interface
while (Devcon.FindByInterfaceGuid(DeviceInterfaceIds.UsbDevice, out var path,
out var instanceId, instance++))
{
Console.WriteLine($"Path: {path}, InstanceId: {instanceId}");
var usbDevice = PnPDevice
.GetDeviceByInterfaceId(path)
.ToUsbPnPDevice();
Console.WriteLine($"Got USB device {usbDevice.InstanceId}");
}
Listen for new and removed USB devices
One or more instances of the DeviceNotificationListener
can be used to listen for plugin and unplug events of various
devices. This class has no dependency on WinForms or WPF and works in Console Applications and Windows Services alike.
var listener = new DeviceNotificationListener();
listener.DeviceArrived += Console.WriteLine;
listener.DeviceRemoved += Console.WriteLine;
// start listening for plugins or unplugs of GUID_DEVINTERFACE_USB_DEVICE interface devices
listener.StartListen(DeviceInterfaceIds.UsbDevice);
Get all driver packages in the Driver Store
var allDriverPackages = DriverStore.ExistingDrivers.ToList();
Remove all copies of mydriver.inf
from the Driver Store
foreach (var driverPackage in allDriverPackages.Where(p => p.Contains("mydriver.inf", StringComparison.OrdinalIgnoreCase)))
{
DriverStore.RemoveDriver(driverPackage);
}
Get Instance ID from a symbolic link (device path)
// e.g. the path "\\?\HID#VID_045E&PID_028E&IG_00#3&31f0e99d&0&0000#{4d1e55b2-f16f-11cf-88cb-001111000030}"
// gets translated to instanceId "HID\VID_045E&PID_028E&IG_00\3&31f0e99d&0&0000"
var instanceId = PnPDevice.GetInstanceIdFromInterfaceId(path);
Get PnPDevice object from symbolic link
// example path: "\\?\HID#VID_046D&PID_C33F&MI_01&COL02#B&31580538&0&0001#{4D1E55B2-F16F-11CF-88CB-001111000030}"
PnPDevice device = PnPDevice.GetDeviceByInterfaceId(path);
Add a driver service to a device class' upper filters
string service = "HidHide";
DeviceClassFilters.AddUpper(DeviceClassIds.XnaComposite, service);
Replace a device instance's function driver with WinUSB
const string instanceId = @"USB\VID_054C&PID_0CE6&MI_03\9&DC32669&3&0003";
PnPDevice device = PnPDevice.GetDeviceByInstanceId(instanceId);
// required for the next call to succeed
device.InstallNullDriver();
Thread.Sleep(1000);
// accepts any INF already present in C:\Windows\INF directory
device.InstallCustomDriver("winusb.inf");
Uninstall device/revert function driver to default
const string instanceId = @"USB\VID_054C&PID_0CE6&MI_03\9&DC32669&3&0003";
PnPDevice device = PnPDevice.GetDeviceByInstanceId(instanceId);
// uninstall/deconfigure device
device.Uninstall();
Thread.Sleep(1000);
// trigger re-enumeration
Devcon.Refresh();
Cycle hub port a given USB device is attached to
if (Devcon.FindByInterfaceGuid(HostRadio.DeviceInterface, out PnPDevice radioDevice))
{
UsbPnPDevice? usbHostRadio = radioDevice.ToUsbPnPDevice();
usbHostRadio.CyclePort();
}
Sources & 3rd party credits
This library benefits from these awesome projects ❤ (appearance in no special order):
- Manage Windows devices in .NET, can enumerate, start, stop, disable, enable, and remove devices
- Tooling to generate metadata for Win32 APIs in the Windows SDK.
- Disable or Enable Device with Hardware ID
- C#/Win32 P/Invoke Source Generator
- Driver Store Explorer [RAPR]
- ViGEm.Management
- XMLDoc2Markdown
- ManagedDevcon
- Driver Updater
Product | Versions Compatible and additional computed target framework versions. |
---|---|
.NET | net5.0 was computed. net5.0-windows was computed. net6.0 was computed. net6.0-android was computed. net6.0-ios was computed. net6.0-maccatalyst was computed. net6.0-macos was computed. net6.0-tvos was computed. net6.0-windows was computed. net7.0 was computed. net7.0-android was computed. net7.0-ios was computed. net7.0-maccatalyst was computed. net7.0-macos was computed. net7.0-tvos was computed. net7.0-windows was computed. net8.0 is compatible. net8.0-android was computed. net8.0-browser was computed. net8.0-ios was computed. net8.0-maccatalyst was computed. net8.0-macos was computed. net8.0-tvos was computed. net8.0-windows was computed. |
.NET Core | netcoreapp2.0 was computed. netcoreapp2.1 was computed. netcoreapp2.2 was computed. netcoreapp3.0 was computed. netcoreapp3.1 was computed. |
.NET Standard | netstandard2.0 is compatible. netstandard2.1 was computed. |
.NET Framework | net461 was computed. net462 is compatible. net463 was computed. net47 was computed. net471 was computed. net472 was computed. net48 is compatible. net481 was computed. |
MonoAndroid | monoandroid was computed. |
MonoMac | monomac was computed. |
MonoTouch | monotouch was computed. |
Tizen | tizen40 was computed. tizen60 was computed. |
Xamarin.iOS | xamarinios was computed. |
Xamarin.Mac | xamarinmac was computed. |
Xamarin.TVOS | xamarintvos was computed. |
Xamarin.WatchOS | xamarinwatchos was computed. |
-
.NETFramework 4.6.2
- System.Memory (>= 4.5.5)
-
.NETFramework 4.8
- System.Memory (>= 4.5.5)
-
.NETStandard 2.0
- System.Memory (>= 4.5.5)
-
net8.0
- System.Memory (>= 4.5.5)
NuGet packages (4)
Showing the top 4 NuGet packages that depend on Nefarius.Utilities.DeviceManagement:
Package | Downloads |
---|---|
Nefarius.Drivers.HidHide
Managed API for configuring HidHide. |
|
Wujek_Dualsense_API
Wujek Dualsense API is a .NET library designed to interface with the PlayStation DualSense controller, providing functionalities to control its various features such as haptic feedback, LEDs, triggers, and more. |
|
Nefarius.Utilities.Bluetooth
Utility library for unconventional Bluetooth tasks on Windows. |
|
O.Usb
Package Description |
GitHub repositories (6)
Showing the top 5 popular GitHub repositories that depend on Nefarius.Utilities.DeviceManagement:
Repository | Stars |
---|---|
Valkirie/HandheldCompanion
ControllerService
|
|
CircumSpector/DS4Windows
A reimagination of DS4Windows.
|
|
project-sbc/Handheld-Control-Panel
|
|
nefarius/Legacinator
The one and only Legacinator
|
|
Struggleton/Delfinovin
An XInput solution for Gamecube Controllers
|
Version | Downloads | Last updated |
---|---|---|
5.0.0 | 150 | 11/9/2024 |
5.0.0-pre001 | 59 | 11/9/2024 |
4.0.3 | 96 | 11/7/2024 |
4.0.3-pre001 | 61 | 11/7/2024 |
4.0.2 | 132 | 10/30/2024 |
4.0.1 | 453 | 10/1/2024 |
4.0.0 | 459 | 9/20/2024 |
4.0.0-pre002 | 64 | 9/20/2024 |
4.0.0-pre001 | 75 | 9/20/2024 |
3.23.0 | 557 | 8/17/2024 |
3.22.0 | 871 | 7/7/2024 |
3.21.0 | 126 | 7/4/2024 |
3.20.0 | 110 | 7/4/2024 |
3.19.0 | 261 | 6/30/2024 |
3.19.0-pre3 | 107 | 6/28/2024 |
3.19.0-pre2 | 93 | 6/27/2024 |
3.18.1 | 1,485 | 3/11/2024 |
3.17.406 | 2,294 | 8/29/2023 |
3.17.403 | 291 | 8/27/2023 |
3.17.401-pre | 134 | 8/26/2023 |
3.16.384-pre | 170 | 8/23/2023 |
3.14.305 | 2,368 | 5/14/2023 |
3.13.303-pre | 145 | 5/14/2023 |
3.12.297-pre | 212 | 5/13/2023 |
3.11.295-pre | 176 | 5/12/2023 |
3.10.293-pre | 224 | 5/9/2023 |
3.9.255 | 1,710 | 4/9/2023 |
3.8.228 | 1,214 | 2/2/2023 |
3.8.225-pre | 183 | 2/1/2023 |
3.6.213 | 639 | 1/12/2023 |
3.6.211 | 315 | 1/12/2023 |
3.5.209 | 527 | 12/26/2022 |
3.4.206 | 399 | 12/20/2022 |
3.4.204-pre | 166 | 12/19/2022 |
3.4.202-pre | 153 | 12/19/2022 |
3.3.196 | 683 | 10/16/2022 |
3.2.193 | 409 | 10/16/2022 |
3.2.191 | 407 | 10/16/2022 |
3.2.189 | 426 | 10/16/2022 |
3.2.186 | 416 | 10/16/2022 |
3.2.184 | 683 | 9/29/2022 |
3.2.175 | 506 | 9/12/2022 |
3.1.173 | 407 | 9/12/2022 |
3.1.171 | 414 | 9/12/2022 |
3.0.168 | 433 | 9/10/2022 |
3.0.165-pre | 242 | 9/9/2022 |
2.9.116 | 483 | 8/25/2022 |
2.8.110 | 892 | 7/19/2022 |
2.8.107 | 718 | 6/15/2022 |
2.7.104 | 445 | 6/14/2022 |
2.6.102 | 605 | 6/2/2022 |
2.6.100 | 477 | 5/26/2022 |
2.6.98 | 498 | 5/24/2022 |
2.4.94 | 488 | 5/19/2022 |
2.4.91 | 487 | 5/14/2022 |
2.4.89 | 421 | 5/14/2022 |
2.3.87 | 451 | 5/13/2022 |
2.2.85 | 476 | 5/11/2022 |
2.1.76 | 443 | 5/11/2022 |
2.1.74 | 454 | 5/10/2022 |
2.0.71 | 469 | 5/10/2022 |
2.0.68 | 487 | 5/8/2022 |
2.0.66 | 449 | 5/8/2022 |
2.0.60 | 453 | 5/8/2022 |
1.6.50 | 483 | 5/6/2022 |
1.6.48-beta | 193 | 5/6/2022 |
1.4.42-beta | 926 | 2/1/2022 |
1.3.28-beta | 209 | 1/30/2022 |
1.2.24-beta | 190 | 1/30/2022 |
1.2.22-beta | 188 | 1/30/2022 |
1.1.20-beta | 197 | 1/30/2022 |
1.0.18-beta | 201 | 1/30/2022 |
1.0.15-beta | 356 | 1/17/2022 |
1.0.13-beta | 199 | 1/17/2022 |
1.0.11-beta | 198 | 1/17/2022 |
1.0.6-beta | 205 | 1/16/2022 |
1.0.4-beta | 209 | 1/16/2022 |
1.0.2-beta | 210 | 1/16/2022 |