diff --git a/src/batch.py b/src/batch.py index 39c8ad3..6718452 100644 --- a/src/batch.py +++ b/src/batch.py @@ -1,23 +1,20 @@ import wireviz import os -readme = '../examples/readme.md' -readme = os.path.abspath(readme) +demos = 0 # 2 +examples = 0 # 6 +tutorials = 7 # 7 -do_demos = False -do_examples = True -do_tutorial = True - -if do_demos: - for i in range(1,3): +if demos: + for i in range(1,demos+1): fn = '../examples/demo{:02d}.yml'.format(i) print(fn) wireviz.parse(fn, gen_bom=True) -if do_examples: - with open(readme, 'w') as file: +if examples: + with open(os.path.abspath('../examples/readme.md'), 'w') as file: file.write('# Example gallery\n') - for i in range(1,7): + for i in range(1,examples+1): fn = '../examples/ex{:02d}.yml'.format(i) print(fn) wireviz.parse(fn, gen_bom=True) @@ -26,8 +23,26 @@ if do_examples: file.write('![](ex{:02d}.png)\n\n'.format(i)) file.write('[Source](ex{:02d}.yml) - [Bill of Materials](ex{:02d}.bom.tsv)\n\n\n'.format(i,i)) -if do_tutorial: - for i in range(1,7): - fn = '../tutorial/tutorial{:02d}.yml'.format(i) - print(fn) - wireviz.parse(fn, gen_bom=True) +if tutorials: + with open(os.path.abspath('../tutorial/readme.md'), 'w') as file: + file.write('# WireViz Tutorial\n') + for i in range(1,tutorials+1): + fn = '../tutorial/tutorial{:02d}.yml'.format(i) + print(fn) + wireviz.parse(fn, gen_bom=True) + + with open(os.path.abspath('../tutorial/tutorial{:02d}.md'.format(i)), 'r') as info: + for line in info: + file.write('{}'.format(line)) + file.write('\n[Source](tutorial{:02d}.yml):\n\n'.format(i)) + + with open(os.path.abspath('../tutorial/tutorial{:02d}.yml'.format(i)), 'r') as src: + for line in src: + file.write(' {}'.format(line)) + file.write('\n') + + file.write('\nOutput:\n\n'.format(i)) + + file.write('![](tutorial{:02d}.png)\n\n'.format(i)) + + # file.write('[Bill of Materials](tutorial{:02d}.bom.tsv)\n\n\n'.format(i)) diff --git a/tutorial/readme.md b/tutorial/readme.md new file mode 100644 index 0000000..2bd9d36 --- /dev/null +++ b/tutorial/readme.md @@ -0,0 +1,323 @@ +# WireViz Tutorial +## Bare-bones example + +* Minimum working example +* Only 1-to-1 sequential wiring + +[Source](tutorial01.yml): + + connectors: + X1: + pincount: 4 + X2: + pincount: 4 + + cables: + W1: + wirecount: 4 + length: 1 + + connections: + - + - X1: [1-4] + - W1: [1-4] + - X2: [1-4] + + +Output: + +![](tutorial01.png) + +## Adding parameters and colors + +* Parameters for connectors and cables +* Auto-calculate AWG from mm2 +* Non-sequential wiring + +[Source](tutorial02.yml): + + connectors: + X1: + pinout: [GND, VCC, RX, TX] + # More connector parameters: + type: Molex KK 254 + subtype: female + X2: + pinout: [GND, VCC, RX, TX] + type: Molex KK 254 + subtype: female + + cables: + W1: + wirecount: 4 + # more cable parameters: + length: 1 + gauge: 0.25 mm2 + show_equiv: true + colors: [WH, BN, GN, YE] + + connections: + - + - X1: [1-4] + - W1: [1-4] + # non-sequential wiring: + - X2: [1,2,4,3] + + +Output: + +![](tutorial02.png) + +## Pinouts, shielding and templates + +* Connector pinouts + * Pincount implicit in pinout +* Cable color codes +* Cable shielding, shield wiring +* Templates + +[Source](tutorial03.yml): + + connectors: + X1: &template1 # define a template for later use + pinout: [GND, VCC, RX, TX] # pincount implicit in pinout + type: Molex KK 254 + subtype: female + X2: + <<: *template1 # reuse template + + cables: + W1: + wirecount: 4 + length: 1 + gauge: 0.25 mm2 + show_equiv: true + color_code: DIN # auto-assign colors based on DIN 47100 + shield: true # add cable shielding + + connections: + - + - X1: [1-4] + - W1: [1-4] + - X2: [1,2,4,3] + - # connect the shielding to a pin + - X1: 1 + - W1: s + + +Output: + +![](tutorial03.png) + +## Templates (cont.), American standards, daisy chaining + +* Overriding template parameters +* American standards: AWG gauge and IEC colors +* Linear daisy-chain + +[Source](tutorial04.yml): + + connectors: + X1: &template_con + pinout: [GND, VCC, SCL, SDA] + type: Molex KK 254 + subtype: male + notes: to microcontroller # add notes + X2: + <<: *template_con # use template + subtype: female # but override certain parameters + notes: to accelerometer + X3: + <<: *template_con + subtype: female + notes: to temperature sensor + + cables: + W1: &template_cbl + wirecount: 4 + length: 0.3 + gauge: 24 AWG # specifying guage in AWG directly + color_code: IEC # IEC 62 colors also supported + W2: + <<: *template_cbl + length: 0.1 + + connections: + - + - X1: [1-4] + - W1: [1-4] + - X2: [1-4] + - # daisy chain connectors (in line) + - X2: [1-4] + - W2: [1-4] + - X3: [1-4] + + +Output: + +![](tutorial04.png) + +## Daisy chaining (II) + +* Zig-zag daisy chain + +[Source](tutorial05.yml): + + templates: + - &template_con + type: Molex KK 254 + subtype: female + pinout: [GND, VCC, SCL, SDA] + - &template_wire + gauge: 0.25 mm2 + length: 0.2 + colors: [PK, TQ, YE, VT] + category: bundle + + connectors: + X1: + <<: *template_con + X2: + <<: *template_con + X3: + <<: *template_con + X4: + <<: *template_con + X5: + <<: *template_con + X6: + <<: *template_con + + cables: + W1: + <<: *template_wire + W2: + <<: *template_wire + W3: + <<: *template_wire + W4: + <<: *template_wire + W5: + <<: *template_wire + + connections: + - + - X1: [1-4] + - W1: [1-4] + - X2: [1-4] + - + - X3: [1-4] + - W2: [1-4] + - X2: [1-4] + - + - X3: [1-4] + - W3: [1-4] + - X4: [1-4] + - + - X5: [1-4] + - W4: [1-4] + - X4: [1-4] + - + - X5: [1-4] + - W5: [1-4] + - X6: [1-4] + + +Output: + +![](tutorial05.png) + +## Ferrules, wire bundles, custom colors + +* Ferrules +* Wire bundles + * Internally treated as cables + * Different treatment in BOM +* Custom colors + +[Source](tutorial06.yml): + + connectors: + X1: + pinout: [+12V, GND, GND, +5V] + type: Molex 8981 + subtype: female + + ferrules: # ferrules + F1: + type: Ferrule, crimp + subtype: 0.5 mm² + color: OG # optional color + + cables: + W1: + category: bundle # budnle + length: 0.3 + gauge: 0.5 mm + colors: [YE, BK, BK, RD] # custom colors, wirecount is implicit + notes: hello! + + connections: + - # attach ferrules + - F1 + - W1: [1-4] # a new ferrule is auto-generated for each wire + - # attach connectors (separetely from ferrules) + - W1: [1-4] + - X1: [1-4] + + +Output: + +![](tutorial06.png) + +## Custom ferrules + +* Custom ferrules + * Allows attaching more than one wire to a ferrule + +[Source](tutorial07.yml): + + connectors: + X1: + pinout: [+12V, GND, GND, +5V] + type: Molex 8981 + subtype: female + F_10_1: # manually define a ferrule (with unique identifier) + category: ferrule + type: Ferrule, crimp + subtype: 1.0 mm² + color: YE + + ferrules: # ferrules + F_05: + type: Ferrule, crimp + subtype: 0.5 mm² + color: OG # optional color + + cables: + W1: + category: bundle # budnle + length: 0.3 + gauge: 0.5 mm + colors: [YE, BK, BK, RD] # custom colors, wirecount is implicit + + connections: + - # attach ferrules + - F_05 + - W1: [1,4] # a new ferrule is auto-generated for each wire + - # attach connectors (separetely from ferrules) + - W1: [1-4] + - X1: [1-4] + - + - F_10_1: 1 # manually defined ferrules are treated like regular connectors, + # thus requiring a pin number + - W1: 2 + - + - F_10_1: 1 + - W1: 3 + + +Output: + +![](tutorial07.png) + diff --git a/tutorial/todo.md b/tutorial/todo.md new file mode 100644 index 0000000..e4907f5 --- /dev/null +++ b/tutorial/todo.md @@ -0,0 +1,12 @@ +* Daisychain + * zig-zag +* Connection types + * con-cbl-con + * con-cbl + * cbl-con + * fer-cbl + * cbl-fer +* Custom color codes + * Looping + * Clipping +* (Merging multiple templates) diff --git a/tutorial/tutorial.md b/tutorial/tutorial.md deleted file mode 100644 index 848b9db..0000000 --- a/tutorial/tutorial.md +++ /dev/null @@ -1,54 +0,0 @@ -# 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) diff --git a/tutorial/tutorial01.bom.tsv b/tutorial/tutorial01.bom.tsv new file mode 100644 index 0000000..ff469a8 --- /dev/null +++ b/tutorial/tutorial01.bom.tsv @@ -0,0 +1,3 @@ +Item Qty Unit Designators +Connector, 4 pins 2 X1, X2 +Cable, 4 wires 1 m W1 diff --git a/tutorial/tutorial01.gv b/tutorial/tutorial01.gv new file mode 100644 index 0000000..a37a4ad --- /dev/null +++ b/tutorial/tutorial01.gv @@ -0,0 +1,22 @@ +graph { +// Graph generated by WireViz +// https://github.com/formatc1702/WireViz + graph [bgcolor=white fontname=arial nodesep=0.33 rankdir=LR ranksep=2] + node [fillcolor=white fontname=arial shape=record style=filled] + edge [fontname=arial style=bold] + X1 [label="X1|{4-pin}|{{1|2|3|4}}"] + X2 [label="X2|{4-pin}|{{1|2|3|4}}"] + edge [color="#000000:#ffffff:#000000"] + X1:p1r:e -- W1:w1:w + W1:w1:e -- X2:p1l:w + edge [color="#000000:#ffffff:#000000"] + X1:p2r:e -- W1:w2:w + W1:w2:e -- X2:p2l:w + edge [color="#000000:#ffffff:#000000"] + X1:p3r:e -- W1:w3:w + W1:w3:e -- X2:p3l:w + edge [color="#000000:#ffffff:#000000"] + X1:p4r:e -- W1:w4:w + W1:w4:e -- X2:p4l:w + W1 [label=<
W1
4x1 m
 
