diff --git a/README.md b/README.md index b1e57ce..d18064b 100644 --- a/README.md +++ b/README.md @@ -1,36 +1,47 @@ HP Omen special feature control for Linux ----------------------------------------- -This is a version of the hp-wmi kernel module that implements some of the features of HP Omen Command Centre. +A version of the hp-wmi kernel module that implements some of the features of HP Omen Command Centre. -It's totally experimental right now, and could easily crash your machine. +This is experimental software and could easily crash your machine. **USE AT YOUR OWN RISK** Currently working: -- FourZone keyboard colour control (`/sys/devices/platforms/hp-wmi/rgb-zones/zone0[0-3]`) -- Omen hotkeys +- FourZone keyboard colour control (`/sys/devices/platform/hp-wmi/rgb-zones/zone0[0-3]`) +- Omen hotkeys (F14-F17) ## Installation -1. Install dkms and kernel headers if needed (already present on Ubuntu) +1. Install dkms and kernel headers -1. Run `sudo make install` + Ubuntu: these packages are already installed + + Arch Linux: `sudo pacman -S dkms linux-headers` -Module will be built and installed, and DKMS will manage rebuilding it on kernel updates. +2. Run `sudo make install` inside this project's root directory + + This will build and install the kernel module. DKMS will manage rebuilding it on kernel updates ## Usage The module creates four files in `/sys/devices/platform/hp-wmi/rgb_zones/` named `zone00 - zone03`. -To change zone highlight color, just print hex colour value in RGB format to the respective file. e.g: +To change a zone's highlight color, write a hex colour value in RGB format to the respective file. For example, + +`sudo bash -c 'echo 00FFFF > /sys/devices/platform/hp-wmi/rgb_zones/zone00'` will change the zone 0 backlight to sky blue. + +Hotkeys are bound to regular X11 keysyms: -`sudo bash -c 'echo 00FFFF > /sys/devices/platform/hp-wmi/rgb_zones/zone00'` to get sky-blue zone 0. + - Windows key lock: F14 + - Omen: F15 + - Fn+Esc: F16 + - Disable touchpad: F17 -Omen and other hotkeys are bound to regular X11 keysyms, use your chosen desktop's hotkey manager to assign them to functions like any other key. +Use your desktop's hotkey manager to assign them to functions like any other key. -## To do: +## To do - [ ] FourZone brightness control - [ ] Fan control