Skip to content

README.md

Latest commit

 

History

History
91 lines (62 loc) · 1.6 KB

README.md

File metadata and controls

91 lines (62 loc) · 1.6 KB

rp360xp — getting started

Python library and CLI for the DigiTech RP360XP guitar effects pedal.

Requirements

  • Python 3.10 or later
  • The pedal connected via USB

Installation

From the src/ directory:

pip install -e .

To also install the test dependencies:

pip install -e ".[dev]"

On some Linux systems pip may warn about installing into a system-managed environment. Either use a virtual environment (recommended) or pass --break-system-packages.

Virtual environment (recommended)

python3 -m venv .venv
source .venv/bin/activate   # Windows: .venv\Scripts\activate
pip install -e ".[dev]"

Serial port permissions (Linux)

On Linux the serial device is typically /dev/ttyACM0. Your user must be a member of the dialout group to access it without sudo:

sudo usermod -aG dialout $USER

Log out and back in (or run newgrp dialout) for the change to take effect. Verify with:

ls -l /dev/ttyACM0
# crw-rw---- 1 root dialout ...

Running the tests

pytest tests/

Basic usage

Connect the pedal via USB, then:

# Show the active preset
rp360xp show

# List all user presets
rp360xp list

# Listen to real-time device notifications (Ctrl-C to quit)
rp360xp listen --no-raw

# Full command reference
rp360xp --help

The port is auto-detected by USB vendor/product ID. If auto-detection fails, pass it explicitly:

rp360xp --port /dev/ttyACM0 show        # Linux
rp360xp --port COM3 show                # Windows

GUI

Do the same as described above, but launch:

rp360xp-gui