JMRI Help System: JMRI Local
Author: Dave Sand
Keywords: JMRI Help Index

## JmriHelp

?

### Table of Contents

- JMRI Help Main Page
- Acknowledgements
- Frequently Asked Questions (FAQ)
- Glossary
- Manuals
- Setup
  - JMRI Preferences Pane
  - Configuration Profiles
  - The System Console
  - Names & Naming Rules
  - USB input
  - Error Codes
  - InstallTest (Windows)
- Hardware Support
  - Anyma
  - Arduino
  - Atlas Commander
  - Bachrus Speedo
  - BiDiB
  - CAN Bus Overview
  - CBUS
  - C/MRI
  - CTI Acela
  - CVP EasyDCC
  - DCC-EX
  - DCC4PC Railcom Reader
  - DCC Specialties
  - Digi XBee
  - Digikeijs Digirail
  - Digitrax
  - Digitrax PR3
  - ESU ECoS
  - Fleischmann Twin Center
  - Hornby Elite
  - Insteon
  - Lenz
  - Lionel TMCC
  - LocoNet
  - Maple Systems
  - Marklin
  - MERG
  - Modbus
  - MQTT
  - MRC
  - NAC Services RPS
  - NCE
  - OakTree Systems (Railroad Control Systems)
  - OpenDCC
  - OpenLCB
  - Powerline
  - ProTrak Grapevine
  - QSI Quantum Programmer
  - Pi Engineering RailDriver Throttle
  - Railroad Control Systems (Oak Tree Systems)
  - Raspberry Pi
  - RFID Readers
  - Roco z21
  - TracTronix SECSI
  - SPROG
  - SPROG Generation 5
  - SRCP
  - TAMs Master Control
  - TCS CS-105
  - X10
  - xAP
  - XPressNet
  - Zimo MX-1
  - ZTC Controls
- Applications
  - DecoderPro
    - Quick Tour
    - Supported Decoder Manufacturers and Models
    - Installing New Decoder Definitions
    - Roster Groups
    - Multi-Decoder Control
    - Error Messages
    - DecoderPro Manual
      - Getting Started
        - Setting Preferences
      - Using DecoderPro
        - Set Up
        - Choose Decoder
        - Programming Modes
      - Basic Programmer
        - Using the Roster
        - The Basic Programmer
        - What Next?
      - Comprehensive Programmer
        - Setup and Roster Panes
        - Basic Pane
        - Motor Control Pane
        - Speed Control Pane
        - Function Mapping Pane
        - Lighting Functions and FX Pane
        - Consisting Functions Pane
        - Advanced Features Pane
        - Sound FX Pane
        - Sound Levels Pane
        - Global CV Listing Pane
        - Manufacturer Specific Data Pane
        - Printing Decoder Data
      - All Manuals
  - DispatcherPro
    - Introduction
      - Glossary
      - Using Transits and Sections
      - Dispatcher Window
      - Active Train Table
      - Allocation Request Table
    - Options Menu
    - Allocated Section Window
    - Allocate Extra
    - New Train
  - OperationsPro
    - OperationsPro Information
    - Settings
    - Locations
      - Yard Tracks
      - Spur Tracks
      - Interchange Tracks
      - Staging Tracks
      - Schedules
    - Cars
    - Locomotives
    - Routes
    - Trains
    - Switch List
  - PanelPro
    - Panel Editor
    - Control Panel Editor
    - Layout Editor
    - Switchboard Editor
    - Panel Controls
    - Displaying Panel Files
  - SoundPro
    - Intro
  - LccPro
    - Intro
  - Additional Applications with connections to JMRI
    - Manifest Creator
  - Jython Apps for JMRI
    - YAAT - YetAnotherAutoTrain
    - Dispatcher System (Python Extension)
- Panels
  - Panel Editor
  - Control Panel Editor
  - Layout Editor
  - Displaying Panel Files
  - Handling Errors
  - Switchboards
- Tables
  - Turnout Table
  - Light Table
  - Sensor Table
  - StringIO Table
  - Signal Head Table
  - Signal Mast Table
  - Block Table
  - OBlock Tables (tabbed)
  - O(ccupancy)Block Table
  - Route Table
  - LRoute Table
  - Logix Table
  - Memory Variable Table
  - Reporter Table
  - RailCom Table
