Rocrail Manual

This software is distributed freely under the GNU GENERAL PUBLIC LICENSE.
If you include portions of this software in other programs, then those programs must also be distributed freely in their entirety under the GNU PUBLIC LICENSE V3.

This Wiki is maintained against the main line of development. Some features could be not available or are different implemented in your version of Rocrail, but it is mostly remarked with a version number.

Options and features not documented in the Wiki are for developers only and should not be a trigger to open a Forum thread.

• Introduction
  
• Important changes
• Glossary
  

• Rocrail's Components
• Addressing
• Supported Operating Systems
• Supported Command Stations
• Reporting bugs and feature requests

• Download
• Before You Start
• Quick Guide
• Step-by-Step Tutorials
• Golden rules
• FAQ

• Circular
• Terminal
• Shunting a car with two locomotives

Rocrail runs entirely on volunteer labor. However, Rocrail also needs contributions of money. Your continued support is vital for keeping Rocrail available.

• Purpose
• Support now by Bank account or Paypal.
• Activating the support key: Support dialog

The Client

• Donation dialog
• Menu
• Configuration
  • Language
  • General
  • Trace
  • Programming
  • SVG Symbols
    • Symbol naming
  • Clock
  • Gamepad support
  • MIC
• Software Updates
• Locomotives Tab
• Accelerators (Hot Keys)
• Drag and Drop
• Command Station Status
• Use multiple clients for viewing
• Reports
• Connect to another server
• Workspaces
• Command line options
• Create an issue
• Loco Widgets
• Guest loco
• Command recorder

• Theme basics and properties
• DB Theme | SpDrS60 Theme | NMBS/SNCB Theme | NS Theme | Roads Theme | Accessories Theme
• New symbol types

• Create/modify a track layout
  • The Undo dialog
  • Move, copy, delete or set RouteIDs a selection
  • Track layout elements
  • Tracks
  • Turnouts
  • Text/Image
• Mouse control

• Locomotive Throttle
• Switch Control
• Route Control
• Power Control

• Mobile Decoders
  • Programming Tab
• Stationary Decoders
  • LocoIO (GCA50)
  • Digitrax
  • Lissy Receiver
  • MERG CBUS
  • GCA
    • GCA50
    • GCA136 Servo
    • GCA141 Wheel counter

• Mobile & Stationary Decoders
  • RocPro

Wireless fun for all.

Android

• Introduction & Setup

Java

• Introduction & Setup

Android

• Introduction & Setup

iPhone and iPod Touch

• Introduction & Setup

iPad

• Introduction & Setup

The Server

• Configuration
  • General
  • Trace
    • Advanced tracing
  • Services
    • Clock Service (Fast Clock)
    • SRCP
    • SNMP
  • Auto mode
  • Command Stations
  • R2Rnet
  • Analyser
• Command Line Options
• ServerMonitor
• Console mode
• Running under Windows
  • Running as service
• Running under Linux
  • Running as daemon
• Stopping the Rocrail server
• Multiple Command Stations
  • Extra programming Command Station
• Power Manager
• Guest Locomotive
• Track plan
  • Track plan analyzer
  • Track plan health
  • Manual editing the track plan XML
• Server messages
• Scripting
  • RCP (Rocrail Client Protocol)
  • SRCP (Simple Railroad Communication Protocol)

Objects for defining a layout.

• Accessory Decoders
  • General | CV
• Actions
  • Actions setup | Action Control | Action Condition | Example | Example 2 - Level Crossing
• Blocks
  • General | Signals | Details | Routes | Interface | Block permissions
• Critical Sections & Block Groups
  • General | Properties | Conditions
• Boosters Power manager
• Cars
  • General | Details | Interface | Functions | CVs
• Fiddle Yard
  • General | Interface | Tracks | Routes
• Locomotives
  • Index | General | Interface | Details | Functions | Multiple Units | CV's | BBT
• Locations
• MVTrack
  • Setup
• Outputs
  • General | Interface
• Routes
  • Index | General | Commands | Sensors | Permissions | Conditions | Wiring
• Schedules
  • Index | Destinations | Follow-up | Locations and Schedules | Test Case 1 | Test Case 2 | Examples
• Sensors
  • General | Interface | Wiring | Bi-Directional | Sensor Types
• Signals
  • General | Interface | Details
• Staging Block
• Switches
  • General | Interface | Wiring | Control | Frog
• Text
• Tours
• Tracks
  • General | Position
• Turntable / Traverser
  • General | Position/Size | Interface | Tracks | Setup | Traverser setup
• Waybills
  • General

Connecting Rocrail with the Command Station(s)
Recommended pages to read first:

• Rocrail Server Setup Dialog
• Command Stations and Digital Devices
• Serial device names

• Atlas
  • Atlas Commander
• BiDiB (OpenDCC)
  • BiDiB
• CAN-digital-Bahn
  • CC-Schnitte
• CT-Elektronik
  • ZF-5
• CTI Electronics
  • Acela
• CVP Products
  • EasyDCC
• Digitrax
  • Command Stations | Interfaces | Fast Clock | Throttles | Transponding | Option Switches | Wiring
• Dinamo
  • RM-H, RM-U, UCCI
• Elektor
  • EDiTS PRO | DCC Command Station (by Patrick Smout)
• ESU
  • ECoS
• Fleischmann
  • TwinCenter
• Hornby
  • Elite
• Karsten Hildebrand
  • Infracar
• Littfinsky
  • HSI88
• Lenz
  • LI10x, LI-USB and LI-ETH
• Massoth
  • DiMAX
• Märklin
  • 6050/6051 | CS1 | CS2
• MDRRC - Model Digital RailRoad Control
  • DIY Central for DCC & MM
• MERG
  • mergCBUS | RFID12
• MTTM D&H
  • FCC
• Müt
  • Multi Control 2004
• NCE
  • Powerhouse & Power CAB USB
