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

Expand tutorial text

Browse Source
This commit is contained in:
Daniel Rojas 2020-06-15 17:29:36 +02:00
parent f09a81c9b4
commit 5739cc30ee
2 changed files with 42 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

23
tutorial/readme.md
View File

@ -1,8 +1,27 @@
# WireViz Tutorial
## Bare-bones example
* Minimum working example
* Only 1-to-1 sequential wiring
This is a minimal example that shows the basic WireViz syntax. A WireViz file consists of three sections: `connectors:` and `cables:` specify the components to be used, while `connections:` creates the links between components.
### `connectors:`
Each connector has a designator (a unique name) and can contain various parameters. The minimum requirement is `pincount`, specifying the number of ports to which wires can be attached.
### `cables:`
A cable is a collection of wires (for bundles of individual wires, see below). Just like connectors, they have a unique designator and a `wirecount`, i.e. the number of wires inside the cable.
In this example, the cable is also given a `length`. This length must be specified in meters.
### `connections:`
This section is a list of connection sets. In this example, only one set is necessary.
The set consists of three parts: A starting connector (`X1`), a cable (`W1`) and a destination connector (`X2`).
This set specifies that connectos 1 through 4 of `X1` should go straight through wires 1 through 4 of `W1` and into connectors 1 through 4 of `X2`: A straight 1-to-1 wiring.
For other ways of defining connection sets, see below.
[Source](tutorial01.yml):

23
tutorial/tutorial01.md
View File

@ -1,4 +1,23 @@
## Bare-bones example
* Minimum working example
* Only 1-to-1 sequential wiring
his is a minimal example that shows the basic WireViz syntax. A WireViz file consists of three sections: `connectors:` and `cables:` specify the components to be used, while `connections:` creates the links between components.
### `connectors`
Each connector has a designator (a unique name) and can contain various parameters. The minimum requirement is `pincount`, specifying the number of ports to which wires can be attached.
### `cables`
A cable is a collection of wires (for bundles of individual wires, see below). Just like connectors, they have a unique designator and a `wirecount`, i.e. the number of wires inside the cable.
In this example, the cable is also given a `length`. This length must be specified in meters.
### `connections`
This section is a list of connection sets. In this example, only one set is necessary.
The set consists of three parts: A starting connector (`X1`), a cable (`W1`) and a destination connector (`X2`).
This set specifies that connectos 1 through 4 of `X1` should go straight through wires 1 through 4 of `W1` and into connectors 1 through 4 of `X2`: A straight 1-to-1 wiring.
For other ways of defining connection sets, see below.