Difference between revisions of "Wiring Editor"

From Open Source Controls Wiki
Jump to navigation Jump to search
 
(148 intermediate revisions by 2 users not shown)
Line 1: Line 1:


<iframe key="wiki" align="right" width="100%" height="1500" level="" path="/gojs/samples/wiring.html" />
<iframe key="wiki" align="right" width="100%" height="1050" level="" path="/gojs/samples/wiring24.html?cid=QmfYGziaSS7BtmoyZxJZU716HJ3BC36YXu4oksLwgLZSKW&palette=heatweb_parts.json&height=660px" />


== See Also ==
* [[Wiring Editor Testing|Latest (Beta Testing) Version]]
*[[Palettes]]
== Menus ==
<gallery widths="200" heights="200">
File:Wmenu1.PNG|Node Inspector
File:Wmenu2.PNG|Button Inspector
File:Wmenu5.PNG|Port Inspector
File:Wmenu6.PNG|Port Mapping Inspector
File:Wmenu3.PNG|Document Attribute Inspector
File:Wmenu4.PNG|Node Attribute Inspector
</gallery>
== Ports and Colours ==
Diagrams are based around nodes (devices) with ports for making connections.
To enable automatic wiring, port types are required as well as rules about how they can be connected.
Colours tend to be the most commonly used identifier for types of connections, with in computer language is a hex value representing red, green and blue. #000000 is black, #ff0000 is red, #00ff00 is green, #ffffff is white, and so on.
However we require another level of distinction as we may desire to wire to a particular GND for example, or to give communications a plus and minus.  This is achieved by using the last digit of the colour as a variation, providing 1,048,576 colours (or signal levels), each with 16 variations.
Taking GND (black) for example.  #000000 is the default black and used for ground connections.  We may however use #00000f for a power supply ground, or #000001 for a less popular ground that can be used if needed in preference to a popular ground.
[[File:Compareblk.png|frameless|257x257px]]
One can take this to an extreme and give every signal level a unique colour value. This may well feature in future live wiring systems. 
By default, ports connect to ports of the same colour.  However, a 0-10V OUT cannot connect to another 0-10V OUT so we specify compatible ports with:
# A port figure, which can be either an "''Input", "Output"'' (shown by a direction arrow)'', or a''ny other standard shape figure including "''Rectangle"'', "''Circle"'', "''TriangleUp"'', etc.  Inputs cannot be wired to outputs. 
# An optional list of compatible colours called '''''signalTypes''''', in order of preference.  If a preferred port type is free it will be used, if not then the next in the list will be tried, and so on.  You can see this in use in the following data for a room thermostat, where it is used to allow connection to both a dry contact #00ffffff and a universal input #fffffe.
{"name":"Room Thermostat","color":"#dbf6cb","leftArray":[],"rightArray":[{"portId":"right0","portColor":"#000000"},{"portId":"right1","portColor":"#00ffff",'''"signalTypes":["#00ffff","#fffffe"]'''}],"topArray":[],"bottomArray":[],"key":"roomstat","size":"78.78515625 47"}
[[File:Rststwire.png]]          [[File:Rststwire2.png|306x306px]]
== Buttons ==
This power supply contains additional buttons for performing actions, such as opening a web page or PDF.
[[File:12vdcicons.png|frameless|220x220px]]<br />
<pre>
{"name":"12VDC Power","buttonArray":[{"href":"https://hwwiki.ddns.net/","color":"#000000","fill":"#0000ff","figure":"ElectricalHazard"},{"text":"Open","href":"https://hwwiki.ddns.net/","color":"#000000","fill":"#0000ff"}],"fill":"#ebebeb","leftArray":[{"portId":"left0","portColor":"#e88600","figure":"Output"},{"portId":"left2","portColor":"#000002","figure":"Output"}],"rightArray":[],"topArray":[],"bottomArray":[],"key":"12VDC22","size":"67 76","loc":"709.4688121714489 -308.66453398276076","figure":"Procedure","color":"#000000","thickness":1,"notes":"","textColor":"#484848"}
</pre>
The buttons are created by adding a '''''buttonArray''''' (shown below).  Buttons have either text or an icon (figure).  The array below has one of each.
<pre>
"buttonArray":[{"href":"https://hwwiki.ddns.net/","color":"#000000","fill":"#0000ff","figure":"ElectricalHazard"},{"text":"Open","href":"https://hwwiki.ddns.net/","color":"#000000","fill":"#0000ff"}]
</pre>


