avell-unofficial-control-center

This is a driver to control RGB keyboard in Linux Systems based on Avell Control Center.

This project is at an early stage. The aim is to implement a Linux userspace driver and control tool for RGB LED keyboard backlight controller Integrated Technology Express ITE Device(8291) Rev 0.03. This RGB keyboard controller is used in many gaming laptops around the world. For a list of reseller-branded devices, see below.

Compatibility

Note:

if you have ITE Device(8291) Rev 0.02 see Project StarBeat

Find out about your laptop's keyboard model

sudo hwinfo --short

It should show the ITE Device(8291) in the keyboard section:

keyboard:
                       Integrated Technology Express ITE Device(8291)
  /dev/input/event0    AT Translated Set 2 keyboard

Known compatible devices

ITE Device(8291) is integrated in widely-used Tongfang gaming laptop barebones:

Tongfang GK5CN5Z / GK5CN6Z / GK5CQ7Z / GK5CP0Z (Barebone)
Avell G1550 FOX, G1513 FOX-7, A65, A52 (BR reseller)
Schenker XMG Neo 15 (DE reseller), Versions M18 & M19
PCSpecialist Recoil II & III (UK reseller)
Scan/3XS LG15 Vengeance Pro (UK reseller)
Overpowered 15 and 15+ (US reseller, sold via Walmart)
Monster Tulpar T5 (TR reseller)
MECHREVO Deep Sea Ghost Z2 (CN reseller)
Raionbook GS5 (IT reseller)
Illegear Onyx (MY reseller)
Hyperbook Pulsar Z15 (PL reseller)
SMART7 Kallisto GX15D (PL reseller)
Aftershock APEX 15 (SG reseller)
Origin-PC EON15-S (USA, Asia, and AU/NZ reseller)
Eluktronics Mech 15 G2 (US reseller)
HIDevolution EVOC 16GK5 (US reseller)
Obsidian GK5CP (PT reseller)
Vulcan JinGang GTX Standard

Project status

Working:

change color of mechanical rgb-keyboard
adjust brightness
disable RGB leds
set predefined styles

To do:

implement a GUI interface in Pyqt/Pyside2
save/load profiles
set custom color in specific key
monitor, cpu/gpu load

Installation

The easy way, using `pip3`

Install via pip using sudo or with root user:

sudo pip3 install avell-unofficial-control-center

The manual way, using `git`

Clone the repository (git clone https://github.com/rodgomesc/avell-unofficial-control-center.git), or update with git pull if cloned previously.
Build an installable package: python3 setup.py build
Install the package: sudo python3 setup.py install

Usage

Plain colors

Colors available are: red, green, blue, teal, pink, yellow, orange, white, olive, maroon, brown, gray, skyblue, navy, crimson, darkgreen, lightgreen, gold, violet.
Brightness options are: 1,2,3 and 4.

To set green color on all keys with max brightness:

aucc -c green -b 4

If no brightness parameter -b is provided, max brightness 4 is applied.

Alternating colors

To set alternating row colors:

aucc -H pink teal -b 4

Use -H for horizontal rows of alternating colors. Use -V for vertical columns of alternating colors.

Apply pre-defined styles

To set keyboard predefined custom styles:

aucc -s style

Styles available are rainbow, marquee, wave, raindrop, aurora, random, reactive, breathing, ripple, reactiveripple, reactiveaurora, fireworks.

Additional single colors are available for the following styles: raindrop, aurora, random, reactive, breathing, ripple, reactiveripple, reactiveaurora and fireworks. The colors available are: Red (r), Orange (o), Yellow (y), Green (g), Blue (b), Teal (t), Purple (p).

Append those styles with the start letter of the color you would like. For example: rippler = Ripple Red, reactiveo = Reactive Orange, reactiveripplep = Reactive Ripple Purple.

Disable all keyboard backlight

To disable all keys:

aucc -d

Thanks to

Avell - For this amazing Laptop
@kirainmoe - For help-me on bring macOs Support

Contributions

Contributions of any kind are welcome. Please follow pep-8 coding style guides.

Donate ☕ ♥️

This is a project I develop in my free time. If you use avell-unofficial-control-center or simply like the project and want to help please consider donating a coffee.

diegofsousa/avell-unofficial-control-center