RomanNum3ral
/
Solaar
mirror of https://github.com/pwr-Solaar/Solaar.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

docs: minor updates and cleanup

This commit is contained in:
Peter F. Patel-Schneider 2021-04-18 11:11:55 -04:00
parent 44b1b5b6d0
commit d3799dcf41
3 changed files with 19 additions and 21 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

23
docs/capabilities.md
View File

@ -11,9 +11,9 @@ Logitech USB receiver (a very small piece of hardware that plugs into one of
your USB ports). your USB ports).
Solaar is designed to detect all connected devices, Solaar is designed to detect all connected devices,
and at the very least display some basic information about them. and at the very least display some basic information about them.
At this moment, all [Unifying][unifying] receivers are supported (devices At this moment, all [Unifying][unifying] receivers are supported (e.g., devices
with USB ID `046d:c52b` or `046d:c532`) as are several Lightspeed Receivers with USB ID `046d:c52b` or `046d:c532`) as are several Lightspeed Receivers
and a dozen Nano receivers. and many Nano receivers.
Solaar also reports on and controls some Logitech devices that directly connect Solaar also reports on and controls some Logitech devices that directly connect
to your computer using a USB cable or via Bluetooth. to your computer using a USB cable or via Bluetooth.
@ -26,18 +26,18 @@ for each device type that directly connects.
The devices that Solaar handles use Logitech's HID++ protocol. The devices that Solaar handles use Logitech's HID++ protocol.
HID++ is a Logitech-proprietary protocol that extends the standard HID HID++ is a Logitech-proprietary protocol that extends the standard HID
protocol for interfacing with keyboards, mice, and so on. It allows protocol for interfacing with receivers, keyboards, mice, and so on. It allows
Logitech receivers to communicate with multiple devices and modify some Logitech receivers to communicate with multiple devices and modify some
features of the device on the device itself. As the HID++ protocol is features of the device. As the HID++ protocol is
proprietary, many aspects of it are unknown. Some information about HID++ proprietary, many aspects of it are unknown. Some information about HID++
has been obtained from Logitech but even that is subject to change and has been obtained from Logitech but even that is subject to change and
extension. extension.
There are several versions of the HID++ and many Logitech There are several versions of HID++ and many Logitech
receivers and devices that utilize it. Different receivers and devices receivers and devices that utilize it. Different receivers and devices
implement different portions of HID++ so even if two devices appear to be implement different portions of HID++ so even if two devices appear to be
the same in both physical appearance and behavior they may work the same in both physical appearance and behavior they may work
completely differently underneath. (For example, there are versions of the differently underneath. (For example, there are versions of the
M510 mouse that use different versions of the HID++ protocol.) M510 mouse that use different versions of the HID++ protocol.)
Contrariwise, two different devices may appear different physically but Contrariwise, two different devices may appear different physically but
actually look the same to software. (For example, some M185 mice look the actually look the same to software. (For example, some M185 mice look the
@ -46,7 +46,7 @@ same to software as some M310 mice.)
The software identity of a receiver can be determined by its USB product ID The software identity of a receiver can be determined by its USB product ID
(reported by Solaar and also viewable in Linux using `lsusb`). The software (reported by Solaar and also viewable in Linux using `lsusb`). The software
identity of a device that connects to a receiver can be determined by identity of a device that connects to a receiver can be determined by
its Wireless PID as reported by Solaar. The software identity of devices that its wireless PID as reported by Solaar. The software identity of devices that
connect via a USB cable or via bluetooth can be determined by their USB or connect via a USB cable or via bluetooth can be determined by their USB or
Bluetooth product ID. Bluetooth product ID.
@ -108,9 +108,8 @@ interactions. These interactions can temporarily slow down the device, so
Solaar tries to internally cache information about devices while it is Solaar tries to internally cache information about devices while it is
running. If the device running. If the device
state is changed by some other means, even sometimes by another invocation state is changed by some other means, even sometimes by another invocation
of the program, this cached information may become incorrect. Currently there is of Solaar, this cached information may become incorrect. Currently there is
no way to force an update of the cached information besides restarting the no way to force an update of the cached information besides restarting Solaar.
program.
Logitech receivers and devices have firmware in them. Some firmware Logitech receivers and devices have firmware in them. Some firmware
can be updated using Logitech software in Windows. For example, there are can be updated using Logitech software in Windows. For example, there are
@ -125,9 +124,9 @@ update installs the wrong firmware.
Solaar has a few capabilities that go beyond simply changing device settings. Solaar has a few capabilities that go beyond simply changing device settings.
### Rule-based Processing of HID++ Feature Notifications ### Rule-based Processing of HID++ Notifications
Solaar can process HID++ Feature Notifications from devices to, for example, Solaar can process HID++ Notifications from devices to, for example,
change the speed of some thumb wheels. These notifications are only sent change the speed of some thumb wheels. These notifications are only sent
for actions that are set in Solaar to their HID++ setting (also known as diverted). for actions that are set in Solaar to their HID++ setting (also known as diverted).
For more information on this capability of Solaar see For more information on this capability of Solaar see

11
docs/index.md
View File

@ -25,14 +25,14 @@ and for more information on its capabilities see
Solaar's GUI normally uses an icon in the system tray and starts with its main window visible. Solaar's GUI normally uses an icon in the system tray and starts with its main window visible.
This aspect of Solaar depends on having an active system tray, which is not the default This aspect of Solaar depends on having an active system tray, which is not the default
situation for recent versions of Gnome. For information on to set up a system Gnome see situation for recent versions of Gnome. For information on to set up a system tray under Gnome see
[the capabilities page](https://pwr-solaar.github.io/Solaar/capabilities). [the capabilities page](https://pwr-solaar.github.io/Solaar/capabilities).
Solaar's GUI can be started in several ways Solaar's GUI can be started in several ways
- `--window=show` (the default) starts with its main window visible, - `--window=show` (the default) starts with its main window visible,
- `--window=hide` starts with its main window hidden, - `--window=hide` starts with its main window hidden,
- `--window=only` do not use the system tray, and start with main window visible. - `--window=only` does not use the system tray, and starts with main window visible.
For more information on Solaar's command-line interface use the help option, For more information on Solaar's command-line interface use the help option,
as in `solaar --help`. as in `solaar --help`.
@ -56,8 +56,8 @@ Please report such experiences by creating an issue in
## Supported Devices ## Supported Devices
Solaar will detect all devices paired with your Unifying, Lightspeed, or Nano Solaar will detect all devices paired with supported Unifying, Lightspeed, or Nano
receiver, and at the very least display some basic information about them. receivers, and at the very least display some basic information about them.
Solaar will detect some Logitech devices that connect via a USB cable or Bluetooth. Solaar will detect some Logitech devices that connect via a USB cable or Bluetooth.
Solaar can pair and unpair a Logitech device showing the Unifying logo Solaar can pair and unpair a Logitech device showing the Unifying logo
@ -142,8 +142,7 @@ for the step-by-step procedure for manual installation.
On these mice changing the Polling Rate setting requires modifying a setting in On these mice changing the Polling Rate setting requires modifying a setting in
the ONBOARD PROFILES feature, which can modify how the mouse works. Changing the the ONBOARD PROFILES feature, which can modify how the mouse works. Changing the
Polling Rate setting to "Ignore this setting" (see above) prevents Solaar from Polling Rate setting to "Ignore this setting" (see above) prevents Solaar from
modifying the ONBOARD PROFILES feature. The mouse needs to be turned off and on modifying the ONBOARD PROFILES feature.
again undo the modification of ONBOARD PROFILES feature.
The mouse has to be reset (e.g., by turning it off and on again) before this fix will take effect. The mouse has to be reset (e.g., by turning it off and on again) before this fix will take effect.

6
docs/installation.md
View File

@ -14,7 +14,7 @@ Clone Solaar from GitHub by `git clone https://github.com/pwr-Solaar/Solaar.git`
Installing Solaar from a repository should have set up all these requirements Installing Solaar from a repository should have set up all these requirements
so in this situation you should be able to skip this section. so in this situation you should be able to skip this section.
Solaar needs a reasonably new kernel (5.2+ should work fine and recent CentOS distributions are likely to work), Solaar needs a reasonably new kernel (5.2+ should work fine),
with kernel modules `hid-logitech-dj` with kernel modules `hid-logitech-dj`
and `hid-logitech-hidpp` loaded. Also, the `udev` package must be installed and `hid-logitech-hidpp` loaded. Also, the `udev` package must be installed
and its daemon running. If you have a recent Linux distribution, you are and its daemon running. If you have a recent Linux distribution, you are
@ -72,9 +72,9 @@ Do not run Solaar as root, you may encounter problems with X11 integration and w
## Installing Solaar Using Pip ## Installing Solaar Using Pip
Python programs are usually installed using [pip][pip]. Python programs are usually installed using [pip][pip].
The pip instructions for solaar are in `setup.py`, the standard place to put such instructions. The pip instructions for Solaar are in `setup.py`, the standard place to put such instructions.
To install solaar for yourself only run `pip install --user .` from the solaar directory. To install Solaar for yourself only run `pip install --user .` from the solaar directory.
This tells pip to install into your `.local` directory, but does not install Solaar's udev rule. This tells pip to install into your `.local` directory, but does not install Solaar's udev rule.
(See above for installing the udev rule.) (See above for installing the udev rule.)
Once the udev rule has been installed you can then run Solaar as `~/.local/bin/solaar`. Once the udev rule has been installed you can then run Solaar as `~/.local/bin/solaar`.