- Tools
  - Audio
  - Blocks
    - Block Table
    - Add/Edit Blocks
  - Consisting Tool
  - CTC
    - CTCEditor
      - Menus
        - File menu
          - New
          - Import
        - Edit menu
          - Fix Error(s)...
        - Configure menu
          - Debugging
          - Defaults
          - Fleeting
          - Patterns
          - GUI Design
      - O.S. Sections List
      - Edit Buttons
        - Code button
        - Signal direction indicators
        - Signal direction lever
        - Switch direction indicators
        - Switch direction lever
        - Call On
        - Traffic locking
        - Turnout locking
        - Indication locking
    - Files
    - CTCMain
    - Definitions
  - Fast Clocks
    - Introduction
    - Setting the Internal Clock
    - The LocoNet Clock
  - Lights
    - Light Table
    - Add/Edit Light
    - Light Controls
    - Simple Light Control
  - Locomotive Speed Matching
  - Logix
    - Logix Table
    - Add/Edit Logix
    - Add/Edit Conditionals using the List Editor
    - Add/Edit Conditionals using the Tree Editor
    - Conditional State Variable and Action List
  - LogixNG
    - LogixNG Reference
    - LogixNG Table
    - LogixNG Table Editor
    - ConditionalNG Editor
    - LogixNG Module Table
    - LogixNG Module Table Editor
    - LogixNG Tables Table
    - LogixNG Tables Table Editor
    - LogixNG Initialization Table
    - LogixNG Logix Import
  - LRoutes
    - LRoute Table
    - Add/Edit LRoutes
  - Memory Variables
    - Memory Variable Table
    - Add/Edit Memory Variables
    - Memory Monitor
  - Programmers
    - Single CV Programmer
    - DecoderPro programmer
  - Reporters
    - Reporter Table
    - Add/Edit Reporters
  - Routes
    - Route Table
    - Add/Edit Routes
  - Scripting
    - Getting Started
    - Python/Jython
    - Example: Setting Turnouts
    - Examples (Links)
    - Scripting How To...
    - Scripting What...Where
    - Jynstruments
    - Jython Apps for JMRI
    - Python 3 Introduction
    - Open Scripting Arch (Apple)
  - Sections
    - Section Table
    - Add/Edit Sections
  - Send DCC Packet Tool
  - Sensors
    - Sensor Table
    - Add/Edit Sensors
    - Sensor Groups
  - StringIOs
    - StringIO Table
    - Add/Edit StringIOs
  - Signaling
    - Signaling Quick Start
    - Signal Heads
      - Signal Head Table
      - Add/Edit Signal Heads
      - European Examples
    - Signal Aspects
    - Signal Masts
      - Signal Mast Table
      - Add/Edit Signal Masts
      - Virtual Signal Mast
      - Signal Head Controlled Signal Mast
      - Turnout Controlled Signal Mast
      - Output Matrix Signal Mast
      - DCC Signal Mast
    - Signal Mast Logic
    - Simple Signal Logic
  - Cab Signaling
  - Speedometer
  - Throttles
    - Android Phone as Throttle
    - iPhone/iPod Touch as Throttle
    - Z21 Throttle (Z21 App and WlanMaus)
    - webThrottle - Web Throttles and Panels
    - inControl - Web Throttles and Panels (older version)
  - Timetable
  - Where Used
  - Tracker (Blocks)
  - Transits
    - Transit Table
    - Add/Edit Transits
    - Transit Actions
  - Turnouts
    - Turnout Table
    - Add/Edit Turnouts
    - Simple Turnout Control
  - Virtual Sound Decoder
  - Warrants
    - Warrants Overview and Getting Started
    - Creating and Editing Warrants
    - NXWarrants
    - SCWarrants
    - The Warrant List
    - When Warrant Speeds Are Modified
    - Train Trackers
    - The Occupancy Block Tables
    - Creating and Editing OBlocks, Portals and OPaths
    - Circuit Builder
  - USS CTC Tools
    - OS Indicator
    - Follower
