Solaar/docs
Ken Sanislo 38b5665e51 Add support for the G560 Gaming Speaker and speaker devices generally
Recognize all HID++ 2.0 device types: the x0005 DeviceName type table
stopped at receiver (7), so newer types resolved to no kind at all.
Add the remaining official types (the G560 reports 14 = speaker) with
matching HID++ 1.0 compatibility values, and themed icons for
speaker/microphone/webcam.

Name LED zone locations by device kind: the wire location codes are
physical-zone handles whose meaning depends on the device kind — the
existing table (Primary/Logo/Left Side/Right Side) matches mice and
keyboards.  On speakers, codes 1-4 denote the left front, right
front, left rear and right rear lamps.  Setting names derive from the
numeric code and are unchanged, so existing configurations keep
working.

Add the Audio Visualizer LED effect (0x07), the G560's factory
default: pulses lamp brightness with the audio signal.  Wire layout
(hardware-derived): control byte at offset 0 (0 = pulse a fixed
color, 1 = self-cycle hue), RGB at 1-3, BE16 period in ms at 5-6.
Control values >= 2 select unmapped non-pulsing sub-modes and are not
exposed.  The effect has no working intensity parameter; overall
brightness is governed by the separate BRIGHTNESS CONTROL (0x8040)
feature.  Without a param table the effect displayed as Unknown(0x07)
and saved settings mis-split the period across the Cycle layout.

Strip the request echo from LED zone effect reads: GetEffect (0x8070
fn 0xE0) replies with the zone index echoed ahead of the effect slot
and parameters, but the reply was parsed as if it began with the
slot, shifting every readback one byte (only accidentally right when
the zone index happened to match the slot).  HeteroValidator gains a
read_skip_byte_count option.

Repaint saved zone effects when LED Control is re-enabled: the
firmware starts a SW-control session blank, so without this the claim
looks like it did nothing (mirrors RGBControl on 0x8071).

All changes verified against a live G560 (046D:0A78); device scan
included.
2026-07-16 23:06:34 -07:00
..
devices Add support for the G560 Gaming Speaker and speaker devices generally 2026-07-16 23:06:34 -07:00
img docs: Use mkdocs for public documentation (#2527) 2024-07-01 08:03:50 -04:00
screenshots docs: Move screenshots into dedicated folder 2024-05-16 15:55:44 -04:00
.gitignore pre-commit: initial fix 2020-07-07 15:11:15 +01:00
20121210110342697.pdf new UI mock-up from Julien Gascard 2012-12-12 21:45:37 +02:00
LICENSE.txt docs: update files shown in documentation 2025-10-23 09:28:52 -04:00
PRO_X2_SUPERSTRIKE_CLI.md device: Add PRO X 2 Superstrike mouse support with HITS tuning settings (#3132) 2026-04-12 09:53:47 -04:00
README.text docs: update files shown in documentation 2025-10-23 09:28:52 -04:00
capabilities.md docs: document haptic capability 2026-04-18 16:31:17 -04:00
debian.md cleanup and lint the docs 2020-08-02 11:25:00 -04:00
devices.md docs: mention Centurion protocol in documentation 2026-04-14 12:31:33 -04:00
features.md device: Add PRO X 2 Superstrike mouse support with HITS tuning settings (#3132) 2026-04-12 09:53:47 -04:00
hidpp-documentation.txt docs: remove logitech files and outdated information; update supported features 2020-07-11 15:36:49 -04:00
i18n.md po: add Irish translation (#3256) 2026-06-11 15:50:43 -04:00
implementation.md docs: improve documentation on onboard profiles 2025-03-29 09:22:59 -04:00
index.md docs: mention Centurion protocol in documentation 2026-04-18 16:31:17 -04:00
installation.md docs: document change to use uinput only 2026-03-08 20:58:43 -04:00
issues.md release 1.1.20rc2 2026-05-24 10:14:45 -04:00
rules.md docs: document change to use uinput only 2026-03-08 20:58:43 -04:00
uninstallation.md docs: give uninstallation file correct name 2025-09-08 13:28:39 -04:00
usage.md docs: improve documentation for cli actions 2024-08-23 20:03:54 -04:00
usb.ids.txt docs: update the USB IDs list 2019-12-29 14:46:59 +00:00

README.text

# Documentation Readme

This project's documentation is hosted using GitHub pages, which serves static pages using Jekyll.
[Please refer to the official documentation for instructions for how to build the site locally.](https://help.github.com/articles/setting-up-your-github-pages-site-locally-with-jekyll/)