diff --git a/tutorial/MolexKK254.jpg b/tutorial/MolexKK254.jpg new file mode 100644 index 000000000..755cfe9a6 Binary files /dev/null and b/tutorial/MolexKK254.jpg differ diff --git a/tutorial/MolexKK254MALE.jpg b/tutorial/MolexKK254MALE.jpg new file mode 100644 index 000000000..c2dc5a75a Binary files /dev/null and b/tutorial/MolexKK254MALE.jpg differ diff --git a/tutorial/readme.md b/tutorial/readme.md index 56f9cce57..8e66fb26c 100644 --- a/tutorial/readme.md +++ b/tutorial/readme.md @@ -1,5 +1,24 @@ # WireViz Tutorial +[01 - Bare-bones example](#01---Bare-bones-example) + +[02 - Adding parameters and colors](#02---adding-parameters-and-colors) + +[03 - Pinouts, shielding, templates (I)](#03---pinouts-shielding-templates-(I)) + +[04 - Templates (II), notes, American standards, daisy chaining (I)](#04---templates-(II)-notes-american-standards-daisy-chaining-(I)) + +[05 - Ferrules, wire bundles, custom wire colors](#05---ferrules,-wire-bundles,-custom-wire-colors) + +[06 - Custom ferrules](#06---custom-ferrules) + +[07 - Daisy chaining (II)](#07---daisy-chaining-(II)) + +[08 - Part numbers and additional components](#08---part-numbers-and-additional-components) + +[09 - Hidden wire information and using a template for nice display](#09---hidden-wire-information-and-using-a-template-for-nice-display-as-a-din6771-document) + + ## 01 - Bare-bones example * Minimum working example @@ -417,3 +436,39 @@ additional_bom_items: [Source](tutorial08.yml) - [Bill of Materials](tutorial08.bom.tsv) +## 09 - Hidden wire information and using a template for nice display as a DIN6771 document + +What will this 'tutorial' show you? + +## Hide wire information + +* Sometimes the box around the wire will be distracting + * unfortunately some fields can not (yetd) be suppressed: + length + gauge + color_code + manufacturer + mpn + supplier + spn + pn + +## Nice uniform template + +* Formatting the end result in a DIN-6771 template makes for a very nice result. + * using a template ensures all your wiring diagrams will have a uniform look + * the template can be found at: + /home/[USER]/.local/lib/python3.10/site-packages/wireviz/templates/din-6771.html + +## Adding images to your components +* Add an image to your component + + +```yaml + + +``` + +![](tutorial09.png) + +[Source](tutorial09.yml) - [Bill of Materials](tutorial09.bom.tsv) \ No newline at end of file diff --git a/tutorial/readme09.md b/tutorial/readme09.md new file mode 100644 index 000000000..ca8afb166 --- /dev/null +++ b/tutorial/readme09.md @@ -0,0 +1,576 @@ +# WireViz Tutorial + +## [01 - Bare-bones example](01---Bare-bones-example) +## [02 - Adding parameters and colors](02---Adding-parameters-and-colors) +## [03 - Pinouts, shielding, templates (I)](03---Pinouts,-shielding,-templates-(I)) +## [04 - Templates (II), notes, American standards, daisy chaining (I)](04---Templates-(II),-notes,-American-standards,-daisy-chaining-(I)) +## [05 - Ferrules, wire bundles, custom wire colors](05---Ferrules,-wire-bundles,-custom-wire-colors) +## [06 - Custom ferrules](06---Custom-ferrules) +## [07 - Daisy chaining (II)](07---Daisy-chaining-(II)) +## [08 - Part numbers and additional components](08---Part-numbers-and-additional-components) +## [09 - Hidden wire information and using a template for nice display as a DIN6771 document](09---Hidden-wire-information-and-using-a-template-for-nice-display-as-a-DIN6771-document) + + +## 01 - Bare-bones example + +* Minimum working example +* Only 1-to-1 sequential wiring + + +```yaml +connectors: + X1: + pincount: 4 + X2: + pincount: 4 + +cables: + W1: + wirecount: 4 + length: 1 + +connections: + - + - X1: [1-4] + - W1: [1-4] + - X2: [1-4] +``` + +![](tutorial01.png) + +[Source](tutorial01.yml) - [Bill of Materials](tutorial01.bom.tsv) + + +## 02 - Adding parameters and colors + +* Parameters for connectors and cables +* Auto-calculate equivalent AWG from mm2 +* Non-sequential wiring + + +```yaml +connectors: + X1: + pincount: 4 + # More connector parameters: + type: Molex KK 254 + subtype: female + X2: + pincount: 4 + type: Molex KK 254 + subtype: female + +cables: + W1: + wirecount: 4 + # more cable parameters: + length: 1 + gauge: 0.25 mm2 + show_equiv: true # auto-calculate AWG equivalent + colors: [WH, BN, GN, YE] + +connections: + - + - X1: [1-4] + - W1: [1-4] + # non-sequential wiring: + - X2: [1,2,4,3] +``` + +![](tutorial02.png) + +[Source](tutorial02.yml) - [Bill of Materials](tutorial02.bom.tsv) + + +## 03 - Pinouts, shielding, templates (I) + +* Connector pinouts + * Pincount implicit in pinout +* Cable color codes +* Cable shielding, shield wiring +* Templates + + +```yaml +connectors: + X1: &template1 # define a template for later use + pinlabels: [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 +``` + +![](tutorial03.png) + +[Source](tutorial03.yml) - [Bill of Materials](tutorial03.bom.tsv) + + +## 04 - Templates (II), notes, American standards, daisy chaining (I) + +* Overriding template parameters +* Add nodes to connectors and cables +* American standards: AWG gauge and IEC colors +* Linear daisy-chain + * Convenient for shorter chains + + +```yaml +connectors: + X1: &template_con + pinlabels: [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 # specify gauge in AWG directly + color_code: IEC # IEC 62 colors also supported + notes: This cable is a bit longer + W2: + <<: *template_cbl + length: 0.1 + notes: This cable is a bit shorter + +connections: + - + - X1: [1-4] + - W1: [1-4] + - X2: [1-4] + - # daisy chain connectors (in line) + - X2: [1-4] + - W2: [1-4] + - X3: [1-4] +``` + +![](tutorial04.png) + +[Source](tutorial04.yml) - [Bill of Materials](tutorial04.bom.tsv) + + +## 05 - Ferrules, wire bundles, custom wire colors + +* Ferrules + * Simpler than connectors + * Compact graphical representation + * Only one pin, only one connection, no designator + * Define once, auto-generate where needed +* Wire bundles + * Internally treated as cables + * Different treatment in BOM: Each wire is listed individually + * Represented with dashed outline +* Custom wire colors + * Wirecount can be implicit in color list + + +```yaml +connectors: + X1: + pinlabels: [+12V, GND, GND, +5V] + type: Molex 8981 + subtype: female + F1: + style: simple + type: Crimp ferrule + subtype: 0.5 mm² + color: OG # optional color + +cables: + W1: + category: bundle # bundle + length: 0.3 + gauge: 0.5 mm2 + colors: [YE, BK, BK, RD] # custom colors, wirecount is implicit + +connections: + - + - F1. # a new ferrule is auto-generated for each of the four wires + - W1: [1-4] + - X1: [1-4] +``` + +![](tutorial05.png) + +[Source](tutorial05.yml) - [Bill of Materials](tutorial05.bom.tsv) + + +## 06 - Custom ferrules + +* Custom ferrules + * Allows attaching more than one wire to a ferrule + * Requires defining them as regular connectors with unique designators, adding `category: ferrule` parameter + + +```yaml +connectors: + X1: + pinlabels: [+12V, GND, GND, +5V] + type: Molex 8981 + subtype: female + F_10: # this is a unique ferrule + style: simple + type: Crimp ferrule + subtype: 1.0 mm² + color: YE # optional color + F_05: # this is a ferrule that will be auto-generated on demand + style: simple + type: Crimp ferrule + subtype: 0.5 mm² + color: OG + +cables: + W1: + category: bundle # bundle + length: 0.3 + gauge: 0.5 mm2 + colors: [YE, BK, BK, RD] # custom colors, wirecount is implicit + +connections: + - + - [F_05., F_10.F1, F_10.F1, F_05.] + - W1: [1-4] + - X1: [1-4] +``` + +![](tutorial06.png) + +[Source](tutorial06.yml) - [Bill of Materials](tutorial06.bom.tsv) + + +## 07 - Daisy chaining (II) + +* Zig-zag daisy chain + * Convenient for longer chains + + +```yaml +connectors: + X1: &template_con + type: Molex KK 254 + subtype: female + pinlabels: [GND, VCC, SCL, SDA] + X2: + <<: *template_con + X3: + <<: *template_con + X4: + <<: *template_con + X5: + <<: *template_con + X6: + <<: *template_con + +cables: + W1: &template_wire + gauge: 0.25 mm2 + length: 0.2 + colors: [TQ, PK, YE, VT] + category: bundle + 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] +``` + +![](tutorial07.png) + +[Source](tutorial07.yml) - [Bill of Materials](tutorial07.bom.tsv) + + +## 08 - Part numbers and additional components + +* Part number information can be added to parts + * Only provided fields will be added to the diagram and bom +* Bundles can have part information specified by wire +* Additional parts can be added to components or just to the bom + * quantities of additional components can be multiplied by features from parent connector or cable + + +```yaml +options: + mini_bom_mode: false + +connectors: + X1: &template1 # define a template for later use + type: Molex KK 254 + pincount: 4 + subtype: female + manufacturer: 'Molex' # set manufacter name + mpn: '22013047' # set manufacturer part number + supplier: Digimouse + spn: 1234 + # add a list of additional components to a part (shown in graph) + additional_components: + - type: Crimp # short identifier used in graph + subtype: Molex KK 254, 22-30 AWG # extra information added to type in bom + qty_multiplier: populated # multipier for quantity (number of populated pins) + manufacturer: Molex # set manufacter name + mpn: 08500030 # set manufacturer part number + - type: Test + qty: 1 + pn: ABC + manufacturer: Molex + mpn: 45454 + supplier: Mousikey + spn: 9999 + X2: + <<: *template1 # reuse template + pn: CON4 # set an internal part number for just this connector + X3: + <<: *template1 # reuse template + +cables: + W1: + wirecount: 4 + length: 1 + gauge: 0.25 mm2 + color_code: IEC + manufacturer: CablesCo + mpn: ABC123 + supplier: Cables R Us + spn: 999-888-777 + pn: CAB1 + W2: + category: bundle + length: 1 + gauge: 0.25 mm2 + colors: [YE, BK, BK, RD] + manufacturer: [WiresCo, WiresCo, WiresCo, WiresCo] # set a manufacter per wire + mpn: [W1-YE, W1-BK, W1-BK, W1-RD] + supplier: [WireShack, WireShack, WireShack, WireShack] + spn: [1001, 1002, 1002, 1009] + pn: [WIRE1, WIRE2, WIRE2, WIRE3] + # add a list of additional components to a part (shown in graph) + additional_components: + - type: Sleve # short identifier used in graph + subtype: Braided nylon, black, 3mm # extra information added to type in bom + qty_multiplier: length # multipier for quantity (length of cable) + unit: m + pn: SLV-1 + +connections: + - - X1: [1-4] + - W1: [1-4] + - X2: [1-4] + - - X1: [1-4] + - W2: [1-4] + - X3: [1-4] + +additional_bom_items: + - # define an additional item to add to the bill of materials (does not appear in graph) + description: Label, pinout information + qty: 2 + designators: + - X2 + - X3 + manufacturer: 'Brady' + mpn: 'B-499' + pn: Label-ID-1 +``` + +![](tutorial08.png) + +[Source](tutorial08.yml) - [Bill of Materials](tutorial08.bom.tsv) + + +## 09 - Hidden wire information and using a template for nice display as a DIN6771 document + +What will this 'tutorial' show you? + +##Hidden wire information +* Sometimes the box around the wire will be distrating + * unfurtionaly some fields can not (yet) be suppressed: + length + gauge + color_code + manufacturer + mpn + supplier + spn + pn +##Nice uniform template +* Formatting the end result in a DIN-6771 template makes for a very nice result. + * using a template ensures all your wiring diagrams will have a uniform look + * the template can be found at: /home/[USER]/.local/lib/python3.10/site-packages/wireviz/templates/din-6771.html +##Adding images to your components +* Add an image to your connector (or wire) + + +```yaml + + +connectors: + X1: &template1 # define a template for later use + type: Molex KK 254 + pincount: 4 + subtype: female + manufacturer: 'Molex' # set manufacter name + mpn: '22013047' # set manufacturer part number + supplier: Digimouse + spn: 1234 + image: + src: MolexKK254.jpg + # add a list of additional components to a part (shown in graph) + additional_components: + - type: Crimp # short identifier used in graph + subtype: Molex KK 254, 22-30 AWG # extra information added to type in bom + qty_multiplier: populated # multipier for quantity (number of populated pins) + manufacturer: Molex # set manufacter name + mpn: 08500030 # set manufacturer part number + - type: Test + qty: 1 + pn: ABC + manufacturer: Molex + mpn: 45454 + supplier: Mousikey + spn: 9999 + X2: + <<: *template1 # reuse template + pn: CON4 # set an internal part number for just this connector + subtype: male + image: + src: MolexKK254MALE.jpg + + X3: + <<: *template1 # reuse template + subtype: male + image: + src: MolexKK254MALE.jpg +cables: + W1: + wirecount: 4 + # length: 1 + # gauge: 0.25 mm2 + # color_code: IEC + # manufacturer: CablesCo + # mpn: ABC123 + # supplier: Cables R Us + # spn: 999-888-777 + # pn: CAB1 + ############# + show_name: false + show_wirecount: false + show_wirenumbers: false + ############# + W2: + category: bundle + length: 1 + gauge: 0.25 mm2 + colors: [YE, BK, BK, RD] + manufacturer: [WiresCo, WiresCo, WiresCo, WiresCo] # set a manufacter per wire + mpn: [W1-YE, W1-BK, W1-BK, W1-RD] + supplier: [WireShack, WireShack, WireShack, WireShack] + spn: [1001, 1002, 1002, 1009] + pn: [WIRE1, WIRE2, WIRE2, WIRE3] + # add a list of additional components to a part (shown in graph) + additional_components: + - type: Sleve # short identifier used in graph + subtype: Braided nylon, black, 3mm # extra information added to type in bom + qty_multiplier: length # multipier for quantity (length of cable) + unit: m + pn: SLV-1 + +connections: + - - X1: [1-4] + - W1: [1-4] + - X2: [1-4] + - - X1: [1-4] + - W2: [1-4] + - X3: [1-4] + ############# +tweak: + override: + graph: + ranksep: "0.5" # Reduce the horizontal spacing (default 2) + wireTweak: &wireTweak + shape: none # Hide the surrounding frame + fontsize: "12" # Reduce the space needed for text + fontcolor: white # Same as background to hide the text + ## W1 uses the gauge and length field, they can not be suppressed at the moment. There was an issue #221 + W1: + <<: *wireTweak + ############### + +###### the din template, A4 format +metadata: + title: Power supplies + pn: PSU + + authors: + Created: + name: Ton + date: 2025-03-11 + Approved: + name: Ton + date: 2025-03-11 + + revisions: + A: + name: Ton + date: 2025-03-12 + changelog: updates] + + template: + name: din-6771 + sheetsize: A4 + +``` + +![](tutorial09.png) + +[Source](tutorial09.yml) - [Bill of Materials](tutorial09.bom.tsv) \ No newline at end of file diff --git a/tutorial/tutorial09.bom.tsv b/tutorial/tutorial09.bom.tsv new file mode 100644 index 000000000..07c8c2c81 --- /dev/null +++ b/tutorial/tutorial09.bom.tsv @@ -0,0 +1,11 @@ +Id Description Qty Unit Designators P/N Manufacturer MPN Supplier SPN +1 Cable, 4 wires 0 m +2 Connector, Molex KK 254, female, 4 pins 1 X1 Molex 22013047 Digimouse 1234 +3 Connector, Molex KK 254, male, 4 pins 1 X3 Molex 22013047 Digimouse 1234 +4 Connector, Molex KK 254, male, 4 pins 1 X2 CON4 Molex 22013047 Digimouse 1234 +5 Crimp, Molex KK 254, 22-30 AWG 12 X1, X2, X3 Molex 08500030 +6 Sleve, Braided nylon, black, 3mm 1 m W2 SLV-1 +7 Test 3 X1, X2, X3 ABC Molex 45454 Mousikey 9999 +8 Wire, 0.25 mm², BK 2 m W2 WIRE2 WiresCo W1-BK WireShack 1002 +9 Wire, 0.25 mm², RD 1 m W2 WIRE3 WiresCo W1-RD WireShack 1009 +10 Wire, 0.25 mm², YE 1 m W2 WIRE1 WiresCo W1-YE WireShack 1001 diff --git a/tutorial/tutorial09.html b/tutorial/tutorial09.html new file mode 100644 index 000000000..ab0842a03 --- /dev/null +++ b/tutorial/tutorial09.html @@ -0,0 +1,730 @@ + + + + + + + Power supplies + + + + +
+
+ +
+ +
+ +
+ + + + + + +%3 + + + +X1 + + +X1 + +Molex: 22013047 + +Digimouse: 1234 + +Molex KK 254 + +female + +4-pin + +1 + +2 + +3 + +4 + + + +Additional components + +4 x #5 (Crimp) + +1 x #7 (Test) + + + +W1 + +  +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 + + + + + + +W2 + + +W2 + +4x + +0.25 mm² + +1 m +  +X1:1 +     YE     +X3:1 + + + +P/N: WIRE1 +WiresCo: W1-YE +WireShack: 1001 +X1:2 +     BK     +X3:2 + + + +P/N: WIRE2 +WiresCo: W1-BK +WireShack: 1002 +X1:3 +     BK     +X3:3 + + + +P/N: WIRE2 +WiresCo: W1-BK +WireShack: 1002 +X1:4 +     RD     +X3:4 + + + +P/N: WIRE3 +WiresCo: W1-RD +WireShack: 1009 +  + +Additional components + +1 m x #6 (Sleve) + + + +X1:e--W2:w + + + + + + +X1:e--W2:w + + + + + + +X1:e--W2:w + + + + + + +X1:e--W2:w + + + + + + +X2 + + +X2 + +P/N: CON4 + +Molex: 22013047 + +Digimouse: 1234 + +Molex KK 254 + +male + +4-pin + +1 + +2 + +3 + +4 + + + +Additional components + +4 x #5 (Crimp) + +1 x #7 (Test) + + + +X3 + + +X3 + +Molex: 22013047 + +Digimouse: 1234 + +Molex KK 254 + +male + +4-pin + +1 + +2 + +3 + +4 + + + +Additional components + +4 x #5 (Crimp) + +1 x #7 (Test) + + + +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 + + + + + + + + +
+ +
+ +
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
10Wire, 0.25 mm², YE1mW2WIRE1WiresCoW1-YEWireShack1001
9Wire, 0.25 mm², RD1mW2WIRE3WiresCoW1-RDWireShack1009
8Wire, 0.25 mm², BK2mW2WIRE2WiresCoW1-BKWireShack1002
7Test3X1, X2, X3ABCMolex45454Mousikey9999
6Sleve, Braided nylon, black, 3mm1mW2SLV-1
5Crimp, Molex KK 254, 22-30 AWG12X1, X2, X3Molex08500030
4Connector, Molex KK 254, male, 4 pins1X2CON4Molex22013047Digimouse1234
3Connector, Molex KK 254, male, 4 pins1X3Molex22013047Digimouse1234
2Connector, Molex KK 254, female, 4 pins1X1Molex22013047Digimouse1234
1Cable, 4 wires0m
IdDescriptionQtyUnitDesignatorsP/NManufacturerMPNSupplierSPN
+ +
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
DateNamePower supplies
Created2025-03-11Ton
Approved2025-03-11Ton
PSUSheet
1
Aupdates]2025-03-12Tonof 1
RevChangelogDateName
+
+ +
+
+ + diff --git a/tutorial/tutorial09.png b/tutorial/tutorial09.png new file mode 100644 index 000000000..e9636e981 Binary files /dev/null and b/tutorial/tutorial09.png differ diff --git a/tutorial/tutorial09.svg b/tutorial/tutorial09.svg new file mode 100644 index 000000000..4ca26f66b --- /dev/null +++ b/tutorial/tutorial09.svg @@ -0,0 +1,312 @@ + + + + + + +%3 + + + +X1 + + +X1 + +Molex: 22013047 + +Digimouse: 1234 + +Molex KK 254 + +female + +4-pin + +1 + +2 + +3 + +4 + + + +Additional components + +4 x #5 (Crimp) + +1 x #7 (Test) + + + +W1 + +  +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 + + + + + + +W2 + + +W2 + +4x + +0.25 mm² + +1 m +  +X1:1 +     YE     +X3:1 + + + +P/N: WIRE1 +WiresCo: W1-YE +WireShack: 1001 +X1:2 +     BK     +X3:2 + + + +P/N: WIRE2 +WiresCo: W1-BK +WireShack: 1002 +X1:3 +     BK     +X3:3 + + + +P/N: WIRE2 +WiresCo: W1-BK +WireShack: 1002 +X1:4 +     RD     +X3:4 + + + +P/N: WIRE3 +WiresCo: W1-RD +WireShack: 1009 +  + +Additional components + +1 m x #6 (Sleve) + + + +X1:e--W2:w + + + + + + +X1:e--W2:w + + + + + + +X1:e--W2:w + + + + + + +X1:e--W2:w + + + + + + +X2 + + +X2 + +P/N: CON4 + +Molex: 22013047 + +Digimouse: 1234 + +Molex KK 254 + +male + +4-pin + +1 + +2 + +3 + +4 + + + +Additional components + +4 x #5 (Crimp) + +1 x #7 (Test) + + + +X3 + + +X3 + +Molex: 22013047 + +Digimouse: 1234 + +Molex KK 254 + +male + +4-pin + +1 + +2 + +3 + +4 + + + +Additional components + +4 x #5 (Crimp) + +1 x #7 (Test) + + + +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/tutorial09.yml b/tutorial/tutorial09.yml new file mode 100644 index 000000000..41c065914 --- /dev/null +++ b/tutorial/tutorial09.yml @@ -0,0 +1,114 @@ +connectors: + X1: &template1 # define a template for later use + type: Molex KK 254 + pincount: 4 + subtype: female + manufacturer: 'Molex' # set manufacter name + mpn: '22013047' # set manufacturer part number + supplier: Digimouse + spn: 1234 + image: + src: MolexKK254.jpg + # add a list of additional components to a part (shown in graph) + additional_components: + - type: Crimp # short identifier used in graph + subtype: Molex KK 254, 22-30 AWG # extra information added to type in bom + qty_multiplier: populated # multipier for quantity (number of populated pins) + manufacturer: Molex # set manufacter name + mpn: 08500030 # set manufacturer part number + - type: Test + qty: 1 + pn: ABC + manufacturer: Molex + mpn: 45454 + supplier: Mousikey + spn: 9999 + X2: + <<: *template1 # reuse template + pn: CON4 # set an internal part number for just this connector + subtype: male + image: + src: MolexKK254MALE.jpg + + X3: + <<: *template1 # reuse template + subtype: male + image: + src: MolexKK254MALE.jpg +cables: + W1: + wirecount: 4 + # length: 1 + # gauge: 0.25 mm2 + # color_code: IEC + # manufacturer: CablesCo + # mpn: ABC123 + # supplier: Cables R Us + # spn: 999-888-777 + # pn: CAB1 + ############# + show_name: false + show_wirecount: false + show_wirenumbers: false + ############# + W2: + category: bundle + length: 1 + gauge: 0.25 mm2 + colors: [YE, BK, BK, RD] + manufacturer: [WiresCo, WiresCo, WiresCo, WiresCo] # set a manufacter per wire + mpn: [W1-YE, W1-BK, W1-BK, W1-RD] + supplier: [WireShack, WireShack, WireShack, WireShack] + spn: [1001, 1002, 1002, 1009] + pn: [WIRE1, WIRE2, WIRE2, WIRE3] + # add a list of additional components to a part (shown in graph) + additional_components: + - type: Sleeve # short identifier used in graph + subtype: Braided nylon, black, 3mm # extra information added to type in bom + qty_multiplier: length # multipier for quantity (length of cable) + unit: m + pn: SLV-1 + +connections: + - - X1: [1-4] + - W1: [1-4] + - X2: [1-4] + - - X1: [1-4] + - W2: [1-4] + - X3: [1-4] + ############# +tweak: + override: + graph: + ranksep: "0.5" # Reduce the horizontal spacing (default 2) + wireTweak: &wireTweak + shape: none # Hide the surrounding frame + fontsize: "12" # Reduce the space needed for text + fontcolor: white # Same as background to hide the text + ## W1 uses the gauge and length field, they can not be suppressed at the moment. There was an issue #221 + W1: + <<: *wireTweak + ############### + +###### the din template, A4 format +metadata: + title: Power supplies + pn: PSU + + authors: + Created: + name: Ton + date: 2025-03-11 + Approved: + name: Ton + date: 2025-03-11 + + revisions: + A: + name: Ton + date: 2025-03-12 + changelog: updates] + + template: + name: din-6771 + sheetsize: A4 \ No newline at end of file diff --git a/tutorial/vscode.md b/tutorial/vscode.md new file mode 100644 index 000000000..1b24e9181 --- /dev/null +++ b/tutorial/vscode.md @@ -0,0 +1,24 @@ +## Editing y(a)ml files with VSCode + +If you already use vscode as your editor you are in luck. Steffano wrote a very handy how-to setup run-on-save extesion for vscode. + +https://www.stefanocottafavi.com/vscode_wireviz/ + + +If you want to use the prepend parameter so you can use a parent document (components.yml) with all your components defined you could do the following. + +```yaml +"settings": { + "emeraldwalk.runonsave": { + "commands": [ + { + "match": "\\.yml$", + "cmd": "wireviz --prepend components.yml ${file} -f h" + }, + + ] + } +} +``` + +(the -f h instructs wireviz to only produce a html file. Do a wireviz -h for a overview of all the parameters) \ No newline at end of file