== How to Use in Articles ==
== How to Use in Articles ==
Line 9: Line 64:
The second element has also been hidden from view.
The second element has also been hidden from view.


This way it is possible to create a design on this page and then include it into articles using pure JSON.  
This way it is possible to create a design on this page and then include it into articles using pure JSON.
 


<pre id="example1" style="display:none">
<pre id="example1" style="display:none">
Line 19: Line 73:
   "linkToPortIdProperty": "toPort",
   "linkToPortIdProperty": "toPort",
   "nodeDataArray": [
   "nodeDataArray": [
{"key":1,"name":"Unit One","loc":"-212 83","leftArray":[{"portColor":"#fae3d7","portId":"left0"}],"topArray":[{"portColor":"#d6effc","portId":"top0"}],"bottomArray":[{"portColor":"#ebe3fc","portId":"bottom0"}],"rightArray":[{"portColor":"#eaeef8","portId":"right0"},{"portColor":"#fadfe5","portId":"right1"}]},
{"key":1,"name":"Unit One","loc":"-25.574964750701383 196.3160717356572","leftArray":[{"portId":"left0","portColor":"#000000"},{"portId":"left1","portColor":"#00ff00"},{"portId":"left2","portColor":"#000000"},{"portId":"left3","portColor":"#00ff00"},{"portId":"left4","portColor":"#000000"},{"portId":"left5","portColor":"#00ff00"},{"portId":"left6","portColor":"#000000"},{"portId":"left7","portColor":"#00ff00"},{"portId":"left8","portColor":"#000000"},{"portId":"left9","portColor":"#44aaaa"},{"portId":"left10","portColor":"#000000"},{"portId":"left11","portColor":"#44aaaa"},{"portId":"left12","portColor":"#000000"},{"portId":"left13","portColor":"#44aaaa"},{"portId":"left14","portColor":"#000000"},{"portId":"left15","portColor":"#44aaaa"},{"portId":"left16","portColor":"#000000"},{"portId":"left17","portColor":"#00ff00"},{"portId":"left18","portColor":"#000000"},{"portId":"left19","portColor":"#00ff00"},{"portId":"left20","portColor":"#000000"},{"portId":"left21","portColor":"#00ff00"},{"portId":"left22","portColor":"#000000"},{"portId":"left23","portColor":"#00ff00"}],"topArray":[{"portColor":"#ff0000","portId":"top0"},{"portId":"top1","portColor":"#000000"}],"bottomArray":[{"portColor":"#00ff00","portId":"bottom0"},{"portId":"bottom1","portColor":"#d6effc"},{"portId":"bottom2","portColor":"#ebe3fc"},{"portId":"bottom3","portColor":"#d6effc"},{"portId":"bottom4","portColor":"#00ff00"},{"portId":"bottom5","portColor":"#fae3d7"},{"portId":"bottom6","portColor":"#6cafdb"},{"portId":"bottom7","portColor":"#6cafdb"},{"portId":"bottom8","portColor":"#ebe3fc"},{"portId":"bottom9","portColor":"#d6effc"},{"portId":"bottom10","portColor":"#eaeef8"},{"portId":"bottom11","portColor":"#fae3d7"}],"rightArray":[{"portColor":"#eaeef8","portId":"right0"},{"portColor":"#fadfe5","portId":"right1"}]},
{"key":2,"name":"Unit Two","loc":"320 152","leftArray":[{"portColor":"#6cafdb","portId":"left0"},{"portColor":"#66d6d1","portId":"left1"},{"portColor":"#fae3d7","portId":"left2"}],"topArray":[{"portColor":"#d6effc","portId":"top0"}],"bottomArray":[{"portColor":"#eaeef8","portId":"bottom0"},{"portColor":"#eaeef8","portId":"bottom1"},{"portColor":"#6cafdb","portId":"bottom2"}],"rightArray":[]},
{"name":"NTC10K","leftArray":[],"rightArray":[{"portId":"right0","portColor":"#6cafdb"},{"portId":"right1","portColor":"#66d6d1"}],"topArray":[],"bottomArray":[],"key":-2,"loc":"-412.56962058479934 29.89544088160406"},
{"key":3,"name":"Unit Three","loc":"384 319","leftArray":[{"portColor":"#66d6d1","portId":"left0"},{"portColor":"#fadfe5","portId":"left1"},{"portColor":"#6cafdb","portId":"left2"}],"topArray":[{"portColor":"#66d6d1","portId":"top0"}],"bottomArray":[{"portColor":"#6cafdb","portId":"bottom0"}],"rightArray":[]},
{"name":"NTC10K","leftArray":[],"rightArray":[{"portId":"right0","portColor":"#6cafdb"},{"portId":"right1","portColor":"#66d6d1"}],"topArray":[],"bottomArray":[],"key":-3,"loc":"-412.56962058479917 100.73012396118509"},
{"key":4,"name":"Unit Four","loc":"138 351","leftArray":[{"portColor":"#fae3d7","portId":"left0"}],"topArray":[{"portColor":"#6cafdb","portId":"top0"}],"bottomArray":[{"portColor":"#6cafdb","portId":"bottom0"}],"rightArray":[{"portColor":"#6cafdb","portId":"right0"},{"portColor":"#66d6d1","portId":"right1"}]}
{"name":"NTC10K","leftArray":[],"rightArray":[{"portId":"right0","portColor":"#6cafdb"},{"portId":"right1","portColor":"#66d6d1"}],"topArray":[],"bottomArray":[],"key":-4,"loc":"-411.7057829862677 171.56480704076617"}
],
],
   "linkDataArray": [
   "linkDataArray": [
{"from":4,"to":2,"fromPort":"top0","toPort":"bottom0","points":[138,313,138,303,138,269.5,310,269.5,310,204,310,190]},
{"from":-2,"to":1,"fromPort":"right0","toPort":"left0","points":[-368.22049949104934,24.89544088160406,-350.22049949104934,24.89544088160406,-212.89773212087536,24.89544088160406,-212.89773212087536,81.3160717356572,-107.57496475070138,81.3160717356572,-93.57496475070138,81.3160717356572]},
{"from":3,"to":2,"fromPort":"top0","toPort":"bottom1","points":[384,281,384,267,384,239.5,320,239.5,320,208,320,190]},
{"from":-2,"to":1,"fromPort":"right1","toPort":"left1","points":[-368.22049949104934,34.89544088160406,-358.22049949104934,34.89544088160406,-220.89773212087536,34.89544088160406,-220.89773212087536,91.3160717356572,-115.57496475070138,91.3160717356572,-93.57496475070138,91.3160717356572]},
{"from":4,"to":3,"fromPort":"right0","toPort":"left0","points":[176,346,190,346,271,346,271,309,320,309,346,309]},
{"from":1,"to":-3,"fromPort":"left2","toPort":"right0","points":[-93.57496475070138,101.3160717356572,-123.57496475070138,101.3160717356572,-248.78522837706498,101.3160717356572,-248.78522837706498,95.73012396118509,-350.22049949104894,95.73012396118509,-368.22049949104894,95.73012396118509]},
{"from":4,"to":3,"fromPort":"right1","toPort":"left2","points":[176,356,198,356,283,356,283,329,336,329,346,329]},
{"from":1,"to":-3,"fromPort":"left3","toPort":"right1","points":[-93.57496475070138,111.3160717356572,-131.57496475070138,111.3160717356572,-258.89773212087516,111.3160717356572,-258.89773212087516,105.73012396118509,-358.22049949104894,105.73012396118509,-368.22049949104894,105.73012396118509]},
{"from":1,"to":2,"fromPort":"right0","toPort":"left1","points":[-174,78,-156,78,68,78,68,152,260,152,282,152]},
{"from":1,"to":-4,"fromPort":"left4","toPort":"right0","points":[-93.57496475070138,121.3160717356572,-255.57496475070138,121.3160717356572,-241.01068999028178,121.3160717356572,-241.01068999028178,166.56480704076617,-353.3566618925176,166.56480704076617,-367.3566618925176,166.56480704076617]},
{"from":1,"to":2,"fromPort":"right1","toPort":"left2","points":[-174,88,-164,88,60,88,60,162,252,162,282,162]}
{"from":1,"to":-4,"fromPort":"left5","toPort":"right1","points":[-93.57496475070138,131.3160717356572,-247.57496475070138,131.3160717356572,-230.46581332160952,131.3160717356572,-230.46581332160952,176.56480704076617,-345.3566618925176,176.56480704076617,-367.3566618925176,176.56480704076617]}
]}
]}
</pre>
</pre>


