Nefarius.Utilities.DeviceManagement

KO | EN

gitlite — search

#javascript #python #hacktoberfest #typescript #go #golang #java #windows #cli #vue #security #pytorch #ios #open-source

Nefarius.Utilities.DeviceManagement

(★ 39)

Managed wrappers around SetupAPI, Cfgmgr32, NewDev and DrvStore Windows APIs.

Nefarius.Utilities.DeviceManagement 최신버젼 다운로드

최종 버전 다운로드 (.zip)

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# <img src="assets/NSS-128x128.png" align="left" />Nefarius.Utilities.DeviceManagement

[![.NET](https://github.com/nefarius/Nefarius.Utilities.DeviceManagement/actions/workflows/build.yml/badge.svg)](https://github.com/nefarius/Nefarius.Utilities.DeviceManagement/actions/workflows/build.yml)
![Requirements](https://img.shields.io/badge/Requires-.NET%20Standard%202.0%2B-blue.svg)
[![Nuget](https://img.shields.io/nuget/v/Nefarius.Utilities.DeviceManagement)](https://www.nuget.org/packages/Nefarius.Utilities.DeviceManagement/)
[![Nuget](https://img.shields.io/nuget/dt/Nefarius.Utilities.DeviceManagement)](https://www.nuget.org/packages/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](https://learn.microsoft.com/en-us/windows-hardware/drivers/install/unified-device-property-model--windows-vista-and-later-)
- 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

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

## Testing

See [TESTING.md](TESTING.md) for Unit/CI filters, hardware lab prerequisites, and how tests run in GitHub Actions.

```powershell
dotnet test Tests/Tests.csproj -c Release --filter "Category=Unit|Category=CI"
```

## Examples

Some usage examples of the core library features are presented below. Samples assume:

```csharp
using System;
using System.Linq;
using System.Threading;
using Nefarius.Utilities.DeviceManagement.Drivers;
using Nefarius.Utilities.DeviceManagement.Extensions;
using Nefarius.Utilities.DeviceManagement.PnP;
```

### Enumerate all USB devices

The `Devcon` utility class offers helper methods to find devices.

```csharp
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.

```csharp
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

```csharp
var allDriverPackages = DriverStore.ExistingDrivers.ToList();
```

### Remove all copies of `mydriver.inf` from the Driver Store

```csharp
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)

```csharp
// 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

```csharp
// 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

```csharp
string service = "HidHide";
DeviceClassFilters.AddUpper(DeviceClassIds.XnaComposite, service);
```

### Replace a device instance's function driver with WinUSB

```csharp
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

```csharp
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

```csharp
// replace with the instance ID of the USB device you want to power-cycle
const string instanceId = @"USB\VID_054C&PID_0CE6\0000000000000000";

PnPDevice device = PnPDevice.GetDeviceByInstanceId(instanceId);
UsbPnPDevice usbDevice = device.ToUsbPnPDevice();
usbDevice.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](https://gist.github.com/jborean93/01ba060ac9043a7b997d396de7aa009e)
- [Tooling to generate metadata for Win32 APIs in the Windows SDK.](https://github.com/microsoft/win32metadata)
- [Disable or Enable Device with Hardware ID](https://gist.github.com/3735943886/f47c355738e3dd7975fe0aa1abd67445)
- [C#/Win32 P/Invoke Source Generator](https://github.com/microsoft/CsWin32)
- [Driver Store Explorer [RAPR]](https://github.com/lostindark/DriverStoreExplorer)
- [ViGEm.Management](https://github.com/ViGEm/ViGEm.Management)
- [XMLDoc2Markdown](https://charlesdevandiere.github.io/xmldoc2md/)
- [ManagedDevcon](https://github.com/nefarius/ManagedDevcon)
- [Driver Updater](https://github.com/WOA-Project/DriverUpdater)

Nefarius.Utilities.DeviceManagement

Nefarius.Utilities.DeviceManagement 최신버젼 다운로드

오늘의 추천 프로젝트

Was this content helpful?

Recent Feedback

Nefarius.Utilities.DeviceManagement

Nefarius.Utilities.DeviceManagement 최신버젼 다운로드

오늘의 추천 프로젝트

Was this content helpful?

Recent Feedback

Download README