Content → Hardware → CTC Modules → CTC Rocrail Configuration → CTC two Buttons and one Display
This documentation is based on Rocrail Version 2.1.4391 dated 29.03.2024 .
As a WIO a Pico-W is used with WIO version 850.

The Task: construct a CTC desk to run a locomotive from one block to the next block



Using this example is done by the users own risk.
The Rocrail workspace.

This example should demonstrate one usage of the CTC-Module "Block with two buttons" (accessory-150).
The LEDs of the CTC-Module are controlled by Rocrail outputs. So during simulation the LEDs of the CTC-Module will show color black. The real LEDs will change their color.

This example uses an XMLScript.

This example is not a complete solution; especially almost all error checking is left open.
The reader is invited to complete this example for his own needs.
This example uses WIO Node ID 51; the user has to replace these values by his own WIO Node ID.

There will be three layers to watch at:

layer	image	description
1		the Rocrail plan with the Rocrail objects
2		the Rocrail plan with the CTC-Module objects for a simulation of the CTC objects
3		real CTC-Modules

This reduced example can handle just two blocks. This can easily be expanded by the reader.
The IDs of the blocks are "bk11" and "bk12".
Each of the blocks has two feedback sensors "fb11+", "fb11-", "fb12+" and "fb12-".
Because there is some optical feedback required the outputs "co_led_bk11_2", "co_led_bk11_5", "co_led_bk12_2" and "co_led_bk12_5" will hand control to the external LEDs of the CTC desk.
Of all the track objects the two connector objects "tkconnector1a" and "tkconnector1b" and one of the track objects "tk_straight" will be used to be shown on the CTC desk.

The contents of the CTC display is configured by the Rocrail block. Setup the values of the tab "Wiring" as follows:

The meaning of the contents of the text field is:
{g1}{E}{R2}{L0} %bkid% {+}%lcbes%{-} {L1}{X0}{+}%lcid%{P}

The description of the commands for the display can be fount at Display SSD1306/SH1106 .
The required large character set can be found at AMP another Large Character Set .

In addition of the two CTC modules "ctc_bk11" and "ctc_bk12" three CTC track modules are prepared: "tkconnector1a", "ctc_tk_straight" and "tkconnector1b".

To map the CTC objects to the Rocrail objects
- just oben the properties of the the Rocrail object
- klick the button "Pixel CTC…" - an fill out the CTC Module dialog.
The parameters can be found in the table below:

The CTC index shows a summary of the CTC module configuration.

The two buttons do not use feedback LEDs;
- therefore the LED values of T1 and T2 are zero.
The CTC block module does not contain any track parts;
- therefore a "Skipped" selection is used for LED2 and LED5; see https://wiki.rocrail.net/doku.php?id=ctc:ctc-led-en#led1
The two LEDs are used to show the state of the pressed buttons.
- The LEDs are controlled by the Rocrail outputs "co_led_bk11_2" … (NeoPixel left/right).
- These Rocrail outputs will be used by the XMLScript.
The CTC block module does not contain a function LED;
- therefore the Function value is zero.

The CTC track modules does not contain any button;
- therefore the LED values of T1 and T2 are zero.
The CTC track modules do contain track parts;
- therefore a "Used" selection is used for LED1 and LED5; see https://wiki.rocrail.net/doku.php?id=ctc:ctc-led-en#led1
The CTC track modules does not contain a function LED;
- therefore the Function value is zero.

The image just shows an example of a real CTC module desk.

The global structure of the XMLScript is:

<?xml version="1.0" encoding="UTF-8"?>
<xmlscript trace="true">
 
  <!-- set the button LED -->
  <function id="abo_fct_setLED" param="blockid,lednr,counter" trace="false">
    ...
  </function>
 
  <!-- reset all button LEDs -->
  <function id="abo_fct_resetAllLEDs" trace="false">
    ...
  </function>
 
  <!-- +++++ begin of main script +++++ -->
  <!-- check auto mode -->
  <!-- check button counter -->
  <!-- case: button counter = 1; (first button): store source block and button -->
  <!-- case: button counter = 2; (second button): execute goto destination -->
    <!-- check for swap -->
    <!-- set destination and go -->
    <!-- cleanup -->
