Difference between revisions of "SHIP:Node:linkset"

From Serious Documentation
Jump to: navigation, search
(→‎Child Nodes)
Line 26: Line 26:
 
| channel || A port name (e.g. UART0)
 
| channel || A port name (e.g. UART0)
 
|-
 
|-
−
| style="background: #CCDDCC;"| refresh* || style="background: #CCDDCC;"|Set true to start a polling cycle on master/slave [[SHIP:Protocols|protocols]]; goes false when poll complete
+
| style="background: #CCDDCC;"| refresh* || style="background: #CCDDCC;"|Set {{Reserved|true}} to start a polling cycle on master/slave [[SHIP:Protocols|protocols]]; goes false when poll complete
 
|-
 
|-
−
| style="background: #CCDDCC;"|enabled* || style="background: #CCDDCC;"|Defaults to false; must be set true at runtime* from a [[SHIP:Sail|Sail script]] to enable the linkset
+
| style="background: #CCDDCC;"|enabled* || style="background: #CCDDCC;"|Defaults to {{Reserved|false}}; must be set {{Reserved|true}} at runtime* from a [[SHIP:Sail|Sail script]] to enable the linkset
 
|}
 
|}
 
{{SHIP:RuntimePropertyNote}}
 
{{SHIP:RuntimePropertyNote}}

Revision as of 06:57, 27 November 2012

Node Home

Within a given link, there may be one or more linkset nodes. Each linkset encompasses all the traffic between two endpoints in a link.

For slave link types of master/slave protocols (for example the MODBUS_SLAVE_RTU), the link may be representing one or more Modbus slaves within the SHIPEngine environment. Even though the protocol is running on a single physical communications channel (e.g. UART0), each linkset within the link can act as one of a number of independent virtual slaves.

For master link types of of master/slave protocols (for example MODBUS_MASTER_ASCII) you may want to address multiple slaves on the channel. Each slave would be identified by a linkset with the slave ID set appropriately.

Parent Nodes

The following nodes are permitted to hold this node:

Child Nodes

The following nodes are permitted to exist within this node:

Properties

Property Name Description
name A unique linkset name within the link
id Some protocols require the endpoint to have an ID number assigned
channel A port name (e.g. UART0)
refresh* Set true to start a polling cycle on master/slave protocols; goes false when poll complete
enabled* Defaults to false; must be set true at runtime* from a Sail script to enable the linkset

*available at SHIPEngine run time only and cannot be set in SHIPTide. Use a Sail script at shiplaunch time if this property needs to be set when the GUI starts to run.

Examples

Adding two linksets to the example in link reference:

Example link with two linksets

In this example, our GUI is acting as a Modbus Slave attached to UART0, potentially one of many on the communications channel. This physical channel could be, for instance, a multi-drop RS485 network with many slaves of which our SIM is only one. Our GUI, because it has the two linksets at ID #1 and #13 created, will respond as if it were two of those slaves on the network.

Retrieved from "https://techref.myserious.com/index.php?title=SHIP:Node:linkset&oldid=754"