X1:1X2:1
X1:2X2:2
X1:3X2:3
X1:4X2:4
 
> fillcolor=white margin=0 shape=box style=""] +} diff --git a/tutorial/tutorial01.html b/tutorial/tutorial01.html new file mode 100644 index 0000000..5672e80 --- /dev/null +++ b/tutorial/tutorial01.html @@ -0,0 +1,134 @@ +

Diagram

+ + + + + + + + +X1 + +X1 + +4-pin + +1 + +2 + +3 + +4 + + + +W1 + + +W1 + +4x + +1 m +  +X1:1 +X2:1 + + + +X1:2 +X2:2 + + + +X1:3 +X2:3 + + + +X1:4 +X2:4 + + + +  + + + +X1:e--W1:w + + + + + + +X1:e--W1:w + + + + + + +X1:e--W1:w + + + + + + +X1:e--W1:w + + + + + + +X2 + +X2 + +4-pin + +1 + +2 + +3 + +4 + + + +W1:e--X2:w + + + + + + +W1:e--X2:w + + + + + + +W1:e--X2:w + + + + + + +W1:e--X2:w + + + + + + +

Bill of Materials

ItemQtyUnitDesignators
Connector, 4 pins2X1, X2
Cable, 4 wires1mW1
\ No newline at end of file diff --git a/tutorial/tutorial01.md b/tutorial/tutorial01.md new file mode 100644 index 0000000..156556f --- /dev/null +++ b/tutorial/tutorial01.md @@ -0,0 +1,4 @@ +## Bare-bones example + +* Minimum working example +* Only 1-to-1 sequential wiring diff --git a/tutorial/tutorial01.png b/tutorial/tutorial01.png new file mode 100644 index 0000000..beab89d Binary files /dev/null and b/tutorial/tutorial01.png differ diff --git a/tutorial/tutorial01.svg b/tutorial/tutorial01.svg new file mode 100644 index 0000000..861658f --- /dev/null +++ b/tutorial/tutorial01.svg @@ -0,0 +1,133 @@ + + + + + + + + + +X1 + +X1 + +4-pin + +1 + +2 + +3 + +4 + + + +W1 + + +W1 + +4x + +1 m +  +X1:1 +X2:1 + + + +X1:2 +X2:2 + + + +X1:3 +X2:3 + + + +X1:4 +X2:4 + + + +  + + + +X1:e--W1:w + + + + + + +X1:e--W1:w + + + + + + +X1:e--W1:w + + + + + + +X1:e--W1:w + + + + + + +X2 + +X2 + +4-pin + +1 + +2 + +3 + +4 + + + +W1:e--X2:w + + + + + + +W1:e--X2:w + + + + + + +W1:e--X2:w + + + + + + +W1:e--X2:w + + + + + + diff --git a/tutorial/tutorial02.bom.tsv b/tutorial/tutorial02.bom.tsv new file mode 100644 index 0000000..726ee4d --- /dev/null +++ b/tutorial/tutorial02.bom.tsv @@ -0,0 +1,3 @@ +Item Qty Unit Designators +Connector, Molex KK 254, female, 4 pins 2 X1, X2 +Cable, 4 x 0.25 mm² 1 m W1 diff --git a/tutorial/tutorial02.gv b/tutorial/tutorial02.gv new file mode 100644 index 0000000..19cc678 --- /dev/null +++ b/tutorial/tutorial02.gv @@ -0,0 +1,22 @@ +graph { +// Graph generated by WireViz +// https://github.com/formatc1702/WireViz + graph [bgcolor=white fontname=arial nodesep=0.33 rankdir=LR ranksep=2] + node [fillcolor=white fontname=arial shape=record style=filled] + edge [fontname=arial style=bold] + X1 [label="X1|{Molex KK 254|female|4-pin}|{{GND|VCC|RX|TX}|{1|2|3|4}}"] + X2 [label="X2|{Molex KK 254|female|4-pin}|{{1|2|3|4}|{GND|VCC|RX|TX}}"] + edge [color="#000000:#ffffff:#000000"] + X1:p1r:e -- W1:w1:w + W1:w1:e -- X2:p1l:w + edge [color="#000000:#666600:#000000"] + X1:p2r:e -- W1:w2:w + W1:w2:e -- X2:p2l:w + edge [color="#000000:#00ff00:#000000"] + X1:p3r:e -- W1:w3:w + W1:w3:e -- X2:p4l:w + edge [color="#000000:#ffff00:#000000"] + X1:p4r:e -- W1:w4:w + W1:w4:e -- X2:p3l:w + W1 [label=<
W1
4x0.25 mm² (24 AWG)1 m
 
X1:1WHX2:1
X1:2BNX2:2
X1:3GNX2:4
X1:4YEX2:3
 
> fillcolor=white margin=0 shape=box style=""] +} diff --git a/tutorial/tutorial02.html b/tutorial/tutorial02.html new file mode 100644 index 0000000..5ca6e92 --- /dev/null +++ b/tutorial/tutorial02.html @@ -0,0 +1,164 @@ +

Diagram

