User Tools

Site Tools


stepbystep-en

Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Both sides previous revisionPrevious revision
Next revision
Previous revision
stepbystep-en [2020/05/01 12:43] – [1.3 The First Start] Language settings besrastepbystep-en [2023/09/01 11:23] (current) rjversluis
Line 14: Line 14:
 Overview: \\ Overview: \\
  
-  *1. [[:stepbystep-en#basics|Basics]] - Downloading and installing Rocrail, exploring the demo plan+  *1. [[:stepbystep-en#basics|Basics]] - Downloading and installing Rocrail, exploring the wikidemo plan
   *2. [[:stepbystep-en#creating_a_new_workspace_and_plan_file|Creating a workspace for an own track plan]]   *2. [[:stepbystep-en#creating_a_new_workspace_and_plan_file|Creating a workspace for an own track plan]]
   *3. [[:stepbystep-en#adding_a_command_station|Connecting the Command station]]   *3. [[:stepbystep-en#adding_a_command_station|Connecting the Command station]]
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|{{:icons:de.png|Deutsche Version}}]], Italian [[stepbystep-it|{{icons:it.png|Versione Italiana}}]] and French [[:stepbystep-fr|{{icons:fr.png|Version Français}}]] +    * This tutorial is also available in German [[stepbystep-de|{{:icons:de.png|Deutsche Version}}]], Italian [[stepbystep-it|{{icons:it.png|Versione Italiana}}]]French [[:stepbystep-fr|{{icons:fr.png|Version Français}}]] Dutch [[stepbystep-nl|{{:icons:nl.png|Nederlandse Versie}}]]
-    * The Dutch tutorial [[stepbystep-nl|{{:icons:nl.png|Nederlandse Versie}}]] +
-    * The Russian version of the StepByStep: [[https://launchpad.net/rocrail/sunrise/2.0/+download/Rocrail-Step-RU.pdf|{{:icons:ru.png}}]]+
  \\  \\
  
  
-| :!: 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 folder (My files/Rocrail, Documents/Rocrail, home/Rocrail, depending on the operating system) has to be deleted manually. Backup your files before doing so! Afterwards Rocrail can be installed again.)) |+| :!: 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 folder (My files/Rocrail, Documents/Rocrail, home/Rocrail, depending on the operating system) has to be deleted manually. Backup your files before doing so! Afterwards Rocrail can be installed again.)) |
  
  \\  \\
Line 73: Line 71:
  
 ===== 1.0 Basics ===== ===== 1.0 Basics =====
-This section describes the very basic steps: Downloading, program installation, starting Rocrail for the first time and learning the concept from the demo track-plan. \\+This section describes the very basic steps: Downloading, program installation, starting Rocrail for the first time and learning the concept from the wikidemo track-plan. \\ 
 + 
 +Rocview common buttons dialog: **[[rocview-common-buttons-en|Common Buttons]]**
  
 \\ \\
 +Here is some basic information:
 +
 +  - Rocrail is not "installed", but is a simple zip which is extracted to any ** arbitrary ** storage location. \\
 +  - 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, automatic operation, locomotive occupancy, etc.\\
 +
 +This concept enables the users to exchange the respective workspaces with each other, to test each other's plans virtually without affecting their own installation in any way. An excellent support concept. \\
  
 +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 "plan") \\
 +  - 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 **[[:download-int|download portal]]** (all operating systems). Rocrail can be downloaded from the **[[:download-int|download portal]]** (all operating systems).
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 aboveRocrail is not installed "classically". Instead, a ZIP file specific to the operating system is unpacked into a folder or directory previously created for this purpose. 
  \\   \\ 
 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):
Line 94: Line 109:
  
 ==== 1.3 The First Start ==== ==== 1.3 The First Start ====
-__Rocview__ (not Rocrail!) is started from the start menu or the place where the OS holds the program linksRocview opens and two pop-up dialogues shows up:+Start __Rocview__. To do this, double-click on the corresponding icon on the desktop
  
-| {{:sbs:sbs-copyright-en.png}} | {{:sbs:sbs-donation-en.png|Donation Dialogue}} | +If no desktop link has been created yet, first open the folder in which the previously unpacked files are located. Then with double-click on the file desktoplink.cmd((depending on operating system settings, the extension .cmd may not be displayed)) a link on the desktop is created((a window that opens and closes briefly is of no importance)). The icon is called ''Rocview''. Double click on this icon to start Rocview. 
-| Info dialogue. Copyright and disclaimer | Donation dialogue |+ 
 +> **Note:** It is important to always start Rocview using this desktop icon, otherwise dependencies may not be resolved correctly and malfunctions may occur.  
 + 
 +Rocview opens and two pop-up dialogues show up: 
 + 
 +| {{:sbs:sbs-copyright-en.png}} | {{:sbs:sbs-donation-en.png|SupportKey Dialoge}} | 
 +| Info dialogue. Copyright and disclaimer | SupportKey dialogue |
  \\  \\
 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 was loaded. The window is closed by pressing **OK**.
  
-> **Note:** Rocrail is developed and maintained entirely on volunteer labour. However, some money is needed to run the project, e.g. for purchasing hardware for testing purposes and to cover other expenses like domain and server hosting. \\ It is thus left to the user to make a small contribution as a donation if the program should be liked and be used in the long term. \\ The pages **[[rocgui-donate-en|Donation Dialogue]]** and **[[donate-en|Donating]]** inform about how to make a donation.+> **Note:** Money is needed to keep the Rocrail project alive.\\ It is thus left to the user to make a small contribution as a support if the program should be liked and be used in the long term. \\ The pages **[[rocgui-supportkey-en|SupportKey Dialogu]]** and **[[supportkey-en|Supporting]]** inform about how to make a financial support.
  
  \\  \\
-After closing the Donation Dialogue, Rocview is displayed in the language specified by the operating system.+After closing the SupportKey Dialogue, Rocview is displayed in the language specified by the operating system. 
 + 
 +<html> 
 +<!-- Please do not translate the following section. --> 
 +<!-- Only relevant in English! --> 
 +<!-- The end of the section is marked. --> 
 +<!-- Thanks. Bernd (Besra) --> 
 +</html>
  
 > **Tip:** If this tutorial is not available in the desired language it may be wise to stay with the English user interface for the time being as the following explanations are based on screen-shots from the English GUI. \\  The language can be changed by choosing //Language// from the //View// menu and the desired language as shown on the picture below. > **Tip:** If this tutorial is not available in the desired language it may be wise to stay with the English user interface for the time being as the following explanations are based on screen-shots from the English GUI. \\  The language can be changed by choosing //Language// from the //View// menu and the desired language as shown on the picture below.
Line 117: Line 145:
 A dialogue appears which is confirmed by pressing **OK**. A dialogue appears which is confirmed by pressing **OK**.
  
 +|< >|
 | {{:sbs:sbs-language-changed-int.png|}} | | {{:sbs:sbs-language-changed-int.png|}} |
 | Prompt to restart Rocview in order to use the new language setting | | Prompt to restart Rocview in order to use the new language setting |
  
  \\   \\ 
-Rocview has to be closed and restarted again, so the changes can take effect. A fresh, empty Rocview looks like this:+Rocview has to be closed and restarted again, so the changes can take effect. 
 + 
 +<html> 
 +<!-- End of section. --> 
 +</html> 
 + 
 +A fresh, empty Rocview looks like this:
  
 | {{:sbs:sbs-empty-rocview-bw-en.png}} | | {{:sbs:sbs-empty-rocview-bw-en.png}} |
Line 135: Line 170:
  
  \\  \\
-In order to get an impression on how Rocview looks like with a plan loaded the demo workspace is opened from the //File// menu. Opening a workspace starts Rocrail (the server) and connects it to Rocview (the client / graphical user interface) in order to control the layout. +To get an impression of what Rocview looks like with a loaded plan, the wiki demo plan is now opened
 +  * In the //File// menu, select //Open Workspace//, then open the ''wikidemo'' folder in the dialogue that opens\\ 
 +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.
  
-| {{:sbs:sbs-open-demo-workspace-menu-en.png|}} | +|< >| 
-Opening the demo workspace |+| {{:sbs:sbs-open-workspace-menu-en.png|}} | 
 +The wiki demo workspace is opened by \\ selecting "Open Workspace..." |
  
  \\   \\ 
Line 152: Line 190:
  
  \\  \\
-In the standard configuration Rocrail uses the **[[:vcs-en|Virtual Command Station]]**. A track-plan with two locomotives, E03 and V200, should appear as shown in the figure below. This virtual layout does not need any connection to a command station or a layout. It is meant as an example to learn about Rocrail's basic functions. The next chapter will explain how to work with the demo-plan.+In the standard configuration Rocrail uses the **[[:vcs-en|Virtual Command Station]]**. A track-plan with two locomotives, E03 and V200, should appear as shown in the figure below. This virtual layout does not need any connection to a command station or a layout. It is meant as an example to learn about Rocrail's basic functions. The next chapter will explain how to work with the wikidemo-plan. It is intended as an example to learn about the basic functions of Rocrail.
  
 | {{:sbs:sbs-plan-commented-en.png|}} | | {{:sbs:sbs-plan-commented-en.png|}} |
-| 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 **[[:gui-cs-status-en|Command Station Status]]** |+| 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 **[[:gui-cs-status-en|Command Station Status]]** |
  
  \\  \\
  
-==== 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 166: 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 **[[:controllers-en|Supported Command Stations]]** for a list.\\ > **Note:** Sensor simulation is working with the Virtual Command Station. Only a few other Command stations do support sensor simulation. See **[[:controllers-en|Supported Command Stations]]** for a list.\\
  
-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 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.
  
 Now the loco can virtually drive around the layout. It should be made sure that no sensors are activated. Next the track power ({{:sbs:sbs-trackpower-bw-int.png?30}} or {{:sbs:sbs-trackpower-int.png?30}}) and auto mode ({{:sbs:sbs-automode-bw-int.png?30}} or {{:sbs:sbs-automode-int.png?30}}) are switched on. Now the loco can virtually drive around the layout. It should be made sure that no sensors are activated. Next the track power ({{:sbs:sbs-trackpower-bw-int.png?30}} or {{:sbs:sbs-trackpower-int.png?30}}) and auto mode ({{:sbs:sbs-automode-bw-int.png?30}} or {{:sbs:sbs-automode-int.png?30}}) are switched on.
  
-Loco E03, already present in block 04 (Step 1, see figures below), is started by double clicking on the block symbol of block 04Now block 01 is marked as destination block and its colour changes to yellow (Step 2). With a click on the sensor symbol __in front of__ the destination block seen in driving direction the **enter** sensor of block 01 is virtually triggered.+Loco E03 is - depending on the version of the demo plan - located in one of the blocks. In the following exampleit is located in block 04 (step 1, see figures below). In other casesthe steps must be carried out from a different starting block.  
 + 
 +The locomotive is started by double-clicking on the block symbol. Then the next one, in the example block 01is automatically selected as destination and therefore marked yellow (status: reserved, step 2). The tracks that belong to the route from block 04 to block 01 are also illuminated yellow. With a click on the sensor symbol __in front of__ the destination block seen in driving direction the **enter** sensor of block 01 is virtually triggered.
  
 > **Tip:** The names of the plan objects are shown if the mouse is moved over them. The correct sensor is ''fb1a'' > **Tip:** The names of the plan objects are shown if the mouse is moved over them. The correct sensor is ''fb1a''
Line 184: Line 224:
  \\  \\
 | {{:sbs:sbs-demo-int.png|}} | {{:sbs:sbs-loco-started-int.png|}} | | {{:sbs:sbs-demo-int.png|}} | {{:sbs:sbs-loco-started-int.png|}} |
-| 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 |
 | {{:sbs:sbs-block01enter-int.png|}} | {{:sbs:sbs-block01in-int.png|}} | | {{:sbs:sbs-block01enter-int.png|}} | {{:sbs:sbs-block01in-int.png|}} |
 | 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 200: 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...// is selected.+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...// is selected.
  
 > **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**.
  
-| {{:sbs:sbs-open-workspace-menu-en.png}} | +|< >| 
-| Opening a workspace |+|  {{:sbs:sbs-open-workspace-menu-en.png}}  
 +| Opening a workspace ||
  
  \\  \\
Line 218: 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 ''Rocrail: New plan''This name can be changed as needed using menu //File -> Track plan title...//. For instance ''My Layout'' could be used. The window title changes to the new name, e.g. ''Rocrail: My Layout''+The window title now reads ''Rocrail: New plan''The title can be changed as needed using menu //File -> Plan properties...//. For instance ''My Layout'' could be used. The window title changes to the new name, e.g. ''Rocrail: My Layout''
  
-**Tip:** To facilitate the opening of the workspace in future //Roc__view__ properties...// can be selected from the //File// menu, then the default workspace is selected on tab //Path// of the dialogue. \\ 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.+**Notes:**  
 +  * :!: A new Workspace should __not__ be created in the Rocrail installation directory tree. 
 +  * To facilitate the opening of the workspace in future //Roc__view__ properties...// can be selected from the //File// menu, then the default workspace is selected on tab //Path// of the dialogue.  
 +  * 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 234: Line 278:
 Open //Rocrail properties...// from the //File// menu (if the option is not available the own workspace has to be opened beforehand in order to establish the connection to the Rocrail server): Open //Rocrail properties...// from the //File// menu (if the option is not available the own workspace has to be opened beforehand in order to establish the connection to the Rocrail server):
  
 +|< >|
 | {{:sbs:sbs-rocrail-properties-menu-en.png|}} | | {{:sbs:sbs-rocrail-properties-menu-en.png|}} |
 | Menu File / Rocrail properties | | Menu File / Rocrail properties |
Line 296: 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 white spaces (blanks)Even though possible, blanks may interfere with Rocrail'advanced features like, e.g.XML scriptingInstead of a blank an underscore can be used: ''BR_298''.+> **General note on IDs:** All IDs (e.g. of locomotives, wagons, switches, signals, etc.) should not contain spaces/blanks or special charactersThis is possible, but can lead to problems in connection with advanced operations (e.g. in XML scripts)For example, the underscore character can be used instead of the space character**''BR_298''**\\ It is strongly recommended to use only combinations of the following characters with a max. length of 32: 
 +**''0 1 2 3 4 5 6 7 8 9'' \\ ''a b c d e f g h i j k l m n o p q r s t u v w x y z'', or Capital letters \\ ''_ . - + [ ]''** 
    
 All other fields are optional and do not need any change for the time being. See **[[:loc-gen-en|Locomotives: General]]** for an explanation.  All other fields are optional and do not need any change for the time being. See **[[:loc-gen-en|Locomotives: General]]** for an explanation. 
Line 353: Line 400:
  \\  \\
 === Speed === === Speed ===
-| {{:loc:loc-speed-en.png|}} |+| {{:sbs:sbs-loc-speed-en.png|}} |
 | Speed Tab | | Speed Tab |
  
Line 423: Line 470:
 If locomotives were created in a first step they are displayed on the loco panel on the left. If locomotives were created in a first step they are displayed on the loco panel on the left.
  
 +|< >|
 | {{:sbs:sbs-loco-panel-en.png|}} | | {{:sbs:sbs-loco-panel-en.png|}} |
 | Loco Panel | | Loco Panel |
Line 431: Line 479:
 Alternatively, a loco can be controlled //via// a throttle window. A throttle is opened by clicking on the {{:sbs:sbs-throttle-button-bw-int.png}} or {{:sbs:sbs-throttle-button-int.png}} symbol on the symbol bar or by double clicking the loco in the loco panel.  Alternatively, a loco can be controlled //via// a throttle window. A throttle is opened by clicking on the {{:sbs:sbs-throttle-button-bw-int.png}} or {{:sbs:sbs-throttle-button-int.png}} symbol on the symbol bar or by double clicking the loco in the loco panel. 
  
 +|< >|
 | {{:sbs:sbs-throttle-en.png|}} | | {{:sbs:sbs-throttle-en.png|}} |
 | Throttle Window | | Throttle Window |
Line 441: Line 490:
 A throttle window allows for direct access to the functions F0 to F14. Further functions, if any, are visible after pressing **FG**. \\ A throttle window allows for direct access to the functions F0 to F14. Further functions, if any, are visible after pressing **FG**. \\
  
-> **Tip:** Multiple throttles controlling multiple locos can be displayed at the same time. Note that a new throttle window is placed above the last active one and has thus to be moved aside.  +> **Tips:** Multiple throttles controlling multiple locos can be displayed at the same time. Note that a new throttle window is placed above the last active one and has thus to be moved aside. \\ \\ The buttons with the Latin numbers (I, II, III, IIII) set the loco speed to one of the programmed velocities **V_Min** (I), **V_Mid** (II), **V_Cru** (III) and **V_Max** (IIII), respectively. \\ \\ The size of the window can be changed as required, making the buttons larger and easier to read.
- +
-> **Tip:** The buttons with the Latin numbers (I, II, III, IIII) set the loco speed to one of the programmed velocities **V_Min** (I), **V_Mid** (II), **V_Cru** (III) and **V_Max** (IIII), respectively.+
  
  \\   \\ 
Line 502: 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's Auto Mode will be described in the next chapter. \\ 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's Auto Mode will be described in the next chapter. \\
-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 layout is designed as an example. 
  
 ==== 6.1 Plotting Tracks ==== ==== 6.1 Plotting Tracks ====
Line 562: Line 609:
  
 \\ \\
-The left gap is filled with a right switch which is selected from the //Add item// dialogue: At first, from the left column **Switch** has to be selected and in a second step the right switch (see screenshot in [[#editing_the_track-plan|chapter 5.2]]) is placed in the plan . The following dialogue asks for the ID of the switch which in this example is to be ''Sw01'' (Step 13). +The left gap is filled with a right switch which is selected from the //Add item// dialogue: At first, from the left column **Switch** has to be selected and in a second step the right switch (see screenshot in [[#editing_the_track-plan|chapter 5.2]]) is placed in the plan.  
 + 
 +Note that newly placed objects are automatically named by default. That is, every object will get it's own unique ID. The first switch object will get the ID ''sw1'', the second ''sw2'' and so on. \\ Automatic IDs can be renamed later on, however, it is recommended to either keep them or to rename them as soon as possible. Renaming at a later date, for example, when a switch has already become part of a route, is not recommended. In some cases this may result in invalid references. \\ 
 +If individual IDs are preferred, this can be set in the Rocview options: //File// -> //Rocview properties...// -> Tab //General// -> **Popup ID Dialogue**. After activating this option, a dialogue will be opened for newly added objects in which the automatic ID is displayed and can be changed if necessary. Individual names should be short in any case. The dialogue, if displayed, has to be confirmed by pressing **OK** (Step 13). 
  
 | {{:sbs:sbs-id-dialogw01-en.png|}} | {{:sbs:sbs-step13-int.png|}} | | {{:sbs:sbs-id-dialogw01-en.png|}} | {{:sbs:sbs-step13-int.png|}} |
-| Step 13: Entry of the Switch ID and result ||+| Step 13: ID dialogue (optional) and result ||
  
  \\  \\
-In the same way the right gap is filled with a **Left Switch** named ''Sw02''. In addition two curves have to be added and rotated to the correct positions. This will complete the extended demo plan for the moment (Step 14).+In the same way the right gap is filled with a **Left Switch**''sw2''. In addition two curves have to be added and rotated to the correct positions. This will complete the extended wikidemo plan for the moment (Step 14).
  
 | {{:sbs:sbs-step14-int.png|}} | | {{:sbs:sbs-step14-int.png|}} |
Line 575: Line 625:
  \\  \\
 === 6.2.2 Configuring Switches === === 6.2.2 Configuring Switches ===
-Two switches have been added in the last paragraph. To be able to operate them, they have to be configured as a next step. A right click on the left switch (''Sw01'') opens the context menu from which **Properties** is chosen. The following dialogue opens:+Two switches have been added in the last paragraph. To be able to operate them, they have to be configured as a next step. A right click on the left switch (''sw1'') opens the context menu from which **Properties** is chosen. The following dialogue opens:
  
 | {{:sbs:sbs-switch-gen-en.png|}} | | {{:sbs:sbs-switch-gen-en.png|}} |
Line 581: Line 631:
  
  \\  \\
-Since the ID is already set nothing has to be changed on this tab for the time being. Pressing **Help** opens the wiki page describing all options. The **Position** tab is skipped and tab **Interface** is selected:+Since the ID is already set nothing has to be changed on this tab for the time being. Pressing **Help** opens the wiki page describing all options. Next, tab **Interface** is selected:
  
 | {{:sbs:sbs-switch-int-en.png|}} | | {{:sbs:sbs-switch-int-en.png|}} |
Line 609: Line 659:
 === Address and Port === === Address and Port ===
 These two fields contain the most important information necessary to control a switch. The __address of the decoder__ and the __output (port) of the decoder__ the switch is connected to have to be entered in these fields. \\ These two fields contain the most important information necessary to control a switch. The __address of the decoder__ and the __output (port) of the decoder__ the switch is connected to have to be entered in these fields. \\
-In the example switch ''Sw01'' will get the switch address 1 (see figure above). \\+In the example switch ''sw1'' will get the switch address 1 (see figure above). \\
  
 > **Tip:** With many CS it is possible to use **[[:addressing-en#port_accessory_decoder_address_pada|PADA]]**. In this case **Address** remains to 0 (zero) and **Port** is set to __address of the switch__ (see comparison table below) > **Tip:** With many CS it is possible to use **[[:addressing-en#port_accessory_decoder_address_pada|PADA]]**. In this case **Address** remains to 0 (zero) and **Port** is set to __address of the switch__ (see comparison table below)
Line 636: Line 686:
 In most cases no further action in required to set up a switch. Further information is available from the wiki by pressing **Help**. \\ In most cases no further action in required to set up a switch. Further information is available from the wiki by pressing **Help**. \\
  
-The configuration of the first switch is thus completed and can be confirmed by pressing **Apply**. After selecting tab **Index** both switches are listed. Switch ''Sw02'' is highlighted as shown below, afterwards again the tab **Interface** is selected.+The configuration of the first switch is thus completed and can be confirmed by pressing **Apply**. After selecting tab **Index** both switches are listed. Switch ''sw2'' is highlighted as shown below, afterwards again the tab **Interface** is selected.
  
 | {{:sbs:sbs-switch-overview-en.png|Index (List of Switches)}} | | {{:sbs:sbs-switch-overview-en.png|Index (List of Switches)}} |
 | Dialogue Switches, Index Tab | | Dialogue Switches, Index Tab |
  
-''Sw02'' in the example shall get the address 2 (Address=1 + Port=2, or Address=0 + Port=2). +''sw2'' in the example shall get the address 2 (Address=1 + Port=2, or Address=0 + Port=2). 
  
 > **Note:** It remains to the reader which address to choose. Of course addresses used on the own layout allowing to test the result can and should be used. > **Note:** It remains to the reader which address to choose. Of course addresses used on the own layout allowing to test the result can and should be used.
Line 672: Line 722:
  
  \\  \\
-Right clicking on the upper gap in the track circle opens the context menu from which **Signal** is chosen. A dialogue opens asking for the Signal ID. The signal shall receive the ID ''S01''. The gap below is now filled with a signal named ''S02'' and the remaining gap is closed by adding signal ''S03''. The signals should be rotated to fit the driving direction as shown below (Step 16). +Right clicking on the upper gap in the track circle opens the context menu from which **Signal** is chosen. Of course it is also possible to use the **Add Item** dialogue again. The signal automatically receives the ID ''sg1'' (see again chapter 6.2.1 for more information on automatic IDs; what is written there applies here accordingly). The gap below is now filled with a signal named ''sg2'' and the remaining gap is closed by adding signal ''sg3''. The signals should be rotated to fit the driving direction as shown below (Step 16). 
  
 | {{:sbs:sbs-step16-int.png|Step 16: Adding Signals}} | | {{:sbs:sbs-step16-int.png|Step 16: Adding Signals}} |
Line 713: 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 ''sg2'' is highlighted and tab **Details** is selected.
 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 ''S02'' should be configured using patterns.+However, as an exercise, signal ''sg2'' should be configured using patterns.
  
-| {{:sbs:sbs-signal-details02-en.png|}} | {{:sbs:sbs-signal-int02-en.png|}} | + {{:sbs:sbs-signal-details02-en.png|}}  | 
-| Configuration of Signal ''S02'' Using Patterns ||+|  {{:sbs:sbs-signal-int02-en.png|}}  
 +| Configuration of Signal ''sg2'' Using Patterns |
  
  \\  \\
Line 727: Line 778:
 Next tab **Interface** is selected and the __signal address__ 4 is entered (as shown in the figure or, alternatively, in PADA notation). Finally **use patterns** has to be activated. Next tab **Interface** is selected and the __signal address__ 4 is entered (as shown in the figure or, alternatively, in PADA notation). Finally **use patterns** has to be activated.
  
-After pressing **Apply** tab **Index** is selected, signal ''S03'' is highlighted and again tab **Details** selected.+After pressing **Apply** tab **Index** is selected, signal ''sg3'' is highlighted and again tab **Details** selected.
 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. \\
  
-| {{:sbs:sbs-signal-details03-en.png|}} | {{:sbs:sbs-signal-int03-en.png}} | + {{:sbs:sbs-signal-details03-en.png|}}  | 
-| Configuration of Signal ''S03'' ||+|  {{:sbs:sbs-signal-int03-en.png}}  
 +| Configuration of Signal ''sg3'' |
  
  \\  \\
Line 739: 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 ''S03'' could be configured using patterns as well. These alternative settings are shown in the figures below.+Alternatively ''sg3'' could be configured using patterns as well. These alternative settings are shown in the figures below.
  
-| {{:sbs:sbs-signal-details03-pattern-en.png|}} | {{:sbs:sbs-signal-int03-pattern-en.png|}} | + {{:sbs:sbs-signal-details03-pattern-en.png|}}  | 
-| Alternative Configuration of Signal ''S03'' Using Patterns ||+|  {{:sbs:sbs-signal-int03-pattern-en.png|}}  
 +| Alternative Configuration of Signal ''sg3'' Using Patterns |
  
  \\  \\
-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 ''S01'' and ''S02'' are shown as two-aspects signals while ''S03'' is showing three aspects (Step 17). \\+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 ''sg1'' and ''sg2'' are shown as two-aspects signals while ''sg3'' is showing three aspects (Step 17). \\
  
 | {{:sbs:sbs-step17-int.png|}} | | {{:sbs:sbs-step17-int.png|}} |
Line 799: 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: \\ 
 +{{:sensor-block.png|}} \\ 
 +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 'OCCUPIED'.  
 +It can easily be converted to the second variant by connecting the middle section to the 'ENTER' sensor. \\
  
 +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 868: Line 929:
 The preferred method of creating routes is very easy by using the **[[:router-en|Router]]**. It will find any possible route and create it automatically. This chapter describes how the Router is used, the next chapter will briefly describe how routes can be created by hand. The preferred method of creating routes is very easy by using the **[[:router-en|Router]]**. It will find any possible route and create it automatically. This chapter describes how the Router is used, the next chapter will briefly describe how routes can be created by hand.
  
-//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 server popup message window the creation of four routes will be confirmed. \\
  
-| {{:sbs:sbs-analyze-menu-en.png|}} | {{:sbs:sbs-analyzer-routes-en.png|}} | +| {{:sbs:sbs-analyze-menu-en.png|}} | {{:sbs:sbs-analyze-menu-2-en.png?300|}} \\ \\ {{:sbs:sbs-analyzer-routes-en.png?300|}} | 
-| 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 888: Line 948:
  
  \\  \\
-The four routes described above are listed on the //Index//-tab. If, for instance, the first route (''[01-]-[03-]'') is highlighted and subsequently the //Switches//-tab is selected, the automatically added switch ''Sw02'' is found in the list.+The four routes described above are listed on the //Index//-tab. If, for instance, the first route (''[01-]-[03-]'') is highlighted and subsequently the //Commands//-tab is selected, the automatically added switch ''Sw02'' is found in the list.
  
 The Router, in addition, added route IDs to each **[[:tracks-en|track]]**. Route IDs are for showing locked routes using the route representation in automatic mode. The route IDs can be viewed after right clicking on a track symbol and selecting //Properties...// from the menu. The Router, in addition, added route IDs to each **[[:tracks-en|track]]**. Route IDs are for showing locked routes using the route representation in automatic mode. The route IDs can be viewed after right clicking on a track symbol and selecting //Properties...// from the menu.
Line 900: Line 960:
  \\  \\
 === 7.3.2 Creating Routes Manually === === 7.3.2 Creating Routes Manually ===
-This section describes how routes are created by hand. In most cases the Router can be used to create routes but sometimes it is good to know how to do this manually. This section can be skipped if not of interest (continue [[#configuring_routes|7.3.3]] below).+This section describes how routes are created manually. In most cases the Router can be used to create routes but sometimes it is good to know how to do this manually. This section can be skipped if not of interest (continue [[#configuring_routes|7.3.3]] below).
  
 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 (''autogen-[01-]-[03-]'') is highlighted (instead, if a new route was to be created, the **NEW** button had to be clicked). Now tab //General// is selected.+First, //Tables -> Routes// is selected from the menu. The //Index// tab is shown. The first route in the list (''[01-]-[03-]'') is highlighted (instead, if a new route was to be created, the **NEW** button had to be clicked). Now tab //General// is selected.
  
 | {{:sbs:sbs-routes-man-gen-en.png}} | | {{:sbs:sbs-routes-man-gen-en.png}} |
Line 910: 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 ''autogen-'' prefix.+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 ''*Generated by the router''.
  
-> **Note:** Do not use ''autogen-'' as prefix for manually created routes. +> **Note:** It is recommended to provide description (e. g. "manual"for manually created routes.
  
 For a manually created route the ID could be simply ''[01-]-[03-]'' or ''01-_to_03-'' or something else which is found to be self explaining.  For a manually created route the ID could be simply ''[01-]-[03-]'' or ''01-_to_03-'' or something else which is found to be self explaining. 
Line 1000: 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 and Rocrail has to be closed and restarted.+> **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.1588329831.txt.gz · Last modified: 2020/05/01 12:43 by besra