A four-axis audit found no HIGH/MEDIUM issues. This addresses the
remaining low-risk items and protects the release path:
- ci: add cargo test + clippy -D warnings gate on master/tags
- ci: reject malformed version tags before the pkgver sed substitution
- fix: move the shipped waybar wrapper's cache/lock to $XDG_RUNTIME_DIR
(mode-700, no cross-user symlink) instead of predictable /tmp paths
- refactor: find_card() returns the open ALSA mixer, dropping a second
open; collapse two if-let blocks into edition-2024 let-chains
- docs: record in DECISIONS.md why the audit's "dead code" stays (it
mirrors the Bragi spec) and why the 5ms HID sleep is left as-is
Bump 0.1.4 -> 0.1.5: the shipped waybar script changes behavior.
The ALSA Sidetone control exposes a playback switch separate from the
volume. Setting only the volume left the switch off, so sidetone stayed
muted regardless of the level. set_level now toggles the switch (level 0
turns it off), and get_level reports 0 when the switch is off instead of
a stale volume reading.
led accepted any u16 and main.rs clamped to 0..=1000 with no feedback,
inconsistent with sidetone which rejects out-of-range at parse time.
Add a clap range validator (0..=1000) and drop the silent clamp, so
invalid input now fails loudly.
Further quality-audit follow-ups:
- remove dead BragiDevice::open() (no caller; binary uses open_with_verbose)
- add tests: led range validation, format_battery for all status
variants, waybar "unknown" class
Bump 0.1.2 -> 0.1.3.
Sync Cargo.toml to 0.1.2 and bring PKGBUILD up to date (was stale at
0.1.0): pin the git source to the release tag for reproducible builds
and install the LICENSE file.
Add MIT LICENSE file (Cargo.toml already declares MIT). Record in
DECISIONS.md that the open-source publish/rename plan is dropped: the
tool is for personal use, distributed as an Arch package via the private
moonarch repo and used primarily as a Waybar widget.
Translate docs/bragi-protocol.md from German to English ahead of
open-source publication. Drop the local reference path and note
additional Bragi devices (HS65, Virtuoso SE).
PLAN.md: 5-phase plan to publish as a multi-protocol headset tool
(rename away from Corsair trademark, abstract device layer, port
additional protocols, publish, upstream to HeadsetControl).
DECISIONS.md: rationale for GPLv3 relicense, naming constraints, and
the multi-protocol architecture.
main.rs declared its own module tree (mod bragi, cli, ...) while lib.rs
re-exported the same modules. The binary recompiled everything without
using the library, producing 9 spurious dead-code warnings for items
that are actually exercised by the integration tests via the library.
Import from the corsairctl library instead. No functional change;
eliminates all 9 warnings.
Tooltip now shows "HS80: 42% — Discharging | Sidetone: 10/23" when
the ALSA sidetone control is available. Falls back gracefully to
battery-only tooltip when sidetone cannot be read.
Bump version to 0.1.1.
Fallback-JSON wenn corsairctl fehlschlägt oder Cache leer ist.
flock -w 5 statt -n damit der zweite Prozess wartet statt
sofort aufzugeben. Atomares mv statt direktem Schreiben in Cache.
Waybar startet pro Monitor eine eigene corsairctl-Instanz.
Mehrere Prozesse auf demselben HID-Gerät verursachen Response-Mixups.
Der Wrapper cached den JSON-Output für 10s und nutzt flock
damit nur ein Prozess gleichzeitig das Gerät anspricht.
Der HID-Puffer kann veraltete Antworten von vorherigen Queries
enthalten. Flush vor jedem send_recv stellt sicher, dass wir
die Antwort auf unsere aktuelle Anfrage lesen.
Komplett ohne Sleep kam es sporadisch zu vertauschten Antworten
(267% Batterie = PID-Response statt Battery-Response). 5ms reicht
als Verarbeitungszeit für das Gerät, ist aber 10x schneller als
die ursprünglichen 50ms aus der Python-Referenz.
Das Default-Feature (linux-static-hidraw) linkt statisch gegen
gebundelte hidapi-Quellen. Arch stellt libhidapi-hidraw.so als
Shared Library bereit — linux-shared-hidraw linkt dagegen.
- Sleep vor HID-Reads entfernt — read_timeout reicht als
Synchronisation, spart ~300ms pro Aufruf
- udev-Regel: MODE 0660 + GROUP plugdev statt world-writable 0666
- Eigener CorsairError::SidetoneNotFound für fehlende ALSA-Controls
- Response-Validierung vorbereitet (parse_response_validated),
Korrelation noch deaktiviert da Response-Format andere Endpoint-IDs
nutzt als das Request-Format (0x00/0x01 vs 0x08/0x09)
- Protokoll-Doku zum Response-Format korrigiert
- 18 neue Tests für output.rs (Waybar-JSON Formatierung + Grenzwerte)
Byte-Zuordnung am echten HS80 verifiziert (Kabel ein/aus):
0x01 = Charging, 0x02 = Discharging, 0x03 = Low, 0x04 = Full
Weicht vom ckb-next-Mapping ab. Verbose-Flag zeigt jetzt auch
Property-Queries für weitere Diagnose.
- PID-Filter in find_and_open(), damit nicht die Harpoon-Maus statt
dem HS80 geöffnet wird
- ALSA Sidetone: Card-Suche über Sidetone-Control statt Kartenname
(war abgeschnitten zu "Gamin")
- Verbose-Flag (-v) für Debug-Output der Init-Sequenz
nevaforget