Repository: https://github.com/KeyofBlueS/kfrgb
License: GNU General Public License v3.0, https://opensource.org/licenses/GPL-3.0
Please make really sure if selected RAM on an SMBus is really a 'Kingston Fury BEAST\RENEGADE DDR5 RGB'. For more info, please refer to https://gitlab.com/CalcProgrammer1/OpenRGB/-/issues/2879. Even if you enter the correct values, the procedure is still risky! This program can confuse your I2C bus, cause data loss or brick your hardware! Proceed AT YOUR OWN RISK!
While waiting for support to be added to OpenRGB, this script is intended to be used to control RGB Leds of a Kingston Fury BEAST\RENEGADE DDR5 RAM ONLY with the help of i2c-tools.
Set any mode (and their parameters) between rainbow, prism, spectrum, slide, wind, static, static_byledcolor, lightspeed, rain, firework, breath, breath_byledcolor, dynamic, twilight, teleport, flame, voltage, countdown and rhythm. By using yad, a graphical dialog to choose a color is shown if no\wrong values for them are entered.
Not all modes are fully supported:
- Mode slither: not supported (we lack the hex values to set this mode and its parameters).
- Modes twilight, teleport, flame, voltage, countdown and rhythm: we lack the hex values to set any of their parameters, nevertheless i've used values from other modes to set them. It works, but likely not the same way as with the official app.
- Modes breath, breath_byledcolor and dynamic: we lack the hex values to set speed, values from other modes doesn't work. These modes will run at their default speed or the last speed set by the official app.
curl -o /tmp/kfrgb.sh 'https://raw.githubusercontent.com/KeyofBlueS/kfrgb/master/kfrgb.sh'
sudo mkdir -p /opt/kfrgb/
sudo mv /tmp/kfrgb.sh /opt/kfrgb/
sudo chown root:root /opt/kfrgb/kfrgb.sh
sudo chmod 755 /opt/kfrgb/kfrgb.sh
sudo chmod +x /opt/kfrgb/kfrgb.sh
sudo ln -s /opt/kfrgb/kfrgb.sh /usr/local/bin/kfrgb
Use the option --ramslots <ramslots_value> to select RAM sticks to control. <ramslots_value> equals a RAM slot. Accept values from 1 to 8.
You can enter a single value to control a single RAM stick or a comma separated set of values to control two or more RAM sticks.
If you enter e.g. --ramslots 2,4 on --smbus 0, but you really only have RAM 2, RAM 4 will be skipped.
If you do not enter this option, 8 possible Kingston Fury BEAST\RENEGADE DDR5 RAM sticks will be searched in the selected SMBus.
If the option --smbus <smbus_number> is omitted, RAM sticks will be searched in all SMBuses that support SMBus Quick Command.
If a wrong\non existent <smbus_number> value is entered, a menu in wich you can select an SMBus will be shown.
Use the option --mode <mode_name> to set a mode.
Available modes are 'rainbow' 'prism' 'spectrum' 'slide' 'wind' 'static' 'static_byledcolor' 'lightspeed' 'rain' 'firework' 'breath' 'breath_byledcolor' 'dynamic' 'twilight' 'teleport' 'flame' 'voltage' 'countdown' 'rhythm'.
Pass 'list' as <mode_name> to get a menu where you can choose a mode to set.
Speed (min 1, max 11) and brightness (min 0, max 100, default 80) are common for every mode. However every mode has it's own available and default parameters also:
- rainbow: speed (default 7); direction (default up).
- prism: speed (default 4); delay (min 1, max 5, default 1).
- spectrum: speed (default 4); delay (min 1, max 3, default 3); direction (default up).
- slide: speed (default 10); delay (min 1, max 4, default 3); lenght (min 1, max 12, default 4); tencolors; backcolor; direction (default down).
- wind: speed (default 10); delay (min 1, max 21, default 1); lenght (min 1, max 32, default 12); tencolors; backcolor; direction (default up).
- static: color.
- static_byledcolor: byledcolors.
- lightspeed: speed (default 9); delay (min 1, max 21, default 1); lenght (min 1, max 18, default 7); tencolors; direction (default up).
- rain: speed (default 11); tencolors; direction (default down).
- firework: speed (default 11); tencolors; direction (default up).
- breath: tencolors. Setting speed not supported, will run at its default speed or the last speed set by the official app.
- breath_byledcolor: byledcolors. Setting speed not supported, will run at its default speed or the last speed set by the official app.
- dynamic: tencolors. Setting speed not supported, will run at its default speed or the last speed set by the official app.
- twilight: speed (default 9).
- teleport: speed (default 10); lenght (min 1, max 12, default 3); tencolors; backcolor; direction (default up).
- flame: speed (default 1); direction (default up).
- voltage: speed (default 3); tencolors; backcolor.
- countdown: speed (default 1); tencolors; backcolor; direction (default up).
- rhythm: speed (default 11); delay (min 1, max 4, default 2); tencolors; backcolor; direction (default down).
To set mode parameters you must use options --speed, --delay, --length, --color, --byledcolors, --tencolors, --tencolorsnumber, --backcolor, --brightness, --direction. Take care if a given parameter is supported by a given mode, and be careful to stay between min and max values. Nevertheless don't be worried, if no/wrong parameter has been entered, the parameter will simply be set to the default value or not set at all if not supported by the selected mode.
Option --speed accept 1 value from 1 to 11.
Use this option to set the speed of the effect in the supported mode (rainbow, prism, spectrum, slide, wind, lightspeed, rain, firework, twilight, teleport, flame, voltage, countdown, rhythm).
Option --delay accept 1 value from 1 to <max_value>. max_value depends on mode.
Use this option to set the delay of the effect in the supported mode (prism, spectrum, slide, wind, lightspeed, rhythm).
Option --length accept 1 value from 1 to <max_value>. max_value depends on mode.
Use this option to set the length of the effect in the supported mode (slide, wind, lightspeed, teleport).
One color is expressed with 3 comma separated values for RGB. So 255,255,255 means white; 255,0,0 means red; 0,255,0 means green; 0,0,255 means blue.
Option --color <r_value,g_value,b_value> accept 3 comma separated values from 0 to 255.
Use this option to set a color in mode static.
Option --byledcolors <byledcolors_values> accept 36 comma separated values from 0 to 255. Every three values equals a color (36 values are 12 colors, this ram has 12 leds indeed).
Use this option to set every single led color in the supported mode (static_byledcolor, breath_byledcolor).
Option --tencolors <tencolors_values> accept 30 comma separated values from 0 to 255. Every three values equals a color (30 values are 10 colors).
Use this option to cycle through these colors in the supported mode (slide, wind, lightspeed, rain, firework, breath, dynamic, teleport, voltage, countdown, rhythm).
Option --tencolorsnumber <tencolorsnumber_value> accept 1 value from 1 to 10.
Use this option to set how many colors will cycle the supported mode (slide, wind, lightspeed, rain, firework, breath, dynamic, teleport, voltage, countdown, rhythm).
e.g. '--tencolorsnumber 3' to cycle the first 3 colors out of 10.
Option --backcolor <r_value,g_value,b_value> accept 3 comma separated values from 0 to 255.
Use this option to set the background color in the supported mode (slide, wind, teleport, voltage, countdown, rhythm).
Option --randomcolor will set a random color in the supported mode (slide, wind, static, static_byledcolor, lightspeed, rain, firework, breath, breath_byledcolor, dynamic, teleport, voltage, countdown, rhythm).
This option will take full priority over any color option.
Option --brightness <brightness_value> accept 1 value from 0 to 100.
Use this option to set the brightness in any mode.
Option --direction <direction_value> accept values up or down.
Use this option to set the direction of the effect in the supported mode (rainbow, spectrum, slide, wind, lightspeed, rain, firework, teleport, flame, countdown, rhythm).
Option --ask, if no/wrong parameter has been entered, will ask for user input instead of automatically set default values.
For color values a graphical dialog to choose a color will be shown.
Option --off will turn off leds on the ram. This option will take full priority over any other option.
Option --simulation will perform a simulation instead of really deploy i2cset commands.
Option --debug will print info useful for debugging, then exits.
Please use this option and post the output if you want to open an issue on https://github.com/KeyofBlueS/kfrgb/issues
Option --wait <wait_value> will set the sleep time between i2cset commands. Accept 1 integer or decimal value.
If no\wrong value has been entered, the wait time will default to 0.015.
Anyway this script will retry (for at most 20 times and then will abort) if an i2cset command fails, so you can keep wait time very low and don't worry about write errors.
Search for RAM 2 on all SMBuses, then choose a mode from a list:
# kfrgb --ramslots 2
show a menu where you can choose a mode to set for RAM 2 on SMBus 0:
# kfrgb --ramslots 2 --smbus 0
show a graphical dialog to choose a color with brightness at 70 for RAM 2 on SMBus 0 without the warning before apply the settings:
# kfrgb --ramslots 2 --smbus 0 --brightness 70 --mode static --ask --nowarn
set a yellow color to RAM 2 and 4 on SMBus 0 (in this case the options --mode static):
# kfrgb --ramslots 2,4 --smbus 0 --color 255,255,0
set every single led color to RAM 2 and 4 on SMBus 0:
# kfrgb --ramslots 2,4 --smbus 0 --mode static_byledcolor --byledcolors 255,0,0,0,255,0,0,0,255,255,0,0,0,255,0,0,0,255,255,0,0,0,255,0,0,0,255,255,0,0,0,255,0,0,0,255
set every single led to a random color to RAM 2 and 4 on SMBus 0:
# kfrgb --ramslots 2,4 --smbus 0 --mode static_byledcolor --randomcolor
set mode wind with default parameters to RAM 2 on SMBus 0 without the warning before apply the settings:
# kfrgb --ramslots 2 --smbus 0 --mode wind --nowarn
set mode wind with brightness at 100 and direction down to RAM 2 on SMBus 0 without the warning before apply the settings:
# kfrgb --ramslots 2 --smbus 0 --mode wind --brightness 100 --direction down --nowarn
set mode wind with backcolor to violet, brightness at 100 and direction down to RAM 2 on SMBus 0 without the warning before apply the settings:
# kfrgb --ramslots 2 --smbus 0 --mode wind --backcolor 150,70,200 --brightness 100 --direction down --nowarn
set mode slide with speed at 8 and direction up to RAM 2 on SMBus 0 without the warning before apply the settings:
# kfrgb --ramslots 2 --smbus 0 --mode slide --speed 8 --direction up --nowarn
set mode rainbow with speed at 1 to RAM 2 on SMBus 0 without the warning before apply the settings:
# kfrgb --ramslots 2 --smbus 0 --mode rainbow --speed 1 --nowarn
set mode slide and 10 colors to cycle through to RAM 2 on SMBus 0 without the warning before apply the settings:
# kfrgb --ramslots 2 --smbus 0 --mode slide --tencolors 255,0,0,0,255,0,255,100,0,0,0,255,238,238,0,128,0,128,0,109,119,255,200,0,255,85,255,60,125,255 --nowarn
set mode slide and 3 colors (you can omit the remaining 7 colors) to cycle through to RAM 2 on SMBus 0 without the warning before apply the settings:
# kfrgb --ramslots 2 --smbus 0 --mode slide --tencolors 255,0,0,0,255,0,255,100,0 --tencolorsnumber 3 --nowarn
set mode wind and, asking for user input, 10 colors to cycle through to RAM 2 on SMBus 0 without the warning before apply the settings:
# kfrgb --ramslots 2 --smbus 0 --mode wind --ask --nowarn
set mode wind and, asking for user input, 3 colors to cycle through to RAM 2 on SMBus 0 without the warning before apply the settings:
# kfrgb --ramslots 2 --smbus 0 --mode wind --tencolorsnumber 3 --ask --nowarn
Turn off leds to RAM 4 on SMBus 0 without the warning before apply the settings:
# kfrgb --ramslots 4 --smbus 0 --off --nowarn
As explained above, RGB values can be set in a comma separated format e.g.:
--tencolors 255,0,0,0,255,0,255,100,0,0,0,255,238,238,0,128,0,128,0,109,119,255,200,0,255,85,255,60,125,255
but also comma/space separated and must be enclosed in single quotes e.g.:
--tencolors '255 0 0,0 255 0,255 100 0,0 0 255,238 238 0,128 0 128,0 109 119,255 200 0,255 85 255,60 125 255'
I prefer the latter because i can visually separate every RGB triplet.
Options:
-s, --smbus <smbus_number> Enter the SMBus number.
-m, --ramslots <ramslots_value> Enter the comma separated RAM slot values.
-d, --mode <mode> Enter the name of the mode. Pass 'list' as <mode_name> to get a menu
where you can choose a mode to set.
-p, --speed <value> Enter 1 value between 1 and 11. Default depends on mode.
-e, --delay <value> Enter 1 value. Min 1, max depends on mode.
-q, --length <value> Enter 1 value. Min 1, max depends on mode.
-i, --direction <value> Enter 1 value between 'up' or 'down'. Default depends on mode.
-c, --color <values> Enter 3 comma separated values between 0 and 255.
-b, --byledcolors <values> Enter 36 comma separated values between 0 and 255.
-t, --tencolors <values> Enter 30 comma separated values between 0 and 255.
-u, --tencolorsnumber <value> Enter 1 value between 1 and 10. Default is 10.
-k, --backcolor <value> Enter 3 comma separated values between 0 and 255.
-z, --randomcolor Set a random color.
-l, --brightness <value> Enter 1 value between 0 and 100. Default is 80.
-o, --off Turn off all leds.
-w, --wait <value> Enter a sleep time between i2cset commands. Default is 0.015.
-n, --nowarn Apply settings without warning.
-a, --ask Ask for input instead of automatically set default values.
-S, --simulation Perform a simulation.
-D, --debug Print info useful for debugging, then exits.
-h, --help Show this help.