<elekdra.distantsignal>

Configuration of a distant signal.

Description

This tag configures a distant signal. This can be a standalone distant signal or a distant signal on the mast of a mandatory signal (<elekdra.signal>). The state can be bound to a single mandatory signal (for example an entry signals) or the state can be computed by a route.
For commanding there exist three options:

configure <loconet>	configure <script>	configure <mast>	Behavior of Elekdra
yes	no	don't care	Sending command via LocoNet as configured here
no	yes	don't care	Calling the script that is configured configured here
no	no	yes	Calling the script that is configured for the signal referenced by <mast>. That script must take care of commanding both the signal and the distant signal appropriately.

Example

This is a distant signal named VSig_a that shows the state of an entry signal called ESig_A, commanded via OPC_SE over LocoNet address 42

<elekdra.distantsignal>
	<name>VSig_a</name>
	<statefrom>ESig_A</statefrom>
	<loconet>
		<protocol>opc_se</protocol>
		<lnaddress>42</lnaddress>
	</loconet>
</elekdra.distantsignal>

Sub tags

Tag	Description
<name> Type: String Cardinality: once	Name of signal. Name of the signal for identification for example by Reference in a <elekdra.route>.
<statefrom> Type: String Cardinality: optional [0..1]	Static assignment for state If this is configured, than the distant signal has a static relationship with the element defined here. It always shows the state of that element. This can be the <name> of: A mandatory signal as configured in a <elekdra.signal> A block as configured in a <elekdra.fieldblock> or <elekdra.axle_block>. This means that this distant signal displays the state of the entry signal of the neighboring station. This only works if the neighboring station implements the transmission of the state of the enty signal. For older block box software, this is not the case.
<mast> Type: String Cardinality: optional [0..1]	This distant signal is on the same mast as a mandatory signal This is a reference to the <name> of a <elekdra.signal>. If that mandatory signal does not show a GO state, this distant signal is switched to SIGNAL_DEAD
<loconet> Type: Loconet Cardinality: optional [0..1]	LocoNet Connection Configuration for commanding via LocoNet
<script> Type: ScriptUsage Cardinality: optional [0..1]	Script Usage Configuration for commanding via a user supplied script. See details on this page. The script will see the following variables set by Elekdra. Any additional information like an address must be defined as variables in the ScriptUsage by the user. distantsignal_name The <name> of this element new_distantsignal_state The actual state of the signal at the time of script execution old_distantsignal_state The state when the script ran the last time. On the very first execution, this is initialized to SIGNAL_DEAD
<myFile> Type: File Cardinality: once
<identifyableKey> Type: String Cardinality: once