g810-led/README.md

# g810-led</br>

Linux led controller for Logitech G213, G410, G413, G512, G513, G610, G810, G815, G910, G915 and GPRO Keyboards.</br>

## Compatible keyboards :</br>
- **G213 Prodigy**</br>
- **G410 Atlas Spectrum**</br>
- **G413 Carbon**</br>
- **G512 Carbon**</br>
- **G513 Carbon**</br>
- **G610 Orion Brown**</br>
- **G610 Orion Red**</br>
- **G810 Orion Spectrum**</br>
- **G815 LIGHTSYNC**</br>
- **G910 Orion Spark**</br>
- **G910 Orion Spectrum**</br>
- **G915 LIGHTSPEED**</br>
- **GPRO**</br>

## Contribute and evolution :</br>
* [CONTRIBUTING.md](https://github.com/MatMoul/g810-led/blob/master/CONTRIBUTING.md)

## Install :</br>
* [INSTALL.md](https://github.com/MatMoul/g810-led/blob/master/INSTALL.md)

## Profiles :<br>
You can load predefined configurations on startup! 
* [PROFILES.md](https://github.com/MatMoul/g810-led/blob/master/PROFILES.md)

## Help :</br>
`g213-led --help`</br>
`g410-led --help`</br>
`g413-led --help`</br>
`g512-led --help`</br>
`g513-led --help`</br>
`g610-led --help`</br>
`g810-led --help`</br>
`g815-led --help`</br>
`g910-led --help`</br>
`g915-led --help`</br>
`gpro-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-led/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 for G213 :</br>
`g213-led -a 00ff00 # Set all keys green`</br>
`g213-led -r 1 ff0000 # Set region 1 red`</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>

## Testing unsupported keyboards :</br>
Start by retrieving the VendorID and the ProductID of your keyboard using lsusb.</br>
`lsusb`</br>
Sample return :<br>
`Bus 001 Device 001: ID 046d:c331 Logitech, Inc.`</br>
In 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>
`g810-led -dv 046d -dp c331 -tuk 1 -a 000000`</br>
If your keyboard set all key to off you have found the protocol (1), if not continue.</br>
`g810-led -dv 046d -dp c331 -tuk 2 -a 000000`</br>
If your keyboard set all key to off you have found the protocol (2), if not continue.</br>
`g810-led -dv 046d -dp c331 -tuk 3 -a 000000`</br>
If your keyboard set all key to off you have found the protocol (2), if not continue.</br>
`g810-led -dv 046d -dp c331 -tuk 4 -a 000000`</br>
If your keyboard set all key to off you have found the protocol (3), if not, need new dump.</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>

## Dumps :
Dumps of keyboards are now stored in a separate project to preserve a small download size of this project.
You can find them here : [https://github.com/MatMoul/g810-led-resources](https://github.com/MatMoul/g810-led-resources)
Add pictures 2017-01-05 00:55:33 +00:00			`# g810-led</br>`
First commit 2016-06-12 20:16:07 +00:00
Add support for G915 (libusb only) 2021-08-23 18:05:52 +00:00			`Linux led controller for Logitech G213, G410, G413, G512, G513, G610, G810, G815, G910, G915 and GPRO Keyboards.</br>`
First commit 2016-06-12 20:16:07 +00:00
Fixed markdown formatting on README.md 2017-03-22 14:07:45 +00:00			`## Compatible keyboards :</br>`
Finalization of g213 support 2017-04-21 21:04:50 +00:00			`- G213 Prodigy</br>`
Update README 2017-01-08 02:26:22 +00:00			`- G410 Atlas Spectrum</br>`
Add G413 support 2017-08-02 09:43:03 +00:00			`- G413 Carbon</br>`
Add support to G512 and G513 2018-08-01 21:37:29 +00:00			`- G512 Carbon</br>`
			`- G513 Carbon</br>`
Update README 2017-01-08 02:26:22 +00:00			`- G610 Orion Brown</br>`
			`- G610 Orion Red</br>`
			`- G810 Orion Spectrum</br>`
Finalize g815 2020-05-05 23:13:18 +00:00			`- G815 LIGHTSYNC</br>`
Update README 2017-01-08 02:26:22 +00:00			`- G910 Orion Spark</br>`
			`- G910 Orion Spectrum</br>`
Add support for G915 (libusb only) 2021-08-23 18:05:52 +00:00			`- G915 LIGHTSPEED</br>`
Make gpro ready for release 2017-05-12 19:29:12 +00:00			`- GPRO</br>`
Add pictures 2017-01-05 00:55:33 +00:00
Fixed markdown formatting on README.md 2017-03-22 14:07:45 +00:00			`## Contribute and evolution :</br>`
Rename TODO.md to CONTRIBUTING.md 2017-05-06 21:13:52 +00:00			`* [CONTRIBUTING.md](https://github.com/MatMoul/g810-led/blob/master/CONTRIBUTING.md)`
Update README 2017-01-26 01:43:40 +00:00
Fixed markdown formatting on README.md 2017-03-22 14:07:45 +00:00			`## Install :</br>`
Update README 2017-01-26 01:29:34 +00:00			`* [INSTALL.md](https://github.com/MatMoul/g810-led/blob/master/INSTALL.md)`
Add INSTALL.md 2017-01-15 01:09:26 +00:00
Adding seperate Profile Sections in README 2019-10-29 16:46:51 +00:00			`## Profiles :<br>`
			`You can load predefined configurations on startup!`
			`* [PROFILES.md](https://github.com/MatMoul/g810-led/blob/master/PROFILES.md)`

Fixed markdown formatting on README.md 2017-03-22 14:07:45 +00:00			`## Help :</br>`
Update project 2017-04-29 14:57:23 +00:00			`g213-led --help`</br>
Add INSTALL.md 2017-01-15 01:20:02 +00:00			`g410-led --help`</br>
Update README.md 2017-08-09 20:06:35 +00:00			`g413-led --help`</br>
Add support to G512 and G513 2018-08-01 21:37:29 +00:00			`g512-led --help`</br>
			`g513-led --help`</br>
Add INSTALL.md 2017-01-15 01:20:02 +00:00			`g610-led --help`</br>
Add INSTALL.md 2017-01-15 01:09:26 +00:00			`g810-led --help`</br>
Finalize g815 2020-05-05 23:13:18 +00:00			`g815-led --help`</br>
Add INSTALL.md 2017-01-15 01:20:02 +00:00			`g910-led --help`</br>
Add support for G915 (libusb only) 2021-08-23 18:05:52 +00:00			`g915-led --help`</br>
Make gpro ready for release 2017-05-12 19:29:12 +00:00			`gpro-led --help`</br>
Update README 2017-01-06 05:51:58 +00:00
Update README 2017-01-26 01:29:34 +00:00			`g810-led --help-keys`</br>
			`g810-led --help-effects`</br>
			`g810-led --help-samples`</br>

Fixed markdown formatting on README.md 2017-03-22 14:07:45 +00:00			`## Samples :</br>`
Fixed path in Sample instructiosn 2019-07-19 05:15:40 +00:00			`g810-led -p /etc/g810-led/profile # Load a profile`</br>
Update README 2016-08-19 21:11:49 +00:00			`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>
Full refactor code 2017-01-21 08:15:18 +00:00			`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>
Update README 2016-12-30 20:41:47 +00:00
Fixed markdown formatting on README.md 2017-03-22 14:07:45 +00:00			`## Samples with no commit :</br>`
Update README 2016-08-19 21:38:20 +00:00			`g810-led -an 000000 # Set color of all key with no action`</br>
Update README 2016-08-19 21:17:13 +00:00			`g810-led -gn modifiers ff0000 # Set color of a group with no action`</br>
Update README 2016-08-19 21:11:49 +00:00			`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>
Add pictures 2017-01-05 00:55:33 +00:00
Fixed heading consistency 2017-10-25 22:38:46 +00:00			`## Samples for G610 :</br>`
Add pictures 2017-01-05 00:55:33 +00:00			`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>
Update README 2017-01-06 05:43:14 +00:00
Fixed heading consistency 2017-10-25 22:38:46 +00:00			`## Samples for G213 :</br>`
Update project 2017-04-29 14:57:23 +00:00			`g213-led -a 00ff00 # Set all keys green`</br>
			`g213-led -r 1 ff0000 # Set region 1 red`</br>

Fixed markdown formatting on README.md 2017-03-22 14:07:45 +00:00			`## Samples with pipe (for effects) :</br>`
Update README 2017-01-06 05:43:14 +00:00			`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>
Implement device IO as a shared library 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> 2017-04-10 18:12:13 +00:00
Fix 'unsupported' spelling Signed-off-by: Stephen Kitt <steve@sk2.org> 2019-01-16 20:51:15 +00:00			`## Testing unsupported keyboards :</br>`
Fix spelling mistakes and grammar in README and INSTALL 2017-10-25 22:37:43 +00:00			`Start by retrieving the VendorID and the ProductID of your keyboard using lsusb.</br>`
Add new arg -tuk for testing unsuported keyboard 2017-05-06 20:41:08 +00:00			`lsusb`</br>
			`Sample return :<br>`
			`Bus 001 Device 001: ID 046d:c331 Logitech, Inc.`</br>
Finalize g815 2020-05-05 23:13:18 +00:00			`In 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>`
Add new arg -tuk for testing unsuported keyboard 2017-05-06 20:41:08 +00:00			`g810-led -dv 046d -dp c331 -tuk 1 -a 000000`</br>
			`If your keyboard set all key to off you have found the protocol (1), if not continue.</br>`
			`g810-led -dv 046d -dp c331 -tuk 2 -a 000000`</br>
			`If your keyboard set all key to off you have found the protocol (2), if not continue.</br>`
			`g810-led -dv 046d -dp c331 -tuk 3 -a 000000`</br>
Finalize g815 2020-05-05 23:13:18 +00:00			`If your keyboard set all key to off you have found the protocol (2), if not continue.</br>`
			`g810-led -dv 046d -dp c331 -tuk 4 -a 000000`</br>
Add new arg -tuk for testing unsuported keyboard 2017-05-06 20:41:08 +00:00			`If your keyboard set all key to off you have found the protocol (3), if not, need new dump.</br>`

Implement device IO as a shared library 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> 2017-04-10 18:12:13 +00:00			`## 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>
Update README 2017-04-29 15:06:01 +00:00
			`## Dumps :`
			`Dumps of keyboards are now stored in a separate project to preserve a small download size of this project.`
			`You can find them here : [https://github.com/MatMoul/g810-led-resources](https://github.com/MatMoul/g810-led-resources)`