Skip to main content

Daemon that synchronizes the Scroll Lock key with the keyboard LED on Linux.

Project description

Scroll Lock LED Daemon

Daemon for Linux that synchronizes a key press with the keyboard LED.

Features

  • Auto-detects keyboard and Scroll Lock LED
  • Listens for key presses and toggles the LED
  • Runs as a systemd service (Type=notify)
  • Auto-reconnects if the keyboard is disconnected
  • One-shot mode: --set on/off and --toggle for scripts
  • Configurable key (--key) and LED (--led)
  • Configuration file support
  • Very low CPU usage (event driven, not polling)
  • --doctor for system diagnostics

Requirements

  • Linux
  • Python 3.10+
  • python3-evdev

Installation

Pacote .deb (Debian/Ubuntu — recomendado)

Baixe o .deb da página de releases:

sudo apt install ./scrolllock-led-daemon_*.deb

Instala automaticamente como serviço systemd com start imediato.

PyPI (pip)

pip install scrolllock-led-daemon

Apenas o binário — você precisa configurar o systemd e udev manualmente.

Script manual (desenvolvimento)

git clone https://github.com/alan-n7x/scrolllock-led-daemon.git
cd scrolllock-led-daemon
./scripts/install.sh

Instala em /usr/local/:

  • /usr/local/bin/scrolllock-led-daemon
  • /etc/systemd/system/scrolllock-led-daemon.service
  • /usr/local/share/man/man8/scrolllock-led-daemon.8
  • /etc/udev/rules.d/99-scrolllock-led-daemon.rules
  • /usr/share/bash-completion/completions/scrolllock-led-daemon.bash
  • /etc/scrolllock-led-daemon.conf

Dependências

sudo apt install python3-evdev

Usage

Usage: scrolllock-led-daemon [OPTIONS]

Options:
  --device PATH     Keyboard device path (overrides auto-detection)
  --led PATH|NAME   LED brightness file or name (scrolllock, capslock, numlock)
  --key NAME        Key to listen for (default: KEY_SCROLLLOCK)
  --set on|off      Set LED state and exit (one-shot mode)
  --toggle          Toggle LED state and exit (one-shot mode)
  --list            List available input devices and exit
  --doctor          Run system diagnostics
  --config PATH     Path to configuration file
  --verbose         Enable debug logs
  --version         Show version
  --help            Show help

Daemon mode (default)

sudo systemctl start scrolllock-led-daemon

One-shot mode

scrolllock-led-daemon --set on
scrolllock-led-daemon --set off
scrolllock-led-daemon --toggle

List devices

scrolllock-led-daemon --list

Diagnostics

Run a system health check:

scrolllock-led-daemon --doctor

Custom device

scrolllock-led-daemon --device /dev/input/event9 --led scrolllock

Custom key

scrolllock-led-daemon --key KEY_F12 --led capslock

Configuration

Settings can be persisted in /etc/scrolllock-led-daemon.conf or ~/.config/scrolllock-led-daemon/scrolllock-led-daemon.conf:

[daemon]
device = /dev/input/event4
led = scrolllock
key = KEY_SCROLLLOCK
verbose = false

CLI arguments override config file values.

Troubleshooting

Permission denied

If you see:

Permission denied while accessing /dev/input/event*

Run with sudo or install the udev rules:

sudo ./scripts/install.sh

The udev rules give your user access to input devices without root.

No keyboard found

If auto-detection fails, list available devices:

scrolllock-led-daemon --list

Then use the exact path:

scrolllock-led-daemon --device /dev/input/event4

Development

Dependencies

pip install ".[test]"

Tests

make test          # or: python -m pytest tests/ -v

Syntax check

make lint          # or: python -m py_compile src/scrolllock_led_daemon.py

Uninstall

Via .deb

sudo apt remove scrolllock-led-daemon

Via script manual

./scripts/uninstall.sh

License

GNU General Public License v3.0

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

scrolllock_led_daemon-1.0.11.tar.gz (22.8 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

scrolllock_led_daemon-1.0.11-py3-none-any.whl (20.6 kB view details)

Uploaded Python 3

File details

Details for the file scrolllock_led_daemon-1.0.11.tar.gz.

File metadata

  • Download URL: scrolllock_led_daemon-1.0.11.tar.gz
  • Upload date:
  • Size: 22.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for scrolllock_led_daemon-1.0.11.tar.gz
Algorithm Hash digest
SHA256 21f913db4a36de18861fa019ca474ad9fd206757e18799d3e1be558fada6769f
MD5 540a43a0940f138d056c78ec6af55ff1
BLAKE2b-256 bd20de4677a4272a32c94bbfe3f57265acb099195b66364f8e6f876a523aebb4

See more details on using hashes here.

File details

Details for the file scrolllock_led_daemon-1.0.11-py3-none-any.whl.

File metadata

File hashes

Hashes for scrolllock_led_daemon-1.0.11-py3-none-any.whl
Algorithm Hash digest
SHA256 ecdbd39963e82ae9416c4bb8409fce76eb2ef946814af353a0379f1138405a69
MD5 3e0262f94aa0b075ab5cc8aacfd4aa04
BLAKE2b-256 1dc01200015a655af02864b318de4bf3b209dd865325bb0f3e49fab89b83fffc

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page