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

Hardware connector details in Readme.md #38

Open
hattesen opened this issue Mar 28, 2021 · 4 comments
Open

Hardware connector details in Readme.md #38

hattesen opened this issue Mar 28, 2021 · 4 comments
Assignees
Milestone

Comments

@hattesen
Copy link

The readme.md is very well written and provides virtually all the information that is required to use the various interfaces, it is a sign of the high level of professionalism of this project, where many other similar projects fall short.

One piece of information that I would like to see added is a reference to the physical connector matching each hardware interface (pitch, pins, rows and a connector part number), especially for the non-0.1" pin headers like the I2C connector, possibly including full specs (both connectors and wiring) for frequently used wiring harness. This will make it easier to locate suitable harnesses/cables or find the parts to make them up.

On a side-note, the details of each interface should probably be moved out of readme.md and into separate interface.md pages, to make the readme.md more manageable, as it is likely to continue to grow over time.

@securelyfitz securelyfitz self-assigned this Apr 1, 2021
@securelyfitz
Copy link
Contributor

Thanks! glad you found the readme useful.

I agree, mechanical specs would be really useful. I'll add them.

I started issue #37 to capture some of the pros and cons of keeping a flat readme vs breaking it out.

@skochinsky
Copy link

+1
My cables arrived with some wires popping out of the connectors so it would be nice to know the "canonical" layout to put them back in proper order (yes I know I can track it back from the pinout but...)

@securelyfitz
Copy link
Contributor

@skochinsky The UART cable came with only VTGT, GND, TX and RX attached since these are what's used 99% of the time. Loose DTR, RTS, etc wires were included in case you wanted to use them, but not assembled to keep the uart wiring harness easier to use for the common case.

Right now the pinouts are listed further below in the readme and will likely be moved up into a single UART section in the refactoring for #37

@securelyfitz securelyfitz added this to the v1.1 release milestone Apr 14, 2021
@skochinsky
Copy link

Thank for the explanation!

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

3 participants