README.md
1# g810-led</br>
2
3Linux led controller for Logitech G213, G410, G413, G512, G513, G610, G810, G815, G910 and GPRO Keyboards.</br>
4
5## Compatible keyboards :</br>
6- **G213 Prodigy**</br>
7- **G410 Atlas Spectrum**</br>
8- **G413 Carbon**</br>
9- **G512 Carbon**</br>
10- **G513 Carbon**</br>
11- **G610 Orion Brown**</br>
12- **G610 Orion Red**</br>
13- **G810 Orion Spectrum**</br>
14- **G815 LIGHTSYNC**</br>
15- **G910 Orion Spark**</br>
16- **G910 Orion Spectrum**</br>
17- **GPRO**</br>
18
19## Contribute and evolution :</br>
20* [CONTRIBUTING.md](https://github.com/MatMoul/g810-led/blob/master/CONTRIBUTING.md)
21
22## Install :</br>
23* [INSTALL.md](https://github.com/MatMoul/g810-led/blob/master/INSTALL.md)
24
25## Profiles :<br>
26You can load predefined configurations on startup!
27* [PROFILES.md](https://github.com/MatMoul/g810-led/blob/master/PROFILES.md)
28
29## Help :</br>
30`g213-led --help`</br>
31`g410-led --help`</br>
32`g413-led --help`</br>
33`g512-led --help`</br>
34`g513-led --help`</br>
35`g610-led --help`</br>
36`g810-led --help`</br>
37`g815-led --help`</br>
38`g910-led --help`</br>
39`gpro-led --help`</br>
40
41`g810-led --help-keys`</br>
42`g810-led --help-effects`</br>
43`g810-led --help-samples`</br>
44
45## Samples :</br>
46`g810-led -p /etc/g810-led/profile # Load a profile`</br>
47`g810-led -k logo ff0000 # Set color of a key`</br>
48`g810-led -a 00ff00 # Set color of all keys`</br>
49`g810-led -g fkeys ff00ff # Set color of a group of keys`</br>
50`g810-led -s color # Set keyboard power on effect`</br>
51`g810-led -fx color keys 00ff00 # Set fixed color effect`</br>
52`g810-led -fx breathing logo 00ff00 0a # Set breathing effect`</br>
53`g810-led -fx cycle all 0a # Set color cycle effect`</br>
54`g810-led -fx hwave keys 0a # Set horizontal wave effect`</br>
55`g810-led -fx vwave keys 0a # Set vertical wave effect`</br>
56`g810-led -fx cwave keys 0a # Set center wave effect`</br>
57
58## Samples with no commit :</br>
59`g810-led -an 000000 # Set color of all key with no action`</br>
60`g810-led -gn modifiers ff0000 # Set color of a group with no action`</br>
61`g810-led -kn w ff0000 # Set color of a key with no action`</br>
62`g810-led -kn a ff0000 # Set color of a key with no action`</br>
63`g810-led -kn s ff0000 # Set color of a key with no action`</br>
64`g810-led -kn d ff0000 # Set color of a key with no action`</br>
65`g810-led -c # Commit all changes`</br>
66
67## Samples for G610 :</br>
68`g610-led -a 60 # Set intensity of all keys`</br>
69`g610-led -k logo ff # Set intensity of a key`</br>
70`g610-led -g fkeys aa # Set intensity of a group of keys`</br>
71
72## Samples for G213 :</br>
73`g213-led -a 00ff00 # Set all keys green`</br>
74`g213-led -r 1 ff0000 # Set region 1 red`</br>
75
76## Samples with pipe (for effects) :</br>
77`g810-led -pp < profilefile # Load a profile`</br>
78`echo -e "k w ff0000\nk a ff0000\nk s ff0000\nk d ff0000\nc" | g810-led -pp # Set multiple keys`</br>
79
80## Testing unsupported keyboards :</br>
81Start by retrieving the VendorID and the ProductID of your keyboard using lsusb.</br>
82`lsusb`</br>
83Sample return :<br>
84`Bus 001 Device 001: ID 046d:c331 Logitech, Inc.`</br>
85In this sample VendorID is 046d and ProductID is c331. Now test your keyboard with all supported protocol (for 2019 keyboard start with -tuk 4):</br>
86`g810-led -dv 046d -dp c331 -tuk 1 -a 000000`</br>
87If your keyboard set all key to off you have found the protocol (1), if not continue.</br>
88`g810-led -dv 046d -dp c331 -tuk 2 -a 000000`</br>
89If your keyboard set all key to off you have found the protocol (2), if not continue.</br>
90`g810-led -dv 046d -dp c331 -tuk 3 -a 000000`</br>
91If your keyboard set all key to off you have found the protocol (2), if not continue.</br>
92`g810-led -dv 046d -dp c331 -tuk 4 -a 000000`</br>
93If your keyboard set all key to off you have found the protocol (3), if not, need new dump.</br>
94
95## Building and linking against the libg810-led library :</br>
96Include in implementing source files.</br>
97```cpp
98#include <g810-led/Keyboard.h>
99```
100To link, simply provide `-lg810-led` to the build flags.</br>
101
102To build the g810-led application as a dynamically-linked variant, run the target:</br>
103`make bin-linked`</br>
104
105## Dumps :
106Dumps of keyboards are now stored in a separate project to preserve a small download size of this project.
107You can find them here : [https://github.com/MatMoul/g810-led-resources](https://github.com/MatMoul/g810-led-resources)
108