tigard-tools / tigard

An FTDI FT2232H-based multi-protocol tool for hardware hacking
Other
592 stars 72 forks source link

Hardware connector details in Readme.md #38

Open hattesen opened 3 years ago

hattesen commented 3 years ago

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 commented 3 years ago

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 commented 3 years ago

+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 commented 3 years ago

@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

skochinsky commented 3 years ago

Thank for the explanation!