diff --git a/docs/syntax.md b/docs/syntax.md index 8e7b8c4..573c62d 100644 --- a/docs/syntax.md +++ b/docs/syntax.md @@ -83,11 +83,18 @@ tweak: # optional tweaking of .gv output hide_disconnected_pins: # defaults to false # loops - loops: # every list item is itself a list of exactly two pins - # on the connector that are to be shorted - - # shorts - shorts: + loops: # a list(dict) of loops + - : # 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 + - : # 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 ` # supplier name spn: # supplier part number bgcolor: # Background color of entry in diagram component box + + references: # A list of designators that are related to this + # component, for example shorts or loops + + # Shorts and Loops specific attributs + 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 `` above. diff --git a/examples/ex15.yml b/examples/ex15.yml index a83f665..e97f56c 100644 --- a/examples/ex15.yml +++ b/examples/ex15.yml @@ -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] diff --git a/examples/ex16.gv b/examples/ex16.gv index 1bc0faf..40df816 100644 --- a/examples/ex16.gv +++ b/examples/ex16.gv @@ -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=< diff --git a/examples/ex16.html b/examples/ex16.html index f7a3c62..b12239a 100644 --- a/examples/ex16.html +++ b/examples/ex16.html @@ -103,9 +103,12 @@ X1:e--X1:e - - - + + + + + + diff --git a/examples/ex16.png b/examples/ex16.png index 684dea2..28abb7d 100644 Binary files a/examples/ex16.png and b/examples/ex16.png differ diff --git a/examples/ex16.svg b/examples/ex16.svg index f6f6209..3248e97 100644 --- a/examples/ex16.svg +++ b/examples/ex16.svg @@ -74,9 +74,12 @@ X1:e--X1:e - - - + + + + + + diff --git a/examples/ex16.yml b/examples/ex16.yml index 118c399..16d10ea 100644 --- a/examples/ex16.yml +++ b/examples/ex16.yml @@ -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