warehack.ing/WireViz
2
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Added Syntax description and comments to examples

Browse Source
This commit is contained in:
Tobias Falk 2024-06-16 22:49:22 +02:00
parent ca206612ac
commit defeda7c4f
7 changed files with 51 additions and 34 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

24
docs/syntax.md
View File

@ -83,11 +83,18 @@ tweak: # optional tweaking of .gv output
hide_disconnected_pins: <bool> # defaults to false
# loops
loops: <List> # every list item is itself a list of exactly two pins
# on the connector that are to be shorted
# shorts
shorts: <List>
loops: # a list(dict) of loops
- <str>: <List> # every list item is itself a list of pins
# on the connector that are to be shorted with a cable loop
# more information about the loop can be added by additional
# components definition (see below)
# Shorts
shorts: # a list(dict) of shorts
- <str>: <List> # every list item is itself a list of pins
# on the connector that are to be shorted represented inside
# the connector table
# more information about the loop can be added by additional
# components definition (see below)
```
## Cable attributes
@ -424,6 +431,13 @@ Parts can be added to a connector or cable in the section `<additional-component
supplier: <str> # supplier name
spn: <str> # supplier part number
bgcolor: <color> # Background color of entry in diagram component box
references: <list> # A list of designators that are related to this
# component, for example shorts or loops
# Shorts and Loops specific attributs
color: <color> # if a reference to a short or loop is defined than
# this color is used for the short or loop
```
Alternatively items can be added to just the BOM by putting them in the section `<bom-item>` above.

20
examples/ex15.yml
View File

@ -1,29 +1,29 @@
connectors:
X1:
connectors: # This is based on ex1 and adds some Shorts to the connectors
X1: # An example of Shorts with more information
type: Molex KK 254
subtype: female
pinlabels: [GND, VCC, RX, TX, GND, VCC, GND]
shorts:
- SH1: [1, 5, 7]
shorts: # A List(Dict) of shorts is created
- SH1: [1, 5, 7] # First is the designator than a list of pins to be shorted
- SH2: [2, 6]
additional_components:
additional_components: # Some Additional Components to describe the short in more detail
- references: SH1
color: PK
color: PK # The color of the short, can also be multicolor
manufacturer: WireViz
mpn: 42XCD42A5
type: shortPartA
qty: 42
unit: mm
qty: 42 # The length or some other quantity
unit: mm # The unit of the qty, in this example the length
- references: SH2
color: RD
manufacturer: WireViz
mpn: 42XCD42A5
type: shortPartB
X2:
X2: # An example of a simple short definition
type: Molex KK 254
subtype: female
pinlabels: [GND, VCC, RX, TX, GND, VCC, GND]
shorts:
shorts: # The definition is the same as above but there is no additional_components for more information
- SH1: [1, 5, 7]
- SH2: [2, 6]

2
examples/ex16.gv generated
View File

@ -71,7 +71,7 @@ graph {
edge [color="#000000:#FF66CC:#000000"]
X1:p1r:e -- X1:p5r:e
X1:p5r:e -- X1:p7r:e
edge [color="#000000:#FF0000:#000000"]
edge [color="#000000:#FF0000:#0066FF:#FF8000:#A0DFFF:#000000"]
X1:p2r:e -- X1:p6r:e
edge [headclip=true style=bold tailclip=true]
X2 [label=<

9
examples/ex16.html generated
View File

@ -103,9 +103,12 @@
<!-- X1&#45;&#45;X1 -->
<g id="edge3" class="edge">
<title>X1:e&#45;&#45;X1:e</title>
<path fill="none" stroke="#000000" stroke-width="2" d="M188.63,-236.54C251.08,-248.5 376.75,-248.5 374.75,-190.5 376.75,-132.5 251.08,-132.5 188.63,-144.47"/>
<path fill="none" stroke="#ff0000" stroke-width="2" d="M188.25,-238.5C251.08,-250.5 376.75,-250.5 376.75,-190.5 376.75,-130.5 251.08,-130.5 188.25,-142.5"/>
<path fill="none" stroke="#000000" stroke-width="2" d="M187.88,-240.47C251.08,-252.5 376.75,-252.5 378.75,-190.5 376.75,-128.5 251.08,-128.5 187.88,-140.54"/>
<path fill="none" stroke="#000000" stroke-width="2" d="M189.19,-233.59C251.08,-245.5 376.75,-245.5 371.75,-190.5 376.75,-135.5 251.08,-135.5 189.19,-147.41"/>
<path fill="none" stroke="#ff0000" stroke-width="2" d="M188.81,-235.55C251.08,-247.5 376.75,-247.5 373.75,-190.5 376.75,-133.5 251.08,-133.5 188.81,-145.45"/>
<path fill="none" stroke="#0066ff" stroke-width="2" d="M188.44,-237.52C251.08,-249.5 376.75,-249.5 375.75,-190.5 376.75,-131.5 251.08,-131.5 188.44,-143.48"/>
<path fill="none" stroke="#ff8000" stroke-width="2" d="M188.06,-239.48C251.08,-251.5 376.75,-251.5 377.75,-190.5 376.75,-129.5 251.08,-129.5 188.06,-141.52"/>
<path fill="none" stroke="#a0dfff" stroke-width="2" d="M187.69,-241.45C251.08,-253.5 376.75,-253.5 379.75,-190.5 376.75,-127.5 251.08,-127.5 187.69,-139.55"/>
<path fill="none" stroke="#000000" stroke-width="2" d="M187.31,-243.41C251.08,-255.5 376.75,-255.5 381.75,-190.5 376.75,-125.5 251.08,-125.5 187.31,-137.59"/>
</g>
<!-- W1 -->
<g id="node2" class="node">

BIN
examples/ex16.png generated
View File

Binary file not shown.
Side by Side Swipe Overlay

Before

Width:  |  Height:  |  Size: 100 KiB

After

Width:  |  Height:  |  Size: 104 KiB

9
examples/ex16.svg generated
View File

@ -74,9 +74,12 @@
<!-- X1&#45;&#45;X1 -->
<g id="edge3" class="edge">
<title>X1:e&#45;&#45;X1:e</title>
<path fill="none" stroke="#000000" stroke-width="2" d="M188.63,-236.54C251.08,-248.5 376.75,-248.5 374.75,-190.5 376.75,-132.5 251.08,-132.5 188.63,-144.47"/>
<path fill="none" stroke="#ff0000" stroke-width="2" d="M188.25,-238.5C251.08,-250.5 376.75,-250.5 376.75,-190.5 376.75,-130.5 251.08,-130.5 188.25,-142.5"/>
<path fill="none" stroke="#000000" stroke-width="2" d="M187.88,-240.47C251.08,-252.5 376.75,-252.5 378.75,-190.5 376.75,-128.5 251.08,-128.5 187.88,-140.54"/>
<path fill="none" stroke="#000000" stroke-width="2" d="M189.19,-233.59C251.08,-245.5 376.75,-245.5 371.75,-190.5 376.75,-135.5 251.08,-135.5 189.19,-147.41"/>
<path fill="none" stroke="#ff0000" stroke-width="2" d="M188.81,-235.55C251.08,-247.5 376.75,-247.5 373.75,-190.5 376.75,-133.5 251.08,-133.5 188.81,-145.45"/>
<path fill="none" stroke="#0066ff" stroke-width="2" d="M188.44,-237.52C251.08,-249.5 376.75,-249.5 375.75,-190.5 376.75,-131.5 251.08,-131.5 188.44,-143.48"/>
<path fill="none" stroke="#ff8000" stroke-width="2" d="M188.06,-239.48C251.08,-251.5 376.75,-251.5 377.75,-190.5 376.75,-129.5 251.08,-129.5 188.06,-141.52"/>
<path fill="none" stroke="#a0dfff" stroke-width="2" d="M187.69,-241.45C251.08,-253.5 376.75,-253.5 379.75,-190.5 376.75,-127.5 251.08,-127.5 187.69,-139.55"/>
<path fill="none" stroke="#000000" stroke-width="2" d="M187.31,-243.41C251.08,-255.5 376.75,-255.5 381.75,-190.5 376.75,-125.5 251.08,-125.5 187.31,-137.59"/>
</g>
<!-- W1 -->
<g id="node2" class="node">

Side by Side Swipe Overlay

Before

Width:  |  Height:  |  Size: 21 KiB

After

Width:  |  Height:  |  Size: 22 KiB

21
examples/ex16.yml
View File

@ -1,24 +1,21 @@
options:
mini_bom_mode: false
connectors:
connectors: # This is based on ex1 and adds some Loops to the connectors
X1:
type: Molex KK 254
subtype: female
pinlabels: [GND, VCC, RX, TX, GND, VCC, GND]
loops:
- LO1: [1, 5, 7]
loops: # A List(Dict) of loops is created
- LO1: [1, 5, 7] # First is the designator than a list of pins to be shorted
- LO2: [2, 6]
additional_components:
additional_components: # Some Additional Components to describe the short in more detail
- references: LO1
color: PK
color: PK # The color of the short, can also be multicolor
manufacturer: WireViz
mpn: 42XCD42A5
type: shortPartA
qty: 42
unit: mm
qty: 42 # The length or some other quantity
unit: mm # The unit of the qty, in this example the length
- references: LO2
color: RD
color: RDBUOGLB # multicolor example
manufacturer: WireViz
mpn: 42XCD42A5
type: shortPartB
@ -33,7 +30,7 @@ connectors:
- LO1: [1, 5, 7]
- LO2: [2, 6]
additional_components:
- references: [LO1, LO2]
- references: [LO1, LO2] # example to show how one additional_components can reference more than one short or loop
color: PK
manufacturer: WireViz
mpn: 42XCD42A5