</xmlscript>

The XMLScript should only run in Automatic Mode.
If Automatic Mode is OFF just reset all LEDs and leave the script.

  <!-- check auto mode -->
  <if state="auto auto = off">
  <then>
    <trace text="abo: Automatic is OFF; Exit."/>
    <call id="abo_fct_resetAllLEDs"/>
    <exit cmt="Automatik ist AUS; Exit."/>
  </then>
  </if>

A counter is used to count the buttons pressed. The value of the counter may be 0, 1 or 2.

  <!-- check button counter -->
  <vr id="vr_abo_button_counter" value="#vr_abo_button_counter"/>
  <if condition="#vr_abo_button_counter > 1">
  <then>
    <trace text="abo: Button Counter larger than 1; set to 0."/>
    <vr id="vr_abo_button_counter" value="0"/>
  </then>
  </if>
 
  <vr id="vr_abo_button_counter" value="#vr_abo_button_counter + 1"/>
  <trace text="-abo: vr_abo_button_counter = #vr_abo_button_counter"/>

Store the block and the button pressed and set the appropriate LEDs.

  <!-- case: button counter = 1; (first button): store source block and button -->
  <if condition="#vr_abo_button_counter = 1">
  <then>
    <vr id="vr_abo_block1" text="%callerid%"/>
    <vr id="vr_abo_button1" text="%state%"/>
    <call id="abo_fct_setLED" param="%callerid%,%state%"/>
    <trace text="abo: (first button): source block= @vr_abo_block1 @vr_abo_button1"/>
  </then>
  </if>

Store the block and the button pressed and set the appropriate LEDs.
Check for swap and let the locomotive go to the next block.
Do some cleanup.

  <!-- case: button counter = 2; (second button): execute goto destination -->
  <if condition="#vr_abo_button_counter = 2">
  <then>
    <vr id="vr_abo_block2" text="%callerid%"/>
    <vr id="vr_abo_button2" text="%state%"/>
    <trace text="abo: (second button): destination block= @vr_abo_block2"/>
    <call id="abo_fct_setLED" param="%callerid%,%state%,#vr_abo_button_counter"/>
 
    <!-- check for swap -->
    <query vr="vr_abo_locid" table="bklist" id="@vr_abo_block1" get="locid"/>
    <query vr="vr_abo_blockenterside" table="lclist" id="@vr_abo_locid" get="blockenterside"/>
    <trace text="abo: vr_abo_blockenterside= @vr_abo_blockenterside"/>
    <!-- plus: blockenterside = true -->
    <!-- minus: blockenterside = false -->
    <if condition="@vr_abo_blockenterside # false|@vr_abo_button1 # button2_on" alltrue="true">
    <then>
      <lc bkid="@vr_abo_block1" cmd="swap"/>
      <trace text="abo: minus AND button2 = swap"/>
    </then>
    </if>
    <if condition="@vr_abo_blockenterside # true|@vr_abo_button1 # button1_on" alltrue="true">
    <then>
      <lc bkid="@vr_abo_block1" cmd="swap"/>
      <trace text="abo: plus AND button1 = swap"/>
    </then>
    </if>
 
    <!-- set destination and go -->
    <lc bkid="@vr_abo_block1" cmd="gotoblock" blockid="@vr_abo_block2"/>
    <lc bkid="@vr_abo_block1" cmd="go"/>
 
    <!-- cleanup -->
    <vr id="vr_abo_button_counter" value="0"/>
    <sleep time="5000"/>
    <call id="abo_fct_resetAllLEDs"/>
  </then>
  </if>

