KB Animator

KB Animator is a Python-based tool for controlling ASUS keyboard backlight animations. It supports both hardware and software-based animations.

Features

• Start and stop animations for ASUS keyboards.
• Supports hardware modes like static, breathe, rainbow, and strobe.
• Software animations like heartbeat, candle flicker, and network speed.
• Logs actions and errors to systemd journal/syslog and a rotating user log file.

Installation

Prerequisites

• Python 3.8 or higher
• pip (Python package installer)
• psutil library (automatically installed as a dependency)

Steps

1. Clone the repository:

   git clone https://github.com/vskvj3/asus-kbbacklit-ctl.git
   cd asus-kbbacklit-ctl

2. Install the package:

   pip install .

3. Verify installation:

   kb-animator --help

Usage

Start an Animation

To start an animation, use the start command:

kb-animator start <animation_name> [--color <color>] [--speed <speed>]

Example:

kb-animator start heartbeat --color red

Stop Animations

To stop all running animations:

kb-animator stop

Logs

Logs are written to:

• Systemd journal (if available)
• Syslog
• A rotating log file at ~/.cache/kb_animator/kb_animator.log

To view the logs:

tail -f ~/.cache/kb_animator/kb_animator.log

Development

Run Locally

To run the tool locally without installation:

python3 cli.py start heartbeat --color red

Testing

Run the tests (if any) using:

pytest

License

This project is licensed under the MIT License. See the LICENSE file for details.