Tutorial: Create a First Track

Christian Benjamin Ries edited this page Sep 10, 2017 · 1 revision

First Track

In this Tutorial we will create a first RailwayEssential project with a small circle, two blocks and one train.

Step 1: Start RailwayEssential

Just start RailwayEssential by clicking the Desktop icon. Following window will be shown.

RailwayEssential Main

Step 2: Create Project

  • Click "File" -> "New Project..."
  • Select a target directory, e.g. "C:\Users\{YOURNAME}\Desktop\Tutorials", the default project name will be "Project{NUMBER}.railwayprj"
  • Click Save

RailwayEssential New project...

Your first project has been generated, the track designer with the track "S#1" is opened automatically.

RailwayEssential Main

On the left-hand side the Object Explorer provides a default list of track objects which provides information about your Model Railway, e.g. a list of Locomotives which are registered within your command station.

The designer is a Cef-sharp based view of your railway track. On top their are control for editing.

RailwayEssential Designer Controls

From left to right:

  • toggles the edit state of the designer
  • reset zoom to default, i.e. 100%
  • Zoom-Out
  • Zoom-In
  • enable adding of track controls
  • enable moving of track controls by use of the computer mouse
  • enable rotating of track controls by clicking them by use of the computer mouse
  • enable removing of track controls
  • enable Object Edit of switches, blocks, signals, etc.pp.

Step 3: Create your Trackplan

RailwayEssential provides two ways to configure and designing your modelrailway. First we can connect directly to your command station (i.e. Live Mode), and second by working in a so-called Dry Run Mode.

  • click "Command Station" --> "Dry Run" for enabling the Dry Run Mode

The indicator on the right-hand side will change:

RailwayEssential Designer Controls

This enables the edit mode of the designer (i.e. the button to toggle the edit mode is clickable):

RailwayEssential Designer Controls

Just click it and the designer will provide a grid and additional comboboxes for selecting track objects which are allowed to add.

RailwayEssential Designer Controls

Just play around and create a plan like this:

RailwayEssential Designer Controls

Save the project: File --> Save

Step 4: Provide Objects

Because we are in Dry Run Mode we have to provide Objects manually. Please open the project directory by clicking Project --> Show Project Directory and overwrite the file TrackObjects.json by the following file in RailwayEssential's GitHub master.

TrackObjects.json file, approx. 267 KB

Please close and reopen the project.

Now you should have two objects:

  1. the Locomotive BR10
  2. a single S88 bus member

RailwayEssential Designer Controls

The BT10 is not sync because of the fact that we are not connected to any command station!

Activate the Dry Run Mode again.

Step 5: Analyze the Trackplan (i.e. Routes and Block Routes)

RailwayEssential does support you to find any possible route between blocks. Only one train is allowed to cruise between two blocks.

Crossing routes are analyzed as well during automode. Two blocks can be connected by more than one route, and when they are cross each other only one train can be within these crossing routes, because of safety!

Click File --> Analyze --> Routes.

Two routes will be found:

  1. #1: Block#1 -> Block#2 and
  2. #2: Block#2 -> Block#1

RailwayEssential Designer Controls

In case you were connected to the command station and on the routes were any switches, you can directly test the switches by using the context menu: Right Mouse-click --> Force Switches.

Please do a double click on one these routes. The selected route will be highlighted within the designer.

RailwayEssential Designer Controls

ESC or Right Mouse-click --> Reset Route will stop the highlighting.

Please save the project.

Step 6: Configure S88 Sensors

Switch to edit mode of the designer. Enable the Object Edit mode:

RailwayEssential Designer Controls

Select one of the sensors, a configuration tab will be show up.

RailwayEssential Designer Controls

Switch to the S88 tab.

The combobox on the left-hand side will provide the available S88-objects, the second combobox allows you to set the S88-pin which should be visualized by the trackplan.

Pins start with the index 1 to the maximum possible value 16 (i.e. information will be provided your command station when they are registered).

RailwayEssential Designer Controls

Click Apply after configuring a sensor.

Repeat this for any sensor.

Please save the project.

The configuration of the S88-objects will be serialized within the file TrackWeaving.json within the project directory. A valid configuration looks like this:

[ {
    "type": "S88", "setup": { 
      "objectId": 100, "pin": 4, "visuX": 13, "visuY": 2,
      "invertSwitch": false, "fncToggle": false,
      "startFncTypes": [], "stopFncTypes": []
    }
  }, {
    "type": "S88", "setup": {
      "objectId": 100, "pin": 1, "visuX": 6, "visuY": 2,
      "invertSwitch": false, "fncToggle": false,
      "startFncTypes": [], "stopFncTypes": []
    }
  }, {
    "type": "S88", "setup": {
      "objectId": 100, "pin": 2, "visuX": 6, "visuY": 5,
      "invertSwitch": false, "fncToggle": false,
      "startFncTypes": [], "stopFncTypes": []
    }
  }, {
    "type": "S88", "setup": {
      "objectId": 100, "pin": 3, "visuX": 13, "visuY": 5,
      "invertSwitch": false, "fncToggle": false,
      "startFncTypes": [], "stopFncTypes": []
    }
  } ]

Step 7: Configure Blocks (i.e. assign S88-events)

With Object Edit mode enabled, select a block.

RailwayEssential Designer Controls

Switch to the "Blocks" tab.

The block events are based on Rocrail's approach. Rocrail has a set of event classifiers, e.g. "enter" or "in". In RailwayEssential enter signals entering a Block area, which means that the speed of a locomotive is decreased to a specific value. The event in will stop the locomotive crusing on the route between two blocks.

Based on these information any block must have event assignments. We set up the following configuration:

RailwayEssential Designer Controls

RailwayEssential Designer Controls

Please save the project.

Step 8: Assign a Locomotive to a Block

Use the combobox Current Locomotive on the tab Blocks to assign a locomotive to the selected block.

RailwayEssential Designer Controls

Disable the edit mode

Step 9: Autoplay (simulate the trackplan)

Now you are ready to play(!!)

  • click Command Station --> Autoplay

The indicator will change:

RailwayEssential Designer Controls

After few seconds the track will visualize a route which the locomotive BR10 will take. The target block will be highlighted with the name of the BR10.

RailwayEssential Designer Controls

Click Sensor#1, as you can see the color will change to red. As well the Object Explorer provide the new state.

RailwayEssential Designer Controls

Because of the fact, that Sensor#1 is configured for in events on the other route, nothing will happen. You can just disable the sensor again.

Open the Autoplay Log, click View --> Autoplay Log and check the output.

Please click Sensor#2. As you can see in the log, the locomotive speed is changing:

RailwayEssential Designer Controls

Please click Sensor#2 again to disable the sensor and click Sensor#3 for enabling it. The locomotive will stop, the next route will be highlighted.

RailwayEssential Designer Controls

Step 10: Real Run Mode :-)

Just build up the circle in real.

Connect to your command station and start.

The network information can be set within the Properties window. Click Command Station --> Properties.

RailwayEssential Designer Controls

Appendix

Live Mode

Within the live mode you are connected to your command station and can start/stop any locomotive, can change switch directions, etc.pp. Be careful, wrong setup steps in live mode can damage your stuff. We strongly advice you to work in Dry Run Mode because of safety reasons.

Dry Run Mode (i.e. Simulation)

The dry run mode is like the live mode but any command to the command station is just logged instead of sending them to control something.

You can’t perform that action at this time.
You signed in with another tab or window. Reload to refresh your session. You signed out in another tab or window. Reload to refresh your session.
Press h to open a hovercard with more details.