Usage
All the information used to generate the network is contained within these 4 files:
- nodes.json - nodes in the network
- links.json - links (cables)
- def_nodes.json - definitions of distros, sources, etc
- def_links.json - definitions of links
- event_data.json - data that will appear in the title block
def_node.json and def_link.json are two JSON lists that contain definitions for the network.
def_node.json defines the nodes on the network, nodes are anything on the network that has some form of power I/O, the example below is for a distro, however nodes with just an output (sources), or nodes with just an input are also defined here.
{
"exampleDist": {
"in": "63/3",
"out": [
{
"count": 1,
"port": "63/3",
"breaker": "RCBO"
}
]
},
"incomer": {
"out": [
{
"count": 1,
"port": "63/3"
}
]
}
}The "in" and "port" keys have to have a value that is defined in the def_links.json file (more on this later), the "breaker" key can take any value and is displayed on the final paperwork just as a reference.
As you can see in our "exampleDist" we named two ports on the distro, "in" and "port", we now need to define the cables that link to these ports, defining a 63/3 cable would look like this:
{
"63/3": {
"color": "red",
"name": "63/3o",
"density": 1.53,
"mvperM": 72.45,
"penwidth": 3
},
}The first key is where we name the cable for use in the def_nodes.json file, as you can see there is another key, "name", this is the display name for the cable and what will appear on the final paperwork.
The "color" and "penwidth" are aesthetic and describe how the line is drawn on the page, the "density" key is fairly self explanatory but is only used currently to give a rough mass of cables used per source.
The "mvperM" key is used to define the voltage drop of the cable per meter, not how the key does not contain a "perA", this is because the voltage drops already account for a 50% load, obviously this should only be used as an indicator as to whether your network will be wildly outrageous, and consideration on how the network will be used and the loads applied to it should be the main factor in determining your design.
Now that we have defined the nodes and links to be used in the network we can now start to create the network. Networks are generated per source, so if you have two generators two networks will be created, obviously.
The first thing we need in our network are some nodes (and a source), below how we would use our exampledist we defined earlier in the network
[
{
"name": "Incomer",
"type": "incomer",
"location": "StageL"
},
{
"name": "MyDistro",
"type": "exampleDist",
"location": "StageR"
}
]The "name" key is the display name of the node, as several nodes can be of the same type (eg. trailer_fridge) but can be named differently for ease, as shown above.
The "type" key is the type of node relating to the nodes we defined earlier in the def_nodes.json file.
The "location" key is a general location that gets printed to the node labels.
The easiest part of this process is linking the nodes together, all the network links are contained within the links.json file, this is how we would link our two nodes together.
[
{
"src": "incomer",
"length": 5,
"dst": "MyDistro"
}
]The "src" and "dst" keys use the node "name" value to define
The title block contains some maybe useful information some of which can be set in the event_data.json file, for our example event this is what that file looks like
{
"eventName": "Wiki network",
"eventDate": "The Future",
"rigNumber": "Some number",
"designer": "Me"
}After all that, just run bin/genPaperwork.sh and a lovely power plan will be generated for you along with some network stats and some labels if you want, for more options see the CLI Options
Here's what our power plan looks like:
