padbound 0.1.0__tar.gz

padbound-0.1.0/.claude/settings.local.json

@@ -0,0 +1,13 @@
+{
+  "permissions": {
+    "allow": [
+      "Bash(python3:*)",
+      "Bash(find:*)",
+      "Bash(grep:*)",
+      "Bash(python -m py_compile:*)",
+      "Bash(cat:*)",
+      "Bash(wc:*)",
+      "Bash(ruff check:*)"
+    ]
+  }
+}

padbound-0.1.0/.github/dependabot.yml

@@ -0,0 +1,16 @@
+version: 2
+updates:
+  - package-ecosystem: "uv"
+    directory: "/"
+    schedule:
+      interval: "weekly"
+    commit-message:
+      prefix: fix
+      prefix-development: chore
+  - package-ecosystem: "github-actions"
+    directory: "/"
+    schedule:
+      interval: "weekly"
+    commit-message:
+      prefix: fix
+      prefix-development: chore

padbound-0.1.0/.github/workflows/conventional-commits.yml

@@ -0,0 +1,19 @@
+# Validates PR title follows conventional commits
+name: conventional-commits
+on:
+  pull_request:
+    branches: [main]
+    types:
+      - edited
+      - opened
+      - synchronize
+      - reopened
+
+concurrency:
+  group: ${{ github.workflow }}-${{ github.ref }}
+  cancel-in-progress: true
+jobs:
+  conventional_commit_title:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: chanzuckerberg/github-actions/.github/actions/conventional-commits@v6.10.0

padbound-0.1.0/.github/workflows/py-formatting.yml

@@ -0,0 +1,23 @@
+name: Python Linting
+
+on:
+  pull_request:
+  push:
+    branches: [main]
+
+jobs:
+  pre_commit_checks:
+    name: pre-commit checks
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v5
+      - uses: actions/setup-python@v6
+        with:
+          python-version: "3.12.5"
+      - name: Install action-validator with asdf
+        uses: asdf-vm/actions/install@v4
+        with:
+          tool_versions: |
+            action-validator 0.6.0
+      - name: check linting
+        uses: pre-commit/action@v3.0.1

padbound-0.1.0/.github/workflows/release-please.yml

@@ -0,0 +1,64 @@
+name: Create Release PRs
+
+on:
+  workflow_dispatch:
+  push:
+    branches:
+      - main
+
+permissions:
+  contents: write
+  issues: write
+  pull-requests: write
+
+jobs:
+  release-please:
+    concurrency:
+      group: ${{ github.workflow }}-${{ github.ref }}
+      cancel-in-progress: true
+
+    runs-on: ubuntu-latest
+    steps:
+      - name: release please
+        uses: googleapis/release-please-action@v4
+        id: release
+        with:
+          manifest-file: ".release-please.manifest.json"
+          config-file: "release-please.config.json"
+          target-branch: "main"
+          token: ${{ secrets.GITHUB_TOKEN }}
+
+    outputs:
+      paths_released: ${{ steps.release.outputs.paths_released }}
+
+  publish-pypi-package:
+    name: Build and publish Python package to PyPI
+    runs-on: ubuntu-latest
+    needs: release-please
+    if: contains(needs.release-please.outputs.paths_released, '.')
+    environment:
+      name: pypi
+      url: https://pypi.org/p/padbound
+    permissions:
+      id-token: write # IMPORTANT: this permission is mandatory for trusted publishing
+    steps:
+      - name: Checkout ref branch
+        uses: actions/checkout@v5
+        with:
+          ref: ${{ github.ref }}
+          fetch-depth: 0
+
+      - name: Install uv
+        uses: astral-sh/setup-uv@v7
+        with:
+          version: "0.7.13"
+          python-version: "3.12"
+
+      - name: build
+        run: |
+          uv build
+
+      - name: Publish distribution 📦 to PyPI
+        uses: pypa/gh-action-pypi-publish@release/v1
+        with:
+          packages-dir: dist

padbound-0.1.0/.gitignore

