msi-keyboard-CLI

[](https://badge.fury.io/js/msi-keyboard-cli)

You can now simply install this tool via npm :

sudo npm install npm -g (optional, uptade npm)

sudo npm install msi-keyboard-cli -g (install msi-keyboard-cli)

Then reopen your terminal, and use it via sudo msikeyboard -c green

========

Note the program has to be used with a sudoer account

You have to install ```libusb-dev``` or ```libusb-1.0-0-dev``` on linux system, on CentOS (```libusbx-devel```)

It uses https://github.com/stevelacy/msi-keyboard as a npm dependency, so no need to install it separatly, just follow the installaton instruction

You can now use this as a bash script:

msibacklight -h (will not work with cron, keep using the explained way above for this)

================

     (msi-keyboard-CLI) Munsch Jeremy <[email protected]>
     https://github.com/Kwaadpepper/msi-keyboard-CLI

    usage : msibacklight section color secondary-color (optional) intensity (optional) blink (optional)
        section (left, middle, right)   ex : left red low

    --eg,       shows usage examples
    --examples
    -d, --debug print debug
    -k (on|off) Keyboard backlight
    -l (on|off) using -l on will force any furter commands to be ignored if not run with this same option.
             (use it to override a cron task by example command without -l), disable it by using `-l off`
    -c  color   Applies to all sections
            colors (red, orange, yellow, green, cyan, blue, purple, white, black)
    -b  blink   blink N ms ex : -b 750 (use 'msibacklight' to run in background)
    -i  intensity   Applies to all sections (high, med, low, light)
    -t  theme   themes are : cool, france, italy, ireland, rasta, canada, cop, sith, k2000
    -m  mod     mods are : normal, gaming, breathe, demo, wave
    -h, --help  prints this help message

    default color : white
    default intensity : high
    default section : all

    dependencies    minimist        https://www.npmjs.org/package/minimist
                    msi-keyboard    https://github.com/stevelacy/msi-keyboard

================ Example of use:

nodejs msi-keyboard-CLI.js
nodejs msi-keyboard-CLI.js -c green
nodejs msi-keyboard-CLI.js -i low
nodejs msi-keyboard-CLI.js -k off
nodejs msi-keyboard-CLI.js -b 600
nodejs msi-keyboard-CLI.js left orange light 0 -k off right red
nodejs msi-keyboard-CLI.js -k off right blue high 1000 left blue high 1000

Installation (in short)

sudo apt-get install npm nodejs
sudo ln -s `which nodejs` /usr/bin/node
git clone https://github.com/Kwaadpepper/msi-keyboard-CLI.git ~/.msi-klm
cd ~/.msi-klm
npm install
msibacklight -k on
(OR)
sudo nodejs msi-keyboard-CLI.js -k on

Installation (explained)

Intall NodeJS, NPM, Python (sudo apt-get install -y python-software-properties python g++ make),(sudo apt-get install build-essential libssl-dev) See http://askubuntu.com/questions/545789/gt70-2pe-dominator-pro-or-equal-keyboard-backlight

then type which nodejs, it should give you /usr/bin/nodejs

• Go to your home folder "cd ~" or "cd /home/myusername"
• Create a folder named .msi-klm "mkdir .msi-klm && cd .msi-klm"
• Clone the projet here "git clone https://github.com/Kwaadpepper/msi-keyboard-CLI.git ~/.msi-klm"
• In /home/myusername/.msi-klm, do a npm install
• Edit cron tab to add 2 commands :
  • one to lightoff keyboard during the day /usr/bin/nodejs /home/myusername/.msi-klm/msi-keyboard-CLI.js -k off
  • one to lightup keyboard at night /usr/bin/nodejs /home/myusername/.msi-klm/msi-keyboard-CLI.js -t france (You can use http://www.openjs.com/scripts/jslibrary/demos/crontab.php, to generate a cron task)

So i have these lines my /etc/crontab i have the following lines (sudo crontab -e):

*       0,1,2,3,4,5,6,7,8,17,18,19,20,21,22,23  *       *       *       /usr/bin/nodejs /home/kwaadpepper/.msi-klm/msi-keyboard-CLI.js -t france
*       9,10,11,12,13,14,15,16  *       *       *       /usr/bin/nodejs /home/kwaadpepepr/.msi-klm/msi-keyboard-CLI.js -k off

You can now directly call msibacklight in a cront task if you installed it using npm -g

Every minute between between 5pm and 8am my keyboard backlight will light up.

Now il I wan't to override this for example while watchi a movie you can use the arg -l on like /usr/bin/nodejs /home/myusername/.msi-klm/msi-keyboard-CLI.js -k off -l on

This will lightoff the keyboard with -k off and the -l will create a file in /tmp so that every time a command is run without -l, it will be ignored (like the one we putted in /etc/crontab).

Advanced users If you use kde or ubuntu or whatever you can add a hotkey to lightup/lightoff or any custom using kdesudo or gksudo or whatever to execute the command like: kdesudo /usr/bin/nodejs /home/myusername/.msi-klm/msi-keyboard-CLI.js -k off -l on

My ~/.bash_alias:

alias keylight='sudo /usr/bin/nodejs /home/kwaadpepper/.msi-klm/msi-keyboard-CLI.js'
alias keylighton='keylight -t cool -l on'
alias keylightoff='keylight -k off -l on'
alias keylightunlock='keylight -k off -l off'

If you want you can set any color at blink you wan't like: /usr/bin/nodejs /home/myusername/.msi-klm/msi-keyboard-CLI.js left red low 0 middle purple med 2000 right blue high 600 (not tested)

I Have Kubuntu on my MSI-GT 70 and blink and modes doesn't work on it.

Please feel free to add anything you think cool, and don't forget to support authors of free libraries !

NOTE Working fine with nodejs v0.10.25 and npm 1.4.21

Autostart the backlit

If you want to activate your backlit at the system startup open the rc.local:

sudo nano /etc/rc.local

Then add your line (let the batch jump to the folder and execute it in the background, your username for "jack"):

cd /home/jack/.msi-klm

sudo nodejs msi-keyboard-CLI.js left purple high 0 middle purple high 2000 right purple high 600

exit 0

You can add what ever color you like. Safe it with "Ctl" + "x", press "y", "Enter" and override the file with "Enter". Done