The output ID "co_led_bk11_2" is calculated by set strings: "co_led_" plus blockid plus "_" plus lednr
The color values are set to a cyan color and blinking is set to ON with a blinking delay of 1:
- red = 33
- green = 255
- blue = 255
Finally the output is set to ON.

  <!-- set the button LED -->
  <function id="abo_fct_setLED" param="blockid,lednr,counter" trace="false">
    <trace text="abo_fct_setLED: begin %subparam1% %subparam2% %subparam3%"/>
    <vr id="vr_abo_fct_blockid" text="%subparam1%"/>
    <vr id="vr_abo_fct_lednr" text="2"/>
    <if condition="%subparam2% # button2_on">
    <then>
      <vr id="vr_abo_fct_lednr" text="5"/>
    </then>
    </if>
    <vr id="vr_abo_fct_coid" text="co_led"/>
    <vr id="vr_abo_fct_coid" format="%s_%s_%s" text="@vr_abo_fct_coid @vr_abo_fct_blockid @vr_abo_fct_lednr"/>
    <trace text="abo_fct_setLED: @vr_abo_fct_coid @vr_abo_fct_blockid @vr_abo_fct_lednr"/>
    <!-- second button LED should blink (just in reality - not during simulation) -->
    <if condition="%subparam3% # 2">
    <then>
      <vr id="vr_abo_fct_true" text="true"/>
      <vr id="vr_abo_fct_delay" value="1"/>
      <vr id="vr_abo_fct_color_on" value="255"/>
      <vr id="vr_abo_fct_color_off" value="33"/>
      <set vr="vr_abo_fct_true" table="colist" id="@vr_abo_fct_coid" set="blink" setint="false"/>
      <set vr="vr_abo_fct_delay" table="colist" id="@vr_abo_fct_coid" set="delay" setint="true"/>
      <set vr="vr_abo_fct_color_off" table="colist" id="@vr_abo_fct_coid" sub="color" subidx="0" set="red" setint="true"/>
      <set vr="vr_abo_fct_color_on" table="colist" id="@vr_abo_fct_coid" sub="color" subidx="0" set="green" setint="true"/>
      <set vr="vr_abo_fct_color_on" table="colist" id="@vr_abo_fct_coid" sub="color" subidx="0" set="blue" setint="true"/>
      <trace text="abo_fct_setLED: @vr_abo_fct_coid with blink @vr_abo_fct_true #vr_abo_fct_delay"/>
    </then>
    </if>
    <co id="@vr_abo_fct_coid" cmd="on"/>
    <trace text="abo_fct_setLED: end"/>
  </function>

All Rocrail outputs with its ID containing "co_led" will be reset.
The color values are rest to a green color and blinking is set to OFF:
- red = 33
- green = 255
- blue = 33
Finally the output is set to OFF.

  <!-- reset all button LEDs -->
  <function id="abo_fct_resetAllLEDs" trace="false">
    <trace text="abo_fct_resetLEDs: begin"/>
    <vr id="vr_abo_fct_false" text="false"/>
    <vr id="vr_abo_fct_color_on" value="255"/>
    <vr id="vr_abo_fct_color_off" value="33"/>
    <foreach table="colist" condition="%oid% ~ co_led">
      <set vr="vr_abo_fct_false" table="colist" id="%oid%" set="blink" setint="false"/>
      <set vr="vr_abo_fct_color_off" table="colist" id="%oid%" sub="color" subidx="0" set="red" setint="true"/>
      <set vr="vr_abo_fct_color_on" table="colist" id="%oid%" sub="color" subidx="0" set="green" setint="true"/>
      <set vr="vr_abo_fct_color_off" table="colist" id="%oid%" sub="color" subidx="0" set="blue" setint="true"/>
      <co id="%oid%" cmd="off"/>
      <sleep time="20"/>
    </foreach>

To build the hardware the following parts are required:
- one Pico-W
- some CTC-Modules with buttons, display and enclosure (or NeoPixel LEDs, a OLED display and extra buttons)
- one USB power supply (or any other 5 Volt power supply).
The picture does include some other parts that are not required for this example.

There are some things to be done:
- is a locomotive in the first block?
– helpfully this is handled by Rocrail by not sending a command to a not present locomotive.
- does the second button differ from the first button?
– helpfully this is handled by Rocrail by not sending a go command to a locomotive that has already reached its destination.
- …