@@ -0,0 +1,167 @@
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+#  Usually these files are written by a python script from a template
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py,cover
+.hypothesis/
+.pytest_cache/
+cover/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+.pybuilder/
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+#   For a library or package, you might want to ignore these files since the code is
+#   intended to run in multiple environments; otherwise, check them in:
+# .python-version
+
+# pipenv
+#   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
+#   However, in case of collaboration, if having platform-specific dependencies or dependencies
+#   having no cross-platform support, pipenv may install dependencies that don't work, or not
+#   install all needed dependencies.
+#Pipfile.lock
+
+# poetry
+#   Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#   https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
+#poetry.lock
+
+# pdm
+#   Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
+#pdm.lock
+#   pdm stores project-wide configurations in .pdm.toml, but it is recommended to not include it
+#   in version control.
+#   https://pdm.fming.dev/#use-with-ide
+.pdm.toml
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/
+
+# pytype static type analyzer
+.pytype/
+
+# Cython debug symbols
+cython_debug/
+
+# PyCharm
+#  JetBrains specific template is maintained in a separate JetBrains.gitignore that can
+#  be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
+#  and can be added to the global gitignore or merged into this file.  For a more nuclear
+#  option (not recommended) you can uncomment the following to ignore the entire idea folder.
+.idea/
+.DS_Store/
+.test/
+.notebook/
+.workspace/
+.CLAUDE.md
+CLAUDE.md
+docs/

padbound-0.1.0/.pre-commit-config.yaml

@@ -0,0 +1,21 @@
+repos:
+- repo: https://github.com/psf/black-pre-commit-mirror
+  rev: 23.9.1
+  hooks:
+  - id: black
+- repo: https://github.com/astral-sh/ruff-pre-commit
+  rev: v0.0.292
+  hooks:
+  - id: ruff
+    args:
+    - --fix
+- repo: https://github.com/pre-commit/pre-commit-hooks
+  rev: v4.5.0
+  hooks:
+  - id: check-toml
+  - id: check-yaml
+    exclude: 'mkdocs.yml'
+  - id: check-json
+  - id: check-merge-conflict
+  - id: end-of-file-fixer
+  - id: trailing-whitespace

padbound-0.1.0/.release-please.manifest.json

@@ -0,0 +1,3 @@
+{
+  ".": "0.1.0"
+}

padbound-0.1.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 Utz Ermel
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

padbound-0.1.0/PKG-INFO

@@ -0,0 +1,264 @@
+Metadata-Version: 2.4
+Name: padbound
+Version: 0.1.0
+Summary: A stateful python interface for USB MIDI controllers.
+Project-URL: Repository, https://github.com/uermel/padbound.git
+Project-URL: Issues, https://github.com/uermel/padbound/issues
+Author-email: "Utz H. Ermel" <utz@ermel.me>
+License: MIT License
+        
+        Copyright (c) 2024 Utz Ermel
+        
+        Permission is hereby granted, free of charge, to any person obtaining a copy
+        of this software and associated documentation files (the "Software"), to deal
+        in the Software without restriction, including without limitation the rights
+        to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+        copies of the Software, and to permit persons to whom the Software is
+        furnished to do so, subject to the following conditions:
+        
+        The above copyright notice and this permission notice shall be included in all
+        copies or substantial portions of the Software.
+        
+        THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+        IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+        FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+        AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+        LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+        OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+        SOFTWARE.
+License-File: LICENSE
+Keywords: MIDI,control surface,controller,interface,stateful
+Classifier: Development Status :: 3 - Alpha
+Classifier: License :: OSI Approved :: MIT License
+Requires-Python: >=3.12
+Requires-Dist: mido>=1.3.3
+Requires-Dist: pydantic>=2.12.5
+Requires-Dist: rich>=13.0.0
+Provides-Extra: dev
+Requires-Dist: black>=25.1.0; extra == 'dev'
+Requires-Dist: ipython>=8.18.1; extra == 'dev'
+Requires-Dist: notebook>=7.4.3; extra == 'dev'
+Requires-Dist: pre-commit>=4.2.0; extra == 'dev'
+Requires-Dist: ruff>=0.12.0; extra == 'dev'
+Requires-Dist: textual-dev>=1.7.0; extra == 'dev'
+Provides-Extra: docs
+Requires-Dist: mkdocs-autorefs>=1.4.2; extra == 'docs'
+Requires-Dist: mkdocs-material>=9.6.14; extra == 'docs'
+Requires-Dist: mkdocs>=1.6.1; extra == 'docs'
+Requires-Dist: mkdocstrings[python]>=0.29.1; extra == 'docs'
+Provides-Extra: test
+Requires-Dist: pytest-cov>=6.2.1; extra == 'test'
+Requires-Dist: pytest>=8.4.1; extra == 'test'
+Description-Content-Type: text/markdown
+
+
+
+<p align="center">
+  <picture>
+    <source media="(prefers-color-scheme: dark)" srcset="https://raw.githubusercontent.com/uermel/padbound/refs/heads/main/assets/logo_dark.svg">
+    <source media="(prefers-color-scheme: light)" srcset="https://raw.githubusercontent.com/uermel/padbound/refs/heads/main/assets/logo_light.svg">
+    <img alt="Padbound" src="https://raw.githubusercontent.com/uermel/padbound/refs/heads/main/assets/logo_light.svg">
+  </picture>
+</p>
+
+
+A general, stateful python interface for MIDI controllers that abstracts hardware differences behind a simple API.
+
+## Overview
+
+Padbound provides a high-level abstraction over MIDI controllers, allowing applications to work with three fundamental
+control types (toggles, momentary triggers, continuous controls) and RGB colors without dealing with raw MIDI messages.
+
+## Features
+
+- **Three Control Types**: Toggle, Momentary, and Continuous controls with unified API
+- **Progressive State Discovery**: Honest representation of hardware limitations (knobs/faders start in "unknown" state)
+- **Capability-Based API**: Validates hardware support before attempting operations
+- **Thread-Safe**: Safe concurrent access from callbacks and main thread
+- **Plugin Architecture**: Extensible system for supporting different controllers
+- **Callback System**: Global, per-control, and type-based callbacks with error isolation
+- **Bank Support**: Handles controllers with bank switching (when supported)
+- **Strict/Permissive Modes**: Choose between errors or warnings for unsupported operations
+
+## Installation
+
+```bash
+pip install -e .
+```
+
+## Quick Start
+
+```python
+from padbound import Controller, ControlType
+
+# Auto-detect and connect to controller
+with Controller(plugin='auto', auto_connect=True) as controller:
+    # Register callback for a specific pad
+    controller.on_control('pad_1', lambda state: print(f"Pad 1: {state.is_on}"))
+
+    # Register callback for all continuous controls (knobs/faders)
+    def on_continuous(control_id, state):
+        if state.is_discovered:
+            print(f"{control_id}: {state.normalized_value:.2f}")
+    controller.on_type(ControlType.CONTINUOUS, on_continuous)
+
+    # Main loop
+    while True:
+        controller.process_events()
+```
+
+## Examples
+
+See the `examples/` directory for controller-specific demos:
+- `demo_akai_lpd8.py` - AKAI LPD8 MK2
+- `demo_akai_apc_mini_mk2.py` - AKAI APC mini MK2
+- `demo_presonus_atom.py` - PreSonus ATOM
+- `demo_xjam.py` - Xjam
+- `demo_x_touch_mini.py` - Behringer X-Touch Mini
+
+### Callback Registration
+
+```python
+from padbound import Controller, ControlType
+
+with Controller(plugin='auto', auto_connect=True) as controller:
+    # Per-control callback
+    controller.on_control('pad_1', lambda state: print(f"Pad 1: {state.is_on}"))
+
+    # Per-type callback (all toggles, all continuous, etc.)
+    controller.on_type(ControlType.TOGGLE, lambda cid, state: print(f"{cid} toggled"))
+
+    # Per-category callback (e.g., all transport buttons)
+    controller.on_category('transport', lambda cid, state: print(f"Transport: {cid}"))
+
+    # Global callback (all controls)
+    controller.on_global(lambda cid, state: print(f"Any control: {cid}"))
+
+    while True:
+        controller.process_events()
+```
+
+### Setting Control State
+
+```python
+from padbound import Controller
+
+with Controller(plugin='auto', auto_connect=True) as controller:
+    # Set pad LED color and state
+    if controller.can_set_state('pad_1', is_on=True, color='red'):
+        controller.set_state('pad_1', is_on=True, color='red')
+
+    # Query control state
+    state = controller.get_state('pad_1')
+    if state:
+        print(f"Pad 1 is {'on' if state.is_on else 'off'}")
+```
+
+### Using Configuration
+
+```python
+from padbound import Controller, ControllerConfig, BankConfig, ControlConfig, ControlType
+
+# Configure pad colors and types
+config = ControllerConfig(banks={
+    'bank_1': BankConfig(controls={
+        'pad_1': ControlConfig(type=ControlType.TOGGLE, color='red', off_color='dim_red'),
+        'pad_2': ControlConfig(type=ControlType.MOMENTARY, color='green'),
+    })
+})
+
+with Controller(plugin='auto', config=config, auto_connect=True) as controller:
+    while True:
+        controller.process_events()
+```
+
+## Supported Controllers
+
+### Capability Comparison
+
+| Controller | Pads | Knobs/Encoders | Faders | Buttons | RGB LEDs | LED Modes | Banks | Persistent Config | Special Features |
+|------------|----|---------------|--------|---------|----------|-----------|-------|-------------------|------------------|
+| **AKAI LPD8 MK2** | 8 | 8 knobs | — | — | ✓ Full | Solid | 4 (HW) | ✓ SysEx | Multi-signal pads (NOTE/CC/PC) |
+| **AKAI APC mini MK2** | 64 | — | 9 | 17 | ✓ Full | Solid/Pulse/Blink | 1 | — | Fader position discovery |
+| **PreSonus ATOM** | 16 | 4 | — | 20 | ✓ Full | Solid/Pulse/Blink | 8 (HW) | — | Native Control mode, encoder acceleration |
+| **Xjam** | 16 | 6 | — | — | — | — | 3 (HW) | ✓ SysEx | Multi-signal pads, multiple encoder modes |
+| **X-Touch Mini** | 16 | 8 + buttons | 1 | — | Single | Solid | 2 (HW) | — | Deferred LED feedback, auto-reflecting encoder rings |
+
+**Legend:**
+- **HW** = Hardware-managed bank switching
+- **RGB LEDs**: Full = True RGB color support, Single = On/off only
+- **LED Modes**: Animation/behavior modes supported
+- **Persistent Config**: Device stores configuration in non-volatile memory
+
+### Detailed Controller Information
+
+#### AKAI LPD8 MK2
+**Control Surface**: 8 RGB pads + 8 knobs\
+**Banks**: 4 banks with hardware-based switching\
+**Capabilities**:
+- **Pad LED Feedback**: Full RGB via SysEx
+- **Pad LED Modes**: Solid
+- **Pad Modes**: Toggle or momentary (global per bank)
+- **Knob Feedback**: None (read-only)
+- **Configuration**: Persistent (SysEx)
+
+#### AKAI APC mini MK2
+**Control Surface**: 8×8 RGB pad grid + 9 faders + 17 buttons\
+**Banks**: Single layer\
+**Capabilities**:
+- **Pad LED Feedback**: Full RGB via SysEx
+- **Pad LED Modes**: Solid, pulse, blink
+- **Pad Modes**: Toggle or momentary (per pad)
+- **Fader Feedback**: None (read-only, initial position discovered)
+- **Button LED Feedback**: Single-color (red for track, green for scene)
+- **Configuration**: Volatile
+
+#### PreSonus ATOM
+**Control Surface**: 16 RGB pads (4×4) + 4 encoders + 20 buttons\
+**Banks**: 8 hardware-managed banks (not software-accessible)\
+**Capabilities**:
+- **Pad LED Feedback**: Full RGB via Native Control mode
+- **Pad LED Modes**: Solid, pulse, breathe
+- **Pad Modes**: Toggle or momentary (per pad)
+- **Encoder Type**: Relative with acceleration
+- **Encoder Feedback**: None (read-only)
+- **Button LED Feedback**: Single-color
+- **Configuration**: Volatile
+
+#### Xjam (ESI/Artesia Pro)
+**Control Surface**: 16 pads + 6 knobs per bank\
+**Banks**: 3 banks (Green, Yellow, Red) with synchronized pad/knob switching\
+**Capabilities**:
+- **Pad LED Feedback**: None (hardware-managed)
+- **Pad Modes**: Toggle or momentary (global)
+- **Knob Type**: Configurable (absolute or 3 relative modes)
+- **Knob Feedback**: None (read-only)
+- **Configuration**: Persistent (SysEx)
+
+#### Behringer X-Touch Mini
+**Control Surface**: 8 encoders with buttons + 16 pads + 1 fader\
+**Banks**: 2 layers (A, B) with hardware switching\
+**Capabilities**:
+- **Pad LED Feedback**: Single-color
+- **Pad LED Modes**: Solid
+- **Pad Modes**: Toggle or momentary (per pad)
+- **Encoder Type**: Absolute
+- **Encoder Feedback**: LED ring auto-reflects value
+- **Encoder Button Feedback**: Single-color
+- **Fader Feedback**: None (read-only)
+- **Configuration**: Volatile
+
+## Documentation
+
+TBD
+
+## Acknowledgements
+
+Some protocol information for supported controllers was gathered from:
+- **AKAI LPD8 MK2**: [stephensrmmartin/lpd8mk2](https://github.com/stephensrmmartin/lpd8mk2)
+- **PreSonus ATOM**: [EMATech/AtomCtrl](https://github.com/EMATech/AtomCtrl)
+- **Behringer X-Touch Mini**: [AndreasPantle/X-Touch-Mini-HandsOn](https://github.com/AndreasPantle/X-Touch-Mini-HandsOn)
+
+## License
+
+MIT License