<pre id="example2" style="display:none">
{{gojs|width=49% |height=600 |src=wiringFrame| id=example1}}
{ "class": "GraphLinksModel",
  "nodeDataArray": [
{"key":1, "loc":"0 0", "text":"Alpha", "details":"some information about Alpha and its importance"},
{"key":2, "loc":"170 0", "text":"Beta", "color":"blue", "thickness":2, "figure":"Procedure"},
{"key":3, "loc":"0 100", "text":"Gamma", "color":"green", "figure":"Cylinder1"},
{"key":4, "loc":"80 180", "text":"Delta", "color":"red", "figure":"Terminator", "size":"80 40"},
{"key":5, "loc":"350 -50", "text":"Zeta", "group":7, "color":"blue", "figure":"CreateRequest"},
{"key":6, "loc":"350 50", "text":"Eta", "group":7, "figure":"Document", "fill":"lightyellow"},
{"key":7, "isGroup":true, "text":"Theta", "color":"green", "fill":"lightgreen"},
{"key":8, "loc":"520 50", "text":"Iota", "fill":"pink"}
],
  "linkDataArray": [
{"from":1, "to":2, "dash":[ 6,3 ], "thickness":4},
{"from":1, "to":3, "dash":[ 2,4 ], "color":"green", "text":"label"},
{"from":3, "to":4, "color":"red", "text":"a red label", "fromSpot":"RightSide"},
{"from":2, "to":1},
{"from":5, "to":6, "text":"in a group"},
{"from":2, "to":7},
{"from":6, "to":8, "dir":0},
{"from":6, "to":8, "dir":1},
{"from":6, "to":8, "dir":2}
]}
 
