Skip to content

Commit

Permalink
update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
Marije Baalman committed Sep 12, 2013
1 parent aee4b90 commit ca24d2d
Showing 1 changed file with 31 additions and 0 deletions.
31 changes: 31 additions & 0 deletions README.txt
Original file line number Diff line number Diff line change
@@ -1,3 +1,34 @@
HIDAPI + parser library for Windows, Linux, FreeBSD and Mac OS X
=========================================================
This version [1] is an extension of the original HIDAPI library, based on Tony Roggs fork [2],
which reads the report descriptor of the device.

The main addition is a parser which parses the retrieved report descriptor, populates a struct
with the element descriptors, and finally provides a data parsing function based on this.

In addition, a CMake build system has been made.

Some test examples are available:
* hidparsertest will list all devices and optionally open one, displaying the element information, and the incoming data
* hidapi2osc will send out the data via OSC (OpenSoundControl), and provides an OSC interface for listing, opening and closing devices (see the supercollider script for testing the interface)

[1] https://github.com/sensestage/hidapi
[2] https://github.com/tonyrog/hidapi

TODO:
- creating + sending output reports
- creating + sending/reading + parsing feature reports
- reading windows report descriptor
- cmake lists for OSX, Windows and FreeBSD


Copyright (C) 2013, Marije Baalman <nescivi _at_ gmail.com>
This work was funded by a crowd-funding initiative for SuperCollider's [1] HID implementation
including a substantial donation from BEK, Bergen Center for Electronic Arts, Norway

[1] http://supercollider.sourceforge.net
[2] http://www.bek.no

HIDAPI library for Windows, Linux, FreeBSD and Mac OS X
=========================================================

Expand Down

0 comments on commit ca24d2d

Please sign in to comment.