From f49ced2d926842589b7bcfef05ec1e95b6bb0d76 Mon Sep 17 00:00:00 2001 From: Daniel Pavel Date: Fri, 7 Dec 2012 19:39:40 +0200 Subject: [PATCH] readme updates --- README.md | 74 +++++++++++++++++++++++++++++++++++-------------------- 1 file changed, 47 insertions(+), 27 deletions(-) diff --git a/README.md b/README.md index ebe3ba4c..5ab64c7b 100644 --- a/README.md +++ b/README.md @@ -1,10 +1,35 @@ **Solaar** is a Linux device manager for Logitech's [Unifying Receiver](http://www.logitech.com/en-us/66/6079) peripherals. -It comes in two flavours, command-line and GUI. Both are able to list the +It comes in two flavors, command-line and GUI. Both are able to list the devices paired to a Unifying Receiver, show detailed info for each device, and also pair/unpair supported devices with the receiver. +## Supported Devices + +**Solaar** will detect all devices paired with your Unifying Receiver, and at +the very least display some basic information about them. Depending on the +device, it may be able to read its battery status. A few devices I was able to +test on also have extended support: + +* The [K750 Solar Keyboard](http://www.logitech.com/keyboards/keyboard/devices/7454) + is also queried for its solar charge status. Pressing the Solar key on the + keyboard will pop-up the application window and display the current lighting + value (Lux) as reported by the keyboard, similar to Logitech's *Solar.app* for + Windows. + + Also, you can change the way the function keys (`F1`..`F12`) work, i.e. + whether holding `FN` while pressing the function keys will generate the + standard keycodes or the special function (yellow icons) keycodes. + +* The [M705 Marathon Mouse](http://www.logitech.com/product/marathon-mouse-m705) + supports turning on/off Smooth Scrolling (higher sensitivity on vertical + scrolling with the wheel). + +Extended support for other devices may be added in the future, depending on the +documentation available, but the K750 keyboard and M705 mouse are the only +devices I have and can test on right now. + ## Requirements You should have a reasonably new kernel (3.2+), with the `logitech-djreceiver` @@ -29,38 +54,33 @@ need to do a one-time udev rule installation to allow access to the Logitech Unifying Receiver. You can run the `rules.d/install.sh` script from Solaar to do this installation -(it will switch to root when necessary), or you can do all the required steps by -hand, as the root user: +automatically (it will switch to root when necessary), or you can do all the +required steps by hand, as the root user: -- copy `rules.d/99-logitech-unfiying-receiver.rules` from Solaar to -`/etc/udev/rules.d/` +1. copy `rules.d/99-logitech-unfiying-receiver.rules` from Solaar to + `/etc/udev/rules.d/` - By default, the rule makes the Unifying Receiver device available for r/w by - all users belonging to the `plugdev` system group (standard Debian/Ubuntu - group for pluggable devices). It may need changes, specific to your - particular system's configuration. If in doubt, replacing `GROUP="plugdev"` - with `GROUP=""` should just work. + By default, the rule makes the Unifying Receiver device available for r/w by + all users belonging to the `plugdev` system group (standard Debian/Ubuntu + group for pluggable devices). It may need changes, specific to your + particular system's configuration. If in doubt, replacing `GROUP="plugdev"` + with `GROUP=""` should just work. -- run `udevadm control --reload-rules` to let the udev daemon know about the new -rule -- physically remove the Unifying Receiver, wait 10 seconds and re-insert it +2. run `udevadm control --reload-rules` to let the udev daemon know about the new + rule +3. physically remove the Unifying Receiver, wait 10 seconds and re-insert it -## Supported Devices +## Known Issues -**Solaar** will detect all devices paired with your Unifying Receiver, and at -the very least display some basic information about them. Depending on the -device, it may be able to read its battery status. Changing various settings -of the devices (like mouse DPI) is currently not supported, but implementation -is planned. +- When running under Ubuntu's Unity, the tray icon will probably not appear, nor + will the application window. Either run the application with the '-S' option, + or whitelist "Solaar" into the systray. For details, see + [How do I access and enable more icons to be in the system tray?](http://askubuntu.com/questions/30742/how-do-i-access-and-enable-more-icons-to-be-in-the-system-tray). -The [K750 Solar Keyboard](http://www.logitech.com/keyboards/keyboard/devices/7454) -is also queried for its solar charge status. Pressing the Solar key on the -keyboard will pop-up the application window and display the current lighting -value, similar to Logitech's Solar app for Windows. - -Extended support for other devices will be added in the future, depending on the -documentation available, but the K750 keyboard is the only device I have and can -test on right now. +- Running the command-line application (`bin/solaar-cli`) while the GUI + application is also running *may* occasionally cause either of them to become + confused about the state of the devices. I haven't encountered this often + enough to be able to be able to diagnose it properly yet. ## Thanks