- System-Specific Tools
  - Acela
    - Configure Nodes
    - Monitor
    - Send Packet
  - Bachrus
    - Speedo Console
  - BiDiB
    - Signal Masts
  - C/MRI
    - Check Pin Assignments
    - Configure Nodes
    - Diagnostics
    - Signals
  - Ecos
    - Ecos Preferences
    - Loco Table
    - Status
    - Send Packet
  - Digitrax
    - BDL16, BDL162, BDL168 Configuration Tool
    - Digitrax Command Station Configuration Tool
    - DS64 Configuration Tool
    - Duplex Network Configuration Tool
    - Firmware Downloader Tool
    - Manage LNCV Modules
    - Manage LocoIO Modules
    - LocoNet Addresses
    - LocoNet Clock Monitor Tool
    - LocoNet ID
    - LocoNet Interface Statistics Tool
    - LocoNet Monitor
    - LocoNet Simulator Tool
    - PM4, PM42 Configuration Tool
    - PR3 Mode Selection Tool
    - Sound
      - Sound Loader
      - Sound Editor
    - SE8C Configuration Tool
    - Slot Monitor
    - Throttle Messages
    - DCS52 Mode Select
    - DCS240 Mode Select
  - Grapevine
    - Configure Node
    - Node Table
    - Renumber Node
  - IEEE802154
    - Add Node
    - Edit Node
    - Configure Node
  - Maple
    - List
    - Configure Node
    - Monitor Maple Traffic
  - Märklin
    - Send Packet
  - MERG
    - CBUS Tools
      - Command Station Monitor
      - Console Tool
      - Event Capture Tool
      - Event Table Tool
      - Firmware Update
      - Node Config Tool
      - Send Frame / Event Tool
      - Simulator
      - Voltage / Current Meter
  - MRC
    - MRC Traffic Monitor
    - Send Packet
  - NCE
    - Send Command
    - Edit Macro
    - Edit Consist
    - DCC Packet Analyzer
    - Monitor Clock
    - USB Interface tool
  - Oaktree
    - Configure Nodes
  - OpenLCB
    - Configure Nodes
    - Event Table
    - Memory Tool
    - Names
    - Signal Masts
    - Send Frame
  - Powerline
    - Send Packet
    - Traffic Monitor
    - Configure Nodes
  - RPS Positioning System
    - Receiver Control
    - Polling Control
    - Debugger Window
    - RPS Sensors
    - Tracking Display
    - Sound Speed Control
  - SRCP
  - SECSI
    - Configure Node
    - Traffic Monitor
    - Send Packet
  - SPROG
    - Console
    - Send Packet
    - Slot Monitor
    - SPROG Version
    - Update SPROG II
  - SPROG Generation 5
    - SPROG Generation 5 Tools
      - Pi-SPROG 3 Mode Switcher
      - Pi-SPROG/SPROG 3 Plus Mode Switcher
    - CBUS Tools
      - Console Tool
      - Send Frame / Event Tool
      - Event Capture Tool
      - Event Table Tool
      - Node Config Tool
      - Command Station Monitor
      - Simulator
      - Firmware Update
      - Voltage / Current Meter
  - TAMs
    - Loco Database
    - Send Packet
  - TMCC
  - Zimo
    - Mx1 Monitor
    - Send Mx1 Packet
  - XBee
    - Configure XBee Node
  - XPressNet (Lenz)
    - System Information
    - LI101 Configuration
    - LZV100 Configuration
- Technical
  - Getting the Source Code
    - Via Git
    - Git FAQs
    - Git for Developers
  - Building Your Own Copy of JMRI
    - Building with Ant
    - Building with NetBeans
    - Building with Eclipse
    - Building with IDEA IntelliJ
  - How We Do Stuff
    - Recommended Practices for Programmers
    - JMRI Library Structure
    - JMRI Program Structure
    - Names and Naming
    - Code Structure Patterns
    - Swing Structure
    - External Connection Structure
    - Threads and Threading
    - JavaHelp HowTo
    - Documentation with Javadoc and UML
    - Unit testing with JUnit
    - The JMRI Website
    - Help and Web Site
      - Providing Help using JavaHelp
      - The JMRI Web Site
      - Updating JMRI Web and Help
      - Creating Help for New Hardware
      - Program Documentation Using Javadoc
  - XML Information
    - Technical Info
    - XML Editors
    - Displaying Panel Files
