razer_blackwidow_chroma_driver

A Linux driver for the Razer Blackwidow Chroma keyboard (supports all lighting modes) includes a daemon for advanced effects

=== Installation ===

• Download Sourcecode:

  git clone --depth=1 https://github.com/pez2001/razer_blackwidow_chroma_driver.git

• Execute installation script:

  cd razer_blackwidow_chroma_driver ./install_driver_debian.sh

• Reboot

=== Installation for non debian based distros ===

• Install dependencies (libdbus-1-dev,jq)
• Execute install script: sudo make -s all install
• Reboot

=== Usage ===

Have a look at the scripts directory. In the driver sub directory you will find the scripts to start the builtin keyboard effects.

To control the effects daemon however more manual work is needed at the moment,inspect the daemon and tests sub directories in scripts. The daemon uses dbus as its IPC mechanism, so you are not bound to shell scripts (someone may even write a Gui to control the daemon , maybe like the node editor in blender)

=== Daemon IPC details ===

[... To be written ...]

=== Status of Code ===

• Driver : Release Candidate
• Daemon : Alpha
• Daemon Effects : Release Candidate
• Daemon Controller : Beta
• Installer : Beta
• Packages : Non Existant

=== First Steps Tutorial ===

How to create a standalone effect easily using the included library ?

First of all we need an idea what the effect shall do.

In this example i just setup the keyboard for a dota profile

First we need to setup the library:

struct razer_chroma *chroma = razer_open();

To create an custom keyboard led layout we need to tell the library to activate the custom mode:

razer_set_custom_mode(chroma);

If the keyboard was using the custom mode before the keys are still lit with the last color settings ,so let us clear it:

razer_clear_all(chroma->keys);

To actually update the keyboard leds we need to razer_update (using the integrated keyboard led frame/keys struct):

razer_update_keys(chroma,chroma->keys);

So now that we got a black keyboard we want to light some keys in different colors

struct razer_rgb red = {.r=255,.g=0,.b=0}; //define a red color
struct razer_rgb yellow = {.r=255,.g=255,.b=0}; //define a yellow color
struct razer_rgb green = {.r=0,.g=255,.b=0}; //define a green color
struct razer_rgb blue = {.r=0,.g=0,.b=255}; //define a blue color
struct razer_rgb light_blue = {.r=0,.g=255,.b=255}; //define a light blue color

struct razer_pos pos;

char *abilities = "QWERDF";

for(int i = 0;i<strlen(abilities);i++)
{	
	razer_convert_ascii_to_pos(abilities[i],&pos);
	razer_set_key_pos(chroma->keys,&pos,&red);
}

char *groups = "1234567";

for(int i = 0;i<strlen(groups);i++)
{	
	razer_convert_ascii_to_pos(groups[i],&pos);
	razer_set_key_pos(chroma->keys,&pos,&yellow);
}

char *items = "YXCV";

for(int i = 0;i<strlen(items);i++)
{	
	razer_convert_ascii_to_pos(items[i],&pos);
	razer_set_key_pos(chroma->keys,&pos,&light_blue);
}


razer_convert_ascii_to_pos('B',&pos);
razer_set_key_pos(chroma->keys,&pos,&green);

razer_convert_ascii_to_pos('A',&pos);
razer_set_key_pos(chroma->keys,&pos,&blue);

razer_convert_ascii_to_pos('S',&pos);
razer_set_key_pos(chroma->keys,&pos,&green);

Dont forget to update the keyboard with the new led color values:

razer_update_keys(chroma,chroma->keys);

Freeing the library is just as easy:

razer_close(chroma);

To compile just type:

gcc  -std=c99  dota_keys.c  -lrazer_chroma  -lm  -o dota_keys

After executing it you should now have a dota profile lighting up your keyboard.(dont forget to sudo) This is just a simple example using a ascii helper,if your profile needs to color function keys ,etc you can set the key colors by manually setting the pos.

=== Daemon effects tutorial ===

How to create an effect to be used in the daemon ? Why not shoot for something crazy like a light blast originating from keys being pressed this time? Its not that much different than writing a self-hosted effect.

[... To be written ...]

=== Contributions ===

Any effect or tool you might want to contribute is welcome. Please use your own source files to host your effects for merging. Fx setup scripts,bug fixes,feature requests,etc are also welcome.

=== TODO ===

dbus interface support array parameters 
  (with another path level added as index into the array)
support remaining effect handlers not called yet once
key locking / automatically skip key on following frame changes 
  / manual overwrite still possible / catch in convience functions
daemon,heatmap examples
gui controller (web interface?)
move remaining lib functions to razer_ namespace
move all daemon types to daemon_ namespace
split library into seperate source files (rgb,frames,hsl,drawing)
free memory / fix leaks
packaging ?
submit kernel patch ?
customizable layout effect

=== Additional Credits ===

• Various installation and makefile related fixes by Jordan King (manual merge)
• Ubuntu file permission fixes by Carsten Teibes (pulled)
• Debugging help of Mosie1 with Linux Mint script bugs (testing)
• Example Effect : Dynamic by TheKiwi5000 (pulled)

=== Donations ===

Goal 1 (5/66) :

All donations go towards buying a Razer Firefly Led-Mousepad (no driver written yet/easy to incorporate)

• Reward: Sound driven example effect(Spectrum based).

Stretch Goal 1 (>166):

Buying a Razer Tartarus (also no driver written yet)

• Reward: Packaging for major distributions (debian based,redhat based,tar balls)

Stretch Goal 2 (>333): Buying a Razer Deathstalker Utimate (no driver too) Reward: A gtk based GUI (simple , something to build upon further).

All goals contain the linux driver for the respective device as reward also.

Thank you for all donations i really appreciate it!

• Luca Steeb

You can send your donations via PayPal to : feckelburger [at] gmx.net