Added WireViz wiring harness diagrams #434
Conversation
abust005
commented
Nov 7, 2023
abust005
commented
- Added WireViz diagrams to documentation.
- Added WireViz YAMLs to regenerate diagrams
…sions Added images of connectors
Added harness images Added harness generation scripts (Windows and Linux)
There was a problem hiding this comment.
This is very cool! I think this is going to be a great addition but I have some comments to improve its helpfulness for novice builders.
Unless I'm missing something obvious, I don't see how builders can infer which wire goes where from the diagrams, which is the main thing they're looking for.
| @@ -5,6 +5,8 @@ The wiring is what connects each of the 10 motors to the motor board carrying po | |||
|  | |||
| Wiring diagram for one side of the rover. The other side is identical. | |||
|
|
|||
| Harness diagrams further below were generated with [WireViz](https://github.com/wireviz/WireViz/) and can be re-generated with the *generateHarness.bat/.sh* scripts. | |||
There was a problem hiding this comment.
This would be a good place to explain to the uninitiated what a wiring harness.
There was a problem hiding this comment.
Love the feedback! Next commit will have a note on terminology that explains the wiring harness.
| @@ -72,6 +74,8 @@ On the other side of the cable, you will attach 4 Dupont female crimps. You now | |||
|
|
|||
| Now we'll insert each crimped cable into the appropriate connectors. Start by writing the pinout on each of the connectors for easy troubleshooting using a sharpie: B, A, G, 5 for channel B, channel A, ground, and +5V respectively. Copy over the annotations from the images below to your connectors, paying close attention to the orientation of each connector. | |||
|
|
|||
|  | |||
There was a problem hiding this comment.
this is the first wiring harness encountered, a link or sentence or two about what to look for in this harness would be useful.
The DuPont connector displayed in this image seems to have 10 positions while it should only have 4. Is that an easy fix?
There was a problem hiding this comment.
I did worry about the DuPont connector image. Unfortunately, I pulled that image from the datasheet, which just uses the 10-position connector as a default, and there doesn't seem to be a reference for just the 4-position. Would it be less confusing if I removed the image? After all, a DuPont connector isn't as direction-sensitive as a Molex or a JST connector.
There was a problem hiding this comment.
Either that or use a cropped version of something like the image here, which also happens to be a really nice wiring diagram. Do you happen to recognize what software they might use for this?
There was a problem hiding this comment.
That is quite nice, I wish I knew what software they're using. It almost seems like it could also be a GraphViz derivative like WireViz, but I'm not sure.
I'm currently working on a fix to the JST and Molex connector diagrams, I might be able to do the DuPont as well while I'm at it.
electrical/wiring/back_encoder.yml
Outdated
There was a problem hiding this comment.
I suggest moving this and other WireViz files into a seperate folder wireviz so its clear what's part of the WireViz files.
electrical/wiring/images/JST-XH.png
Outdated
There was a problem hiding this comment.
It's not entirely clear from this diagram which wire goes where. I don't see how numbers 1-4 correspond to the positions in the connector.
There was a problem hiding this comment.
Number 1 corresponds to the side with the notch, so in this case the right. However, this image suffers from the same problem as the DuPont diagram in that it's a 5-pin instead of a 4-pin. I'll see if I can find a better diagram image
There was a problem hiding this comment.
This is much better, but it's still not entirely clear what side you're looking at.
There was a problem hiding this comment.
From the wire side, with the clip on the bottom. As with the JST, I'll see if I can find a better diagram
electrical/wiring/images/dupont.png
Outdated
There was a problem hiding this comment.
This needs to be a 4p connector and would also benefit from an indication of which pin is which.
Changed connector diagram images Moved WireViz files to separate directory Updated WireViz templates with new images
