Changelog

All notable changes to this project will be documented in this file.

The format is based on Keep a Changelog, and this project adheres to Semantic Versioning.

Unreleased

1.3.1 (2026-06-25)

Fixed

The Home dashboard metric cards now lay out responsively and no longer compress their icons when the value text is long. Metric styling moved from inline Tailwind utilities into dedicated CSS classes (.metric-card / .metric-body / .metric-icon / .metric-copy), the metric grid uses auto-fit columns, and the hardware panel corners are aligned to rounded-2xl.

Changed

CI and release builds now pin the macOS runner to macos-15 instead of the floating macos-latest label, which migrates to macOS 26 from 2026-06-15 (actions/runner-images#14167). Release builds stay reproducible, and the bundle/signing/notarization step conditionals were decoupled from the exact label (startsWith(matrix.platform, 'macos')) so the pinned version can be bumped without touching every gate.

1.3.0 (2026-06-22)

Fixed

Serial frame watch-log entries are now throttled to at most one per second. The firmware streams frames continuously and the buffered serial backlog is drained in a burst on connect, which previously flooded the watch log with hundreds of identical Frame serial recebido / Slideres elegiveis para aplicacao entries within a few milliseconds. Audio application is unaffected — only logging is sampled.
The firmware handshake is now retried (up to 5 times, every 2 s) while no handshake has been received. The initial HELLO? could be lost to the DTR auto-reset / bootloader boot noise, leaving the app stuck on “Aguardando handshake” even though frames were streaming normally.

Changed

The release workflow now gates every build and publish job on the full CI workflow (reused via workflow_call), including the Windows/macOS native-audio-smoke job. This stops a tag from becoming a release with a broken platform build — the cause of the v1.2.2 → v1.2.3 hotfix, where the Windows compile error was only detected by CI after the tag was pushed
The GitHub Release body is now the matching CHANGELOG.md section, extracted deterministically and published verbatim (with a download-verification footer)
Dropped the duplicated firmware host-parser test from the release pipeline; the firmware-host CI job already runs it via the ci-gate, so the release job only builds and uploads the artifact

Removed

Removed the AI-assisted changelog generation from the release pipeline (the prepare-release-notes job: GitHub Copilot CLI with a Codex fallback that committed and pushed a generated CHANGELOG.md back to main mid-release). Release notes are now hand-authored and reviewed in CHANGELOG.md — no machine-generated content, no release-time writes to main, and no COPILOT_PAT / OPENAI_API_KEY in the release path
Removed the archived legacy/ Python/GTK prototype and the docs/migration/ planning material, along with every reference to the legacy directory across root docs, the PT-BR mirror set, and the docs-site. The legacy P1:512 packet-format compatibility (a live protocol feature) is unaffected.

1.2.3 (2026-06-21)

Fixed

Fixed the Windows Rust build for the new mute control action by using the IAudioEndpointVolume::SetMute(bool, ...) wrapper directly instead of importing a non-exported Win32::Foundation::BOOL type

1.2.2 (2026-06-21)

Features

Completed Scrum 11 button/encoder support: profiles now accept controls bindings for mute, next and prev, and the shared serial parser understands prefixed EV button/encoder packets without changing existing slider frames
Firmware 0.5.1 can be compiled with IORUBA_NUM_BUTTONS / IORUBA_NUM_ENCODERS, reads digital controls with INPUT_PULLUP, debounce and encoder quadrature, and emits control events only after the desktop opts in with EVENTS ON
Desktop runtime resolves control events from the active profile and dispatches actions through Tauri: Linux supports mute via pactl and media next/previous via playerctl; Windows supports default-output mute; unsupported actions are reported in the watch log instead of breaking serial processing

Changed

Hardware setup documentation now covers optional button/encoder wiring, compile flags, control-event packets and profile controls examples in English and Portuguese

1.2.1 (2026-06-21)

Features

knob→audio apply latency is now instrumented: each batch apply is timed and a warning is logged to the watch log when it exceeds the budget (80 ms), with the elapsed time and target count — surfacing slow pactl/backend calls without flooding the log (Scrum 13)
Export session telemetry statistics to a file as JSON or CSV (Scrum 16): new buttons on the session-stats panel save a per-knob summary (samples, min/avg/max/last percent) via a save dialog, reusing the existing export flow. Pure sessionStatsToJson / sessionStatsToCsv formatters in @ioruba/shared and an export_session_stats Tauri command
Always-visible connection-health indicator in the sidebar (Scrum 18): a colour-coded status dot + label and a live signal-freshness readout (time since the last serial/demo frame, refreshed every second) as a latency proxy, aligned with .impeccable.md (“connection state must be impossible to miss”). Backed by a new lastFrameAt field in the store
Redesigned navigation: the sidebar is now organized into labelled groups (Operation / Monitoring / Adjustments) with finer-grained sections. Channels (live knobs) split out of the control panel, and a dedicated Hardware section was added
Settings split into three focused sidebar entries — Profiles, Editor and Advanced — each a full-width view instead of one dense two-column page (the ProfileWorkbench now takes a view prop)
New HardwarePanel surfaces the firmware handshake end to end — board, MCU, ADC resolution (10/12-bit), protocol compatibility, knob count and per-knob calibration — with a clear empty state when no controller is connected (Scrum 18: hardware diagnostics panel)
ESP32 and RP2040/Pico toolchains are now built in CI (Scrum 11): a dedicated firmware-arch job installs each 12-bit core and compiles the firmware, validating the adcBits=12 path end to end on real toolchains
Per-board analog-pin tables (Scrum 11): the firmware no longer hard-codes {A0, A1, A2}. Pins are selected at compile time per board (Nano A0..A7, Uno A0..A5, Mega2560 A0..A15, Leonardo/Micro A0..A11, ESP32 ADC1, RP2040/Pico A0..A2) and the first IORUBA_NUM_KNOBS are used. This enables >6 knobs on the Mega (up to 16); a static_assert rejects a knob count that exceeds the board’s analog channels
CI compiles the firmware across an FQBN matrix (Nano, Uno, Mega2560, Leonardo, Micro); a dedicated host job runs the config-parser tests in both the default (3 knobs / 10-bit) and wide (8 knobs / 12-bit) configurations. npm run firmware:compile:matrix and npm run firmware:test:wide reproduce these locally
Supported-boards matrix (MCU, ADC bits, channels, max knobs, pin order) documented in docs/guides/hardware-setup.md
ADC resolution is now generic across boards (Scrum 11 keystone). The firmware handshake reports mcu= and adcBits= (additive protocol v2 fields; older hosts ignore them), and @ioruba/shared normalizes raw readings against the active adcBits instead of the hard-coded 10-bit 1023. 12-bit boards (ESP32, RP2040/Pico → 0..4095) now map to the correct percent
Firmware derives ADC_MAX from IORUBA_ADC_BITS (auto-set to 12 on ESP32/RP2040, 10 on AVR; overridable by define) and reports the detected MCU name (ATmega328P/ATmega2560/ATmega32U4/RP2040/ESP32)
Desktop overview panel shows a Hardware tile with the detected board, MCU, ADC bit depth and protocol version

Fixed

Firmware BOARD_NAME constant renamed to IORUBA_BOARD_NAME to avoid a collision with the BOARD_NAME macro defined by the arduino-pico (RP2040) core, which broke RP2040 builds

Security

Updated transitive development dependency undici from 7.25.0 to 7.28.0, resolving CVE-2026-9697 and CVE-2026-9678 reported by Dependabot

Changed

@ioruba/shared mixer/runtime functions take an optional adcMax argument (defaults to 10-bit for backward compatibility); the serial frame parser accepts raw values up to 16-bit, leaving per-board normalization to the runtime via adcBits

1.2.0 (2026-06-17)

Features

Cross-platform one-line installer: scripts/install.sh (Linux/macOS) and scripts/install.ps1 (Windows) auto-detect OS and architecture, download the matching asset from the latest release (or a pinned --version/-Version), verify it against SHA256SUMS.txt, and install it (rootless AppImage by default on Linux, .app into /Applications on macOS, MSI/NSIS on Windows)
Session telemetry statistics: per-knob sample count, min/avg/max and current percent that persist for the whole session (independent of the sliding chart window), shown in a new SessionStatsPanel on the telemetry tab with a reset action
updateSessionStats / createSessionStats / knobAveragePercent pure reducers in @ioruba/shared (O(points), no unbounded growth); session aggregates reset automatically whenever telemetry is cleared (new connection, demo toggle, profile reset)
Windows Core Audio backend (audio/windows.rs) using WASAPI via windows crate for default output (master) volume control
macOS Core Audio backend (audio/macos.rs) using the system CoreAudio framework (hand-rolled FFI, no extra crate) for default output (master) volume control, with per-channel scalar fallback
Application/source/sink targets return explicit unavailable outcome on Windows and macOS instead of pretending to work
AppImage validation script (scripts/validate-appimage.sh) with extraction, structure, and optional launch smoke test under Xvfb
CI integration: Linux release job runs scripts/validate-appimage.sh --require-launch on Ubuntu 22.04 before publishing assets
CI: native-audio-smoke matrix job compiles, lints, and links the Rust backend on macos-latest and windows-latest, validating the cfg-gated CoreAudio/WASAPI code that the Linux gate never builds
AudioBackendBanner distinguishes platform-unsupported (Windows/macOS) from missing-pactl (Linux) with tailored fallback UX
Test coverage for audio backend banner fallback behavior (audio-backend-banner.test.tsx)

Changed

Platform matrix: Windows and macOS now “Partial” (master/default-output volume only via Core Audio)
Updated docs (README, QUICKSTART, TESTING) to reflect Windows and macOS partial audio support

Fixed

Onboarding checklist marks audio as ready for any functional backend (Windows/macOS Core Audio), not only the Linux pactl backend
Completed the AudioInventory.backend type union with the "macos" member the Rust backend already serializes
Collapsed identical severity branches in audio/windows.rs (clippy if_same_then_else), surfaced for the first time by the new Windows CI smoke job

1.1.0 (2026-06-13)

Features

ready-made profile presets for streaming, calls, and music, applied from the profile workbench
import and export profiles as JSON files (export_profile / import_profile Tauri commands with save/open dialogs and atomic write), with validation and id/name de-duplication on import
first-run onboarding checklist on the home tab deriving live steps from runtime state (controller connected, serial port found, audio backend available); dismissal is persisted
firmware protocol-version validation: SUPPORTED_PROTOCOL_VERSION and a protocolSupported flag warn when a connected firmware speaks a different protocol
boot, serial-connection, and inventory-refresh timings recorded in the watch log via performance.now()
firmware now emits ERR command-too-long / ERR config-rejected and skips redundant EEPROM writes on unchanged CONFIG

Performance

pushTelemetry rewritten to a single allocation per serial frame (was merge-and-slice)
telemetry chart lazy-loaded (recharts kept out of the initial bundle until the telemetry tab opens), memoized series, and React.memo renders
short-TTL cache for the pactl inventory snapshot shared between listing and applying volumes
watch-log append is now O(1) amortized instead of a full read-modify-write per event
knob bars honor the configured transitionDurationMs (and prefers-reduced-motion) instead of a fixed duration

Bug Fixes

fixed clippy::needless_borrow so the -D warnings gate compiles
fixed undefined behavior passing a possibly-negative char to isspace in firmware
partial pactl failures are surfaced in inventory diagnostics instead of returning an empty inventory

Security

restrictive Content-Security-Policy on the webview (was null)
narrowed the dialog capability to allow-save + allow-open (was the full default)
persist-credentials: false on every read-only checkout in CI
pinned the CodeQL action to a fixed v4.36.2 SHA and stopped cancelling scheduled scans

Changed

hardened persisted-state writes: dedicated lock, unique temp suffix, and fsync before/after rename
apply_slider_targets_batch runs async via spawn_blocking so blocking pactl calls leave the command thread
CI gains cargo fmt/clippy -D warnings, a firmware host-test for the CONFIG parser, a glib-vendor staleness gate, and SHA-pinned actions
added a product roadmap (docs/roadmap.md) with a multi-controller study and post-migration backlog

1.0.0 (2026-06-12)

Changed

refreshed frontend, Tauri CLI, Rust, and GitHub Actions dependencies
grouped compatible Dependabot updates to reduce fragmented dependency PRs

Removed

removed the unreliable automated documentation update workflow
removed the obsolete vendored PHF generator patch after the dependency graph moved to PHF 0.13

0.6.12 (2026-05-22)

Features

added schemaVersion field to PersistedState for future-safe migration tracking
atomic state write with .tmp + rename, eliminating partial-write corruption
automatic backup of persisted state when schemaVersion changes (named ioruba-state.backup.v{ver}.{timestamp}.json)
export watch log via save-file dialog (tauri-plugin-dialog), writing JSON Lines; Rust command export_watch_log returns path and entry count
Export button in the Watch Log panel with inline result/cancellation message and accessible aria-live status
JSON parse errors in profile import now include line and column numbers

Bug Fixes

load_watch_log_entries now reports malformed lines as a structured Warning in the watch log instead of silently discarding them
allowed non-Linux audio module code paths to compile without dead-code warnings

Changed

updated docs-site home page (index.md), added Getting Started guide, quick-reference sidebar card, and new deck cards on the home layout

0.6.11 (2026-05-22)

Changed

synchronized desktop package metadata for the 0.6.11 release
updated release jobs to build artifacts from the target release tag and keep updater JSON disabled until updater signing is configured

Bug Fixes

split the macOS build into signed and unsigned steps to avoid codesign failures
patched tauri.conf.json to use ad-hoc macOS signing when no certificate secret is available
allowed downstream release jobs to run after partial matrix failures
handled rebase failures and tightened job conditions for desktop builds

0.6.10 (2026-05-22)

Features

added AudioBackendBanner for missing pactl detection
classified serial open errors with actionable messages in the runtime observability flow
configured Windows and macOS code signing and notarization
closed Scrum 07 release tasks (provenance, checksums, tray docs, recovery guide)

Bug Fixes

hardened CI workflow correctness and safety
fixed CI step conditions to avoid Unrecognized named-value: secrets errors

0.6.9 (2026-05-22)

Changed

bumped all Dependabot updates (#40-#49)
updated the changelog for v0.6.8

0.6.8 (2026-05-07)

Changed

hardened the docs auto-update workflow in CI
synchronized repository documentation and refreshed the repository screenshot
refreshed desktop dependencies across Tauri and frontend tooling (@tauri-apps/api, @tauri-apps/cli, tauri, tauri-build, @vitejs/plugin-react, @tailwindcss/vite, vitest, jsdom, lucide-react)

Bug Fixes

removed a duplicate Sessão key in TEXT_MAP

Security

updated the Tauri security patch and bumped the rand dependency line in the desktop stack

0.6.7 (2026-04-22)

Bug Fixes

skipped the macOS dmg bundle in CI release builds to avoid macOS GUI-dependent bundling failures and keep macOS artifacts publishable

Changed

updated changelog entries for the v0.6.7 release

0.6.6 (2026-04-22)

Changed

synchronized repository documentation

Features

added an automated documentation update workflow

0.6.4 (2026-04-21)

Bug Fixes

fixed arch-pkgbuild job computing sha256sum from a local git archive tarball instead of the actual GitHub-generated tarball; the two differ in metadata so hashes never matched, causing makepkg verification to fail on install; replaced with a curl download of the real archive/refs/tags/vN.N.N.tar.gz before hashing

0.6.3 (2026-04-21)

Bug Fixes

fixed aur-publish job failing to download .SRCINFO and .SRCINFO-bin assets: GitHub silently renames dot-prefixed files on upload (.SRCINFO → default.SRCINFO); release assets are now uploaded as SRCINFO/SRCINFO-bin (no leading dot) and renamed back to .SRCINFO after download in the aur-publish step

0.6.2 (2026-04-21)

Bug Fixes

fixed PKGBUILD-bin generation: nested <<'LAUNCHER' heredoc inside <<EOF caused YAML indentation stripping to break the heredoc delimiter, producing a syntactically invalid PKGBUILD; replaced with run-appimage-compat.sh fetched as a source entry and a two-line printf wrapper
fixed .SRCINFO source lines using literal ${pkgver} instead of the expanded version number
fixed .SRCINFO and .SRCINFO-bin missing provides, conflicts, and replaces fields
fixed PKGBUILD-bin missing provides=ioruba, conflicts=ioruba-desktop-bin, and replaces=ioruba
added missing libayatana-appindicator3-dev to CI Linux dependency list, preventing silent build failures

Features

added aur-publish job to the release workflow: automatically clones ioruba-desktop and ioruba-desktop-bin AUR repos and pushes updated PKGBUILDs after each release, eliminating manual AUR publishing

0.6.1 (2026-04-20)

Changed

split the desktop release workflow so the AppImage upload runs in its own job, isolating it from the other installers
added a timeout guard to the desktop bundle jobs to avoid indefinite hangs during release publication

Bug Fixes

kept the AppImage publish step from blocking the deb/rpm/Windows/macOS release assets

0.6.0 (2026-04-20)

Changed

modernized the docs site, navigation, and page-generation workflow for GitHub Pages
refreshed the Portuguese documentation set to align with the GitHub migration and README updates
added Dependabot coverage for the docs and workflow surface
refreshed TypeScript, Vitest, and GitHub Actions dependencies after Dependabot resolution

Features

added PT-BR documentation translations across the root docs, guides, migration notes, and support materials
added an AppImage compatibility script and updated the desktop launcher and release flow

Bug Fixes

allowed the repository smoke workflow to include the scripts directory
stabilized GitHub Actions usage across CI, CodeQL, and Pages deployment

0.5.0 (2026-04-20)

Changed

synchronized the workspace versioning and release metadata for the 0.5.0 cut
refreshed the documentation set for the current desktop, firmware, testing, and migration flow

Features

added PT-BR/EN translation helpers, a translation guide, and accessibility shell coverage for the desktop app
expanded the release workflow to ship AppImage and Arch packaging metadata alongside the existing desktop and firmware artifacts

Bug Fixes

stabilized CodeQL workflow configuration and Dependabot update resolution
improved the Linux packaging dependency path for the current release flow

0.4.0 (2026-04-19)

Changed

refreshed the repository documentation to match the active Tauri desktop stack, Linux-first audio support, and current hardware workflow
added the Arduino Nano Type-C circuit diagram and updated the Nano, hardware, testing, and release docs for the new firmware handshake and Arch smoke-test flow

Features

persist knob calibration and firmware tuning in EEPROM
add tray/background handling and launch-on-login support on Linux
expose firmware thresholds, deadzone, smoothing, and per-knob calibration in the desktop profile workbench
expand the serial handshake to report controller config with protocol v2

Bug Fixes

keep the release and CI workflows pinned to current GitHub Actions versions
preserve legacy P1:512 packets while adding controller config support to the serial parser
align Linux desktop packaging metadata with tray and indicator requirements

Security

upgraded vite from 7.3.1 to 7.3.2 in the desktop toolchain
resolved GitHub/Dependabot advisories GHSA-p9ff-h696-f583, GHSA-v2wj-q39q-566r, and GHSA-4w7w-66w2-5vf9
confirmed the npm toolchain reports 0 open audit vulnerabilities after the upgrade
documented that the remaining Rust audit findings are upstream/transitive warnings in the current Tauri + GTK3 Linux stack, not newly introduced project-level advisories

0.3.0 (2026-03-20)

Features

refresh the desktop control deck UI and live watch workflow
persist watch logs and improve serial runtime diagnostics

Bug Fixes

keep Arduino serial sessions stable during idle periods and port discovery
backport the Linux glib fix for GHSA-wrw7-89jp-8q8g

0.2.3 (2026-03-19)

Bug Fixes

preserve docker release artifact permissions (2815390)

0.2.2 (2026-03-19)

Bug Fixes

ship installable release artifacts (d474351)

0.2.1 (2026-03-19)

Bug Fixes

pass tag name when uploading manual release assets (08b7291)
support chained and manual release artifact runs (42e42f8)

0.2.0 (2026-03-19)

Features

add Arduino Nano support with 3 potentiometers (d04715b)
implement serial communication with Arduino (2739438)
polish runtime docs and release surface (66138ba)
refresh nano controller app and docs (89d854d)
ship haskell runtime and modernize repo surface (dd34cae)

Bug Fixes

keep ci focused on actionable checks (cdab0aa)
keep release-please versioning on package yaml (ae44855)
make CI fail faster and pass HLint (bcae458)
make metadata sync skip cleanly without token (d59f445)
make release-please update generic version files (d7c871d)
stabilize automation and hlint compliance (0c7c114)

0.1.0 - 2025-12-22

Added

Initial tagged baseline before the current Haskell-first productization pass