Skip to content

About

Guided-capture toolkit for adding new handheld PCs to InputPlumber / Armada. First target: AYANEO Pocket ACE.

Topics

Resources

Stars

0 stars

Watchers

0 watching

Forks

Repository files navigation

InputPlumber Capture Suite (ipcap)

A guided-capture tool that helps you add InputPlumber support for a new device by prompting you to press each Steam-Deck-canonical button, then emitting the required CompositeDevice + CapabilityMap YAML files.

Status: early scaffold. First target device: AYANEO Pocket ACE (via Armada).

Why

InputPlumber's onboarding for a new device is entirely manual:

  1. Read /sys/firmware/devicetree/base/model (or DMI on x86).
  2. Enumerate every /dev/input/event* and /dev/hidraw*, guess which ones belong to the built-in gamepad.
  3. Press every button, watch evtest output, hand-copy the evdev codes.
  4. Hand-write two YAML files.

ipcap collapses steps 2–4 into a wizard.

Design at a glance

See RESEARCH.md for the full write-up. Short version:

  • ipcap.canonical — single source of truth for the Steam-Deck-canonical button/axis vocabulary (mirrored from InputPlumber's GamepadButton enum).
  • ipcap.discover — DMI + /sys/firmware/devicetree + /dev/input/event* + /dev/hidraw* enumeration.
  • ipcap.capture — evdev/hidraw event capture with a per-prompt timeout.
  • ipcap.mapper — session state: {canonical_name → observed (node, event_type, event_code, value_type)}.
  • ipcap.emit — pure function: mapper state → validated CompositeDevice.yaml + CapabilityMap.yaml.
  • ipcap.ui — PyQt6 wizard; deferred until headless core is stable.

Development environment

The core (canonical, discover, emit, YAML validation) runs anywhere Python 3.12 does. Live capture requires:

  • Linux with /dev/input/event* and the target gamepad plugged in.
  • python-evdev (built against kernel headers ≥ 6.5 for newest key codes).
  • Optional: python3-pyqt6 for the wizard UI.

On this Azure VM we develop and test the headless modules. Live capture and the UI wizard are exercised on the actual handheld (e.g. win5 or the Pocket ACE running Armada).

cd projects/inputplumber-suite
python3 -m venv .venv
. .venv/bin/activate
pip install -e '.[dev]'          # once pyproject exists
python -m pytest tests/           # everything except live-capture

First target: AYANEO Pocket ACE

Armada currently lists Pocket ACE as untested. The device conf sets ARMADA_GAMEPAD_QUIRK=ayaneo-xbox, but the 01-ayaneo-controller.yaml CompositeDevice only matches EVO/DS/S 2K. First contribution goal:

  1. Run ipcap capture on a Pocket ACE with Armada booted.
  2. Compare captured evdev vocabulary against ayaneo_mcu_xbox.yaml.
  3. If it matches, submit a one-line PR adding AYANEO Pocket ACE to the matches: block.
  4. If it doesn't, submit a PR with a new capability_map + composite update.

Either way, the tool proves itself and delivers real value upstream.

License

GPLv3+ to match InputPlumber.

About

Guided-capture toolkit for adding new handheld PCs to InputPlumber / Armada. First target: AYANEO Pocket ACE.

Topics

Resources

Stars

0 stars

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages