WireViz/tutorial/tutorial.md

Tutorial Outline

01

• Minimum working example
• Only 1-to-1 sequential wiring

02

• Parameters for connectors and cables
• Auto-calculate AWG from mm2
• Non-sequential wiring

03

• Connector pinouts
  • Pincount implicit in pinout
• Cable color codes
• Cable shielding, shield wiring
• Templates

04

• Overriding template parameters
• American standards: AWG gauge and IEC colors
• Linear daisy-chain

05

• Ferrules
• Wire bundles
  • Internally treated as cables
  • Different treatment in BOM
• Custom colors

06

• Custom ferrules
  • Allows attaching more than one wire to a ferrule

To do

• Daisychain
  • zig-zag
• Connection types
  • con-cbl-con
  • con-cbl
  • cbl-con
  • fer-cbl
  • cbl-fer
• Custom color codes
  • Looping
  • Clipping
• (Merging multiple templates)