noahandClaude Opus 5.5 d22ee79159
source / check (pull_request) Skipped
verify / verify (pull_request) Successful in 7m18s
verify / verify-windows (pull_request) Successful in 4m48s
Keep every coloured text readable in light and dark themes
Checked in real system dark and light mode on macOS (SkyLight theme
switch on the M1, restored afterwards), Windows 11 (the app-mode
setting, run on the VM's desktop) and Linux (Adwaita and Adwaita:dark),
measuring each screenshot's text against its background with the WCAG
contrast formula.

The app's own colours fell short on every platform. The fixed firmware
hues were 2.6 to 3.9:1 (LuxOS gold and ePIC blue on light, Alkane navy,
Braiins purple and Bixbit red on dark). The hashrate greens and
temperature purples were about 4:1, and the play/pause icons about 2:1
on light buttons.

- readable()/readable_at(): nudge a colour toward black (light theme)
  or white (dark theme), keeping its hue, until it reaches 4.5:1 for
  text (3:1 for icons) against every given background.
- palette(): green/amber/red/accent/label are made readable against the
  window, the zebra row and the KPI card; Palette::text() guards every
  computed cell colour (ratio and temperature blends, firmware hues).
- Media button icons: at least 3:1 against the theme's button face.
- macOS snapshot (wx-rs patch 0011): capture the window's frame view.
  The content view alone left unpainted areas transparent, which read
  as a white toolbar strip in dark mode. On screen the area was always
  the dark window colour.

After the change, no app-coloured text is below 4.5:1 in any of the
six theme/platform combinations. What the checker still flags is theme
chrome (grid lines, GTK header labels, button outlines, the zoom
slider) and anti-aliasing on thin fonts.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01BdKQBRg6YCM1XXQCTnD5GF
2026-11-04 13:40:10 -06:00
2026-09-23 08:05:11 -06:00
2026-09-23 08:05:11 -06:00

Alkane Toolkit

CI tests coverage bench bench coverage lines of code code quality dependencies license

The badges link to the project site: the manual, the code-quality dashboard (how the grade is set, coverage by crate and file) and the benchmark history.

Desktop miner discovery and monitoring. The Rust GUI uses wxWidgets through a patched wx-rs bridge. In-app image flashing is disabled while that path is reworked.

Run locally

scripts/build-wx-linux.sh
scripts/build-gui-linux.sh
ALKANE_FAKE_SCAN=1 ~/.cache/alkane-tk-target/release/alkane-toolkit

The first command builds wxWidgets 3.3.3 once. Linux needs GTK 3. Fake scan uses offline fixtures and does not contact hardware.

Windows 10/11 builds are cross-compiled on Linux (scripts/build-wx-windows.sh, then scripts/build-gui-windows.sh) and attached to every release as a self-contained alkane-toolkit.exe; see docs/windows.md. macOS builds run on a Mac (scripts/build-wx-macos.sh, then scripts/build-gui-macos.sh) and produce one universal app for Apple Silicon and Intel, macOS 11 or later; see docs/macos.md.

Current scope

  • Discover miners by CIDR or IP range with vendored asic-rs.
  • Show model, firmware, health, hashrate, temperatures, fans, PSU, and workers.
  • Filter and sort the desktop table; inspect probes with miner_probe.
  • Use controls supported by the selected firmware and restore supported aftermarket firmware to stock.

Discovery is read-only. Control and restore actions change miners. Check the selected devices before applying them.

Development

WX_RS_WXCONFIG="$HOME/.cache/wx-3.3.3-linux/bin/wx-config" \
  CARGO_TARGET_DIR="$HOME/.cache/alkane-tk-target" \
  cargo test -p alkane-gui --offline

Keep build output off the source share. main runs full CI and publishes qualifying releases; next builds -rc candidates. Badges measure host code, not installation support. See the benchmark history.

Firmware safety

Installation must follow the SDK install rules: use the exact board's packer and boot-switch procedure, verify through an independent channel, and never write bootloader or secure regions.

License

MIT. Vendored dependencies keep their own terms.

S
Description
Rust + wxWidgets cross-platform toolkit: install stock or alkaneOS on any ASIC miner
Readme MIT
92 MiB
v0.115.0
Latest
2026-11-17 00:03:11 -07:00
Languages
Rust 87.8%
Python 8.5%
Shell 3.5%
Dockerfile 0.2%