mirror of
https://github.com/MatMoul/g810-led.git
synced 2024-12-23 17:26:11 +00:00
e5193b5985
Provide make targets and build configuration to create a shared object for other systems/applications to use to control keyboard LEDs without the need for instantiating the g810-led process. Provide make targets for installing library and development files into environments, such as the current system or package builders. Currently preserves precious behavior of building g810-led binary as statically linked. Provides an alternative build target of "bin-linked" which will create a dynamically linked variant. Signed-off-by: Kevin Pearson <pearson.kevin.m@gmail.com>
69 lines
2.5 KiB
Markdown
69 lines
2.5 KiB
Markdown
# g810-led</br>
|
|
|
|
Linux led controller for Logitech G410, G610, G810 and G910 Keyboards.</br>
|
|
|
|
## Compatible keyboards :</br>
|
|
- **G410 Atlas Spectrum**</br>
|
|
- **G610 Orion Brown**</br>
|
|
- **G610 Orion Red**</br>
|
|
- **G810 Orion Spectrum**</br>
|
|
- **G910 Orion Spark**</br>
|
|
- **G910 Orion Spectrum**</br>
|
|
|
|
## Contribute and evolution :</br>
|
|
* [TODO.md](https://github.com/MatMoul/g810-led/blob/master/TODO.md)
|
|
|
|
## Install :</br>
|
|
* [INSTALL.md](https://github.com/MatMoul/g810-led/blob/master/INSTALL.md)
|
|
|
|
## Help :</br>
|
|
`g410-led --help`</br>
|
|
`g610-led --help`</br>
|
|
`g810-led --help`</br>
|
|
`g910-led --help`</br>
|
|
|
|
`g810-led --help-keys`</br>
|
|
`g810-led --help-effects`</br>
|
|
`g810-led --help-samples`</br>
|
|
|
|
## Samples :</br>
|
|
`g810-led -p /etc/g810/profile # Load a profile`</br>
|
|
`g810-led -k logo ff0000 # Set color of a key`</br>
|
|
`g810-led -a 00ff00 # Set color of all keys`</br>
|
|
`g810-led -g fkeys ff00ff # Set color of a group of keys`</br>
|
|
`g810-led -s color # Set keyboard power on effect`</br>
|
|
`g810-led -fx color keys 00ff00 # Set fixed color effect`</br>
|
|
`g810-led -fx breathing logo 00ff00 0a # Set breathing effect`</br>
|
|
`g810-led -fx cycle all 0a # Set color cycle effect`</br>
|
|
`g810-led -fx hwave keys 0a # Set horizontal wave effect`</br>
|
|
`g810-led -fx vwave keys 0a # Set vertical wave effect`</br>
|
|
`g810-led -fx cwave keys 0a # Set center wave effect`</br>
|
|
|
|
## Samples with no commit :</br>
|
|
`g810-led -an 000000 # Set color of all key with no action`</br>
|
|
`g810-led -gn modifiers ff0000 # Set color of a group with no action`</br>
|
|
`g810-led -kn w ff0000 # Set color of a key with no action`</br>
|
|
`g810-led -kn a ff0000 # Set color of a key with no action`</br>
|
|
`g810-led -kn s ff0000 # Set color of a key with no action`</br>
|
|
`g810-led -kn d ff0000 # Set color of a key with no action`</br>
|
|
`g810-led -c # Commit all changes`</br>
|
|
|
|
## Samples for g610 :</br>
|
|
`g610-led -a 60 # Set intensity of all keys`</br>
|
|
`g610-led -k logo ff # Set intensity of a key`</br>
|
|
`g610-led -g fkeys aa # Set intensity of a group of keys`</br>
|
|
|
|
## Samples with pipe (for effects) :</br>
|
|
`g810-led -pp < profilefile # Load a profile`</br>
|
|
`echo -e "k w ff0000\nk a ff0000\nk s ff0000\nk d ff0000\nc" | g810-led -pp # Set multiple keys`</br>
|
|
|
|
## Building and linking against the libg810-led library :</br>
|
|
Include in implementing source files.</br>
|
|
```cpp
|
|
#include <g810-led/Keyboard.h>
|
|
```
|
|
To link, simply provide `-lg810-led` to the build flags.</br>
|
|
|
|
To build the g810-led application as a dynamically-linked variant, run the target:</br>
|
|
`make bin-linked`</br>
|