- Web Access to JMRI

### Index

- Frequently Asked Questions (FAQ)
- Acela (CTI) - Hardware, Connection, Tools
- Acknowledgements
- Additional Applications with connections to JMRI
- Anyma DMX
- AnyRail
- AppleScript
- Arduinos
  - Connection Details
  - Example Uses
- Aspect (Signaling-)
- Audio
- Audio Table
- Automation in JMRI
- Bachrus - Hardware, Connection, Tools
- BiDiB - Hardware, Connection, Tools
  - Signal Masts
- Blocks
  - Add Blocks
  - Block Table
  - Block Tracking
  - Edit Blocks
- Block Table
- CATS (Crandic Automated Traffic System)
- C/MRI - Hardware, Connection, Tools
  - C/MRI Signals
  - Check Pin Assignments
  - Configure Nodes
  - Diagnostics
  - Byte Communications using Arduinos
- Cab Signals
- CAN Bus - Hardware, Connection, Tools
- CBUS
  - Connection Details
  - Console Tool
  - Event Capture Tool
  - Event Table Tool
  - Firmware update
  - Naming Events
  - Node Config Tool
  - Send Frame / Event Tool
  - Simulator
  - Voltage / Current Meter
- Circuit Builder (CPE)
- Configuration Profiles (Setup)
- Consisting Tool
- Continuous Integration (CI) (Developers)
- Control Panel Editor (CPE)
- CTC (Tool)
  - CTC Main
  - CTCEditor
    - CTC Editor
    - Edit Buttons
      - Call On
      - Code button
      - Indication locking
      - Signal direction indicators
      - Signal direction lever
      - Switch direction indicators
      - Switch direction lever
      - Traffic locking
      - Turnout locking
    - Menus
      - Configure menu
        - Debugging
        - Defaults
        - Fleeting
        - GUI Design
        - Patterns
      - Edit menu
        - Fix Error(s)...
      - File menu
        - Import
        - New
    - O.S. Sections List
  - Definitions
  - Files
- DCC Specialties - Hardware, Connection, Tools
- DCC-EX Hardware, Connection, Tools
- Debug Menu
- DecoderPro
  - Introduction
  - The Roster Pane
  - Programming Decoders
  - Installing New Decoder Definitions
  - Error Messages
  - Manual
- Digikeijs (Digirails) - Hardware, Connection, Tools
- DigiTrainsPro (Throttle for Android)
- Digitrax - Hardware, Connection, Tools
  - BDL16
  - BDL162
  - BDL168
  - Digitrax Duplex Radio System
  - DS54
  - DS64
  - LocoNet ID
  - LocoNet Interface Statistics
  - LocoNet Monitor
  - LocoNet Tools
  - PM4
  - PR2
  - PR3
  - PR3 Mode Selection Tool
  - SE8C
  - Slot Monitor
  - Sound
    - Downloader
    - SDF Sound Program Editor
    - SPJ Project File Editor
  - Standalone LocoNet
  - Throttle Messages
  - UR90
  - UR90X
  - UR91
  - UR92
- Dispatcher (Tool)
- DispatcherPro
  - Active Trains
  - Dispatcher Options
  - Glossary
  - New Train
  - Requirements
- Dispatcher System (Python Extension)
- Dropbox (Profile Sharing)
- EasyDCC - Hardware, Connection, Tools
- Eclipse IDE (Developers)
- ECoS - Hardware, Connection, Tools
- Entry-Exit Routing - Tool
- Error Codes
- Fast Clock
  - LocoNet Fast Clock
  - Setting The Internal Clock
- File Locations (JMRI-, User-)
- FindBugs (Developers)
- Fleischmann - Hardware, Connection, Tools
- Git (Developers)
  - Getting the Source Code Via Git
  - Git FAQs
  - Git for Developers
- Glossary of JMRI Terms
- Grapevine - Hardware, Connection, Tools
- Hardware, Connecting to
- Hornby Elite
- Help Menu
- ID Tag
- IEEE 801.2.5.4 - Hardware, Connection, Tools
  - Add Node
  - Configure Node
  - Edit Node