• OpenDCC
  • OpenDCC Z1 | BiDiB (http://bidib.org/)
• Paco
  • NanoX | DCC_Gen | GenLI | GenHSI
• PerZ
  • PerIR
• Raspberry
  • Pi
• Rautenhaus
  • RMX95x
• Roco
  • Rocomotion | Z21
• SPROG
  • SPROG 2/3
• Stärz
  • ZS1/ZS2
• Trix
  • Selectrix
• Tams
  • Easy Control | RailCom RC-Link
• Uhlenbrock
  • Intellibox-I 'Classic' | IB-Basic, IB-Com, IB-II and USB-LocoNet Interface
    • S88-LN
• Zimo
  • MX1, MX1EC

• Virtual CS For testing.
• LocoNet Slotserver Simulating a LocoNet CS for FRED support.

• DCC232 DCC over USB-RS232.
• DDX Digital Direct Xtra DCC and MM over RS232, S88 over LPT.
  • ORD-1 | ORD-2 | ORD-3 | Delta 6604 to ORD-1/rs232 | 6015/6017 Booster to RS232 | S88 Modules

• SRCP
• RocNet

• General information

• BiDiB GBM16T
• Tams RailCom RC-Link (Stand alone)
• Uhlenbrock MARCo (Loconet)
• Blücher GBM16xn (Loconet, XPressnet)

• RFID-12 Reader (Stand alone)
• RFID CBUS Concentrator

• Uhlenbrock Lissy (Loconet)
• PerIR (Stand alone)

• Digitrax Transponding (Loconet)
• BartJut Barcode Reader (Stand alone)

• Fast Clock Driver

• suitable USB to RS232 converter

Let the computer run the trains.

By creating a layout with Sensors, Blocks, and Routes, and then assigning your Locomotives to the Blocks, Rocrail can move the Locomotives by itself. You can use Schedules and Critical Sections to create and fine-tune complex movements for each Locomotive.

• Automatic and Half automatic
• Block types and train types
• Commands
• Critical Sections
• Direction
• Manual operated signals
• Manual operated routes / CTC
• Reversing Loop
• Routes
  • Block side routes: Prefered way of defining routes; The classic way is no longer supported and will be removed in 2013.
• Sensors and blocks
• Setting up a commuter train
• Signal aspects and second next block
• Slow Motion Switch Machines
• Terminal station
• Turntable
• Wheel Counting
• Accept Identification in blocks by BiDi
• Trains and length

• Operator Control
  • Locomotive control | Train | Operations Game
• R2Rnet; Rocrail servers in a network.

• Tips for blocks and sensors
• Dinamo MCC

• Sensor simulation

• Routes with actions
  • Extended example

• How it all fit together
• Setup
• Module Connection

Loco-I/O compatible hardware by PhG.

• GCA50 Loco-I/O 16 ports unit
• GCA85 RS232 Loco-Buffer with 12V 3A Power supply
• GCA91 Loco-I/O Patch Panel
• GCA101 Ethernet Loco-buffer
• GCA124 Fremo's FredI in GCA-style

CBus/CAN based hardware by PhG.

• CAN-GCA Overview
• CAN-GC1 RS232/USB PC interface with 3 Amp power supply.
• CAN-GC1e Ethernet PC interface with 3 Amp power supply.
• CAN-GCLN LocoNet Bridge.
• CAN-GC2 Universal 16 port I/O. Compatible with all interface modules for the MGV50.
• CAN-GC3 DCC Command Station with PT and ORD-3 connector.
  • ORD-3 3A Booster
• CAN-GC4 RFID Concentrator.
• CAN-GC5 Stationary keyboard and display.
• CAN-GC6 4 Channel Servo Controller.
  • GCA137 Relay board
• CAN-GC7 Fast Clock.
• CAN-GC8 Display driver for dynamic text.

Interfaces for GCA50 and CAN-GC2 by PhG.

• Overview
• GCA76 8 port output driver for turnout coils > 0,5A
• GCA77 8 port output driver for turnout coils <0,5A
• GCA86 slow dimming LED signal decoder
• GCA93 8 port current detector with signals
• GCA98 EDits to DDX interface
• GCA99 2-Rail current detection
• GCA100 polarity switch
• GCA102 Reverse loop switch with turnout control
• GCA115 Stand alone servo driver
• GCA116 Bascule bridge lifter
• GCA118 Display for GCA119
• GCA119 Time/temp central
• GCA120 Heavy load relay
• GCA122 Reversal switch
• GCA125 Interface for 8 motor- or single coil powered turnouts
• GCA126 Interface for Motor powered turnouts with feed-back
• GCA127 Interface for indication with 8 or 16 Leds
• GCA128 Switch / pushbutton unit for GCA50
• GCA129 Multi led indicator interface
• GCA131 Relay interface for motor posered turnouts
• GCA133 Quadruple infra red gate or reflection sensor
• GCA136 4 servo driver (with feed-back) and attachable relay board
• GCA137 Relay board for GCA136
• GCA139 Genli like interface RS232 to Xpressnet
• GCA141c I Sensor board for GCA133
• GCA145 Turntable / Fiddleyard controller
• GCA146 Manual control for GCA145
• GCA168 Böhler WA2 interface with feed-back and frog/center high current switch
• GCA173 Hall-sensor and/or reed-switch input unit
• GCA174 DCC / Motorola Interface for GCA145
• GCA179 isolated hall-sensor and reed-switch input unit
• GCA180 relay unit for standard Tuntable control
• BS-1 Universal Led flasher with many -selectable- flashing programs

• GCA servo support ServoSet

• Hall-sensor and reed-switch solution

• Adapter for connection of PICPROG3 to GCAxxx and CAN-GCx boards

• GCA82 4 servo Motorola decoder/driver
  

Optional hardware for the software command station DDX.

• ORD-3 driver, 3 Amp booster, with regulated and adjustable power, also adaptable to LocoNet Railsync
• S88 GenHSI (Paco)
• GCA98 interface DDX to Edits

• OpenDCC
• MDRRC

General DCC decoders based on OpenDCC.

• ORA-1 accessory decoder
• ORA-2 accessory decoder
• ORM-1 motor switch adapter

• ORXJ-1 Xpressnet Junction
• GCA139 Xpressnet to PC interface (copy of GenLi)

State of the art car illumination.

• BS-1 Universal Led flasher with many -selectable- flashing programs
• Coach Car
• Dutch traction unit "HondeKop"

• CTC with LocoNet

PDA (discontinued)

• Introduction
• Setup
• How to use

Browser (discontinued)

• Introduction
• Setup

• ORF-1 current sensor (No longer maintained.)
• ORD-1 driver, booster (No longer maintained.)
• ORB-1 booster (No longer maintained.)

Take the following actions if you encounter problems using Rocrail:

1. Read the Wiki Documentation. (The English version too.)
2. Search for similar problems and their solutions on the Rocrail Forum.
3. Consult Reporting Bugs and Feature Requests for further steps

Jump only to the next item in the list if the previous did not solve the problem!

• Dos and Don'ts
• USB-RS232 Converters
• FAQ