HidDeviceReaderLibrary 4.5.0

dotnet add package HidDeviceReaderLibrary --version 4.5.0
                    
NuGet\Install-Package HidDeviceReaderLibrary -Version 4.5.0
                    
This command is intended to be used within the Package Manager Console in Visual Studio, as it uses the NuGet module's version of Install-Package.
<PackageReference Include="HidDeviceReaderLibrary" Version="4.5.0" />
                    
For projects that support PackageReference, copy this XML node into the project file to reference the package.
<PackageVersion Include="HidDeviceReaderLibrary" Version="4.5.0" />
                    
Directory.Packages.props
<PackageReference Include="HidDeviceReaderLibrary" />
                    
Project file
For projects that support Central Package Management (CPM), copy this XML node into the solution Directory.Packages.props file to version the package.
paket add HidDeviceReaderLibrary --version 4.5.0
                    
#r "nuget: HidDeviceReaderLibrary, 4.5.0"
                    
#r directive can be used in F# Interactive and Polyglot Notebooks. Copy this into the interactive tool or source code of the script to reference the package.
#addin nuget:?package=HidDeviceReaderLibrary&version=4.5.0
                    
Install as a Cake Addin
#tool nuget:?package=HidDeviceReaderLibrary&version=4.5.0
                    
Install as a Cake Tool

HidDeviceReaderLibrary

Introduction

HidDeviceReaderLibrary is a .NET library for reading data from USB HID devices (not supporting virtual keyboard mode) and parsing JSON data. It is suitable for scenarios where you need to communicate with HID devices and process their data.

Features

  • Supports finding and connecting HID devices by VendorID and ProductID
  • Real-time reading of HID device data streams
  • Automatically filters ASCII data and extracts JSON strings
  • Supports parsing JSON and retrieving specific field values
  • Asynchronous data retrieval via event callbacks
  • Supports custom cancellation of reading (CancellationToken)

Supported Platforms

  • .NET Core 2.0 and above
  • .NET 6/8/9
  • Windows, Linux, macOS (platforms supported by HidSharp)

Installation

dotnet add package HidDeviceReaderLibrary

Quick Start Example

using System; 
using System.Threading; 
using HidDeviceReaderLibrary;
class Program { 
    static async void Main() 
        {
            // your HID device VendorID 和 ProductID
            var reader = new HidDeviceReader(0x2F50, 0x0300);
            reader.OnDataReceived += data =>
            {
                Console.WriteLine($"Received data: {data}");
            };

            using (var cts = new CancellationTokenSource())
            {
                // press Ctrl+C cancels
                Console.CancelKeyPress += (s, e) => {
                    e.Cancel = true;
                    cts.Cancel();
                };

                await reader.StartReadingAsync(cts.Token);
                Console.ReadKey();
            }
        }
}

Dependencies

License

MIT

Product 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 was computed.  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.  net9.0 was computed.  net9.0-android was computed.  net9.0-browser was computed.  net9.0-ios was computed.  net9.0-maccatalyst was computed.  net9.0-macos was computed.  net9.0-tvos was computed.  net9.0-windows was computed.  net10.0 was computed.  net10.0-android was computed.  net10.0-browser was computed.  net10.0-ios was computed.  net10.0-maccatalyst was computed.  net10.0-macos was computed.  net10.0-tvos was computed.  net10.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 was computed.  net463 was computed.  net47 was computed.  net471 was computed.  net472 was computed.  net48 was computed.  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. 
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.

NuGet packages

This package is not used by any NuGet packages.

GitHub repositories

This package is not used by any popular GitHub repositories.

Version Downloads Last Updated
4.5.0 194 5/16/2025
4.4.0 196 5/16/2025
4.3.0 203 5/16/2025
4.2.0 205 5/16/2025
4.1.0 209 5/16/2025
4.0.0 207 5/16/2025
3.9.3 212 5/16/2025
3.9.2 212 5/16/2025
3.9.1 214 5/15/2025
3.9.0 216 5/15/2025
3.7.0 219 5/15/2025
3.6.0 219 5/14/2025
3.5.0 215 5/14/2025
3.4.0 216 5/14/2025
3.3.0 219 5/14/2025
3.2.0 219 5/14/2025
3.1.0 218 5/14/2025
3.0.0 223 5/14/2025
1.2.0 221 5/14/2025
1.1.0 190 5/16/2025

## version 4.5.0
     - [update] readme.md