- Install JMRI, How To
- InstallTest (Setup on Windows)
- Insteon
- IntelliJ IDE (Developers)
- Internationalization/I18N (Developers)
- iPhone/iPod, Connecting to (Hardware)
- Issue Reporter
- Javadoc (Developers)
- JavaHelp (Developers)
- JUnit, Testing Code with (Developers)
- Jynstruments
- Jython (in Scripting)
- Jython Apps for JMRI
- Layout Editor (Panels)
- LccPro
- LDT Signals
- Lenz XpressNet - Hardware, Connection, Tools
- Lights
  - What are Lights?
  - Add/Edit a Light
  - Light Table
  - Variable Intensity Lights
- Light Table
- Lionel TMCC - Hardware, Connection, Tools
- LNCV Programmer
- LocoNet
  - BDL16/BDL162/BDL168
  - Command Station Configuration Tool
  - DS54
  - DS64
  - Duplex Group
  - Fast Clock
  - Firmware Downloader
  - Manage LNCV Modules
  - Manage LNSV1 Modules
  - LocoBuffer
  - LocoBuffer-II
  - LocoBuffer-USB
  - LocoBuffer-NG
  - LocoIO
  - LocoNet Addressing
  - LocoNet Monitor
  - LocoNet Status
  - Packet sender
  - PM4
  - PR2
  - PR3
  - SE8C
  - Slot Monitor
  - Standalone LocoNet
- Logix
  - Add Logix
  - Add/Edit Conditionals using the List Editor
  - Add/Edit Conditionals using the Tree Editor
  - Conditional State Variable and Action List
  - Edit Logix
  - Logix Table
- LogixNG
  - LogixNG Reference
  - LogixNG Table
  - LogixNG Table Editor
  - ConditionalNG Editor
  - LogixNG Module Table
  - LogixNG Module Table Editor
  - LogixNG Tables Table
  - LogixNG Tables Table Editor
  - LogixNG Initialization Table
  - LogixNG Logix Import
- LRoute
  - Add/Edit LRoute
  - LRoute Table
- macOS Serial Ports (Hardware)
- Manifest Creator
- Manuals
- Maple Systems - Hardware, Connection, Tools
- Marklin - Hardware, Connection, Tools
- Memory (-Variable)
  - Add Memory Variable
  - Memory Monitor
  - Memory Variable Table
- MERG - Hardware, Connection, Tools
- Modbus - Hardware, Connection, Tools
- MQTT - Hardware, Connection, Tools
- MRC - Hardware, Connection, Tools
- Multi-Decoder Control
- Multi-sensor Icon
- Naming JMRI Objects
- NCE - Hardware, Connection, Tools
  - NCE Speedometer
- NetBeans IDE (Developers)
- NX Warrants
- OakTree Systems - Hardware, Connection, Tools
- OBlock (Occupancy Block, Warrants)
- OBlock (using tabbed interface)
- OPath (Occupancy Path, Warrants)
- Occupancy Sensor
- OpenLCB - Hardware, Connection, Tools
  - Configure Nodes
  - Event Table
  - Memory Tool
  - Names
  - Signal Masts
  - Send Frame
- OperationsPro
  - Comprehensive Info
  - Building Trains
  - Cars
  - Locations
    - Interchange Tracks
    - Spur Tracks
    - Staging Tracks
    - Yard Tracks
  - Locomotives
  - Routes
  - Schedules
  - Settings
  - Switch List
  - Trains
- Panel Editor
- PanelPro
  - Intro
  - Panel Editor
  - Control Panel Editor
  - Switchboard Editor
  - Layout Editor
  - Panel Controls
  - Handling Errors
  - Display Panel Files
- Panels Menu
- Path (in OBlock)
- Pi (Raspberry) - Hardware, Connection, Tools
- Portals (Warrants)
- Power Control Panel
- Powerline - Hardware, Connection, Tools
- Preferences, JMRI
- Prefix, Hardware Connection-
- Profile, User-
- Programmer
  - DecoderPro Basic Programmer
  - DecoderPro Comprehensive Programmer
  - Single CV Programmer
- Programmer Messages
- Properties Files (Developers, I18N)
- Python (in Scripting)
- QSI - Hardware, Connection, Tools
- RailCom
- RailDriver Throttle
- Raspberry Pi - Hardware, Connection, Tools
- Reporter
  - Add Reporter
  - Reporter Table
