56 lines
1.8 KiB
Markdown
56 lines
1.8 KiB
Markdown
<div align="center">
|
|
|
|
# `keylightd`
|
|
|
|
### Keyboard backlight daemon for Framework laptops
|
|
|
|
</div>
|
|
|
|
`keylightd` is a small system daemon for [Framework] laptops that listens to keyboard and touchpad input, and turns on the keyboard backlight while either is being used.
|
|
|
|
[Framework]: https://frame.work/
|
|
|
|
## Installation
|
|
|
|
To install from source, clone the repository and run:
|
|
|
|
```shell
|
|
$ cargo build --release
|
|
$ sudo cp target/release/keylightd /usr/local/bin
|
|
```
|
|
|
|
`keylightd` has no native dependencies you have to install first (apart from a recent Rust toolchain for building it, of course).
|
|
It implements communication with the Embedded Controller itself, and talks to the input devices using `evdev` ioctls directly.
|
|
It also does not have any hard dependencies on a desktop environment or display server.
|
|
|
|
If you want to configure `keylightd` as a systemd service that starts on boot, you can use the provided service file:
|
|
|
|
```shell
|
|
$ sudo cp etc/keylightd.service /etc/systemd/system
|
|
$ sudo systemctl enable --now keylightd
|
|
```
|
|
|
|
## Running
|
|
|
|
Note that `keylightd` needs to be run as root, since it accesses the Embedded Controller to control the keyboard backlight.
|
|
|
|
`keylightd` takes the following command-line arguments:
|
|
|
|
```
|
|
Usage: keylightd [--brightness <brightness>] [--timeout <timeout>]
|
|
|
|
keylightd - automatic keyboard backlight daemon for Framework laptops
|
|
|
|
Options:
|
|
--brightness brightness level when active (0-100) [default=30]
|
|
--timeout activity timeout in seconds [default=10]
|
|
--help display usage information
|
|
```
|
|
|
|
If you're using the provided `keylightd.service` file, you can adjust the command line parameters there.
|
|
|
|
## Contributing
|
|
|
|
This project does not generally accept contributions. It is finished and does what I want of it.
|
|
|
|
Minor fixes and readme additions *may* be accepted.
|