README.md
1# OpenCorsairLink [](https://travis-ci.com/audiohacked/OpenCorsairLink)
2
3OpenCorsairLink is a status & control utility that interacts with CorsairLink products.
4
5### Disclaimer
6> __DISCLAIMER__: OpenCorsairLink is not an official Corsair product. It is licensed under the GNU General Public License (version 2) in the hope that it will be useful, but with NO WARRANTY of any kind. Corsair and Corsair Link are trademarks or registered trademarks of Corsair Components, Inc. The trademark holders are not affiliated with the maker of this product and do not endorse this product.
7
8## Installation
9### Requirements
10* libusb-1.0
11* pkg-config
12
13```
14$ make
15$ sudo make install
16```
17
18## Usage
19Since the program needs direct hardware access you should run this with 'sudo' or as root.
20
21```
22$ sudo ./OpenCorsairLink.elf
23$ sudo ./OpenCorsairLink.elf --help
24$ sudo ./OpenCorsairLink.elf --device 0
25$ sudo ./OpenCorsairLink.elf --device 0 --led channel=0,mode=0,color=00FF00
26$ sudo ./OpenCorsairLink.elf --device 0 --fan channel=0,mode=5
27$ sudo ./OpenCorsairLink.elf --device 0 --pump mode=5
28```
29
30## Development
31### Branches
32 - master: Stable or Release Version
33 - testing: Testing or Release Canidate
34 - feature\/\*: Cutting Edge Features (Use at your own risk)
35
36## Contributing
37Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.
38
39Please make sure to update tests as appropriate.
40
41## Contact
42
43Maintainers reserve the rights to modify and remove issues, pull requests and comments therein, that are denunciating, off-topic, harmful, hateful and overall inappropriate.
44Please be appreciative, humble and kind to each other.
45
46* [GitHub Issues](https://github.com/audiohacked/OpenCorsairLink/issues)
47
48## License
49[GPLv2](https://choosealicense.com/licenses/gpl-2.0/)
50
){kind=link}