Skip to content

Fix typo and improve readability and documentation in README.md #12

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
Scr0nch wants to merge 2 commits into
base: master
Choose a base branch
from
Open

Fix typo and improve readability and documentation in README.md #12

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
5629011
Fix a tiny typo in README.md
Scr0nch Jun 4, 2021
560415a
Improve readability and documentation in README.md
Scr0nch Jun 4, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
33 changes: 22 additions & 11 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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 (<kbd>F14</kbd>-<kbd>F17</kbd>)

## 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: <kbd>F14</kbd>
- Omen: <kbd>F15</kbd>
- <kbd>Fn</kbd>+<kbd>Esc</kbd>: <kbd>F16</kbd>
- Disable touchpad: <kbd>F17</kbd>

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
Expand Down