Skip to content

modm-io/modm-pinout

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

11 Commits
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

modm-pinout

modm-pinout builds a static pin-mapping site from device definitions provided by modm-devices.

The generated output contains:

  • one HTML page per device
  • shared CSS and JavaScript assets
  • shared JSON datasets grouped by source XML
  • an index page for device lookup
  • a manifest describing generated pages and datasets

The package installs a CLI named modm_pinout.

Please note that this code was vibe-coded, since we're not good at web development. modm-devices is still written by humans though and it shows lol.

Installation

python -m pip install modm-pinout

For local development:

python -m venv .venv
source .venv/bin/activate
python -m pip install -e .

Usage

Generate one device page:

modm_pinout stm32c011f4p6 -o build

Generate all supported devices:

modm_pinout --all -o build

Output Layout

The generated site uses this structure:

build/
  index.html
  manifest.json
  assets/
  data/
  devices/

Notes

  • Device metadata and XML inputs are loaded from the installed modm-devices package.
  • Templates and frontend assets are bundled as package data inside modm_pinout.
  • The package and CLI naming are generic so additional device families can be integrated later.

About

Pinout Generator for Regex-based matching of Pin Functionality

Resources

License

Stars

Watchers

Forks

Contributors