Wayland LED Manager

A lightweight user friendly tool to manage keyboard backlight (LED) in Wayland enviroments. There is a script to handle the keyboard backlight and a service to monitor the backlight. Supports Bash, Fish and Zsh. More shell support will be added with updates.

Features

1. Keyboard Backlight Control: Type 'on' or 'off' on your terminal of choice to change the backlight.

2. Cross-Shell Support: Automatically sets up aliases ('on' and 'off') for your shell (Bash, Fish, Zsh).

3. Persistent State Managemnet: Uses systemd to keep the keyboard backlight on.

Installation

Requirements

1. Wayland: This tool was designed to work with Wayland enviroments. Since 'xset' is not supported. Obviously.

2. brightnessctl: The main command used in the backlight.sh script (should be installed by default in most systems). Install it using your package manager:

sudo apt install brightnessctl  # For Debain/Ubuntu
sudo dnf install brightnessctl  # For Fedora
sudo pacman -S brightnessctl    # For Arch Linux

Installation Steps

1. Clone the repository

git clone https://github.com/somniasum/wayland-backlight-led
cd wayland-backlight-led

2. Run script

The format for installing: sudo (install script) (home directory) (shell name)

sudo ./install.sh $(echo $HOME) $(echo $SHELL | awk -F'/' '{print $NF}')

This sets up everything needed. Home directory and shell are needed in order to auto-set aliases for your shell config.

3. Service Set-Up

Manually set up the systemd service using:

sudo systemctl daemon-reload
sudo enable baclight@on.service backlight@off.service

For turning on the keyboad backlight (LED) service

sudo start baclight@on.service 

Usage

Aliases

After installation, you can use the following on your terminal to toggle the backlight:

Turn backlight on:

on

Turn backlight off:

off

You can change the aliases to your preferred choice. Just look through your shell config to do so.

Configuration

Unsupported Shell Configuration

You use a different shell from Bash, Fish, and Zsh. You can set the aliases manually in your shell config:

alias on='/usr/local/bin/backlight.sh on'
alias off='usr/local/bin/backlight.sh off'

Troubleshooting

No Scroll Lock Device Found

If the script returns and error [*] Error No scroll lock device found, make sure your keyboard supports scroll lock and that brightnessctl can detect it. Use the following to check:

brightnessctl -l | grep scrolllock

Monitor services

You can check how the services are performing currently:

sudo systemctl status backlight@on.service backlight@off.service