Updated readme

This commit is contained in:
EonaCat 2025-07-12 22:45:21 +02:00
parent 115bac01ca
commit 8529cdc43f
14 changed files with 39 additions and 3 deletions

View File

@ -2,6 +2,9 @@
namespace EonaCat.HID.EventArguments
{
// This file is part of the EonaCat project(s) which is released under the Apache License.
// See the LICENSE file or go to https://EonaCat.com/license for full license details.
/// <summary>
/// Event args for received data
/// </summary>

View File

@ -2,6 +2,9 @@
namespace EonaCat.HID.EventArguments
{
// This file is part of the EonaCat project(s) which is released under the Apache License.
// See the LICENSE file or go to https://EonaCat.com/license for full license details.
/// <summary>
/// Event args for error events
/// </summary>

View File

@ -2,6 +2,9 @@
namespace EonaCat.HID.EventArguments
{
// This file is part of the EonaCat project(s) which is released under the Apache License.
// See the LICENSE file or go to https://EonaCat.com/license for full license details.
/// <summary>
/// Event arguments with HID device info.
/// </summary>

View File

@ -5,7 +5,7 @@ using System.Text;
namespace EonaCat.HID.Helpers
{
// This file is part of the EonaCat project(s) which is released under the Apache License.
// See the LICENSE file or go to https://EonaCat.com/License for full license details.
// See the LICENSE file or go to https://EonaCat.com/license for full license details.
public static class ByteHelper
{

View File

@ -3,6 +3,9 @@ using System.Runtime.InteropServices;
namespace EonaCat.HID
{
// This file is part of the EonaCat project(s) which is released under the Apache License.
// See the LICENSE file or go to https://EonaCat.com/license for full license details.
/// <summary>
/// Main static factory class to create platform-specific implementations.
/// </summary>

View File

@ -10,6 +10,9 @@ using System.Threading.Tasks;
namespace EonaCat.HID
{
// This file is part of the EonaCat project(s) which is released under the Apache License.
// See the LICENSE file or go to https://EonaCat.com/license for full license details.
internal sealed class HidLinux : IHid
{
private readonly string _devicePath;

View File

@ -7,6 +7,9 @@ using System.Threading.Tasks;
namespace EonaCat.HID
{
// This file is part of the EonaCat project(s) which is released under the Apache License.
// See the LICENSE file or go to https://EonaCat.com/license for full license details.
internal sealed class HidMac : IHid
{
private IntPtr _deviceHandle;

View File

@ -14,6 +14,9 @@ using static EonaCat.HID.Managers.Windows.NativeMethods;
namespace EonaCat.HID
{
// This file is part of the EonaCat project(s) which is released under the Apache License.
// See the LICENSE file or go to https://EonaCat.com/license for full license details.
internal sealed class HidWindows : IHid
{
private SafeFileHandle _deviceHandle;

View File

@ -6,6 +6,9 @@ using EonaCat.HID.EventArguments;
namespace EonaCat.HID
{
// This file is part of the EonaCat project(s) which is released under the Apache License.
// See the LICENSE file or go to https://EonaCat.com/license for full license details.
/// <summary>
/// Interface abstraction for a HID device.
/// </summary>

View File

@ -4,6 +4,9 @@ using System.Collections.Generic;
namespace EonaCat.HID
{
// This file is part of the EonaCat project(s) which is released under the Apache License.
// See the LICENSE file or go to https://EonaCat.com/license for full license details.
/// <summary>
/// Interface for manager to enumerate devices and monitor connect/disconnect
/// </summary>

View File

@ -6,10 +6,12 @@ using System.Linq;
using System.Runtime.InteropServices;
using System.Threading;
using System.Threading.Tasks;
using static EonaCat.HID.Managers.Linux.NativeMethods;
namespace EonaCat.HID.Managers.Linux
{
// This file is part of the EonaCat project(s) which is released under the Apache License.
// See the LICENSE file or go to https://EonaCat.com/license for full license details.
internal sealed class HidManagerLinux : IHidManager
{
public event EventHandler<HidEventArgs> OnDeviceInserted;

View File

@ -6,6 +6,9 @@ using static EonaCat.HID.Managers.Mac.NativeMethods;
namespace EonaCat.HID.Managers.Mac
{
// This file is part of the EonaCat project(s) which is released under the Apache License.
// See the LICENSE file or go to https://EonaCat.com/license for full license details.
internal sealed class HidManagerMac : IHidManager, IDisposable
{
private IntPtr _hidManager;

View File

@ -9,6 +9,9 @@ using static EonaCat.HID.Managers.Windows.NativeMethods;
namespace EonaCat.HID.Managers.Windows
{
// This file is part of the EonaCat project(s) which is released under the Apache License.
// See the LICENSE file or go to https://EonaCat.com/license for full license details.
internal sealed class HidManagerWindows : IHidManager, IDisposable
{
private const int DIGCF_PRESENT = 0x00000002;

View File

@ -1,3 +1,4 @@
# EonaCat.HID
EonaCat Usb Devices
Cross platform library for HID devices.
Works on Windows, Linux and macOS.