</pre>


== Versions ==
{| class="wikitable"
|+
!Version
!
|-
|wiring22
|
* Attributes added for all nodes
*Palettes can be loaded from saved drawings and palettes on either server of IPFS
|-
|version21
|
* Added Attribute Inspector including page title and orientation (portrait/landscape)
* Orientation tied to PDF page orientation
* PDF scaling corrected
* Saves to server filesystem as well as IPFS
* Where the Title attribute is filled in, diagrams will also be saved to this filename on the server  This is to provide an updateable diagram, and also an immutable IPFS copy
|-
|wiring20
|
* Added Button Inspector (up to 3 buttons)
* Added node context menu to add a New Button
|-
|wiring19
|
* Port value Map Inspector added, appears if ''mapUnits'' is not empty
*Port sizes can be altered via Inspector
*Hidden wide ports can now be used to move other ports apart, or position to corners
|-
|wiring18
|
* Port context menu altered to assign ''signalType''
*Port Inspector
|-
|wiring17
|
* Connection processing with export for controller
|-
|wiring16
|
* PDF Download
|-
|wiring15
|
* Nodes can be rotated
* Groups given dotted surround
* Converted SVG images replaced with data URLs
* General layout alterations
|-
|wiring14
|
* Button to save to IPFS
* Loads from IPFS CID
|-
|wiring13
|
* Node icons refined to allow both figures and text
* Node icons arranged vertically
|-
|wiring12
|
* Node icons changed to buttons with option for text
* Icon buttons open web pages in a target window
|-
|wiring11
|
* Port directions (figures) added, so inputs and outputs can share the same identity colour
*Autowiring updated to account for compatible directions
*Node icons added
|-
|wiring10
|
* Node shapes added to context menu
|-
|wiring9
|
* Port selection added to port context menu
|-
|wiring8
|
* Context menus for links
* Context menus for changing node and link line type, colour, and thickness
* Grouping on nodes using Ctrl+G with group context menus
|-
|wiring7
|
* Port labels shown on hover
|-
|wiring6
|
* Palette reduced in width
*Download PNG
|-
|wiringFrame
|basic view with download SVG button
|}


