huekeys

README

huekeys

Huekeys is a fun application that makes it easy to adjust your System76 keyboard colors and brightness. In addition to the simple ability to set and get the color and brightness, it also provides several patterns that you can run indefinitely, to really make your keyboard pop!

• Change the color according to CPU utilization (cold to hot).

• Monitor the desktop picture and change the keyboard color to match.

• Pulse the keyboard brightness up and down.

• Loop through all the colors of the rainbow.

• Constantly change the color to a random selection.

• Change the color according to typing speed (cold to hot)

  • Optionally switch to another pattern while typing has stopped for a while!

• And best of all, manage it from a convenient system tray interface!

  

Installation

Choose one of the following that works best for you:

• Using Homebrew on Linux:

  $ brew install bitponyllc/tap/huekeys
  

• Using GitHub CLI:

  $ gh release  download -R BitPonyLLC/huekeys -p huekeys
  

• Download from the Releases page

Requires sudo privs to modify the backlight files in /sys/class/leds/system76. You may consider adjusting permissions. For example, if your user is in the adm group (use id to determine your group membership), the following will allow setting of color and brightness:

$ ( cd /sys/class/leds/system76*\:\:kbd_backlight && \
    sudo chgrp adm color* brightness && \
    sudo chmod 664 brightness color* )

NOTE: this only works until reboot since these devices will be recreated w/ the original permissions.

Usage

# show the basic help
$ huekeys

# set color to red
$ huekeys set -c red

# set brightness
$ huekeys set -b 255

# set color and brightness
$ huekeys set -c pink -b 127

# run an infinite rainbow in the background
$ huekeys run rainbow &

# run an infinite pulse in the background
$ huekeys run pulse &

# my personal favorite, make the colors get warmer the faster you type,
# but synchronize with the desktop background when idle!
$ huekeys run typing -i desktop

Attribution

This project was originally produced as https://github.com/bambash/sys76-kb. Though it's signifcantly different as huekeys, a huge thanks goes out to bambash's original as an excellent starting point!