- RFID
- Roco - Hardware, Connection, Tools
- Roster (Decoder List)
  - Roster Group Table
  - Roster Groups
- Route
  - Add/Edit a Route
  - Route Table
- Route Table
- RPS Position System
  - Panel Icons
  - Polling Control
  - Receiver Control
  - RPS Debug Display
  - RPS Sensors
  - Sound Speed Control
  - Storing Your Work
  - Tracking Display
- SC Warrant (Signal Controlled)
- Scripting
  - Getting Started
  - Example: Setting Turnouts
  - Examples (Links)
  - Python 3 Introduction
  - Scripting How To...
  - Scripting What...Where
- SECSI (TrakTronix)
- Section
  - Add/Edit a Section
  - Section Table
- Send DCC Packet
- Sensor
  - Add/Edit a Sensor
  - Sensor Groups
  - Sensor Table
- Sensor Table
- Setting up JMRI
- Signal Aspects
- Signal Head
  - Add/Edit a Signal Head
  - European Examples
  - Signal Head Table
- Signal Head Table
- Signal Mast
  - Add/Edit a Signal Mast
  - Signal Mast Table
- Signal Mast Logic
  - Signal Mast Logic
  - Signal Mast Logic Edit
- Signal Mast Repeater
- Signal Mast Table
- Signaling
- Signals
- Simple Clock
- Simple Light Control
- Simple Signal Logic
- Simple Turnout Control
- SoundPro
- Speed Matching, Locomotive
- Speedometer
- SpotBugs (Developers)
- SPROG
  - Console
  - Send Packet
  - Slot Monitor
  - SPROG Version
  - Update SPROG II
- SPROG Generation 5
  - Hardware Support
  - Pi SPROG 3 Mode Switcher
  - Pi-Sprog/SPROG 3 Plus Mode Switcher
  - See also: CBUS
- StringIO
  - Add/Edit a StringIO
  - StringIO Table
- Supported Decoders
- Supported Digital Control Hardware
- Supported Operating Systems to run JMRI
- Swing (Developers)
- Switchboard Editor (Panels)
- System Console (JMRI System Messages)
- TAMs
- TCH Tech
- TCS
- Technical
- Terminal Server connection
- Thread Monitor (Developers)
- Throttle
  - Add a Throttle
  - Android Phone as Throttle
  - Z21 Throttle (Z21 App and WlanMaus)
  - inControl - Web Throttles and Panels (older version)
  - iPhone/iPod as Throttle
  - USB Joypad as Throttle
  - webThrottle - Web Throttles and Panels
  - Wii Remote as Throttle
- Timetable
- TMCC (Lionel)
- Tools Menu
- Tracker
- Train Throttle App (Windows Throttle)
- Train Trackers (Warrants)
- TrainCrew
- Transit
  - Add/Edit a Transit
  - Transit Actions
  - Transit Table
- Translate (Move) Selection (Panels)
- Turnout
  - Add/Edit a Turnout
  - Turnout Table
- Uhlenbrock Intelllibox - Hardware, Connection, Tools
- Upload Debugging Information
- US&S CTC Tools
  - Follower
  - OS Indicator
- USB Port
- USB-to-Serial Adapter (Hardware)
- Variable Intensity Lights
- Virtual Sound Decoder
- Wangrow - Hardware, Connection, Tools
- Warrants
  - Warrants Overiew and Getting Started
  - Creating and Editing Warrants
  - Warrant List
  - When Warrant Speeds Are Modified
- Web Access to JMRI
- Where Used
- Wii Remote, Connecting to
- WiThrottle for iPhone/iPad
- X10 (Powerline) - Hardware, Connection, Tools
- xAP - Hardware, Connection, Tools
- XBee - Hardware, Connection, Tools
- XML (Developers)
  - Technical Information
  - Viewing Panel Files
  - XML Editors
  - XML Schema
  - XML Usage
- XPressNet (Lenz) - Hardware, Connection, Tools
- XTrackCAD/Reader
- YAAT - YetAnotherAutoTrain.py
- Zimo - Hardware, Connection, Tools
- ZTC - Hardware, Connection, Tools

### Search result