+ + + + + + + + +X1 + +X1 + +Molex KK 254 + +female + +4-pin + +GND + +VCC + +RX + +TX + +1 + +2 + +3 + +4 + + + +W1 + + +W1 + +4x + +0.25 mm² (24 AWG) + +1 m +  +X1:1 +WH +X2:1 + + + +X1:2 +BN +X2:2 + + + +X1:3 +GN +X2:4 + + + +X1:4 +YE +X2:3 + + + +  + + + +X1:e--W1:w + + + + + + +X1:e--W1:w + + + + + + +X1:e--W1:w + + + + + + +X1:e--W1:w + + + + + + +X2 + +X2 + +Molex KK 254 + +female + +4-pin + +1 + +2 + +3 + +4 + +GND + +VCC + +RX + +TX + + + +W1:e--X2:w + + + + + + +W1:e--X2:w + + + + + + +W1:e--X2:w + + + + + + +W1:e--X2:w + + + + + + +

Bill of Materials

ItemQtyUnitDesignators
Connector, Molex KK 254, female, 4 pins2X1, X2
Cable, 4 x 0.25 mm²1mW1
\ No newline at end of file diff --git a/tutorial/tutorial02.md b/tutorial/tutorial02.md new file mode 100644 index 0000000..6b58fbd --- /dev/null +++ b/tutorial/tutorial02.md @@ -0,0 +1,5 @@ +## Adding parameters and colors + +* Parameters for connectors and cables +* Auto-calculate AWG from mm2 +* Non-sequential wiring diff --git a/tutorial/tutorial02.png b/tutorial/tutorial02.png new file mode 100644 index 0000000..7d6da76 Binary files /dev/null and b/tutorial/tutorial02.png differ diff --git a/tutorial/tutorial02.svg b/tutorial/tutorial02.svg new file mode 100644 index 0000000..fe5d84e --- /dev/null +++ b/tutorial/tutorial02.svg @@ -0,0 +1,163 @@ + + + + + + + + + +X1 + +X1 + +Molex KK 254 + +female + +4-pin + +GND + +VCC + +RX + +TX + +1 + +2 + +3 + +4 + + + +W1 + + +W1 + +4x + +0.25 mm² (24 AWG) + +1 m +  +X1:1 +WH +X2:1 + + + +X1:2 +BN +X2:2 + + + +X1:3 +GN +X2:4 + + + +X1:4 +YE +X2:3 + + + +  + + + +X1:e--W1:w + + + + + + +X1:e--W1:w + + + + + + +X1:e--W1:w + + + + + + +X1:e--W1:w + + + + + + +X2 + +X2 + +Molex KK 254 + +female + +4-pin + +1 + +2 + +3 + +4 + +GND + +VCC + +RX + +TX + + + +W1:e--X2:w + + + + + + +W1:e--X2:w + + + + + + +W1:e--X2:w + + + + + + +W1:e--X2:w + + + + + + diff --git a/tutorial/tutorial03.bom.tsv b/tutorial/tutorial03.bom.tsv new file mode 100644 index 0000000..a9c25a8 --- /dev/null +++ b/tutorial/tutorial03.bom.tsv @@ -0,0 +1,3 @@ +Item Qty Unit Designators +Connector, Molex KK 254, female, 4 pins 2 X1, X2 +Cable, 4 x 0.25 mm² shielded 1 m W1 diff --git a/tutorial/tutorial03.gv b/tutorial/tutorial03.gv new file mode 100644 index 0000000..ce13013 --- /dev/null +++ b/tutorial/tutorial03.gv @@ -0,0 +1,24 @@ +graph { +// Graph generated by WireViz +// https://github.com/formatc1702/WireViz + graph [bgcolor=white fontname=arial nodesep=0.33 rankdir=LR ranksep=2] + node [fillcolor=white fontname=arial shape=record style=filled] + edge [fontname=arial style=bold] + X1 [label="X1|{Molex KK 254|female|4-pin}|{{GND|VCC|RX|TX}|{1|2|3|4}}"] + X2 [label="X2|{Molex KK 254|female|4-pin}|{{1|2|3|4}|{GND|VCC|RX|TX}}"] + edge [color="#000000:#ffffff:#000000"] + X1:p1r:e -- W1:w1:w + W1:w1:e -- X2:p1l:w + edge [color="#000000:#666600:#000000"] + X1:p2r:e -- W1:w2:w + W1:w2:e -- X2:p2l:w + edge [color="#000000:#00ff00:#000000"] + X1:p3r:e -- W1:w3:w + W1:w3:e -- X2:p4l:w + edge [color="#000000:#ffff00:#000000"] + X1:p4r:e -- W1:w4:w + W1:w4:e -- X2:p3l:w + edge [color="#000000"] + X1:p1r:e -- W1:ws:w + W1 [label=<
W1
4x0.25 mm² (24 AWG)+ S1 m
 
X1:1WHX2:1
X1:2BNX2:2
X1:3GNX2:4
X1:4YEX2:3
 
X1:1Shield
 
> fillcolor=white margin=0 shape=box style=""] +} diff --git a/tutorial/tutorial03.html b/tutorial/tutorial03.html new file mode 100644 index 0000000..8e46c3f --- /dev/null +++ b/tutorial/tutorial03.html @@ -0,0 +1,175 @@ +

Diagram

+ + + + + + + + +X1 + +X1 + +Molex KK 254 + +female + +4-pin + +GND + +VCC + +RX + +TX + +1 + +2 + +3 + +4 + + + +W1 + + +W1 + +4x + +0.25 mm² (24 AWG) + ++ S + +1 m +  +X1:1 +WH +X2:1 + + + +X1:2 +BN +X2:2 + + + +X1:3 +GN +X2:4 + + + +X1:4 +YE +X2:3 + + + +  +X1:1 +Shield + +  + + + +X1:e--W1:w + + + + + + +X1:e--W1:w + + + + + + +X1:e--W1:w + + + + + + +X1:e--W1:w + + + + + + +X1:e--W1:w + + + + +X2 + +X2 + +Molex KK 254 + +female + +4-pin + +1 + +2 + +3 + +4 + +GND + +VCC + +RX + +TX + + + +W1:e--X2:w + + + + + + +W1:e--X2:w + + + + + + +W1:e--X2:w + + + + + + +W1:e--X2:w + + + + + + +

Bill of Materials

ItemQtyUnitDesignators
Connector, Molex KK 254, female, 4 pins2X1, X2
Cable, 4 x 0.25 mm² shielded1mW1
\ No newline at end of file diff --git a/tutorial/tutorial03.md b/tutorial/tutorial03.md new file mode 100644 index 0000000..1d965e7 --- /dev/null +++ b/tutorial/tutorial03.md @@ -0,0 +1,7 @@ +## Pinouts, shielding and templates + +* Connector pinouts + * Pincount implicit in pinout +* Cable color codes +* Cable shielding, shield wiring +* Templates diff --git a/tutorial/tutorial03.png b/tutorial/tutorial03.png new file mode 100644 index 0000000..e2f69a4 Binary files /dev/null and b/tutorial/tutorial03.png differ diff --git a/tutorial/tutorial03.svg b/tutorial/tutorial03.svg new file mode 100644 index 0000000..2fd3833 --- /dev/null +++ b/tutorial/tutorial03.svg @@ -0,0 +1,174 @@ + + + + + + + + + +X1 + +X1 + +Molex KK 254 + +female + +4-pin + +GND + +VCC + +RX + +TX + +1 + +2 + +3 + +4 + + + +W1 + + +W1 + +4x + +0.25 mm² (24 AWG) + ++ S + +1 m +  +X1:1 +WH +X2:1 + + + +X1:2 +BN +X2:2 + + + +X1:3 +GN +X2:4 + + + +X1:4 +YE +X2:3 + + + +  +X1:1 +Shield + +  + + + +X1:e--W1:w + + + + + + +X1:e--W1:w + + + + + + +X1:e--W1:w + + + + + + +X1:e--W1:w + + + + + + +X1:e--W1:w + + + + +X2 + +X2 + +Molex KK 254 + +female + +4-pin + +1 + +2 + +3 + +4 + +GND + +VCC + +RX + +TX + + + +W1:e--X2:w + + + + + + +W1:e--X2:w + + + + + + +W1:e--X2:w + + + + + + +W1:e--X2:w + + + + + + diff --git a/tutorial/tutorial04.bom.tsv b/tutorial/tutorial04.bom.tsv new file mode 100644 index 0000000..92f70f8 --- /dev/null +++ b/tutorial/tutorial04.bom.tsv @@ -0,0 +1,4 @@ +Item Qty Unit Designators +Connector, Molex KK 254, female, 4 pins 2 X2, X3 +Connector, Molex KK 254, male, 4 pins 1 X1 +Cable, 4 x 24 AWG 0.4 m W1, W2 diff --git a/tutorial/tutorial04.gv b/tutorial/tutorial04.gv new file mode 100644 index 0000000..bc89b14 --- /dev/null +++ b/tutorial/tutorial04.gv @@ -0,0 +1,36 @@ +graph { +// Graph generated by WireViz +// https://github.com/formatc1702/WireViz + graph [bgcolor=white fontname=arial nodesep=0.33 rankdir=LR ranksep=2] + node [fillcolor=white fontname=arial shape=record style=filled] + edge [fontname=arial style=bold] + X1 [label="X1|{Molex KK 254|male|4-pin}|{{GND|VCC|SCL|SDA}|{1|2|3|4}}|to microcontroller"] + X2 [label="X2|{Molex KK 254|female|4-pin}|{{1|2|3|4}|{GND|VCC|SCL|SDA}|{1|2|3|4}}|to accelerometer"] + X3 [label="X3|{Molex KK 254|female|4-pin}|{{1|2|3|4}|{GND|VCC|SCL|SDA}}|to temperature sensor"] + edge [color="#000000:#666600:#000000"] + X1:p1r:e -- W1:w1:w + W1:w1:e -- X2:p1l:w + edge [color="#000000:#ff0000:#000000"] + X1:p2r:e -- W1:w2:w + W1:w2:e -- X2:p2l:w + edge [color="#000000:#ff8000:#000000"] + X1:p3r:e -- W1:w3:w + W1:w3:e -- X2:p3l:w + edge [color="#000000:#ffff00:#000000"] + X1:p4r:e -- W1:w4:w + W1:w4:e -- X2:p4l:w + W1 [label=<
W1
4x24 AWG0.3 m
 
X1:1BNX2:1
X1:2RDX2:2
X1:3OGX2:3
X1:4YEX2:4
 
> fillcolor=white margin=0 shape=box style=""] + edge [color="#000000:#666600:#000000"] + X2:p1r:e -- W2:w1:w + W2:w1:e -- X3:p1l:w + edge [color="#000000:#ff0000:#000000"] + X2:p2r:e -- W2:w2:w + W2:w2:e -- X3:p2l:w + edge [color="#000000:#ff8000:#000000"] + X2:p3r:e -- W2:w3:w + W2:w3:e -- X3:p3l:w + edge [color="#000000:#ffff00:#000000"] + X2:p4r:e -- W2:w4:w + W2:w4:e -- X3:p4l:w + W2 [label=<
W2
4x24 AWG0.1 m
 
X2:1BNX3:1
X2:2RDX3:2
X2:3OGX3:3
X2:4YEX3:4
 
> fillcolor=white margin=0 shape=box style=""] +} diff --git a/tutorial/tutorial04.html b/tutorial/tutorial04.html new file mode 100644 index 0000000..2174704 --- /dev/null +++ b/tutorial/tutorial04.html @@ -0,0 +1,301 @@ +

Diagram

+ + + + + + + + +X1 + +X1 + +Molex KK 254 + +male + +4-pin + +GND + +VCC + +SCL + +SDA + +1 + +2 + +3 + +4 + +to microcontroller + + + +W1 + + +W1 + +4x + +24 AWG + +0.3 m +  +X1:1 +BN +X2:1 + + + +X1:2 +RD +X2:2 + + + +X1:3 +OG +X2:3 + + + +X1:4 +YE +X2:4 + + + +  + + + +X1:e--W1:w + + + + + + +X1:e--W1:w + + + + + + +X1:e--W1:w + + + + + + +X1:e--W1:w + + + + + + +X2 + +X2 + +Molex KK 254 + +female + +4-pin + +1 + +2 + +3 + +4 + +GND + +VCC + +SCL + +SDA + +1 + +2 + +3 + +4 + +to accelerometer + + + +W2 + + +W2 + +4x + +24 AWG + +0.1 m +  +X2:1 +BN +X3:1 + + + +X2:2 +RD +X3:2 + + + +X2:3 +OG +X3:3 + + + +X2:4 +YE +X3:4 + + + +  + + + +X2:e--W2:w + + + + + + +X2:e--W2:w + + + + + + +X2:e--W2:w + + + + + + +X2:e--W2:w + + + + + + +X3 + +X3 + +Molex KK 254 + +female + +4-pin + +1 + +2 + +3 + +4 + +GND + +VCC + +SCL + +SDA + +to temperature sensor + + + +W1:e--X2:w + + + + + + +W1:e--X2:w + + + + + + +W1:e--X2:w + + + + + + +W1:e--X2:w + + + + + + +W2:e--X3:w + + + + + + +W2:e--X3:w + + + + + + +W2:e--X3:w + + + + + + +W2:e--X3:w + + + + + + +

Bill of Materials

ItemQtyUnitDesignators
Connector, Molex KK 254, female, 4 pins2X2, X3
Connector, Molex KK 254, male, 4 pins1X1
Cable, 4 x 24 AWG0.4mW1, W2
\ No newline at end of file diff --git a/tutorial/tutorial04.md b/tutorial/tutorial04.md new file mode 100644 index 0000000..a85c64e --- /dev/null +++ b/tutorial/tutorial04.md @@ -0,0 +1,5 @@ +## Templates (cont.), American standards, daisy chaining + +* Overriding template parameters +* American standards: AWG gauge and IEC colors +* Linear daisy-chain diff --git a/tutorial/tutorial04.png b/tutorial/tutorial04.png new file mode 100644 index 0000000..1af706f Binary files /dev/null and b/tutorial/tutorial04.png differ diff --git a/tutorial/tutorial04.svg b/tutorial/tutorial04.svg new file mode 100644 index 0000000..d831c04 --- /dev/null +++ b/tutorial/tutorial04.svg @@ -0,0 +1,300 @@ + + + + + + + + + +X1 + +X1 + +Molex KK 254 + +male + +4-pin + +GND + +VCC + +SCL + +SDA + +1 + +2 + +3 + +4 + +to microcontroller + + + +W1 + + +W1 + +4x + +24 AWG + +0.3 m +  +X1:1 +BN +X2:1 + + + +X1:2 +RD +X2:2 + + + +X1:3 +OG +X2:3 + + + +X1:4 +YE +X2:4 + + + +  + + + +X1:e--W1:w + + + + + + +X1:e--W1:w + + + + + + +X1:e--W1:w + + + + + + +X1:e--W1:w + + + + + + +X2 + +X2 + +Molex KK 254 + +female + +4-pin + +1 + +2 + +3 + +4 + +GND + +VCC + +SCL + +SDA + +1 + +2 + +3 + +4 + +to accelerometer + + + +W2 + + +W2 + +4x + +24 AWG + +0.1 m +  +X2:1 +BN +X3:1 + + + +X2:2 +RD +X3:2 + + + +X2:3 +OG +X3:3 + + + +X2:4 +YE +X3:4 + + + +  + + + +X2:e--W2:w + + + + + + +X2:e--W2:w + + + + + + +X2:e--W2:w + + + + + + +X2:e--W2:w + + + + + + +X3 + +X3 + +Molex KK 254 + +female + +4-pin + +1 + +2 + +3 + +4 + +GND + +VCC + +SCL + +SDA + +to temperature sensor + + + +W1:e--X2:w + + + + + + +W1:e--X2:w + + + + + + +W1:e--X2:w + + + + + + +W1:e--X2:w + + + + + + +W2:e--X3:w + + + + + + +W2:e--X3:w + + + + + + +W2:e--X3:w + + + + + + +W2:e--X3:w + + + + + + diff --git a/tutorial/tutorial05.bom.tsv b/tutorial/tutorial05.bom.tsv new file mode 100644 index 0000000..7885f32 --- /dev/null +++ b/tutorial/tutorial05.bom.tsv @@ -0,0 +1,6 @@ +Item Qty Unit Designators +Connector, Molex KK 254, female, 4 pins 6 X1, X2, X3, X4, X5, X6 +Wire, 0.25 mm², PK 1.0 m W1, W2, W3, W4, W5 +Wire, 0.25 mm², TQ 1.0 m W1, W2, W3, W4, W5 +Wire, 0.25 mm², VT 1.0 m W1, W2, W3, W4, W5 +Wire, 0.25 mm², YE 1.0 m W1, W2, W3, W4, W5 diff --git a/tutorial/tutorial05.gv b/tutorial/tutorial05.gv new file mode 100644 index 0000000..2779de2 --- /dev/null +++ b/tutorial/tutorial05.gv @@ -0,0 +1,78 @@ +graph { +// Graph generated by WireViz +// https://github.com/formatc1702/WireViz + graph [bgcolor=white fontname=arial nodesep=0.33 rankdir=LR ranksep=2] + node [fillcolor=white fontname=arial shape=record style=filled] + edge [fontname=arial style=bold] + X1 [label="X1|{Molex KK 254|female|4-pin}|{{GND|VCC|SCL|SDA}|{1|2|3|4}}"] + X2 [label="X2|{Molex KK 254|female|4-pin}|{{1|2|3|4}|{GND|VCC|SCL|SDA}}"] + X3 [label="X3|{Molex KK 254|female|4-pin}|{{GND|VCC|SCL|SDA}|{1|2|3|4}}"] + X4 [label="X4|{Molex KK 254|female|4-pin}|{{1|2|3|4}|{GND|VCC|SCL|SDA}}"] + X5 [label="X5|{Molex KK 254|female|4-pin}|{{GND|VCC|SCL|SDA}|{1|2|3|4}}"] + X6 [label="X6|{Molex KK 254|female|4-pin}|{{1|2|3|4}|{GND|VCC|SCL|SDA}}"] + edge [color="#000000:#ff66cc:#000000"] + X1:p1r:e -- W1:w1:w + W1:w1:e -- X2:p1l:w + edge [color="#000000:#00ffff:#000000"] + X1:p2r:e -- W1:w2:w + W1:w2:e -- X2:p2l:w + edge [color="#000000:#ffff00:#000000"] + X1:p3r:e -- W1:w3:w + W1:w3:e -- X2:p3l:w + edge [color="#000000:#8000ff:#000000"] + X1:p4r:e -- W1:w4:w + W1:w4:e -- X2:p4l:w + W1 [label=<
W1
4x0.25 mm²0.2 m
 
X1:1PKX2:1
X1:2TQX2:2
X1:3YEX2:3
X1:4VTX2:4
 
> fillcolor=white margin=0 shape=box style="filled,dashed"] + edge [color="#000000:#ff66cc:#000000"] + X3:p1r:e -- W2:w1:w + W2:w1:e -- X2:p1l:w + edge [color="#000000:#00ffff:#000000"] + X3:p2r:e -- W2:w2:w + W2:w2:e -- X2:p2l:w + edge [color="#000000:#ffff00:#000000"] + X3:p3r:e -- W2:w3:w + W2:w3:e -- X2:p3l:w + edge [color="#000000:#8000ff:#000000"] + X3:p4r:e -- W2:w4:w + W2:w4:e -- X2:p4l:w + W2 [label=<
W2
4x0.25 mm²0.2 m
 
X3:1PKX2:1
X3:2TQX2:2
X3:3YEX2:3
X3:4VTX2:4
 
> fillcolor=white margin=0 shape=box style="filled,dashed"] + edge [color="#000000:#ff66cc:#000000"] + X3:p1r:e -- W3:w1:w + W3:w1:e -- X4:p1l:w + edge [color="#000000:#00ffff:#000000"] + X3:p2r:e -- W3:w2:w + W3:w2:e -- X4:p2l:w + edge [color="#000000:#ffff00:#000000"] + X3:p3r:e -- W3:w3:w + W3:w3:e -- X4:p3l:w + edge [color="#000000:#8000ff:#000000"] + X3:p4r:e -- W3:w4:w + W3:w4:e -- X4:p4l:w + W3 [label=<
W3
4x0.25 mm²0.2 m
 
X3:1PKX4:1
X3:2TQX4:2
X3:3YEX4:3
X3:4VTX4:4
 
> fillcolor=white margin=0 shape=box style="filled,dashed"] + edge [color="#000000:#ff66cc:#000000"] + X5:p1r:e -- W4:w1:w + W4:w1:e -- X4:p1l:w + edge [color="#000000:#00ffff:#000000"] + X5:p2r:e -- W4:w2:w + W4:w2:e -- X4:p2l:w + edge [color="#000000:#ffff00:#000000"] + X5:p3r:e -- W4:w3:w + W4:w3:e -- X4:p3l:w + edge [color="#000000:#8000ff:#000000"] + X5:p4r:e -- W4:w4:w + W4:w4:e -- X4:p4l:w + W4 [label=<
W4
4x0.25 mm²0.2 m
 
X5:1PKX4:1
X5:2TQX4:2
X5:3YEX4:3
X5:4VTX4:4
 
> fillcolor=white margin=0 shape=box style="filled,dashed"] + edge [color="#000000:#ff66cc:#000000"] + X5:p1r:e -- W5:w1:w + W5:w1:e -- X6:p1l:w + edge [color="#000000:#00ffff:#000000"] + X5:p2r:e -- W5:w2:w + W5:w2:e -- X6:p2l:w + edge [color="#000000:#ffff00:#000000"] + X5:p3r:e -- W5:w3:w + W5:w3:e -- X6:p3l:w + edge [color="#000000:#8000ff:#000000"] + X5:p4r:e -- W5:w4:w + W5:w4:e -- X6:p4l:w + W5 [label=<
W5
4x0.25 mm²0.2 m
 
X5:1PKX6:1
X5:2TQX6:2
X5:3YEX6:3
X5:4VTX6:4
 
> fillcolor=white margin=0 shape=box style="filled,dashed"] +} diff --git a/tutorial/tutorial05.html b/tutorial/tutorial05.html new file mode 100644 index 0000000..ea542d0 --- /dev/null +++ b/tutorial/tutorial05.html @@ -0,0 +1,656 @@ +

Diagram

+ + + + + + + + +X1 + +X1 + +Molex KK 254 + +female + +4-pin + +GND + +VCC + +SCL + +SDA + +1 + +2 + +3 + +4 + + + +W1 + + +W1 + +4x + +0.25 mm² + +0.2 m +  +X1:1 +PK +X2:1 + + + +X1:2 +TQ +X2:2 + + + +X1:3 +YE +X2:3 + + + +X1:4 +VT +X2:4 + + + +  + + + +X1:e--W1:w + + + + + + +X1:e--W1:w + + + + + + +X1:e--W1:w + + + + + + +X1:e--W1:w + + + + + + +X2 + +X2 + +Molex KK 254 + +female + +4-pin + +1 + +2 + +3 + +4 + +GND + +VCC + +SCL + +SDA + + + +X3 + +X3 + +Molex KK 254 + +female + +4-pin + +GND + +VCC + +SCL + +SDA + +1 + +2 + +3 + +4 + + + +W2 + + +W2 + +4x + +0.25 mm² + +0.2 m +  +X3:1 +PK +X2:1 + + + +X3:2 +TQ +X2:2 + + + +X3:3 +YE +X2:3 + + + +X3:4 +VT +X2:4 + + + +  + + + +X3:e--W2:w + + + + + + +X3:e--W2:w + + + + + + +X3:e--W2:w + + + + + + +X3:e--W2:w + + + + + + +W3 + + +W3 + +4x + +0.25 mm² + +0.2 m +  +X3:1 +PK +X4:1 + + + +X3:2 +TQ +X4:2 + + + +X3:3 +YE +X4:3 + + + +X3:4 +VT +X4:4 + + + +  + + + +X3:e--W3:w + + + + + + +X3:e--W3:w + + + + + + +X3:e--W3:w + + + + + + +X3:e--W3:w + + + + + + +X4 + +X4 + +Molex KK 254 + +female + +4-pin + +1 + +2 + +3 + +4 + +GND + +VCC + +SCL + +SDA + + + +X5 + +X5 + +Molex KK 254 + +female + +4-pin + +GND + +VCC + +SCL + +SDA + +1 + +2 + +3 + +4 + + + +W4 + + +W4 + +4x + +0.25 mm² + +0.2 m +  +X5:1 +PK +X4:1 + + + +X5:2 +TQ +X4:2 + + + +X5:3 +YE +X4:3 + + + +X5:4 +VT +X4:4 + + + +  + + + +X5:e--W4:w + + + + + + +X5:e--W4:w + + + + + + +X5:e--W4:w + + + + + + +X5:e--W4:w + + + + + + +W5 + + +W5 + +4x + +0.25 mm² + +0.2 m +  +X5:1 +PK +X6:1 + + + +X5:2 +TQ +X6:2 + + + +X5:3 +YE +X6:3 + + + +X5:4 +VT +X6:4 + + + +  + + + +X5:e--W5:w + + + + + + +X5:e--W5:w + + + + + + +X5:e--W5:w + + + + + + +X5:e--W5:w + + + + + + +X6 + +X6 + +Molex KK 254 + +female + +4-pin + +1 + +2 + +3 + +4 + +GND + +VCC + +SCL + +SDA + + + +W1:e--X2:w + + + + + + +W1:e--X2:w + + + + + + +W1:e--X2:w + + + + + + +W1:e--X2:w + + + + + + +W2:e--X2:w + + + + + + +W2:e--X2:w + + + + + + +W2:e--X2:w + + + + + + +W2:e--X2:w + + + + + + +W3:e--X4:w + + + + + + +W3:e--X4:w + + + + + + +W3:e--X4:w + + + + + + +W3:e--X4:w + + + + + + +W4:e--X4:w + + + + + + +W4:e--X4:w + + + + + + +W4:e--X4:w + + + + + + +W4:e--X4:w + + + + + + +W5:e--X6:w + + + + + + +W5:e--X6:w + + + + + + +W5:e--X6:w + + + + + + +W5:e--X6:w + + + + + + +

Bill of Materials

ItemQtyUnitDesignators
Connector, Molex KK 254, female, 4 pins6X1, X2, X3, X4, X5, X6
Wire, 0.25 mm², PK1.0mW1, W2, W3, W4, W5
Wire, 0.25 mm², TQ1.0mW1, W2, W3, W4, W5
Wire, 0.25 mm², VT1.0mW1, W2, W3, W4, W5
Wire, 0.25 mm², YE1.0mW1, W2, W3, W4, W5
\ No newline at end of file diff --git a/tutorial/tutorial05.md b/tutorial/tutorial05.md new file mode 100644 index 0000000..6157478 --- /dev/null +++ b/tutorial/tutorial05.md @@ -0,0 +1,3 @@ +## Daisy chaining (II) + +* Zig-zag daisy chain diff --git a/tutorial/tutorial05.png b/tutorial/tutorial05.png new file mode 100644 index 0000000..ba0a2bf Binary files /dev/null and b/tutorial/tutorial05.png differ diff --git a/tutorial/tutorial05.svg b/tutorial/tutorial05.svg new file mode 100644 index 0000000..a0d0387 --- /dev/null +++ b/tutorial/tutorial05.svg @@ -0,0 +1,655 @@ + + + + + + + + + +X1 + +X1 + +Molex KK 254 + +female + +4-pin + +GND + +VCC + +SCL + +SDA + +1 + +2 + +3 + +4 + + + +W1 + + +W1 + +4x + +0.25 mm² + +0.2 m +  +X1:1 +PK +X2:1 + + + +X1:2 +TQ +X2:2 + + + +X1:3 +YE +X2:3 + + + +X1:4 +VT +X2:4 + + + +  + + + +X1:e--W1:w + + + + + + +X1:e--W1:w + + + + + + +X1:e--W1:w + + + + + + +X1:e--W1:w + + + + + + +X2 + +X2 + +Molex KK 254 + +female + +4-pin + +1 + +2 + +3 + +4 + +GND + +VCC + +SCL + +SDA + + + +X3 + +X3 + +Molex KK 254 + +female + +4-pin + +GND + +VCC + +SCL + +SDA + +1 + +2 + +3 + +4 + + + +W2 + + +W2 + +4x + +0.25 mm² + +0.2 m +  +X3:1 +PK +X2:1 + + + +X3:2 +TQ +X2:2 + + + +X3:3 +YE +X2:3 + + + +X3:4 +VT +X2:4 + + + +  + + + +X3:e--W2:w + + + + + + +X3:e--W2:w + + + + + + +X3:e--W2:w + + + + + + +X3:e--W2:w + + + + + + +W3 + + +W3 + +4x + +0.25 mm² + +0.2 m +  +X3:1 +PK +X4:1 + + + +X3:2 +TQ +X4:2 + + + +X3:3 +YE +X4:3 + + + +X3:4 +VT +X4:4 + + + +  + + + +X3:e--W3:w + + + + + + +X3:e--W3:w + + + + + + +X3:e--W3:w + + + + + + +X3:e--W3:w + + + + + + +X4 + +X4 + +Molex KK 254 + +female + +4-pin + +1 + +2 + +3 + +4 + +GND + +VCC + +SCL + +SDA + + + +X5 + +X5 + +Molex KK 254 + +female + +4-pin + +GND + +VCC + +SCL + +SDA + +1 + +2 + +3 + +4 + + + +W4 + + +W4 + +4x + +0.25 mm² + +0.2 m +  +X5:1 +PK +X4:1 + + + +X5:2 +TQ +X4:2 + + + +X5:3 +YE +X4:3 + + + +X5:4 +VT +X4:4 + + + +  + + + +X5:e--W4:w + + + + + + +X5:e--W4:w + + + + + + +X5:e--W4:w + + + + + + +X5:e--W4:w + + + + + + +W5 + + +W5 + +4x + +0.25 mm² + +0.2 m +  +X5:1 +PK +X6:1 + + + +X5:2 +TQ +X6:2 + + + +X5:3 +YE +X6:3 + + + +X5:4 +VT +X6:4 + + + +  + + + +X5:e--W5:w + + + + + + +X5:e--W5:w + + + + + + +X5:e--W5:w + + + + + + +X5:e--W5:w + + + + + + +X6 + +X6 + +Molex KK 254 + +female + +4-pin + +1 + +2 + +3 + +4 + +GND + +VCC + +SCL + +SDA + + + +W1:e--X2:w + + + + + + +W1:e--X2:w + + + + + + +W1:e--X2:w + + + + + + +W1:e--X2:w + + + + + + +W2:e--X2:w + + + + + + +W2:e--X2:w + + + + + + +W2:e--X2:w + + + + + + +W2:e--X2:w + + + + + + +W3:e--X4:w + + + + + + +W3:e--X4:w + + + + + + +W3:e--X4:w + + + + + + +W3:e--X4:w + + + + + + +W4:e--X4:w + + + + + + +W4:e--X4:w + + + + + + +W4:e--X4:w + + + + + + +W4:e--X4:w + + + + + + +W5:e--X6:w + + + + + + +W5:e--X6:w + + + + + + +W5:e--X6:w + + + + + + +W5:e--X6:w + + + + + + diff --git a/tutorial/tutorial05.yml b/tutorial/tutorial05.yml index d0a4d1a..2e2333e 100644 --- a/tutorial/tutorial05.yml +++ b/tutorial/tutorial05.yml @@ -1,27 +1,58 @@ +templates: + - &template_con + type: Molex KK 254 + subtype: female + pinout: [GND, VCC, SCL, SDA] + - &template_wire + gauge: 0.25 mm2 + length: 0.2 + colors: [PK, TQ, YE, VT] + category: bundle + connectors: X1: - pinout: [+12V, GND, GND, +5V] - type: Molex 8981 - subtype: female - -ferrules: # ferrules - F1: - type: Ferrule, crimp - subtype: 0.5 mm² - color: OG # optional color + <<: *template_con + X2: + <<: *template_con + X3: + <<: *template_con + X4: + <<: *template_con + X5: + <<: *template_con + X6: + <<: *template_con cables: W1: - category: bundle # budnle - length: 0.3 - gauge: 0.5 mm - colors: [YE, BK, BK, RD] # custom colors, wirecount is implicit - notes: hello! + <<: *template_wire + W2: + <<: *template_wire + W3: + <<: *template_wire + W4: + <<: *template_wire + W5: + <<: *template_wire connections: - - # attach ferrules - - F1 - - W1: [1-4] # a new ferrule is auto-generated for each wire - - # attach connectors (separetely from ferrules) - - W1: [1-4] + - - X1: [1-4] + - W1: [1-4] + - X2: [1-4] + - + - X3: [1-4] + - W2: [1-4] + - X2: [1-4] + - + - X3: [1-4] + - W3: [1-4] + - X4: [1-4] + - + - X5: [1-4] + - W4: [1-4] + - X4: [1-4] + - + - X5: [1-4] + - W5: [1-4] + - X6: [1-4] diff --git a/tutorial/tutorial06.bom.tsv b/tutorial/tutorial06.bom.tsv new file mode 100644 index 0000000..ea7ee62 --- /dev/null +++ b/tutorial/tutorial06.bom.tsv @@ -0,0 +1,6 @@ +Item Qty Unit Designators +Connector, Ferrule, crimp, 0.5 mm², OG 4 +Connector, Molex 8981, female, 4 pins 1 X1 +Wire, 0.5 mm, BK 0.6 m W1 +Wire, 0.5 mm, RD 0.3 m W1 +Wire, 0.5 mm, YE 0.3 m W1 diff --git a/tutorial/tutorial06.gv b/tutorial/tutorial06.gv new file mode 100644 index 0000000..dca9b6f --- /dev/null +++ b/tutorial/tutorial06.gv @@ -0,0 +1,65 @@ +graph { +// Graph generated by WireViz +// https://github.com/formatc1702/WireViz + graph [bgcolor=white fontname=arial nodesep=0.33 rankdir=LR ranksep=2] + node [fillcolor=white fontname=arial shape=record style=filled] + edge [fontname=arial style=bold] + X1 [label="X1|{Molex 8981|female|4-pin}|{{1|2|3|4}|{+12V|GND|GND|+5V}}"] + _F1 [label=< + + + + + +
Ferrule, crimp, 0.5 mm² OG
+ + + > margin=0 orientation=180 shape=none style=filled] + _F2 [label=< + + + + + +
Ferrule, crimp, 0.5 mm² OG
+ + + > margin=0 orientation=180 shape=none style=filled] + _F3 [label=< + + + + + +
Ferrule, crimp, 0.5 mm² OG
+ + + > margin=0 orientation=180 shape=none style=filled] + _F4 [label=< + + + + + +
Ferrule, crimp, 0.5 mm² OG
+ + + > margin=0 orientation=180 shape=none style=filled] + edge [color="#000000:#ffff00:#000000"] + _F1:e -- W1:w1:w + edge [color="#000000:#000000:#000000"] + _F2:e -- W1:w2:w + edge [color="#000000:#000000:#000000"] + _F3:e -- W1:w3:w + edge [color="#000000:#ff0000:#000000"] + _F4:e -- W1:w4:w + edge [color="#000000:#ffff00:#000000"] + W1:w1:e -- X1:p1l:w + edge [color="#000000:#000000:#000000"] + W1:w2:e -- X1:p2l:w + edge [color="#000000:#000000:#000000"] + W1:w3:e -- X1:p3l:w + edge [color="#000000:#ff0000:#000000"] + W1:w4:e -- X1:p4l:w + W1 [label=<
W1
4x0.5 mm0.3 m
 
YEX1:1
BKX1:2
BKX1:3
RDX1:4
 
hello!
 
> fillcolor=white margin=0 shape=box style="filled,dashed"] +} diff --git a/tutorial/tutorial06.html b/tutorial/tutorial06.html new file mode 100644 index 0000000..e099d07 --- /dev/null +++ b/tutorial/tutorial06.html @@ -0,0 +1,178 @@ +

Diagram

+ + + + + + + + +X1 + +X1 + +Molex 8981 + +female + +4-pin + +1 + +2 + +3 + +4 + ++12V + +GND + +GND + ++5V + + + +_F1 + + Ferrule, crimp, 0.5 mm² OG + + + +   + + + + +W1 + + +W1 + +4x + +0.5 mm + +0.3 m +  +YE +X1:1 + + + +BK +X1:2 + + + +BK +X1:3 + + + +RD +X1:4 + + + +  +hello! +  + + + +_F1:e--W1:w + + + + + + +_F2 + + Ferrule, crimp, 0.5 mm² OG + + + +   + + + + +_F2:e--W1:w + + + + + + +_F3 + + Ferrule, crimp, 0.5 mm² OG + + + +   + + + + +_F3:e--W1:w + + + + + + +_F4 + + Ferrule, crimp, 0.5 mm² OG + + + +   + + + + +_F4:e--W1:w + + + + + + +W1:e--X1:w + + + + + + +W1:e--X1:w + + + + + + +W1:e--X1:w + + + + + + +W1:e--X1:w + + + + + + +

Bill of Materials

ItemQtyUnitDesignators
Connector, Ferrule, crimp, 0.5 mm², OG4
Connector, Molex 8981, female, 4 pins1X1
Wire, 0.5 mm, BK0.6mW1
Wire, 0.5 mm, RD0.3mW1
Wire, 0.5 mm, YE0.3mW1
\ No newline at end of file diff --git a/tutorial/tutorial06.md b/tutorial/tutorial06.md new file mode 100644 index 0000000..7b6984c --- /dev/null +++ b/tutorial/tutorial06.md @@ -0,0 +1,7 @@ +## Ferrules, wire bundles, custom colors + +* Ferrules +* Wire bundles + * Internally treated as cables + * Different treatment in BOM +* Custom colors diff --git a/tutorial/tutorial06.png b/tutorial/tutorial06.png new file mode 100644 index 0000000..920a5c9 Binary files /dev/null and b/tutorial/tutorial06.png differ diff --git a/tutorial/tutorial06.svg b/tutorial/tutorial06.svg new file mode 100644 index 0000000..082c3c0 --- /dev/null +++ b/tutorial/tutorial06.svg @@ -0,0 +1,177 @@ + + + + + + + + + +X1 + +X1 + +Molex 8981 + +female + +4-pin + +1 + +2 + +3 + +4 + ++12V + +GND + +GND + ++5V + + + +_F1 + + Ferrule, crimp, 0.5 mm² OG + + + +   + + + + +W1 + + +W1 + +4x + +0.5 mm + +0.3 m +  +YE +X1:1 + + + +BK +X1:2 + + + +BK +X1:3 + + + +RD +X1:4 + + + +  +hello! +  + + + +_F1:e--W1:w + + + + + + +_F2 + + Ferrule, crimp, 0.5 mm² OG + + + +   + + + + +_F2:e--W1:w + + + + + + +_F3 + + Ferrule, crimp, 0.5 mm² OG + + + +   + + + + +_F3:e--W1:w + + + + + + +_F4 + + Ferrule, crimp, 0.5 mm² OG + + + +   + + + + +_F4:e--W1:w + + + + + + +W1:e--X1:w + + + + + + +W1:e--X1:w + + + + + + +W1:e--X1:w + + + + + + +W1:e--X1:w + + + + + + diff --git a/tutorial/tutorial06.yml b/tutorial/tutorial06.yml index ee0b3de..d0a4d1a 100644 --- a/tutorial/tutorial06.yml +++ b/tutorial/tutorial06.yml @@ -3,14 +3,9 @@ connectors: pinout: [+12V, GND, GND, +5V] type: Molex 8981 subtype: female - F_10_1: # manually define a ferrule (with unique identifier) - category: ferrule - type: Ferrule, crimp - subtype: 1.0 mm² - color: YE ferrules: # ferrules - F_05: + F1: type: Ferrule, crimp subtype: 0.5 mm² color: OG # optional color @@ -21,18 +16,12 @@ cables: length: 0.3 gauge: 0.5 mm colors: [YE, BK, BK, RD] # custom colors, wirecount is implicit + notes: hello! connections: - # attach ferrules - - F_05 - - W1: [1,4] # a new ferrule is auto-generated for each wire + - F1 + - W1: [1-4] # a new ferrule is auto-generated for each wire - # attach connectors (separetely from ferrules) - W1: [1-4] - X1: [1-4] - - - - F_10_1: 1 # manually defined ferrules are treated like regular connectors, - # thus requiring a pin number - - W1: 2 - - - - F_10_1: 1 - - W1: 3 diff --git a/tutorial/tutorial07.bom.tsv b/tutorial/tutorial07.bom.tsv new file mode 100644 index 0000000..3776094 --- /dev/null +++ b/tutorial/tutorial07.bom.tsv @@ -0,0 +1,7 @@ +Item Qty Unit Designators +Connector, Ferrule, crimp, 0.5 mm², OG 2 +Connector, Ferrule, crimp, 1.0 mm², YE 1 +Connector, Molex 8981, female, 4 pins 1 X1 +Wire, 0.5 mm, BK 0.6 m W1 +Wire, 0.5 mm, RD 0.3 m W1 +Wire, 0.5 mm, YE 0.3 m W1 diff --git a/tutorial/tutorial07.gv b/tutorial/tutorial07.gv new file mode 100644 index 0000000..74e80f5 --- /dev/null +++ b/tutorial/tutorial07.gv @@ -0,0 +1,55 @@ +graph { +// Graph generated by WireViz +// https://github.com/formatc1702/WireViz + graph [bgcolor=white fontname=arial nodesep=0.33 rankdir=LR ranksep=2] + node [fillcolor=white fontname=arial shape=record style=filled] + edge [fontname=arial style=bold] + X1 [label="X1|{Molex 8981|female|4-pin}|{{1|2|3|4}|{+12V|GND|GND|+5V}}"] + F_10_1 [label=< + + + + + +
Ferrule, crimp, 1.0 mm² YE
+ + + > margin=0 orientation=180 shape=none style=filled] + _F1 [label=< + + + + + +
Ferrule, crimp, 0.5 mm² OG
+ + + > margin=0 orientation=180 shape=none style=filled] + _F2 [label=< + + + + + +
Ferrule, crimp, 0.5 mm² OG
+ + + > margin=0 orientation=180 shape=none style=filled] + edge [color="#000000:#ffff00:#000000"] + _F1:e -- W1:w1:w + edge [color="#000000:#ff0000:#000000"] + _F2:e -- W1:w4:w + edge [color="#000000:#ffff00:#000000"] + W1:w1:e -- X1:p1l:w + edge [color="#000000:#000000:#000000"] + W1:w2:e -- X1:p2l:w + edge [color="#000000:#000000:#000000"] + W1:w3:e -- X1:p3l:w + edge [color="#000000:#ff0000:#000000"] + W1:w4:e -- X1:p4l:w + edge [color="#000000:#000000:#000000"] + F_10_1:e -- W1:w2:w + edge [color="#000000:#000000:#000000"] + F_10_1:e -- W1:w3:w + W1 [label=<
W1
4x0.5 mm0.3 m
 
YEX1:1
BKX1:2
BKX1:3
RDX1:4
 
> fillcolor=white margin=0 shape=box style="filled,dashed"] +} diff --git a/tutorial/tutorial07.html b/tutorial/tutorial07.html new file mode 100644 index 0000000..8b05c31 --- /dev/null +++ b/tutorial/tutorial07.html @@ -0,0 +1,165 @@ +

Diagram

+ + + + + + + + +X1 + +X1 + +Molex 8981 + +female + +4-pin + +1 + +2 + +3 + +4 + ++12V + +GND + +GND + ++5V + + + +F_10_1 + + Ferrule, crimp, 1.0 mm² YE + + + +   + + + + +W1 + + +W1 + +4x + +0.5 mm + +0.3 m +  +YE +X1:1 + + + +BK +X1:2 + + + +BK +X1:3 + + + +RD +X1:4 + + + +  + + + +F_10_1:e--W1:w + + + + + + +F_10_1:e--W1:w + + + + + + +_F1 + + Ferrule, crimp, 0.5 mm² OG + + + +   + + + + +_F1:e--W1:w + + + + + + +_F2 + + Ferrule, crimp, 0.5 mm² OG + + + +   + + + + +_F2:e--W1:w + + + + + + +W1:e--X1:w + + + + + + +W1:e--X1:w + + + + + + +W1:e--X1:w + + + + + + +W1:e--X1:w + + + + + + +

Bill of Materials

ItemQtyUnitDesignators
Connector, Ferrule, crimp, 0.5 mm², OG2
Connector, Ferrule, crimp, 1.0 mm², YE1
Connector, Molex 8981, female, 4 pins1X1
Wire, 0.5 mm, BK0.6mW1
Wire, 0.5 mm, RD0.3mW1
Wire, 0.5 mm, YE0.3mW1
\ No newline at end of file diff --git a/tutorial/tutorial07.md b/tutorial/tutorial07.md new file mode 100644 index 0000000..b15abbb --- /dev/null +++ b/tutorial/tutorial07.md @@ -0,0 +1,4 @@ +## Custom ferrules + +* Custom ferrules + * Allows attaching more than one wire to a ferrule diff --git a/tutorial/tutorial07.png b/tutorial/tutorial07.png new file mode 100644 index 0000000..2f7901d Binary files /dev/null and b/tutorial/tutorial07.png differ diff --git a/tutorial/tutorial07.svg b/tutorial/tutorial07.svg new file mode 100644 index 0000000..a68a0a7 --- /dev/null +++ b/tutorial/tutorial07.svg @@ -0,0 +1,164 @@ + + + + + + + + + +X1 + +X1 + +Molex 8981 + +female + +4-pin + +1 + +2 + +3 + +4 + ++12V + +GND + +GND + ++5V + + + +F_10_1 + + Ferrule, crimp, 1.0 mm² YE + + + +   + + + + +W1 + + +W1 + +4x + +0.5 mm + +0.3 m +  +YE +X1:1 + + + +BK +X1:2 + + + +BK +X1:3 + + + +RD +X1:4 + + + +  + + + +F_10_1:e--W1:w + + + + + + +F_10_1:e--W1:w + + + + + + +_F1 + + Ferrule, crimp, 0.5 mm² OG + + + +   + + + + +_F1:e--W1:w + + + + + + +_F2 + + Ferrule, crimp, 0.5 mm² OG + + + +   + + + + +_F2:e--W1:w + + + + + + +W1:e--X1:w + + + + + + +W1:e--X1:w + + + + + + +W1:e--X1:w + + + + + + +W1:e--X1:w + + + + + + diff --git a/tutorial/tutorial07.yml b/tutorial/tutorial07.yml new file mode 100644 index 0000000..ee0b3de --- /dev/null +++ b/tutorial/tutorial07.yml @@ -0,0 +1,38 @@ +connectors: + X1: + pinout: [+12V, GND, GND, +5V] + type: Molex 8981 + subtype: female + F_10_1: # manually define a ferrule (with unique identifier) + category: ferrule + type: Ferrule, crimp + subtype: 1.0 mm² + color: YE + +ferrules: # ferrules + F_05: + type: Ferrule, crimp + subtype: 0.5 mm² + color: OG # optional color + +cables: + W1: + category: bundle # budnle + length: 0.3 + gauge: 0.5 mm + colors: [YE, BK, BK, RD] # custom colors, wirecount is implicit + +connections: + - # attach ferrules + - F_05 + - W1: [1,4] # a new ferrule is auto-generated for each wire + - # attach connectors (separetely from ferrules) + - W1: [1-4] + - X1: [1-4] + - + - F_10_1: 1 # manually defined ferrules are treated like regular connectors, + # thus requiring a pin number + - W1: 2 + - + - F_10_1: 1 + - W1: 3