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

docs: add information on key reprogramming

This commit is contained in:
Peter F. Patel-Schneider 2020-06-13 10:39:40 -04:00
parent 922414ae04
commit a4bf1da6f9
2 changed files with 23 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

BIN
docs/Solaar-main-window-button-actions.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 94 KiB

23
docs/usage.md
View File

@ -46,6 +46,8 @@ Clicking on "About Solaar" pops up a window with information on Solaar.
Clicking on the lightbulb (or similar icon) displays detailed information
about the selected receiver or device (mostly only useful for debugging).
### Pairing and unpairing devices
When a receiver is selected in the main window you can pair a new device by
clicking on the "Pair new device" button.
Then turn on the device and it should pair with the receiver if that is possible.
@ -64,6 +66,8 @@ When a device is selected you can unpair the device if your receiver supports
unpairing. To unpair the device, just click on the "Unpair" button and
confirm in the window that pops up.
### Viewing and changing device settings
When a device is selected you can see the approximate battery level of the
device, if that is reported by the device, and the status of the link
between the device and its receiver.
@ -80,6 +84,25 @@ but it still can be unpaired if its receiver allows unpairing.
![Solaar-main-window-offline](Solaar-main-window-offline.png)
#### Reprogramming key and button actions
For many devices Solaar can reprogram some of their keys or buttons to
perform a different action. (This actually changes the information that the
device sends when the key or button is activated.) Only some keys on some
devices can be reprogrammed and they can only be reprogrammed to a limited
number of actions. The reprogramming is done in Solaar by selecting a key
or button in the left-hand box on the ``Action'' setting line and then
selecting the action to be performed in the right-hand box. The default
action is always the shown first in the list. If the key or button has not
been reprogrammed the action box will be blank. As with all settings,
Solaar will remembers past action settings and restore them on the device
from then on.
![Solaar-main-window-actions](Solaar-main-window-button-actions.png)
The names of the keys, buttons, and actions are mostly taken from Logitech
documentation and may not be completely obvious.
## Solaar command line interface