BlackSharp.IO.Ports 1.2.2

<h1 align="center">BlackSharp</h1>

Reusable .NET building blocks for application logic, device communication and desktop interfaces.

BlackSharp brings commonly needed functionality into a set of focused libraries: core utilities, USB HID communication, native serial and raw USB access, MVVM helpers and Avalonia controls. Share proven building blocks across applications without copying infrastructure code into every project.

The libraries are general-purpose components.

Key capabilities

• Everyday utilities for collections, strings, files, byte and bit operations, unit conversions, reflection, logging, asynchronous work & more
• USB HID communication with device discovery, report metadata and cancellable worker-based I/O on Windows and Linux
• Native serial and raw USB access with configurable timeouts, flow control, device discovery and platform-specific transports
• MVVM foundations built on CommunityToolkit.Mvvm, including view-model bases, drag-and-drop contracts and shared dialog models
• Avalonia desktop components including dialogs, numeric text boxes, busy indicators, reorderable controls, behaviors, converters and shared styles
• Modular dependencies so utility and device-access consumers do not need to bring in a desktop UI framework

Choosing a package

Install the required packages through your IDE's NuGet package manager.

Start with BlackSharp.Core for shared application utilities.

Add BlackSharp.IO.HID for HID devices or BlackSharp.IO.Ports for serial and raw USB communication.

Use BlackSharp.MVVM for view-model infrastructure and BlackSharp.UI.Avalonia for the Avalonia integration.

Projects

Project	NuGet package	Downloads	Purpose
BlackSharp.Core			General-purpose utilities, conversions, collections, logging and native interop helpers
BlackSharp.IO.HID			USB HID discovery, report handling and device streams
BlackSharp.IO.Ports			Native serial communication and raw USB device access
BlackSharp.MVVM			View-model bases and shared MVVM contracts
BlackSharp.UI.Avalonia			Avalonia controls, dialogs, behaviors, styles and desktop integration

Supported .NET versions

Quick start

Core utilities

Reference BlackSharp.Core to use shared helpers without any UI or device-transport dependencies:

using System;
using BlackSharp.Core.Converters;
using BlackSharp.Core.Converters.Enums;

var mebibytes = DataUnitConverter.Convert(1048576m, DataUnit.Byte, DataUnit.MebiByte);

Console.WriteLine($"{mebibytes} MiB");

HID discovery

Reference BlackSharp.IO.HID to enumerate HID interfaces on Windows or Linux:

using System;
using BlackSharp.IO.HID;

foreach (var device in HIDDeviceEnumerator.GetDevices())
{
    Console.WriteLine($"{device.VendorID:X4}:{device.ProductID:X4} {device.ProductName}");
}

Open a selected interface through HIDDevice.Open() or TryOpen() when your application is ready to communicate and dispose the returned stream when finished. Device-specific report formats still need to be implemented by the consumer.

Versioning

Versions/BLACKSHARP.VERSION is the single authoritative version for the five NuGet packages and the projects that produce them. Change only this file to prepare the next version; individual project files do not carry separate release numbers.

Use packages from the same BlackSharp release together.

Troubleshooting and support

For device-access failures, check permissions, the installed device driver, native dependencies and whether another application is using the device. For UI issues, distinguish a reusable BlackSharp component from the Avalonia backend and application-specific resource configuration.

When opening a GitHub issue, include the affected package and version, target framework, operating system, architecture, a minimal reproduction and the complete exception. For device issues, include relevant device identifiers and transport settings; remove serial numbers, credentials and other sensitive data before posting.

Contributing

Everyone is welcome and encouraged to contribute. Bug reports, documentation, tests, fixes and additional reusable components are all valuable. Keep changes focused and follow the existing architecture, naming, documentation, formatting and code style. Include or update tests and documentation where applicable, and describe the affected packages, platforms and validation in the pull request.

AI-assisted contributions

Transparency about the use of artificial intelligence is required. Changes created entirely by AI must be clearly marked as AI-generated in the pull request description. Changes to which an AI tool contributed must likewise be marked as AI-assisted, even when they were subsequently reviewed or edited by the contributor. The disclosure should identify the affected parts of the change. Contributors remain responsible for understanding, reviewing and testing their submissions, as well as for their correctness, security and license compliance.

AI tools have supported the development of this project, including documentation and unit testing.

License

Licensed under the Mozilla Public License 2.0.