{{gojs|width=49% |height=300 |src=wiringFrame| id=example1}}
== Improvements ==
{{gojs|width=49% |height=300 |src=wiringFrame| id=example2}}


* Number terminals
* Fix widths with top/bottom terminals
* Hover text over terminals
* Change colour of blocks
* Position terminals (drag along sides)
* Menu to change line thickness, type, colour, arrows.
* Optional wire labels = controller number + terminal number (e.g. 101)


[[Category:Calculators]]
[[Category:Calculators]]

Latest revision as of 17:54, 23 January 2023


See Also

Menus

  • Node Inspector

  • Button Inspector

  • Port Inspector

  • Port Mapping Inspector

  • Document Attribute Inspector

  • Node Attribute Inspector

Ports and Colours

Diagrams are based around nodes (devices) with ports for making connections.

To enable automatic wiring, port types are required as well as rules about how they can be connected.

Colours tend to be the most commonly used identifier for types of connections, with in computer language is a hex value representing red, green and blue. #000000 is black, #ff0000 is red, #00ff00 is green, #ffffff is white, and so on.

However we require another level of distinction as we may desire to wire to a particular GND for example, or to give communications a plus and minus. This is achieved by using the last digit of the colour as a variation, providing 1,048,576 colours (or signal levels), each with 16 variations.

Taking GND (black) for example. #000000 is the default black and used for ground connections. We may however use #00000f for a power supply ground, or #000001 for a less popular ground that can be used if needed in preference to a popular ground.

Compareblk.png

One can take this to an extreme and give every signal level a unique colour value. This may well feature in future live wiring systems.

By default, ports connect to ports of the same colour. However, a 0-10V OUT cannot connect to another 0-10V OUT so we specify compatible ports with:

  1. A port figure, which can be either an "Input", "Output" (shown by a direction arrow), or any other standard shape figure including "Rectangle", "Circle", "TriangleUp", etc. Inputs cannot be wired to outputs.
  2. An optional list of compatible colours called signalTypes, in order of preference. If a preferred port type is free it will be used, if not then the next in the list will be tried, and so on. You can see this in use in the following data for a room thermostat, where it is used to allow connection to both a dry contact #00ffffff and a universal input #fffffe.
{"name":"Room Thermostat","color":"#dbf6cb","leftArray":[],"rightArray":[{"portId":"right0","portColor":"#000000"},{"portId":"right1","portColor":"#00ffff","signalTypes":["#00ffff","#fffffe"]}],"topArray":[],"bottomArray":[],"key":"roomstat","size":"78.78515625 47"}

