crystal-hidapi

A Crystal interface to HIDAPI library.

It works on Linux and macOS.

Installation

1. Add the dependency to your shard.yml:

   dependencies:
     crystal-hidapi:
       github: mamantoha/crystal-hidapi
   

2. Run shards install

Compile time dependencies

You need to install the development package for hidapi

• macOS: brew install hidapi
• Arch Linux: pacman -S hidapi
• Ubuntu: apt install libhidapi-dev

Usage

require "crystal-hidapi"

Sample Usage

Explore the following examples:

• Retrieve battery level for Sony PlayStation 5 DualSense controller
• Fetch battery capacity and status for Sony DualShock4 (2nd gen) controller

Development

crystal ./lib/crystal_lib/src/main.cr src/hidapi/lib_hidapi.cr.in > src/hidapi/lib_hidapi.cr

External Resources Usage

• libusb's hidapi on GitHub
• hidapi header file
• hidapi test code
• hidapitester code by todbot

Contributing

1. Fork it (https://github.com/mamantoha/crystal-hidapi/fork)
2. Create your feature branch (git checkout -b my-new-feature)
3. Commit your changes (git commit -am 'Add some feature')
4. Push to the branch (git push origin my-new-feature)
5. Create a new Pull Request

Contributors

• Anton Maminov - creator and maintainer