README
1**Solaar** is a Linux device manager for Logitech's [Unifying][unifying] Receiver
2peripherals. It is able to pair/unpair devices to the receiver, and for most
3devices read battery status.
4
5It comes in two flavors, command-line and GUI. Both are able to list the
6devices paired to a Unifying Receiver, show detailed info for each device, and
7also pair/unpair supported devices with the receiver.
8
9[unifying]: http://logitech.com/promotions/6072
10
11## Supported Devices
12
13**Solaar** will detect all devices paired with your Unifying Receiver, and at
14the very least display some basic information about them.
15
16For some devices, extra settings (usually not available through the standard
17Linux system configuration) are supported. For a full list of supported devices
18and their features, see [docs/devices.md](docs/devices.md).
19
20
21## Pre-built packages
22
23Pre-built packages are available for a few Linux distros.
24
25* Arch `solaar` package in the [community repository][arch]
26* Debian 7 (Wheezy) or higher: packages in this [repository](docs/debian.md)
27* Ubuntu/Kubuntu 16.04+: use the `solaar-gnome3` and/or `solaar` package from [universe repository][universe repository]
28* Ubuntu/Kubuntu 12.04 to 14.04: use `solaar` package from [ppa:daniel.pavel/solaar][ppa]
29
30The `solaar` package uses a standard system tray implementation; to ensure
31integration with *gnome-shell* or *Unity*, install `solaar-gnome3`.
32
33* an [Arch AUR solaar-git package][arch-git], courtesy of Maxime Poulin
34* a [Fedora package][fedora], courtesy of Eric Smith
35* a [Gentoo package][gentoo], courtesy of Carlos Silva and Tim Harder
36* a [Mageia package][mageia], courtesy of David Geiger
37* an [OpenSUSE rpm][opensuse], courtesy of Mathias Homann
38
39[ppa]: http://launchpad.net/~daniel.pavel/+archive/solaar
40[arch]: https://www.archlinux.org/packages/community/any/solaar/
41[arch-git]: https://aur.archlinux.org/packages/solaar-git/
42[fedora]: https://apps.fedoraproject.org/packages/solaar
43[gentoo]: https://packages.gentoo.org/packages/app-misc/solaar
44[mageia]: http://mageia.madb.org/package/show/release/cauldron/application/0/name/solaar
45[opensuse]: http://software.opensuse.org/package/Solaar
46[universe repository]: http://packages.ubuntu.com/search?keywords=solaar&searchon=names&suite=all§ion=all
47
48
49## Manual installation
50
51See [docs/installation.md](docs/installation.md) for the step-by-step
52procedure for manual installation.
53
54
55## Known Issues
56
57- KDE/Kubuntu: if some icons appear broken in the application, make sure you've
58 properly configured the Gtk theme and icon theme in KDE's control panel.
59
60- Some devices using the [Nano Receiver][nano] (which is very similar to the
61 Unifying Receiver) are supported, but not all. For details, see
62 [docs/devices.md](docs/devices.md).
63
64- Running the command-line application (`bin/solaar-cli`) while the GUI
65 application is also running *may* occasionally cause either of them to become
66 confused about the state of the devices. I haven't encountered this often
67 enough to be able to be able to diagnose it properly yet.
68
69[nano]: http://support.logitech.com/en_us/parts
70
71
72## License
73
74This software is distributed under the terms of the
75[GNU Public License, v2](COPYING).
76
77
78## Thanks
79
80This project began as a third-hand clone of [Noah K. Tilton](https://github.com/noah)'s
81logitech-solar-k750 project on GitHub (no longer available). It was developed
82further thanks to the diggings in Logitech's HID++ protocol done by many other
83people:
84
85- [Julien Danjou](http://julien.danjou.info/blog/2012/logitech-k750-linux-support),
86who also provided some internal
87[Logitech documentation](http://julien.danjou.info/blog/2012/logitech-unifying-upower)
88- [Lars-Dominik Braun](http://6xq.net/git/lars/lshidpp.git)
89- [Alexander Hofbauer](http://derhofbauer.at/blog/blog/2012/08/28/logitech-performance-mx)
90- [Clach04](http://bitbucket.org/clach04/logitech-unifying-receiver-tools)
91- [Peter Wu](https://lekensteyn.nl/logitech-unifying.html)
92- [Nestor Lopez Casado](http://drive.google.com/folderview?id=0BxbRzx7vEV7eWmgwazJ3NUFfQ28)
93provided some more Logitech specifications for the HID++ protocol
94
95Also thanks to Douglas Wagner, Julien Gascard and Peter Wu for helping with
96application testing and supporting new devices.
97
README.md
1**Solaar** is a Linux device manager for Logitech's [Unifying][unifying] Receiver
2peripherals. It is able to pair/unpair devices to the receiver, and for most
3devices read battery status.
4
5It comes in two flavors, command-line and GUI. Both are able to list the
6devices paired to a Unifying Receiver, show detailed info for each device, and
7also pair/unpair supported devices with the receiver.
8
9[unifying]: http://logitech.com/promotions/6072
10
11## Supported Devices
12
13**Solaar** will detect all devices paired with your Unifying Receiver, and at
14the very least display some basic information about them.
15
16For some devices, extra settings (usually not available through the standard
17Linux system configuration) are supported. For a full list of supported devices
18and their features, see [docs/devices.md](docs/devices.md).
19
20
21## Pre-built packages
22
23Pre-built packages are available for a few Linux distros.
24
25* Arch `solaar` package in the [community repository][arch]
26* Debian 7 (Wheezy) or higher: packages in this [repository](docs/debian.md)
27* Ubuntu/Kubuntu 16.04+: use the `solaar-gnome3` and/or `solaar` package from [universe repository][universe repository]
28* Ubuntu/Kubuntu 12.04 to 14.04: use `solaar` package from [ppa:daniel.pavel/solaar][ppa]
29
30The `solaar` package uses a standard system tray implementation; to ensure
31integration with *gnome-shell* or *Unity*, install `solaar-gnome3`.
32
33* an [Arch AUR solaar-git package][arch-git], courtesy of Maxime Poulin
34* a [Fedora package][fedora], courtesy of Eric Smith
35* a [Gentoo package][gentoo], courtesy of Carlos Silva and Tim Harder
36* a [Mageia package][mageia], courtesy of David Geiger
37* an [OpenSUSE rpm][opensuse], courtesy of Mathias Homann
38
39[ppa]: http://launchpad.net/~daniel.pavel/+archive/solaar
40[arch]: https://www.archlinux.org/packages/community/any/solaar/
41[arch-git]: https://aur.archlinux.org/packages/solaar-git/
42[fedora]: https://apps.fedoraproject.org/packages/solaar
43[gentoo]: https://packages.gentoo.org/packages/app-misc/solaar
44[mageia]: http://mageia.madb.org/package/show/release/cauldron/application/0/name/solaar
45[opensuse]: http://software.opensuse.org/package/Solaar
46[universe repository]: http://packages.ubuntu.com/search?keywords=solaar&searchon=names&suite=all§ion=all
47
48
49## Manual installation
50
51See [docs/installation.md](docs/installation.md) for the step-by-step
52procedure for manual installation.
53
54
55## Known Issues
56
57- KDE/Kubuntu: if some icons appear broken in the application, make sure you've
58 properly configured the Gtk theme and icon theme in KDE's control panel.
59
60- Some devices using the [Nano Receiver][nano] (which is very similar to the
61 Unifying Receiver) are supported, but not all. For details, see
62 [docs/devices.md](docs/devices.md).
63
64- Running the command-line application (`bin/solaar-cli`) while the GUI
65 application is also running *may* occasionally cause either of them to become
66 confused about the state of the devices. I haven't encountered this often
67 enough to be able to be able to diagnose it properly yet.
68
69[nano]: http://support.logitech.com/en_us/parts
70
71
72## License
73
74This software is distributed under the terms of the
75[GNU Public License, v2](COPYING).
76
77
78## Thanks
79
80This project began as a third-hand clone of [Noah K. Tilton](https://github.com/noah)'s
81logitech-solar-k750 project on GitHub (no longer available). It was developed
82further thanks to the diggings in Logitech's HID++ protocol done by many other
83people:
84
85- [Julien Danjou](http://julien.danjou.info/blog/2012/logitech-k750-linux-support),
86who also provided some internal
87[Logitech documentation](http://julien.danjou.info/blog/2012/logitech-unifying-upower)
88- [Lars-Dominik Braun](http://6xq.net/git/lars/lshidpp.git)
89- [Alexander Hofbauer](http://derhofbauer.at/blog/blog/2012/08/28/logitech-performance-mx)
90- [Clach04](http://bitbucket.org/clach04/logitech-unifying-receiver-tools)
91- [Peter Wu](https://lekensteyn.nl/logitech-unifying.html)
92- [Nestor Lopez Casado](http://drive.google.com/folderview?id=0BxbRzx7vEV7eWmgwazJ3NUFfQ28)
93provided some more Logitech specifications for the HID++ protocol
94
95Also thanks to Douglas Wagner, Julien Gascard and Peter Wu for helping with
96application testing and supporting new devices.
97