Skip to content

About

Keyboard Backlight Controls — control RGB del teclado AERO X16 vía HID LampArray

Resources

Code of conduct

Contributing

Security policy

Stars

0 stars

Watchers

0 watching

Forks

Repository files navigation

Keyboard Backlight Controls (keybackcon)

Propósito de este documento

  • Objetivos: Explicar qué es keybackcon, cómo instalarlo y los comandos de la CLI/GUI sin sustituir la spec HID ni los ADR.
  • Estructura: Instalación → uso → cómo funciona → problemas típicos → desarrollo y contratos.
  • Contenido a integrar según contexto: Adapta comandos y empaquetado de este repo. No copies un README de SaaS. El detalle HID está en docs/architecture/protocol.md; no lo dupliques aquí.

CI Release Rust GTK4 License

Fija la luz de tu teclado AERO X16 en dos toques: elige color, ajusta intensidad y listo. Desde terminal o con mesa de luz gráfica, todo en castellano.

Mesa de luz en tema oscuro Demostración: fijar color y animación

La mesa de luz vive también en la bandeja del sistema (keybackcon-gui --tray) y sigue el tema claro/oscuro de tu escritorio.

Empieza en 3 pasos

  1. Instala el .deb desde la release (o el script local; ver abajo).
  2. Fija un color: keybackcon set ff7800.
  3. Abre la mesa de luz: keybackcon-gui (requiere GTK4 y libadwaita ≥ 1.5).

Instalación

  1. Ubuntu/Debian (.deb, canal principal de GUI+CLI): descarga el .deb de cada release e instala con sudo apt install ./keybackcon_X.Y.Z-1_amd64.deb (binario, GUI, icono, regla udev y unidades de usuario). Debian 12: el CLI funciona; la mesa de luz nativa exige libadwaita ≥ 1.5 (ver matriz).
  2. Script local (~/.local): ./scripts/install.sh (pide sudo una vez para la regla udev).
  3. npm (solo CLI): npm install -g keybackcon instala el binario precompilado (Linux x86_64/arm64) y, si el postinstalador lo permite, la regla udev y unidades de usuario. No incluye la mesa de luz GTK ni sus recursos. Omite udev con KEYBACKCON_SKIP_UDEV=1.
  4. Arch (AUR): el empaquetado existe en el árbol del repo; la publicación AUR y los checksums no están verificados en esta revisión. No uses yay -S keybackcon como canal acreditado hasta que la matriz lo marque como probado. Mientras tanto: script local o binario de la release.
  5. Fedora: usa el script local o el CLI de npm. El empaquetado RPM no está verificado aún.

Cada release trae además el tarball keybackcon-vX.Y.Z-linux-x86_64.tar.gz, SHA256SUMS y SBOM CycloneDX (inventario del crate Rust; la GUI tiene dependencias de sistema aparte).

Matriz completa (probado / candidato / experimental / no soportado): docs/compatibility/matriz.md.

Compatibilidad

El CLI es un binario sin crates externos (sí depende de libc y del kernel). La mesa de luz necesita GTK 4 y libadwaita ≥ 1.5. La bandeja (Ayatana) es opcional y separada.

Distro Instalación CLI GUI (Adw ≥ 1.5)
Debian 12 .deb / script Candidato No soportada (Adw 1.2)
Debian 13 / Ubuntu 24.04+ .deb / script Candidato Candidato si Adw ≥ 1.5
Ubuntu 22.04 .deb / script Candidato No anunciada hasta medir Adw ≥ 1.5
Arch script / release Candidato Candidato; AUR no acreditado
Fedora script / npm CLI Candidato Candidato; RPM no verificado
openSUSE — Fuera del alcance anunciado —
npm npm i -g keybackcon Sí (solo binario) No incluida

install.sh y la GUI detectan la distro (/etc/os-release) y proponen el comando de paquetes cuando falta algo. Sin systemd: udev y CLI siguen válidos; las unidades de usuario se omiten. Hyprland: integración experimental hasta completar evidencias (docs/guides/hyprland.md).

Contrato de brillo, apagado, restauración y JSON: docs/product/contrato.md.

Uso

Comando Efecto
keybackcon set ff7800 Fija color (hex, #hex o nombre: red, blue, orange…)
keybackcon brightness 60 Ajusta intensidad (o +10 / -10)
keybackcon animation breathe Anima (breathe o rainbow); stop la para
keybackcon off Apaga (conserva tu color)
keybackcon restore Reaplica tu color guardado (p. ej. al iniciar sesión)
keybackcon info Muestra dispositivo y estado
keybackcon-gui --tray Mesa de luz (solo bandeja con --tray)

Atajos de la GUI: Ctrl+1…9 cambia de filtro, +/− ajusta intensidad.

Idioma: la mesa de luz sigue el locale del sistema y trae catálogos completos en español e inglés (cae a español si el locale no está soportado). El CLI no se traduce.

Cómo funciona

  • Habla directamente con el teclado por USB: el CLI es el único escritor; sin demonio privilegiado en medio.
  • Tu color y brillo se guardan y sobreviven a reinicios. Ajustar el brillo no detiene una animación en curso (la animación relee el porcentaje).
  • Solo hay una escritura a la vez (candado /run/keybackcon/writer.lock). Fijar color o pedir stop detiene la animación antes de volver a escribir.

Detalle técnico (HID LampArray, informes, estado): docs/architecture/protocol.md, diseño en ARCHITECTURE.md y decisiones en docs/architecture/decisions/DECISIONS.md.

Problemas típicos

Síntoma Qué hacer
No encuentra el teclado Revisa la conexión y prueba keybackcon info
Permiso denegado en /dev/hidraw* sudo udevadm trigger y vuelve a iniciar sesión
La animación no para keybackcon stop

Runbook: docs/runbooks/dispositivo.md.

Desarrollo

¿Quieres compilar o contribuir? docs/guides/desarrollo.md y CONTRIBUTING.md. Índice de documentos: docs/README.md.

make validate   # lint + test + smoke

Contratos

Licencia MIT — ver LICENSE.

About

Keyboard Backlight Controls — control RGB del teclado AERO X16 vía HID LampArray

Resources

Code of conduct

Contributing

Security policy

Stars

0 stars

Watchers

0 watching

Forks

Releases

Packages

Used by

Contributors

Languages