-
Notifications
You must be signed in to change notification settings - Fork 223
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
a418005
commit d7c3e6b
Showing
1 changed file
with
93 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,93 @@ | ||
# WireViz Syntax | ||
|
||
## Main sections | ||
|
||
```yaml | ||
connectors: # dictionary of all used connectors | ||
X1: # unique connector designator/name | ||
... # connector attributes (see below) | ||
X2: | ||
... | ||
... | ||
|
||
cables: # dictionary of all used cables and wires | ||
W1: # unique cable designator/name | ||
... # cable attributes (see below) | ||
W2: | ||
... | ||
... | ||
|
||
connections: # list of all connections to be made | ||
# between cables and connectors | ||
- | ||
... # connection set (see below) | ||
- | ||
... | ||
``` | ||
## Connector attributes | ||
```yaml | ||
X1: | ||
# general information about a connector (all optional) | ||
type: <string> | ||
subtype: <string> | ||
color: <colorcode> | ||
notes: <string> | ||
|
||
# pinout information | ||
# at least one of the following must be specified | ||
pincount: <int> # if omitted, is set to length of specified list(s) | ||
pins: <List> # if omitted, is autofilled with [1, 2, ..., pincount] | ||
pinlabels: <List> # if omitted, is autofilled with blanks | ||
|
||
# product information (all optional) | ||
manufacturer: <string> | ||
manufacturer_part_number: <string> | ||
internel_part_number: <string> | ||
|
||
# rendering information | ||
style: <style> # optional; may be set to simple for single pin connectors | ||
show_name: <bool> # optional; defaults to true for regular connectors, | ||
# false for simple connectors | ||
show_pincount: <bool> # opional; defaults to true for regular connectors | ||
# false for simple connectors | ||
hide_disconnected_pins: <bool> # optional; defaults to false | ||
|
||
# loops and shorts | ||
loops: <List> # TODO | ||
|
||
# auto-generation | ||
autogenerate: <bool> # optional; defaults to false; see below | ||
|
||
``` | ||
|
||
### Auto-generation of connectors | ||
|
||
<!-- TODO --> | ||
|
||
## Cable attributes | ||
|
||
<!-- TODO --> | ||
|
||
## Connection sets | ||
|
||
<!-- TODO --> | ||
|
||
## Color codes | ||
|
||
A color code is an uppercase, two character string. | ||
|
||
``` | ||
TODO: list valid colors | ||
``` | ||
|
||
## Multiline strings | ||
|
||
Accepted in the following fields: | ||
<!-- TODO --> | ||
|
||
How to use | ||
<!-- TODO --> | ||
|
||
Link to [yaml-multiline.info](https://yaml-multiline.info/) |