Skip to content

markusressel/keyboard-backlight-daemon

Repository files navigation


keyboard-backlight-daemon

A daemon to make your keyboard backlight smart.

Programming Language Latest Release License

Features

  • Light up keyboard backlight based on user interaction (keyboard, mouse, touchpad)
  • No system dependencies

Tested on

  • Asus ROG Zephyrus M16 (2021)

How to use

Installation

cd contrib
makepkg -sic

Manual

Download the latest release from GitHub:

curl -L -o keyboard-backlight-daemon https://github.com/markusressel/keyboard-backlight-daemon/releases/latest/download/keyboard-backlight-daemon-linux-amd64
chmod +x keyboard-backlight-daemon
sudo cp ./keyboard-backlight-daemon /usr/bin/keyboard-backlight-daemon
sudo keyboard-backlight-daemon

Or compile yourself:

git clone https://github.com/markusressel/keyboard-backlight-daemon.git
cd keyboard-backlight-daemon
make build
sudo cp ./bin/keyboard-backlight-daemon /usr/bin/keyboard-backlight-daemon
sudo chmod ug+x /usr/bin/keyboard-backlight-daemon
sudo keyboard-backlight-daemon

Configuration

If you want to change the default behaviour of keyboard-backlight-daemon you can create a YAML configuration file in one of the following locations:

  • /etc/keyboard-backlight-daemon/keyboard-backlight-daemon.yaml (recommended)
  • ~/.config/keyboard-backlight-daemon.yaml
  • ./keyboard-backlight-daemon.yaml
sudo mkdir /etc/keyboard-backlight-daemon
sudo nano /etc/keyboard-backlight-daemon/keyboard-backlight-daemon.yaml

Run

Systemd Service

Use the systemd unit file in this repository. To enable it simply run:

sudo cp ./keyboard-backlight-daemon.service /etc/systemd/system/
sudo systemctl daemon-reload
sudo systemctl enable --now keyboard-backlight-daemon
# follow logs
journalctl -u keyboard-backlight-daemon -f

Dependencies

See go.mod

Similar Projects

License

keyboard-backlight-daemon
Copyright (C) 2021  Markus Ressel

This program is free software: you can redistribute it and/or modify
it under the terms of the GNU Affero General Public License as published
by the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.

This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
GNU Affero General Public License for more details.

You should have received a copy of the GNU Affero General Public License
along with this program.  If not, see <https://www.gnu.org/licenses/>.