Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feature request: Configurable/custom pinout interface for documentation and permalinks #5

Open
disq opened this issue Nov 13, 2022 · 1 comment

Comments

@disq
Copy link

disq commented Nov 13, 2022

How about enabling a "Custom" interface makers can specify which pin connections their project needs? They could then get a screenshot (you could add subtle "pinout.xyz" somewhere in the render) and include it in their documentation, or provide a permalink that will open in pinout.xyz to show it in a better printable/zoomable format.

Something like this as the end result (which was done tediously in developer tools "Edit HTML")
https://github.com/disq/ledcontrol/blob/main/doc/pinout.png

  • Add a new setting filter called "Custom pinout". If enabled, show a textarea to paste CSV data: pin number, name, background color[, foreground color]
  • Render the said CSV data as new TD tags
  • Show it as a new interface filter called "Custom". Allow the user to enable/disable it along with the other interfaces, and support reversed mode as well.
  • Modify the hash part of the URL to create permalinks so that the link can be shared.

What do you think?

@Gadgetoid
Copy link
Collaborator

At some point I hope to move all of the pin details into .csv or similar so that the various flavours of Pico and RP2040 board websites can be generated mostly dynamically (like the main pinout.xyz but... less of a disaster). This- I think- might also cover your use-case.

Having an online editor and storage is wildly outside the scope of the project and the time and resources I can dedicate to it. It's a nice idea in principle, though.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants