stepbystep-en
Differences
This shows you the differences between two versions of the page.
Both sides previous revisionPrevious revisionNext revision | Previous revision | ||
stepbystep-en [2020/05/02 15:40] – [6.3 Signals] IDs besra | stepbystep-en [2023/09/01 11:23] (current) – rjversluis | ||
---|---|---|---|
Line 14: | Line 14: | ||
Overview: \\ | Overview: \\ | ||
- | *1. [[: | + | *1. [[: |
*2. [[: | *2. [[: | ||
*3. [[: | *3. [[: | ||
Line 33: | Line 33: | ||
===== Further Tutorials ===== | ===== Further Tutorials ===== | ||
* Language Versions (click on flags to access pages): | * Language Versions (click on flags to access pages): | ||
- | * This tutorial is also available in German [[stepbystep-de|{{: | + | * This tutorial is also available in German [[stepbystep-de|{{: |
- | * The Dutch tutorial | + | |
- | * The Russian version of the StepByStep: [[https:// | + | |
\\ | \\ | ||
- | | :!: Please note: This tutorial is based on an unaltered first-time installation of Rocrail. \\ If changes of settings were made prior to reading this instruction success is not guaranteed! \\ __A simple de-installation / re-installation of Rocrail will not help in this case!__ See footnote((To bring back the initial settings of Rocrail first the application has to be de-installed if offered by the operating system. Afterwards the Rocail | + | | :!: Please note: This tutorial is based on an unaltered first-time installation of Rocrail. \\ If changes of settings were made prior to reading this instruction success is not guaranteed! \\ __A simple de-installation / re-installation of Rocrail will not help in this case!__ See footnote((To bring back the initial settings of Rocrail first the application has to be de-installed if offered by the operating system. Afterwards the Rocrail |
\\ | \\ | ||
Line 73: | Line 71: | ||
===== 1.0 Basics ===== | ===== 1.0 Basics ===== | ||
- | This section describes the very basic steps: Downloading, | + | This section describes the very basic steps: Downloading, |
+ | |||
+ | Rocview common buttons dialog: **[[rocview-common-buttons-en|Common Buttons]]** | ||
\\ | \\ | ||
+ | Here is some basic information: | ||
+ | - Rocrail is not " | ||
+ | - The zip contains the correct shortcut for starting ROCVIEW (there is no server to start!) \\ | ||
+ | - As a rule, there are no individual (plan) files in Rocrail, but WORK AREAS (called workspace) to be opened (created and saved). The main reason for this is that a Rocrail working environment not only consists of the plan, but also the rocrail.ini with the essential definitions for controllers, | ||
+ | |||
+ | This concept enables the users to exchange the respective workspaces with each other, to test each other' | ||
+ | |||
+ | So: \\ | ||
+ | - Start Rocview \\ | ||
+ | - Open a (new) workspace. The workspace starts the server with the correct parameters and definitions i.e. rocrail.ini \\ | ||
+ | - Create a plan (it can still be called " | ||
+ | - Make the settings for the controllers and automatic system etc. \\ | ||
+ | - Save the workspace [this workspace may be ** anywhere ** (you should remember where) - when you open it again, Rocrail follows the (Windows) paths]. \\ | ||
==== 1.1 Download ==== | ==== 1.1 Download ==== | ||
Rocrail can be downloaded from the **[[: | Rocrail can be downloaded from the **[[: | ||
Line 83: | Line 96: | ||
==== 1.2 Installation ==== | ==== 1.2 Installation ==== | ||
- | | :!: If the installer offers the option, **Wiki plan** (__not__ Demo plan) should be selected to be installed. | + | |
+ | As already mentioned above, Rocrail is not installed | ||
| | ||
OS-dependent information is found here (return to this page after the software was installed and proceed with section 1.3): | OS-dependent information is found here (return to this page after the software was installed and proceed with section 1.3): | ||
- | * **[[:rocrailonastick-en#windows|Windows]]** | + | * **[[:win-en|Windows]]** |
* **[[: | * **[[: | ||
* **[[: | * **[[: | ||
Line 94: | Line 109: | ||
==== 1.3 The First Start ==== | ==== 1.3 The First Start ==== | ||
- | __Rocview__ | + | Start __Rocview__. To do this, double-click on the corresponding icon on the desktop. |
- | If Rocrail was installed using the ZIP installer (**[[: | + | If no desktop link has been created yet, first open the folder |
- | > **Note:** It is important to always start Rocview using the automatically created icon in the start menu or the desktop | + | > **Note:** It is important to always start Rocview using this desktop |
- | Rocview opens and two pop-up dialogues | + | Rocview opens and two pop-up dialogues |
- | | {{: | + | | {{: |
- | | Info dialogue. Copyright and disclaimer | Donation | + | | Info dialogue. Copyright and disclaimer | SupportKey |
\\ | \\ | ||
The one shown on the left is the Info dialogue. It appears only at the very first start of Rocrail. The terms and conditions have to be accepted and confirmed in order to use the program. | The one shown on the left is the Info dialogue. It appears only at the very first start of Rocrail. The terms and conditions have to be accepted and confirmed in order to use the program. | ||
- | The dialogue on the right is the **[[rocgui-donate-en|Donation Dialogue]]**. It will appear every time Rocview is started as long as no donation key was loaded. The window is closed by pressing **OK**. | + | The dialogue on the right is the **[[rocgui-supportkey-en|SupportKey Dialoge]]**. It will appear every time Rocview is started as long as no SupportKey |
- | > **Note: | + | > **Note: |
\\ | \\ | ||
- | After closing the Donation | + | After closing the SupportKey |
< | < | ||
Line 155: | Line 170: | ||
\\ | \\ | ||
- | To get an impression of what Rocview looks like with a loaded plan, the demo plan is now opened: | + | To get an impression of what Rocview looks like with a loaded plan, the wiki demo plan is now opened: |
- | * If Rocrail was installed classically by installation file: In the menu //file// select the item //Demo workspace// | + | * In the //File// menu, select //Open Workspace//, |
- | * If Rocrail ZIP was used: In the menu // | + | |
By opening a workspace Rocrail (the server) and Rocview (the client / graphical user interface) start with a common connection to control the model railway layout. | By opening a workspace Rocrail (the server) and Rocview (the client / graphical user interface) start with a common connection to control the model railway layout. | ||
|< >| | |< >| | ||
- | | {{: | + | | {{: |
- | | Depending on the installation method, the Demo workspace is either | + | | The wiki demo workspace is opened by \\ selecting |
| | ||
Line 176: | Line 190: | ||
\\ | \\ | ||
- | In the standard configuration Rocrail uses the **[[: | + | In the standard configuration Rocrail uses the **[[: |
| {{: | | {{: | ||
- | | The Demo-Plan (plan.xml). The most relevant controls and indicators are described. \\ *: Track current display is working only if supported by the command station \\ %%**%%: For details regarding the status indicators see **[[: | + | | The wikidemo-Plan (plan.xml). The most relevant controls and indicators are described. \\ *: Track current display is working only if supported by the command station \\ %%**%%: For details regarding the status indicators see **[[: |
\\ | \\ | ||
- | ==== 1.4 Working with the Demo-Plan ==== | + | ==== 1.4 Working with the wikidemo-Plan ==== |
To get a better overview the plan can be enlarged using the zoom. | To get a better overview the plan can be enlarged using the zoom. | ||
Line 190: | Line 204: | ||
\\ | \\ | ||
- | The demo-plan is consisting of four blocks, eight sensors (green circles), two switches (points) and the connecting tracks. The direction tracks (green arrows) are for the orientation of the user only. Switches can be switched by clicking on their symbol. The sensors can be activated by clicking them. They are deactivated by a second click. \\ | + | The wikidemo-plan is consisting of four blocks, eight sensors (green circles), two switches (points) and the connecting tracks. The direction tracks (green arrows) are for the orientation of the user only. Switches can be switched by clicking on their symbol. The sensors can be activated by clicking them. They are deactivated by a second click. \\ |
> **Note:** Sensor simulation is working with the Virtual Command Station. Only a few other Command stations do support sensor simulation. See **[[: | > **Note:** Sensor simulation is working with the Virtual Command Station. Only a few other Command stations do support sensor simulation. See **[[: | ||
- | On the demo layout each block is equipped with two sensors. Each time the first one, lying in front of the block symbol seen in driving direction is the **enter** sensor, the second one is called **in**. The **enter** sensor informs Rocrail that a locomotive has entered the block, the **in** sensor is the signal that the loco has now completely moved into the block. It will be explained later on that blocks can also be equipped with only one sensor or with additional sensors. | + | On the wikidemo |
Now the loco can virtually drive around the layout. It should be made sure that no sensors are activated. Next the track power ({{: | Now the loco can virtually drive around the layout. It should be made sure that no sensors are activated. Next the track power ({{: | ||
Line 210: | Line 224: | ||
\\ | \\ | ||
| {{: | | {{: | ||
- | | 1. The Demo-Plan | 2. Loco started by a double click, destination block 01 | | + | | 1. The wikidemo-Plan | 2. Loco started by a double click, destination block 01 | |
| {{: | | {{: | ||
| 3. Simulating **enter** of block 01 | 4. Simulating **in** of block 01 | | | 3. Simulating **enter** of block 01 | 4. Simulating **in** of block 01 | | ||
Line 226: | Line 240: | ||
A workspace contains a configuration file for the Rocrail server and a plan file. In the first for instance the configuration of the command station and the auto mode settings are stored, the latter contains all objects managed by Rocrail, e.g. switches, signals, blocks as well as locomotives. | A workspace contains a configuration file for the Rocrail server and a plan file. In the first for instance the configuration of the command station and the auto mode settings are stored, the latter contains all objects managed by Rocrail, e.g. switches, signals, blocks as well as locomotives. | ||
- | In order to use an own plan instead of the demo plan, a new workspace is created: Rocview is (re-) started, then from the //File// menu //Open workspace...// | + | In order to use an own plan instead of a (wiki)demo plan, a new workspace is created: Rocview is (re-) started, then from the //File// menu //Open workspace...// |
> **Note:** If Rocview is not closed and restarted before opening a workspace a warning message may show up telling that this will shut down the server. This has to be accepted by clicking **Yes**. | > **Note:** If Rocview is not closed and restarted before opening a workspace a warning message may show up telling that this will shut down the server. This has to be accepted by clicking **Yes**. | ||
Line 245: | Line 259: | ||
Rocview automatically writes the necessary files with default values into the new folder. In the background the Rocrail server is started to which Rocview automatically connects. | Rocview automatically writes the necessary files with default values into the new folder. In the background the Rocrail server is started to which Rocview automatically connects. | ||
- | The window title now reads '' | + | The window title now reads '' |
- | > **Tip:** To facilitate the opening of the workspace in future // | + | **Notes:** |
+ | * :!: A new Workspace should __not__ be created in the Rocrail installation directory tree. | ||
+ | | ||
+ | * It is __not__ recommended to check the //"Use workspace at startup"// option for the time being as the beginner may want to experiment with different plans in different workspaces. | ||
\\ | \\ | ||
Line 324: | Line 341: | ||
> **Note:** The loco ID is used as an unique identifier within Rocrail and is thus very important. Two or more locos must not share the same ID. \\ Some CS (e. g. ECoS) require exactly the same ID in both Rocrail and the CS. See the wiki page on the relevant CS, if applicable. | > **Note:** The loco ID is used as an unique identifier within Rocrail and is thus very important. Two or more locos must not share the same ID. \\ Some CS (e. g. ECoS) require exactly the same ID in both Rocrail and the CS. See the wiki page on the relevant CS, if applicable. | ||
- | > **Note:** IDs should not contain | + | > **General note on IDs:** All IDs (e.g. of locomotives, |
+ | **'' | ||
All other fields are optional and do not need any change for the time being. See **[[: | All other fields are optional and do not need any change for the time being. See **[[: | ||
Line 530: | Line 549: | ||
===== 6.0 Basic Plan Elements ===== | ===== 6.0 Basic Plan Elements ===== | ||
The elements described in this chapter are necessary for basic train operations. With tracks, switches and signals trains can be operated manually already. Additional elements required for Rocrail' | The elements described in this chapter are necessary for basic train operations. With tracks, switches and signals trains can be operated manually already. Additional elements required for Rocrail' | ||
- | In this tutorial a small layout in the style of the demo layout is designed as an example. | + | In this tutorial a small layout in the style of the wikidemo |
==== 6.1 Plotting Tracks ==== | ==== 6.1 Plotting Tracks ==== | ||
Line 599: | Line 618: | ||
\\ | \\ | ||
- | In the same way the right gap is filled with a **Left Switch**, '' | + | In the same way the right gap is filled with a **Left Switch**, '' |
| {{: | | {{: | ||
Line 744: | Line 763: | ||
\\ | \\ | ||
- | The index is showing all three signals available. Signal 'S02' is highlighted and tab **Details** is selected. | + | The index is showing all three signals available. Signal '' |
The second signal could be configured in the same way as the first one. \\ | The second signal could be configured in the same way as the first one. \\ | ||
- | However, as an exercise, signal '' | + | However, as an exercise, signal '' |
- | | {{: | + | | {{: |
- | | Configuration of Signal '' | + | | |
+ | | Configuration of Signal '' | ||
\\ | \\ | ||
Line 758: | Line 778: | ||
Next tab **Interface** is selected and the __signal address__ 4 is entered (as shown in the figure or, alternatively, | Next tab **Interface** is selected and the __signal address__ 4 is entered (as shown in the figure or, alternatively, | ||
- | After pressing **Apply** tab **Index** is selected, signal '' | + | After pressing **Apply** tab **Index** is selected, signal '' |
The third signal is to be a three aspects semaphore signal. Therefore on tab **Details** only **Semaphore Signal** has to be selected. | The third signal is to be a three aspects semaphore signal. Therefore on tab **Details** only **Semaphore Signal** has to be selected. | ||
After selecting tab **Interface** the address is entered: The three aspects signal will need two addresses, one for red / green and the other one for the yellow aspect. The signal in this example will receive the addresses 5 and 6. In the figure below they have been entered in PADA notation. \\ | After selecting tab **Interface** the address is entered: The three aspects signal will need two addresses, one for red / green and the other one for the yellow aspect. The signal in this example will receive the addresses 5 and 6. In the figure below they have been entered in PADA notation. \\ | ||
- | | {{: | + | | {{: |
- | | Configuration of Signal '' | + | | |
+ | | Configuration of Signal '' | ||
\\ | \\ | ||
Line 770: | Line 791: | ||
> **Note:** If the signal aspects are found to be interchanged the gates have to be changed from red to green and green to red. | > **Note:** If the signal aspects are found to be interchanged the gates have to be changed from red to green and green to red. | ||
- | Alternatively '' | + | Alternatively '' |
- | | {{: | + | | {{: |
- | | Alternative Configuration of Signal '' | + | | |
+ | | Alternative Configuration of Signal '' | ||
\\ | \\ | ||
- | If all settings are correct **Apply** is pressed to confirm the changes and the dialogue is closed by pressing **OK**. The symbolic representations of the signals on the track plan have changed due to the settings made before: Signals '' | + | If all settings are correct **Apply** is pressed to confirm the changes and the dialogue is closed by pressing **OK**. The symbolic representations of the signals on the track plan have changed due to the settings made before: Signals '' |
| {{: | | {{: | ||
Line 830: | Line 852: | ||
==== 7.2 Sensors ==== | ==== 7.2 Sensors ==== | ||
- | In this section sensors are added to the plan and subsequently are configured. | + | In this section sensors are added to the plan and subsequently are configured. |
+ | Some sensor configuration options: \\ | ||
+ | {{: | ||
+ | You can use all three variants without any problems. \\ | ||
+ | Option 1: This variant does not offer continuous electrical detection. But this is not necessary for the operation of Rocrail. \\ | ||
+ | Option 2: This variant is only suitable for one-way trains (each track for one direction) because of its asymmetry. \\ | ||
+ | Option 3: This variant is good if you want maximum flexibility use it with a third, middle sensor with the event ' | ||
+ | It can easily be converted to the second variant by connecting the middle section to the ' | ||
+ | We now continue with the demo plan. \\ | ||
All blocks will be equipped with two sensors each. These sensors have the functions **enter** and **in**, respectively. Two sensors per block represent the standard configuration of Rocrail: One sensor at the beginning of a block (**enter**) telling Rocrail the train has arrived the block and one sensor at the end of the block (**in**) telling Rocrail the train has completely moved into the block. The train will be slowed down when it reaches **enter** __if__ the train has to stop in the particular block. Reaching **in** the train will be decelerated to a halt __if__ the train has to stop. The **in**-sensor also triggers clearing of the previous block. | All blocks will be equipped with two sensors each. These sensors have the functions **enter** and **in**, respectively. Two sensors per block represent the standard configuration of Rocrail: One sensor at the beginning of a block (**enter**) telling Rocrail the train has arrived the block and one sensor at the end of the block (**in**) telling Rocrail the train has completely moved into the block. The train will be slowed down when it reaches **enter** __if__ the train has to stop in the particular block. Reaching **in** the train will be decelerated to a halt __if__ the train has to stop. The **in**-sensor also triggers clearing of the previous block. | ||
Line 899: | Line 929: | ||
The preferred method of creating routes is very easy by using the **[[: | The preferred method of creating routes is very easy by using the **[[: | ||
- | //Router -> Routing// is selected from the //File//-menu to run the Router. In the server message window the creation of four routes will be confirmed. \\ | + | //Router -> Routing// is selected from the //Track plan//-menu to choose options and run the Router. In a server |
- | | {{: | + | | {{: |
- | | Running the Router and Result || | + | | Running the Router and Result | | |
\\ | \\ | ||
- | Rocrail has to be closed and restarted after running the Router. | ||
Four routes have been generated because (only) these four routes are possible if the plan is used in running direction (clockwise as indicated by the direction tracks): Block 01 (minus side) to block 03 (minus side), block 02 (-) to block 03 (-), 03 (+) to 01 (+) and 03 (+) to 02 (+). \\ | Four routes have been generated because (only) these four routes are possible if the plan is used in running direction (clockwise as indicated by the direction tracks): Block 01 (minus side) to block 03 (minus side), block 02 (-) to block 03 (-), 03 (+) to 01 (+) and 03 (+) to 02 (+). \\ | ||
Line 919: | Line 948: | ||
\\ | \\ | ||
- | The four routes described above are listed on the // | + | The four routes described above are listed on the // |
The Router, in addition, added route IDs to each **[[: | The Router, in addition, added route IDs to each **[[: | ||
Line 931: | Line 960: | ||
\\ | \\ | ||
=== 7.3.2 Creating Routes Manually === | === 7.3.2 Creating Routes Manually === | ||
- | This section describes how routes are created | + | This section describes how routes are created |
An existing route created be the Router will be used to explain the course of action. | An existing route created be the Router will be used to explain the course of action. | ||
- | First, //Tables -> Routes// is selected from the menu. The //Index// tab is shown. The first route in the list ('' | + | First, //Tables -> Routes// is selected from the menu. The //Index// tab is shown. The first route in the list ('' |
| {{: | | {{: | ||
Line 941: | Line 970: | ||
\\ | \\ | ||
- | For a newly created route first of all the ID had to entered. Here, the ID was created by the Router which is indicated by the '' | + | For a newly created route first of all the ID had to entered. Here, the ID was created by the Router which is indicated by the description |
- | > **Note: | + | > **Note: |
For a manually created route the ID could be simply '' | For a manually created route the ID could be simply '' | ||
Line 1031: | Line 1060: | ||
After all settings are done **Apply** is pressed and the dialogue is closed by pressing **OK**. \\ | After all settings are done **Apply** is pressed and the dialogue is closed by pressing **OK**. \\ | ||
- | > **Tip:** The Router in many cases can configure routes automatically. Prior to this in the dialogue available from menu //File// -> //Rocrail properties...// -> tab //Router// option **Assign feedbacks to blocks** has to be selected | + | > **Tip:** The Router in many cases can configure routes automatically. Prior to this in the dialogue available from menu //Track plan// -> //Router// -> tab //Routing// option **Assign feedbacks to blocks** has to be selected. |
Rocrail is now ready to run trains in automatic mode. \\ | Rocrail is now ready to run trains in automatic mode. \\ |
stepbystep-en.1588426841.txt.gz · Last modified: 2020/05/02 15:40 by besra