Rststwire.png Rststwire2.png

Buttons

This power supply contains additional buttons for performing actions, such as opening a web page or PDF.

12vdcicons.png

{"name":"12VDC Power","buttonArray":[{"href":"https://hwwiki.ddns.net/","color":"#000000","fill":"#0000ff","figure":"ElectricalHazard"},{"text":"Open","href":"https://hwwiki.ddns.net/","color":"#000000","fill":"#0000ff"}],"fill":"#ebebeb","leftArray":[{"portId":"left0","portColor":"#e88600","figure":"Output"},{"portId":"left2","portColor":"#000002","figure":"Output"}],"rightArray":[],"topArray":[],"bottomArray":[],"key":"12VDC22","size":"67 76","loc":"709.4688121714489 -308.66453398276076","figure":"Procedure","color":"#000000","thickness":1,"notes":"","textColor":"#484848"}

The buttons are created by adding a buttonArray (shown below). Buttons have either text or an icon (figure). The array below has one of each. 

"buttonArray":[{"href":"https://hwwiki.ddns.net/","color":"#000000","fill":"#0000ff","figure":"ElectricalHazard"},{"text":"Open","href":"https://hwwiki.ddns.net/","color":"#000000","fill":"#0000ff"}]

How to Use in Articles

The following two elements have been given an id (view in the source) that can then be passed to a diagram using an iframe tag.

The second element has also been hidden from view.

This way it is possible to create a design on this page and then include it into articles using pure JSON.

Versions

Version
wiring22
  • Attributes added for all nodes
  • Palettes can be loaded from saved drawings and palettes on either server of IPFS
version21
  • Added Attribute Inspector including page title and orientation (portrait/landscape)
  • Orientation tied to PDF page orientation
  • PDF scaling corrected
  • Saves to server filesystem as well as IPFS
  • Where the Title attribute is filled in, diagrams will also be saved to this filename on the server This is to provide an updateable diagram, and also an immutable IPFS copy
wiring20
  • Added Button Inspector (up to 3 buttons)
  • Added node context menu to add a New Button
wiring19
  • Port value Map Inspector added, appears if mapUnits is not empty
  • Port sizes can be altered via Inspector
  • Hidden wide ports can now be used to move other ports apart, or position to corners
wiring18
  • Port context menu altered to assign signalType
  • Port Inspector
wiring17
  • Connection processing with export for controller
wiring16
  • PDF Download
wiring15
  • Nodes can be rotated
  • Groups given dotted surround
  • Converted SVG images replaced with data URLs
  • General layout alterations
wiring14
  • Button to save to IPFS
  • Loads from IPFS CID
wiring13
  • Node icons refined to allow both figures and text
  • Node icons arranged vertically
wiring12
  • Node icons changed to buttons with option for text
  • Icon buttons open web pages in a target window
wiring11
  • Port directions (figures) added, so inputs and outputs can share the same identity colour
  • Autowiring updated to account for compatible directions
  • Node icons added
wiring10
  • Node shapes added to context menu
wiring9
  • Port selection added to port context menu
wiring8
  • Context menus for links
  • Context menus for changing node and link line type, colour, and thickness
  • Grouping on nodes using Ctrl+G with group context menus
wiring7
  • Port labels shown on hover
wiring6
  • Palette reduced in width
  • Download PNG
wiringFrame basic view with download SVG button

Improvements

  • Number terminals
  • Fix widths with top/bottom terminals
  • Hover text over terminals
  • Change colour of blocks
  • Position terminals (drag along sides)
  • Menu to change line thickness, type, colour, arrows.
  • Optional wire labels = controller number + terminal number (e.g. 101)
Retrieved from ‘https://hwwiki.ddns.net/index.php?title=Wiring_Editor&oldid=3392’