User Tools

Site Tools


functionality-en

Differences

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


functionality-en [2022/01/31 15:21] (current) – created - external edit 127.0.0.1
Line 1: Line 1:
 +====== Functionality Index ======
 +
 +
 +This page is an attempt to create an index for some functions in Rocrail. \\
 +For example: if you have a question about Running in Automatic Mode, this page attempts to link all the Automatic Mode related articles from the Wiki. \\
 +=====Test Plan=====
 +Testing a plan from another user \\
 +
 +Windows instructions: \\
 +1W. Copy the new plan in a folder for example: ''C:\Users\<username>\Documents\Rocrail\Test'' **((As a test, copy the plan.xml file from the wikidemo folder, \\ which is included in the download of the Rocrail installation. \\ This plan has 2 sensors in each block. \\ See also: **[[block-sensor-en|How many sensors in a block?]]**))** \\ 
 +2W. start Rocrail. \\
 +3W. select the test plan: File->Open Workspace find folder created in step 1W. \\ \\
 +Mac instructions: \\
 +1M. create a new folder "myWorkspace3" in the Documents folder of your Mac; \\
 +2M. copy (not move!!!) into that folder; \\
 +3M. start Rocrail; \\
 +3.1M. open the workspace "myWorkspace3" of the Documents folder created in step 1M. \\ \\
 +4. set a loco in a block. If the arrow is to the right then loco will go right, if that is not the direction you want to go then right mouse click in the block of the loco and select "swap logical direction", now the loco will go left. \\
 +5. automode on, right mouse click in the block and choose "start locomotive". \\
 +6. loco starts, the next block turns yellow. click on the first sensor encountered, (this is the ENTER sensor), now the block turns blue (click again on ENTER sensor to reset the sensor). \\
 +7. click on the next sensor (IN sensor for block), block turns red (the previous block is now white (available for another loco)). (click again on IN sensor to reset the sensor). \\
 +8. continue to the next block and repeat steps 6 and 7. \\
 +
 +=====Automatic=====
 +Options in Rocrail that defines automatic operation. \\
 +
 +**[[automatic-en|Running Automatic]]** \\
 +**[[virtual-automatic-en|Running Virtual Automatic]]** \\
 +
 +**[[block-gen-en#half_automatic|Block: Automatic]]** \\
 +**[[direction-en|Block: Direction]]** \\
 +
 +**[[loc-tab-en#manual_automatically_operated|Loc: Automatic]]** \\
 +
 +**[[rocgui-menu-en#automatic|Rocrail: Automatic]]** \\
 +
 +=====Automatic Sequence =====
 +Options in Rocrail that sequences automatic operation. \\
 +
 +1. Set Route (maybe 20 milliseconds) \\
 +**[[rocrailini-automode-en#route_switch_time|Rocrail Properties: Route Switch Time]]** \\
 +
 +2. Set Turnouts (Switches) (maybe 250 ms) \\ 
 +**[[rocrailini-automode-en#switch_time|Rocrail Properties: Turnout Switch Time]]** \\
 +
 +3. Set Signals to Green (maybe 1 sec) \\
 +**[[rocrailini-automode-en#semaphore_time|Rocrail Properties: Semaphore Switch Time]]** \\
 +**[[rocrailini-automode-en#signal_time|Rocrail Properties: Signal Switch Time]]** \\
 +
 +4. Use Station Announcements (Optional) \\
 +//**Use Actions or XML to provide function.**// 
 + \\
 +**[[timed-actions-en|Action]]** \\
 +
 +5. Locomotive Blows Horn/whistle (Optional) \\
 +//**Use Actions or XML to provide function.**// 
 + \\
 +
 +6. Train Departs (default 1 sec) \\
 +**[[loc-details-en#block_wait_time|Loc Details: Loc Start]]** \\
 +**[[block-gen-en#depart_delay|Block General: Depart Delay]]** \\
 +
 +
 +7. Set Signal back to Red (maybe 2 sec) \\
 +**[[rocrailini-automode-en#reset_signal|Rocrail Properties: Signal Reset]]** \\
 +
 +=====Delayed Departure Options=====
 +Some ways to delay the departure of a train, after the route has been set.\\
 +**[[rocrailini-automode-en#semaphore_time|Rocrail ini: Semaphore time delay]]** \\
 +**[[rocrailini-automode-en#signal_time|Rocrail ini: Light Signal time delay]]** \\
 +**[[block-gen-en#depart_delay|Block General: Block depart delay]]** \\
 +
 +=====How to use BBT=====
 +Options in Rocrail that allows the precise stopping of a train. \\
 +
 +**[[loc-bbt-en|BBT: Overview]]** \\
 +**[[loc-details-en|BBT: Select]]** \\
 +
 +The Proper approach: \\
 +-- Set number of steps to 16. \\
 +-- Teach BBT for block X until the stop is exactly at the IN sensor, shortly before the IN the speed should go to 0 (V0), if so then BBT is taught. (What you want is a gradually deceleration from the Enter (sensor) to the IN (sensor)). \\
 +-- Now in the BBT screen (bottom left) check 'fixed'  and check 'center train' (if you want to center the train), likewise in the Lok parameter check 'centered hold'. \\
 +
 +**[[block-gen-en#bbt|BBT in Block: Select]]** \\
 +**[[block-gen-en#center_train|BBT in Block: Center train]]** \\
 +
 +The trains stay centered without having to manually manipulate the data.
 +If you now want to move this centered stop-point, use offset at the respective block. \\
 +**[[block-gen-en#offset|BBT in Block: Change the offset]]** \\
 +
 +Train operations: \\
 +**[[operator-consist-en#center_train|Train Operations: Change the Center]]** 
 +With or without the locomotive length included. \\
 +
 +
 +=====Length=====
 +Options in Rocrail where length impacts operations. \\
 +**Note:** Train Length overrides Loco length.\\
 +
 +**[[loc-gen-en#length|Loc: General]]** \\
 +
 +**[[block-gen-en#length|Block: General]]** \\
 +
 +**[[car-details-en#length|Railcar: General]]** \\
 +
 +**[[rocrailini-automode-en#min_block_-_train_length|Rocrail Properties: Automatic ]]** \\
 +
 +**[[route-perm-en#max._train_length|Route: Permissions ]]** \\
 +
 +**[[trains-en#train_length_and_block_length_dependencies|Trains: ]]** \\
 +
 +====Staging Block length====
 +
 +**[[stageblock:stage-gen-en#section_length|Staging Block: General]]** \\
 +
 +**[[stageblock:stage-sections-en#length|Staging Block: Section]]** \\
 +
 +=====Locs do not start=====
 +Some of the criteria why a loc does not start. \\
 + 
 +1. loc not in a block \\
 +2. loc is in a block but placed facing the wrong side \\
 +3. routes from this block are closed \\
 +4. route does not exist \\
 +5. loc is electrified (but destination block is not) \\
 +6. loc in manual mode \\
 +7. loc has automatic mode deactivated. \\
 +8. permission / train type does not fit to route or block \\
 +9. train length or commuter does not fit \\
 +
 +=====Locs start in automatic mode=====
 +1. Set loc in Block \\
 +2. Watch the little arrow, it should point in the direction you want to go \\
 +a. if not, right mouse click, in the block of the loc, and select swap block entry side \\
 +3. Turn on auto mode \\
 +4. Right mouse click, in the block of the loc, select start loc (or double click on loc), other methods are available \\
 +5. Make sure that the Loc direction in the loco throttle dialog shows to the right (">>") **[[loc-throttle-en#direction_image|Loc direction]]** \\
 +
 +The next time you start Rocrail the loco should be still correct in a block, unless you perform manual activities \\
 +
 +**[[direction-en#avoiding_problems_with_unwanted_direction_of_travel|Direction of Travel]]** \\
 +
 +> **Tip1:** If the block this loco occupies has a light blue border and its intended route is shown in light blue, then the loc is in shunting mode. **[[loc-tab-en#shunting_on_off|Shunting on or off]]** \\
 +> **Tip2: ** If the Loc ID in the block is shown in bold and blue, then the loc is in manual resp. halfautomatic mode. **[[loc-tab-en#manual_automatically_operated|Manual or Automatic Mode]]** \\
 +
 +=====No destination found=====
 +Error message in Rocrail that impacts running in Automatic mode. \\
 +To see these Trace details, the **[[rocrailini-trace-en|User-Trace-Level "Automatic" and "Information"]]** needs to be checked. (File -> Rocrail Properties -> Trace)\\
 +
 +
 +The *.trc file states: **"Trains do not fit"**. \\
 +The *.trc file states: **"Block [xy] is not electrified; E-Loco [z] can not use it."**\\
 +Locomotive is defined as **Electric**: **[[loc-details-en#engine|Loc: Details]]**, but the block does not have **Catenary**: **[[block-gen-en#electrified|Block: General]]** \\
 +The *.trc file states: **has no permission to use route [ZZZ]; only with schedule is allowed** or **only with random is allowed.**\\
 +**[[route-perm-en#auto_mode|Route: Permissions]]**. \\
 +
 +
 +The *.trc file states: **"Block "XXX" is too short for "Loco YYY"; LocoLen=160 + MinOverLen=5 > BlockLen=160".** \\
 +Length of a **Block**: **[[block-gen-en#length|Block: General]]** is shorter than the length of the **Train**: **[[loc-gen-en#length|Loc: General]]**, which is **Added** to the minimum **Train Length**: **[[rocrailini-automode-en#min_block_-_train_length|Rocrailini: Automode]]**. \\
 +Train length of [YYY] not set for stage [XXX_ZZ]. Check the length of the loco, it should have a length > 0, before it is allowed in a Staging Block.\\
 +
 +See also: **[[trains-en#train_length_and_block_length_dependencies|Trains: ]]** \\
 +
 +The *.trc file states: **"Loc [YYY] has no permission to enter **//block//** [XXX]"** \\
 +The *.trc file states: **"block [XXX] for (Loc) [YYY] does not fit"** Check "Include" Permission table to see if loc YYY is not in the column. \\
 +Check if there is a blank loc in the "include" Permission table, by including a loc, to delete select blank and delete the entry. \\
 +Check the Loc permissions: **[[block-permissions-en|Block: Permissions]]**. \\
 +
 +The *.trc file states: **"Loc [YYY] has no permission to use **//route//** [ZZZ]"** \\
 +Check "Include" Permission table to see if loc YYY is not in the column. \\
 +Check if there is a blank loc in the "include" Permission table, by including a loc, to delete select blank and delete the entry. \\
 +Check the Loc permissions: **[[route-perm-en|Route: Permissions]]**. \\
 +
 +Check if a **Route**: **[[route-gen-en#from_block|Route: General]]** exist for both blocks ("TO" and "FROM"). \\
 +Check the direction of the **Arrow** in the **Block**: **[[direction-en#arrow|Direction]]**, it needs to point towards the "TO" block. If the direction arrow in the block does not point to the direction desired, right-click the loco ID on the loco panel and select **Swap block enter side**: **[[blockenterside-en|Block Enterside]]** \\
 +
 +After editing Loco names it is important to verify that the "Include" and "Exclude" Permissions in the Routes, are also updated to reflect the new names. If not "No destination found" messages can occur.\\
 +
 +=====Schedules and Tours=====
 +How to implement Schedules and Tours. \\
 +
 +**[[loc-details-en#use_schedules_departure_time|Loc: Details - Time]]** \\
 +**[[loc-details-en#startup_schedule|Loc: Details - Schedule]]** \\
 +**[[loc-details-en#startup_tour|Loc: Details - Tour ]]** \\
 +
 +**[[rocgui-gen-en#show_only_start_schedules|Rocgui: Schedule]]** \\
 +
 +**[[schedules-index-en|Schedule]]** \\
 +
 +**[[stepbystep-en#scheduled_service|Stepbystep: Schedule]]** Read until paragraph 9.0\\
 +
 +**[[tours-en|Tour]]** \\
 +
 +**[[:userpages:jpxrail:kombi-fahrplaene-de|Good example in German]]** \\
 +
 +=====Speed in Auto Mode=====
 +Options in Rocrail that impacts speed of a train. \\
 +
 +**[[block-details-en#speed|Block: Details]]** \\
 +
 +**[[loc-int-en#speed|Loc: Interface]]** \\
 +**[[loc-bbt-en|Loc: Block Brake Timer - BBT]]** \\
 +**[[loc-sbt-en|Loc: Soft Brake Timer - SBT ]]** \\
 +
 +**[[route-gen-en#example|Route: General]]** \\
 +**[[route-speed-en|Route: Speed]]** \\
 +**[[route-turnouts-en|Route: Command]]** \\
 +
 +**[[operator-consist-en#max._km_h|Operator: Speed of a Train]]** \\
 +**[[operator-consist-en#max._km_h|Railroad Car: Railcar speed]]** \\
 +
 +**[[rocrailini-automode-en|Rocrail: Properties]]** Find "speed"\\
 +
 +**[[auto-speed-en|Speed in automatic mode]]** \\
 +
 +**[[:userpages:peter-basti:fahren-thema|Drive Prototypically]]**: Interplay of possibilities, example from practice (in German). \\
 +
 +=====Options to influence the turnout switch time=====
 +**[[rocrailini-automode-en#switch_time|Rocrail Properties: Switch time]]** \\
 +**[[rocrailini-automode-en#route_switch_time|Rocrail Properties: Route Switch time]]** \\
 +
 +===Additional options to slow the train departure===
 +**[[rocrailini-automode-en#semaphore_time|Rocrail Properties: Semaphore delay]]** \\
 +**[[rocrailini-automode-en#signal_time|Rocrail Properties: Light signal delay]]** \\
 +
 +
 +
 +
 +
 +=====Waiting=====
 +Options in Rocrail that impacts the waiting of a train. \\
 +
 +**[[block_traintype-en#overview|Block: Overview]]** Find "wait" \\
 +**[[block-gen-en#wait|Block: General]]** \\
 +**[[block-details-en#wait|Block: Details]]** \\
 +
 +**[[loc-details-en#block_wait_time|Loc: Details]]** Find "wait"\\
 +
 +=====Wheel counting=====
 +**[[wheelcounting:wheelcounting-en|How "Wheel counting" works]]**  \\
 + 
 +
 +=====Influence layout functionality with Actions or XML=====
 +Options in Rocrail that define or impact Actions. \\
 +
 +**[[actions-en|Action: Action Setup **What**]]** \\
 +**[[actionctrl-en|Action: Action Control **How**]]** \\
 +**[[actioncond-en|Action: Action Condition **Which**]]** \\
 +
 +
 +**[[action-example-en|Action: Action Example]]** \\
 +
 +**[[schedules-actions-en#actions|Schedule: Schedule Actions]]** \\
 +
 +XML examples and definitions \\
 +
 +**[[xmlscripting-en|XML: Scripts]]** \\
 +**[[xmlscripting:xmldb-en|XML: Variable definitions]]** \\
 +**[[xmlscripting-en|XML: Examples]]** \\
 +**[[xmledit-en|XML: edits and uses]]** \\
 +**[[xmlscripting:course-en|XML: School]]** \\
 +
 +Variables \\  
 +
 +**[[variable-en|User Variables]]** \\
 +
 +**[[text-en|Variables you can use in Actions or XML]]** \\
 +
 +**[[:userpages:entaxi57:scriptesammlung-de|Good example in German]]** \\
 +**[[action-example-de|Other examples in German]]** \\
 +
 +=====Modular Layout=====
 +
 +**[[:conversion-modular-concept-en|Convert a regular layout to a modular layout]]** \\
 +
 +**[[:modules:modules-en|Modular Setup]]** \\