uhle/solaar

Linux device manager for Logitech devices

title	layout
Solaar	default

Solaar is a Linux manager for Logitech's devices that connect via a USB Unifying, Lightspeed, or Nano receiver.
Solaar does not work with Logitech peripherals that use Bluetooth or peripherals from other companies.

Solaar can be used as a GUI application or via its command-line interface. Both interfaces are able to list the devices paired to a receiver and show information about each device, including battery status for devices that support this feature. Solaar's GUI normally uses an icon in the system tray and starts with its main window hidden. If Solaar is invoked with the --window=show option (the default) Solaar starts with its main window visible. If Solaar is invoked with the --window=hide option Solaar starts with its main window hidden. If solaar is invoked with the --window=only option Solaar does not set up an icon in the system tray and also starts with its main window showing. For more information on Solaar's command-line interface use the help option, as in solaar --help.

Solaar is able to pair and unpair devices with receivers as supported by the receiver. Solaar can also control some of the changeable features of devices, such as smooth scrolling or function key behavior.
For more information on the capabilities of Solaar see docs/capabilities.md.

Solaar does not process normal input from the devices. Solaar is thus unable to fix problems that arise from incorrect handling of mouse movements or keycodes by Linux drivers or other software.

Solaar has progressed past version 1.0. Problems with earlier versions should not be reported as bugs. Instead upgrade to a recent version or manually install the current version from GitHub. Some of the capabilities of Solaar have been developed by observing the behavior of Logitech receivers and devices and generalizing from these observations. If your Logitech receiver or device behaves in a strange way this may be caused by an incorrect behavior generalization. Please report such experiences by creating an issue in the Solaar repository.

Supported Devices

Solaar will detect all devices paired with your Unifying, Lightspeed, or Nano receiver, and at the very least display some basic information about them. Solaar can pair and unpair a Logitech device showing the Unifying logo (Solaar's version of the logo) with any Unifying receiver and can pair and unpair devices with Lightspeed receivers. Solaar can pair some Logitech devices with Logitech Nano receivers but not all Logitech devices can be paired with Nano receivers. Logitech devices without a Unifying logo generally cannot be paired with Unifying receivers.

For some devices, extra settings (usually not available through the standard Linux system configuration) are supported. For a list of supported devices and their features, see docs/devices.md.

Pre-built packages

Pre-built packages are available for a few Linux distros.

• Arch solaar package in the community repository
• Debian 7 (Wheezy) or higher: packages in this repository
• Ubuntu/Kubuntu 16.04+: use the solaar package from universe repository
• Ubuntu/Kubuntu stable packages: use the solaar package from Solaar stable ppa
• Ubuntu/Kubuntu git build packages: use the solaar package from Solaar git ppa
• a Fedora package, courtesy of Eric Smith
• a Gentoo package, courtesy of Carlos Silva and Tim Harder
• a Mageia package, courtesy of David Geiger
• an OpenSUSE rpm, courtesy of Mathias Homann
• an Ubuntu/Kubuntu git and stable ppa, courtesy of gogo

The solaar package uses a standard system tray implementation; solaar-gnome3 is no longer required for gnome or unity integration.

Manual installation

See docs/installation.md for the step-by-step procedure for manual installation.

Known Issues

• KDE/Kubuntu: if some icons appear broken in the application, make sure you've properly configured the Gtk theme and icon theme in KDE's control panel.

• Running the command-line application while the GUI application is also running may occasionally cause either of them to become confused about the state of the devices.

License

This software is distributed under the terms of the GNU Public License, v2.

Thanks

This project began as a third-hand clone of Noah K. Tilton's logitech-solar-k750 project on GitHub (no longer available). It was developed further thanks to the diggings in Logitech's HID++ protocol done by many other people:

• Julien Danjou, who also provided some internal Logitech documentation
• Lars-Dominik Braun
• Alexander Hofbauer
• Clach04
• Peter Wu
• Nestor Lopez Casado provided some more Logitech specifications for the HID++ protocol

Also thanks to Douglas Wagner, Julien Gascard and Peter Wu for helping with application testing and supporting new devices.