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

New Pin Properties #128

Open
lorennorman opened this issue Nov 10, 2023 · 0 comments
Open

New Pin Properties #128

lorennorman opened this issue Nov 10, 2023 · 0 comments

Comments

@lorennorman
Copy link
Contributor

We've been discussing moving away from:

{
  "name": "D0",
  "displayName": "arbitrary string"
}

...and moving to something that closer reflects reality:

{
  "logicalPin": 0,
  "silkscreen": "COPY_FROM_SILKSCREEN_IMAGE"
}

The "D" is synthetic in the first example, just an arbitrary label we've used to denote a digital pin. We'd like to move to using the actual logical pin integer here to reduce surprise, confusion, and parseInt operations!

displayName has been nice for putting arbitrary text into the web app without a developer having to push code, but we've ended up:

  • doing common things that we could generate programmatically
  • not really following any kind of standard, no way of checking if it's "right"

Once a board has a magic json file, I believe we could entirely generate nice display names for pins, if we desire.

We'd also like to have a silkscreen property that should be exactly what appears on the silkscreens for a given board. This should reduce confusion for the user and we can always easily double-check that things are correct if there's an issue.

We can evaluate the difficulty of this after we've rolled out magic JSON for all boards

tyeth added a commit that referenced this issue Nov 28, 2023
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

1 participant