HIDSharp is a cross-platform .NET wrapper for Windows, MacOS, and Linux (hidraw) USB HID APIs.
It can interface with arbitrary USB HID devices as well as read and write raw reports.
It also includes cross-platform serial port communications and supports interprocess communication for exclusion of HID devices between programs.
See the version list below for details.
Install-Package HidSharp -Version 2.0.5
dotnet add package HidSharp --version 2.0.5
<PackageReference Include="HidSharp" Version="2.0.5" />
paket add HidSharp --version 2.0.5
#r "nuget: HidSharp, 2.0.5"
// Install HidSharp as a Cake Addin #addin nuget:?package=HidSharp&version=2.0.5 // Install HidSharp as a Cake Tool #tool nuget:?package=HidSharp&version=2.0.5
2.0.5 (October 15, 2018):
HIDSharp is now compatible with .NET Core on Linux.
Fixed a garbage collector-related crash on MacOS.
2.0.2 (May 5, 2018):
Fixed a bug on Linux which caused output reports to be sent incorrectly on devices which do not use a Report ID.
DeviceList GetSerialDeviceOrNull() will now match the filesystem name (COM1, /dev/ttyUSB, etc.) as well as DevicePath.
2.0.1 (April 11, 2018):
Fixed a bug on Windows where, in some cases, being unable to reconstruct a device's report descriptor could prevent that device from being opened at all.
HIDSharp now includes assemblies for both .NET Framework 3.5+ and .NET Standard 2.0+.
2.0 (April 9, 2018):
Vastly improved the report descriptor parsing functionality.
You can now decode (nearly) any HID device's reports, on all platforms!
Added GetReportDescriptor support on MacOS version 10.8 and higher.
Added GetReportDescriptor support on Windows. This descriptor is a reconstruction as Windows does not provide a way to directly access this information.
Added an AreDriversBeingInstalled property on DeviceList. (Windows will sometimes close streams of composite HID devices opened while their drivers are being installed.)
Added a Changed event on DeviceList, for detecting device connect and disconnect.
Added a NativeImplementation property to Device.
Added an exclusivity layer, with the ability to request interruption. This is useful for interprocess cooperation, but must be enabled manually.
Added support for serial ports. This is still somewhat buggy on Linux, but on MacOS it works better than the Mono native implementation.
Added support for Linux libudev.so.1.
Exposed GetFileSystemName(). This can be used on Linux to check hidraw permissions.
Fixed max report lengths on MacOS for devices which do not use a Report ID.
Fixed Linux and MacOS not throwing IOException on HID Read() when the device is disconnected.
Fixed Linux support on recent Mono versions.
Fixed 32-bit Linux support (Raspberry Pi).
GetFeature() and SetFeature() now work on Linux.
HIDSharp now uses the Apache open-source license.
Feedback on the new features is appreciated. Some code modifications will be needed to use this new version.
1.5 (May 18, 2013):
Added the DevicePath property to HidDevice.
This is useful for differentiating devices with the same VID, PID, etc.
126.96.36.199 (April 21, 2013):
Added missing XML documentation file to the archive.
1.4 (April 20, 2013):
Documented the most important classes.
Fixed a problem with output reports on 64-bit Windows.
Fixed a timeout bug on Windows.
Parallelized device enumeration.
Reordered platform detection to prevent binary planting on Windows.
1.3 (February 23, 2013):
Fixed Linux libudev reference to not require developer package symlinks.
1.2 (October 16, 2012):
Fixed MacOS support.
1.1 (July 28, 2012):
Added experimental MacOS and Linux support.
Added experimental report descriptor parsing.
1.0 (August 28, 2010):
This package has no dependencies.
NuGet packages (14)
Showing the top 5 NuGet packages that depend on HidSharp:
Buttplug Server Hid Device and Serial Port Subtype Manager, based on the HidSharp Library. (.Net Framework 4.7+/.Net Standard 2.0)
BlinkStick Generic Hid Library with KeesTalksTech modifications
Munts Technologies Remote I/O Library for .Net Standard 2.0
Cross-platform .NET Standard library for asynchronous access to HID Devices (e.g. gamepads, joysticks, etc.)
Monitor the temperature sensors, fan speeds, voltages, load and clock speeds of your computer.
GitHub repositories (7)
Showing the top 5 popular GitHub repositories that depend on HidSharp:
Windows Driver and XInput Wrapper for Sony DualShock 3/4 Controllers
Libre Hardware Monitor, home of the fork of Open Hardware Monitor
Provides advanced unified lighting across many different brands RGB peripherals
DirectInput to XInput wrapper
The one-stop SDK for RGB-peripherals