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/06/03 15:20] – smitt48 | stepbystep-en [2023/09/01 11:23] (current) – rjversluis | ||
---|---|---|---|
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 74: | Line 72: | ||
===== 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): | ||
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, one of the two demo plans can now be opened: | + | To get an impression of what Rocview looks like with a loaded plan, the wiki demo plan is now opened: |
- | * 1. From the menu // file // select the item // Demo workspace //. \\ | + | * In the //File// menu, select //Open Workspace//, then open the '' |
- | * 2. From the menu // File // select // Open Workspace // and then open the folder “wikidemo” in the dialog box 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. | 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. | ||
|< >| | |< >| | ||
- | | {{: | + | | {{: |
- | | The Demo workspace is opened by \\ clicking on // Demo Workspace | + | | The wiki demo workspace is opened by \\ selecting " |
| | ||
Line 247: | Line 261: | ||
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 833: | 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 902: | 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 922: | 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 934: | 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 944: | 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 1034: | 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.1591190431.txt.gz · Last modified: 2020/06/03 15:20 by smitt48