Linux device manager for Logitech devices
Go to file
Peter F. Patel-Schneider 24798ee310 docs: remove logitech files and outdated information; update supported features 2020-07-11 15:36:49 -04:00
.github ci: add pre-commit 2020-07-07 15:11:15 +01:00
bin yapf: adjust style to not indent closing brackets 2020-07-07 15:11:15 +01:00
docs docs: remove logitech files and outdated information; update supported features 2020-07-11 15:36:49 -04:00
jekyll/images Squash previous changes and rebase master branch 2019-07-27 15:56:53 +01:00
lib cli: make config faster 2020-07-10 14:16:41 -04:00
po po: minor fix to es translation file 2020-05-22 01:19:20 +01:00
rules.d receiver: add c53d as a Lightspeed receiver 2020-05-25 20:51:17 -04:00
share ui: add 'desktop-entry' hint to indicate notification source. 2020-05-01 13:56:22 -04:00
tools yapf: set max line lenght to 127 2020-07-07 15:11:15 +01:00
.git-blame-ignore-revs git-blame-ignore-revs: add pre-commit bulk change 2020-07-07 16:10:37 +01:00
.gitignore git: add lib/solaar.egg-info/ to .gitignore 2020-05-13 15:35:35 +01:00
.pre-commit-config.yaml pre-commit: add flake8 2020-07-07 15:11:15 +01:00
COPYING added copyright notices to all source files 2013-07-15 17:54:42 +02:00
COPYRIGHT clarify license status; fix debian packaging copyight notice 2019-12-24 18:53:43 +00:00
ChangeLog pre-commit: initial fix 2020-07-07 15:11:15 +01:00
MANIFEST.in started i18n support 2013-07-15 17:16:44 +02:00
README added a symlink to README.md to pacify sdist 2013-07-07 12:25:12 +02:00
README.md docs: Deduplicate README contents, use a symlink 2019-08-20 09:36:16 +02:00
RELEASE.md release: fix up RELEASE.md 2020-05-10 03:49:32 +01:00
release.sh release: release candidates do not have hyphen before rc 2020-05-02 17:42:13 +01:00
setup.cfg yapf: adjust style to not indent closing brackets 2020-07-07 15:11:15 +01:00
setup.py setup.py: set minimum python version to 3.5 2020-07-07 15:11:15 +01:00

README.md

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 how to use Solaar see docs/usage.md. 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.

Solaar has progressed beyond version 1.0 but some distros or repositories version 0.9.2, which is very old. Installing the current version will provide significant improvements. If a recent version of Solaar is not available from the standard repositories for your distribution you can try one of these packages.

Solaar 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

  • The icon in the system tray can show up as 'black on black' in dark distributions. This is due to problems in many system tray implementations. Changing to a different theme may help.

  • If some icons appear broken in the application, make sure you've properly configured the Gtk theme and icon theme in your 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:

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