Skip to content

Firmware v2.2.0.0

Latest

Choose a tag to compare

@github-actions github-actions released this 26 Jun 18:07
· 14 commits to main since this release
c31edf4

FaultyCat v2.2.0.0

Firmware (RP2040 UF2) and host CLI/TUI built from tag
v2.2.0.0. The host package on this release
only talks to firmware built from this same tag —
re-flash the UF2 before upgrading the host package, or pass
--ignore-version-mismatch to bypass during development.

Highlights

Relevant commits since v2.1.0.1:

  • fix(host): recover CDC interface number on macOS (0252ab1)
  • ci(release): ship a Windows standalone .exe; symmetric entry points (75979ff)
  • ci(release): trim release surface — drop ELF + picotool, add Highlights (16eea92)
  • feat: fix pre-commit (3eed883)
  • ci(release): tag-driven release workflow + scripts/get_build.sh (8a55cea)
  • feat(host): CLI + TUI version surface; fix TUI quit deadlock (32723b0)
  • feat(host): version_check module + exact-match gate on every connect (dd5c5dc)
  • feat(fw): version-aware firmware — CMake-driven macros, PING+shell+banner (cf6d06b)
  • fix(ci): stabilize ruff isort, fix PyInstaller entry (7a7b6bb)
  • fix(ci): align Unity tests with current code, apply ruff auto-fix (5cad5a7)
  • feat(fw): Implement v3 core services and standardize C/C++ pointer style (006c862)
  • feat: Introduce code style and linting with pre-commit hooks and CI (637f099)
  • feat: Enhance README with v3 programming and documentation index (8d89639)
  • refactor: Archive legacy Python host tools and planning documents (1d7f2fc)
  • refactor: Remove legacy v2.x C and MicroPython firmware (a42131c)
  • refactor(flash.sh): Improve error handling and output formatting (6d98904)
  • feat(host): Add EXT_PULSE_NEG to Python protocols and TUI (e9108f8)
  • feat(firmware): Add EXT_PULSE_NEG trigger polarity (38a9d55)
  • fix(crowbar): PIO: Restore gate pin to SIO output on deinit (033afa2)
  • feat(host): CLI/Protocols: Set default trigger timeout to 60 seconds (c96a09a)
  • feat(host): TUI: Pass trigger timeout from forms to fire commands (4d80b69)
  • feat(host): TUI: Introduce configurable trigger timeout in modals (6a01018)
  • feat: Make Crowbar modal operations asynchronous via daemon threads (eb07bf5)
  • feat: Make EMFI modal operations asynchronous via daemon threads (fdd9b50)
  • feat: Offload Campaign sweep stop to a daemon thread (cd99163)
  • feat: Introduce CDC0 lock for EMFI client and use in polling loop (eb16d1c)
  • feat(swd_core): Implement SWD DP power-up sequence (c271bbb)
  • feat(tui): implement Scanner/SWD control modal (F11-0d) (547b78d)
  • refactor(tui): harden shutdown and modal quit logic (f91c7b5)
  • feat(cli): enhance 'scanner scan-swd' with interactive init (f15060b)
  • feat(host): add XDG config persistence module entry to docs (1f367ab)
  • feat(scanner): add parse_scan_swd_match utility and tests (48b2e16)
  • feat: Refactors SWD detection for bus-wide scanning (4018d59)
  • fix(Hw):C23_And_C24_Added (d570dca)
  • feat(F11-0c): Campaign control modal — full sweep params, no demo lock (9640656)
  • feat(F11-0b): Crowbar control modal + SharedSerial CDC1 race fix (135b32f)
  • fix(F11-0a-fix): integrate EMFI modal with EmfiClient surface (24b38b4)
  • feat(F11-0a): EMFI control modal + HV confirm + last-config persistence (876124f)
  • fix(F10-polish): TUI shadowed Textual App._workers attr (f5a784d)
  • feat(F10-6): host-py CI workflow + main + ruff cleanup (ae99355)
  • feat(F10-5): faultycmd.tui — Textual 4-panel dashboard (76b35c3)
  • feat(F10-4): faultycmd.cli — click command groups + Rich output (6c13ab3)
  • feat(F10-3): faultycmd.protocols.scanner — CDC2 text-shell wrapper (568213a)
  • feat(F10-2): faultycmd.protocols.{_base, emfi, crowbar, campaign} (8071889)
  • feat(F10-1): faultycmd-py skeleton + framing + USB enum (9bcf6bf)
  • feat(F9-5): tools/campaign_client.py reference client (6858e8b)
  • fix(F9-4): bump CROWBAR_PROTO_MAX_PAYLOAD + static reply buffers (516a0f1)
  • feat(F9-4): host_proto/campaign_proto + extend emfi/crowbar protos (6b4dab9)
  • feat(F9-3): campaign manager engine adapters + shell sub-shell (7aa9bcd)
  • feat(F9-2): services/campaign_manager core — sweep state machine (b360858)
  • fix(F9-1): wire swd_bus_lock into services/ + tests/ CMakeLists (938db61)
  • feat(F9-1): services/swd_bus_lock — service-layer SWD bus mutex (48d0669)
  • fix(F8-6): pinout_scanner stability check + shell mode-switch bleed (90a6ad6)
  • feat(F8-5): services/flashrom_serprog — serprog v1 + 4-pin SPI bitbang (1bd76c7)
  • feat(F8-4): services/buspirate_compat — BPv1 BBIO + OpenOCD JTAG (224caa0)
  • feat(F8-3): top-level menu shell on CDC2 + F8-4/F8-5 stubs (fcac659)
  • feat(F8-2): services/pinout_scanner — JTAGulator-style brute force (1ca26b8)
  • feat(F8-1): services/jtag_core — CPU bit-bang TAP + IDCODE chain (97f5d1f)
  • fix(F6-7): SWD DP layer — turnaround + dormant-to-SWD + TARGETSEL (54c7c8e)
  • fix(F6-7): correct SWD PIO program + add open-drain SWDIO emulation (25ca36f)
  • fix(F6-7): hal pio sideset bit_count must include the optional enable bit (5f5d559)
  • fix(F6-2): bound EVERY swd_phy FIFO spin, not just the read path (b6f64ba)
  • fix(F6-2): bound the spin in swd_phy_read_bits to recover from absent target (77ebae4)
  • fix(F6-5): drop CDC2 from usb_composite echo loop — owned by swd_shell (9ffe14e)
  • feat(F6-5): SWD shell on CDC2 + tools/swd_diag.py reference client (945e7d7)
  • feat(F6-4): swd_mem — MEM-AP read32/write32 (CSW + TAR + DRW + RDBUFF) (91c3130)
  • feat(F6-3): swd_dp — wire protocol from scratch (parity, ACK, R/W DP+AP) (790dcda)
  • feat(F6-2): swd_phy — debugprobe PIO bit-bang ported to runtime pins (1ec9965)
  • feat(F6-1): skeleton swd_core + scanner-header SWD pin defaults (87c00bd)
  • feat(F5-4): crowbar_proto on CDC1 + main integration (57fd52b)
  • feat(F5-3): crowbar_campaign — state machine + break-before-make hand-off (31208ab)
  • feat(F5-2): crowbar_pio — PIO trigger+delay+pulse on pio0/SM1, IRQ 1 (e7c3f3f)
  • feat(F5-1): skeleton crowbar service + crowbar_proto stubs (b26e4b8)
  • feat(F4-6): emfi_proto on CDC0 + main.c integration — closes F4 (e49a81c)
  • feat(F4-5): emfi_campaign state machine + 100ms HV invariant activated (c2f3258)
  • fix(F4-4): emfi_capture_init calls hal_adc_init for ordering independence (68a0315)
  • feat(F4-4): emfi_capture — 8 KB ADC DMA ring on GP29 + hal/adc FIFO/DREQ (2851a3b)
  • feat(F4-3): emfi_pio service + driver PIO attach — first GP14 PIO path (dd663ad)
  • feat(F4-2): lift hal/dma — claim/configure/ring/DREQ + 8 Unity cases (456bc52)
  • fix(F4-1): address code review — sideset surface, in_pin guard, missing tests (34bfdb5)
  • feat(F4-1): lift hal/pio — SM/program/FIFO/IRQ + host fake + 11 Unity cases (4e8ac97)
  • feat(F3-4): diag moves to CDC2 scanner — closes F3 (be517ce)
  • feat(F3-3): HID IF CMSIS-DAP v1 stub — endpoint budget 16/16 confirmed (1b1c398)
  • feat(F3-2): Vendor IF CMSIS-DAP v2 stub + MS OS 2.0 descriptors for WinUSB (b6cce17)
  • feat(usb): magic baud 1200 reboots into BOOTSEL, tools/bootsel.sh (7c530e6)
  • feat(F3-1): USB composite device — 4× CDC echo, VID:PID 1209:FA17 (aa9b865)
  • feat(F2b-4): drivers/emfi_pulse (CPU-timed) — closes F2b, SIGNED (69792ac)
  • feat(F2b-3): drivers/hv_charger + hal/pwm + docs/SAFETY.md — SIGNED (f450d43)
  • feat(F2b-2): drivers/voltage_mux — stub with #error (no HW mux on v2.x) (91d8632)
  • feat(F2b-1): drivers/crowbar_mosfet — LP/HP path selector with break-before-make (853b9d5)
  • feat(F2a-5): drivers/ext_trigger — external trigger in on GP8 — closes F2a (51dcd53)
  • feat(F2a-4): drivers/scanner_io — 8 channels GP0..GP7 (6a2ca5f)
  • feat(F2a-3): drivers/target_monitor + lift hal/adc stub (f500881)
  • feat(F2a-2): drivers/ui_buttons + USB-serial diag loop (fb457b3)
  • feat(F2a-1): drivers/ui_leds — 3 LEDs + HV hysteresis + board_v2.h (33891e1)
  • ci(F1): add host-tests job alongside the UF2 build (3512a82)
  • feat(F1): rewrite F0 blink on top of the HAL (a7ed586)
  • feat(F1): HAL gpio + time — portable API, RP2040 impl, native fakes, 10 unit tests (45f3ac9)
  • fix(v3): F0 blink on GP10 (real STATUS LED on v2.x) — NOT GP25 (2ca2068)
  • ci(v3): GitHub Action builds release UF2 on every push (88492bb)
  • feat: Removes unused comments (e2383e4)
  • feat: deleted debug lines (33b3563)
  • feat: fix Serial trigger (e4d448a)
  • feat: fix interactive_menú (716269e)
  • feat: files_modified, board_config.h (9b31fd5)
  • fix(hw): change switch orientation (ce88d10)
  • feat(hw):added_component_replacement (10c4584)
  • feat(Hw):Update_Labels (5d5a72f)
  • feat(Hw):Update_BOM (00eeb2f)
  • feat(Hw):Bom_Updated (2aa72bd)
  • fix(hw): move components (a4dec4b)
  • fix(hw): remove manuf# from P1 (daff7ae)
  • refactor(hw): change shape of labels on voltage selector (22dbad1)
  • fix(hw): move labels (f0ca877)
  • feat(hw): change selector switch (5d23938)
  • feat: delete dnp resistor (5f44971)

