3df2a30f30
Software-managed LED persistence and power management for devices that expose RGBEffects (0x8071) — primarily G515 LIGHTSPEED TKL, but the same infrastructure works on any 0x8071 device that supports SW takeover. Core mechanism: RGBControl toggle drives a Set SWControl(mode=3, flags) handshake. While SW control is held, the host owns the LED pipeline: zone effects, per-key paint, idle/sleep transitions, and the NvConfig boot/exit animations. On release, the firmware resumes its onboard profile. Major pieces: - rgb_power.py — new module hosting the software RGB power manager: ACTIVE / DIMMING / IDLE / SLEEPING state machine driven by firmware onUserActivity events, smooth 5-second dim ramp (zone or per-key), idle Static color snap, software sleep timer, wake handler that re-pushes saved state. Includes the cleanup hook that runs on device close (and, optionally, fires the cap 0x0040 shutdown trigger). - RGBControl (settings_templates) — switch-style render via BooleanValidator (true_value=3 / false_value=0) plus a full _claim_sw_control / _release_sw_control pair: profile-management mode, SetSWControl, per-key flag reset, manager start, cleanup registration, and a post-claim repaint pass so the device immediately reflects Solaar's saved zone + per-key state. - RGBEffectSetting — zone-effect Setting subclass for 0x8071. Handles per-key/zone coexistence: per-key paint dominates only when zone is Static and the user has explicitly opted in via the lock icon; under animations or before opt-in, the zone wire push is the visible layer. - RGBIdleEffect / RGBIdleTimeout / RGBSleepTimeout — Solaar-managed idle behavior. Choice list: "No change" → Dim → Static (snap to color) → device-specific animations. Static idle substitutes the idle color for unset per-key cells via effective_zone_base_color's state-aware lookup. - RgbStartupAnimation / RgbShutdownAnimation — toggle-and-color rows for RGBEffects NvConfig caps 0x0001 and 0x0040, exposed only on devices that answer the probe. Shutdown trigger fires SetRgbPowerMode(0) at cleanup time so the firmware plays the configured animation on exit. - PerKeyLighting — per-key painter improvements: explicit-opt-in dominance over zone effects, BUSY retry, FrameEnd suppression on per-cell failure, single-shot prep sequence (SetEffectByIndex into the out-of-range slot) on mice with firmware effect cards. - device_quirks.py — small per-model quirks table keyed by device.modelId (stable across USB/BLE/wireless). Currently used to mark RGBEffects NvConfig color slots as inert on devices where the firmware accepts but ignores the bytes (G502 X PLUS startup colors). - config_panel.py — HeteroKeyControl gains a TOGGLE field kind that renders as a Gtk.Switch (used by the boot-effect rows). Visual gate greys out RGB settings whose prerequisites aren't met: rgb_zone_* / rgb_idle_* / rgb_sleep_timeout require LED Control = Solaar; per-key additionally requires every zone effect to be Static. Visual-only — doesn't touch the persister's user lock-icon state. - tests/test_rgb_power.py — coverage for the power manager state machine, dim ramp, idle effects, wake path, and per-key/zone coexistence. Closes pwr-Solaar/Solaar#3149. |
||
|---|---|---|
| .github | ||
| bin | ||
| docs | ||
| lib | ||
| po | ||
| rules.d | ||
| rules.d-uinput | ||
| share | ||
| tests | ||
| tools | ||
| .coveragerc | ||
| .git-blame-ignore-revs | ||
| .gitignore | ||
| .pre-commit-config.yaml | ||
| .python-version | ||
| CHANGELOG.md | ||
| COPYRIGHT | ||
| LICENSE.txt | ||
| MANIFEST.in | ||
| Makefile | ||
| README.md | ||
| RELEASE.md | ||
| RHEL.md | ||
| Release_Notes.md | ||
| mkdocs.yml | ||
| pyproject.toml | ||
| release.sh | ||
| setup.py | ||
README.md
Solaar
Solaar is a Linux manager for many Logitech keyboards, mice, and other devices that connect wirelessly to a Unifying, Bolt, Lightspeed or Nano receiver as well as many Logitech devices that connect via a USB cable or Bluetooth. Solaar is not a device driver and responds only to special messages from devices that are otherwise ignored by the Linux input system.
More Information - Usage - Capabilities - Rules - Manual Installation - Known Issues
Solaar supports:
- pairing/unpairing of devices with receivers
- configuring device settings
- custom button configuration
- running rules in response to special messages from devices
For more information see the main Solaar documentation page. -
Installation Packages
Up-to-date prebuilt packages are available for some Linux distros (e.g., Fedora) in their standard repositories. If a recent version of Solaar is not available from the standard repositories for your distribution, you can try one of these packages:
- Arch solaar package in the extra repository
- Ubuntu/Kubuntu package in Solaar stable ppa
- NixOS Flake package in Svenum/Solaar-Flake
Solaar is available from some other repositories but may be several versions behind the current version:
- a Debian package, courtesy of Stephen Kitt
- a Ubuntu package is available from universe repository
- a Gentoo package, courtesy of Carlos Silva and Tim Harder
- a Mageia package, courtesy of David Geiger