Skip to content

Blizzardo1/hid-sharp

Repository files navigation

Static Badge GitHub last commit GitHub branch check runs GitHub commit activity GitHub License

HID#

HID# is a wrapper for the hidapi library written in C. It is an implementation to read and write directly to any HID available on your device. Why did I do this? To have another way to monitor my Keychron K10 Pro Keyboards. There are other libraries available for NodeJS and Python, so why not have a C# implementation? I personally believe in trying to expand through other languages to make our lives easier.

Getting Started

These instructions will give you a copy of the project up and running on your local machine for development and testing purposes. See deployment for notes on deploying the project on a live system.

Prerequisites

Requirements for the software and other tools to build, test and push:

  • Latest .NET Framework

Installing

Simply clone this repo to your choice of IDE, be it Rider, VS Code, or Visual Studio. For now, the HIDAPI x64 library is available; however, eventually I and future contributors would need to add x86 backwards compatibility and rewrite the code to become more platform agnostic.

Built With

Built with Visual Studio 2022 Enterprise with .NET 8.0

Contributing

Please read CONTRIBUTING.md for details on our code of conduct, and the process for submitting pull requests to us.

Code of Conduct

Please read CODE_OF_CONDUCT.md and follow this document with utmost respect. We want everyone to feel welcome here.

Versioning

We use Semantic Versioning for versioning.
Examples:

  • 1.0.0
  • 1.1.0-alpha
  • 1.0.1+32
  • 1.0.0-alpha+64

and so forth.

Authors

See also the list of contributors who participated in this project.

License

This project is licensed under the GPL v3 License.
See the LICENSE.md file for details

Acknowledgments

  • Hat tip to anyone whose code is used
  • Inspiration for my Keychron K10 Pro Keyboards
  • The HID API
  • You

About

No description, website, or topics provided.

Resources

License

Code of conduct

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published