Flashing the firmware

  1. Hold the BOOTSEL button on the FaultyCat and plug it
    into USB. The board appears as a mass-storage volume
    named RPI-RP2.
  2. Drag faultycat_v2.2.0.0.uf2 onto that volume.
    The board reboots into the new firmware automatically
    and re-enumerates as 1209:fa17.

Verify with:

faultycmd info

The firmware row should show v2.2.0.0 (match).

Installing the host CLI/TUI

Windows — standalone .exe (no Python install needed)

Download faultycmd_v2.2.0.0.exe, drop it
wherever is convenient (a folder on PATH, your Desktop,
a project directory — anywhere), and run it. The .exe
bundles Python and every dependency.

From the same directory the .exe lives in (PowerShell
or cmd.exe), the .\ prefix is required to tell the
shell to run the local file instead of searching PATH:

.\faultycmd_v2.2.0.0.exe info
.\faultycmd_v2.2.0.0.exe tui

Easier: rename the file to something shorter
(e.g. faultycmd.exe), and the invocations become

.\faultycmd.exe info
.\faultycmd.exe tui

And if you put that renamed faultycmd.exe in a folder
that is already on your PATH, you can drop the .\
too and just type faultycmd info from anywhere.

Linux / macOS / Windows-with-Python — wheel or sdist

Python wheels follow PEP 440 and do NOT carry the v prefix:

pip install faultycmd-2.2.0.0-py3-none-any.whl
# or, from the source tarball:
pip install faultycmd-2.2.0.0.tar.gz

Artifacts

File Purpose
faultycat_v2.2.0.0.uf2 RP2040 firmware (BOOTSEL flashable)
faultycmd_v2.2.0.0.exe Windows standalone CLI/TUI (no Python needed)
faultycmd-2.2.0.0-py3-none-any.whl Host CLI/TUI wheel (Linux / macOS / Windows pip)
faultycmd-2.2.0.0.tar.gz Host source distribution

What's Changed

  • Fixes Windows USB Enumeration & Enhances Host Discovery by @HeikkiRadu in #22
  • tag-driven release flow — version parity gate, Windows .exe, draft GitHub Release by @HeikkiRadu in #24
  • Recover CDC interface number on macOS by @HeikkiRadu in #26
  • Firmware v3 — rewrite for FaultyCat v2.x hardware by @HeikkiRadu in #23

Full Changelog: v2.2...v2.2.0.0