/oclink

A port of Audiohacked's OpenCorsairLink to C

Primary LanguageCGNU General Public License v3.0GPL-3.0

oclink

A port of Audiohacked's OpenCorsairLink to C Written using information from this thread.

WARNING

This is a Work in Progress, and may not work. Pull requests welcome!

Components

There are several components to this software:

Supported CorsairLink Systems

Building

All products are built using CMake, with the exception of the OSX GUI, which is built using Xcode.

HIDAPI is a dependency and must be installed separately. See here for instructions.

On most systems, you can build the products using the following commands

$ mkdir build && cd build
$ cmake ..
$ cmake --build .

To install:

$ cmake --build . --target install

The following options are available

  • -DCMAKE_INSTALL_PREFIX=/where/you/want/to/install

    to change the installation prefix

  • -DBUILD_SHARED_LIBS=[ON,OFF]

    whether or not to build shared libraries (default is static)

  • -DHIDAPI_PREFIX=/path/to/hidapi/install/location

    the prefix of the directory where hidapi is installed (default is /usr/local)

  • -DBUILD_DOCUMENTATION=[ON,OFF]

    to build the doxygen documentation. Doxygen is required.

For more advanced use or questions about CMake, please read the CMake FAQ.

Documentation

After configuring the build, run

$ make doc

to build the Doxygen documentation. Documentation is also available online [here][ocl-gh-pages]

Using the CLI

TODO

Using the GUI

TODO