JMRI® v2.14.1 Manual (Archived)
AS REFERENCE FOR OLDER HARDWARE
Updated 7/26/2012
JMRI® is a Java-based cross-platform application for model railroaders. JMRI® contains applications for:
- The programming of Digital Command Control (DCC) decoders, (DecoderPro®).
- Programming decoders and using throttle run trains, DecoderPro 3®
- Drawing computer based panels for depicting a model railroad layout, (PanelPro® ).
- Controlling the layout , (Layout Editor).
- Creating train manifests for duplicating railroad operations, Operations
- Controlling the signals on the layout
- Controlling lighting and sound in the room, and so forth. (SoundPro®)
All this capability is contained in one program (JMRI) which has several “start-up” screens for the various applications.
JMRI® can run on any computer system that will run Java 1.6.0 or later, whether it is Macintosh, Windows, or Linux based. It does require that Java be installed on the computer. You can get Java as a free (but very large...) download at:
If this is your first visit to our manual we suggest that you take the DecoderPro® tour at http://jmri.org/help/en/html/apps/DecoderPro/Tour.shtml
to get an overview of what we're about to cover.
Note: All screen shots in this manual are from a Windows machine using the "Metal" User Interface option . While your screens will probably differ in some layout details, they will be essentially the same. All programming examples shown are with Digitrax PR3(MS100 mode) connected to Digitrax Super Chief Radio Command Station. Most of the decoders in locomotive samples will be Digitrax, except for sound examples.
Note: This entire manual has been updated to correspond to DecoderPro 2.12, and the HTML verified using HTML4 and Cascading Style Sheets. If the formatting looks odd, you probably need to update your browser.
DecoderPro v2.14.1 Help Table of Contents
Installing JMRI
Getting started
- What is DCC?
- What DCC systems will DecoderPro® work with?
- What hardware do I need?
- How do I start the program?
- How do I set up my preferences?
Using DecoderPro®
DecoderPro® Programming Modes
- Single CV Programmer
- Service Mode Programmer
- Ops Mode Programming
- Multi Decoder Control (Programming)
The Basic Programmer
- Entering locomotives in the "Roster"
- The basic programmer
- Reading the data from the decoder
- Entering and editing new data
- Writing the new data to the decoder
- Saving the new data to a file
- What if I need to do more?
The Comprehensive Programmer
- Set-up and Roster Panes
- Expanded Basic Pane
- Motor Control Pane
- Basic Speed Control Pane
- Speed Table Pane
- Function Mapping Pane
- Lights Pane
- Consisting Pane
- Advanced Features Pane
- Analog Controls Pane
- Sound Pane
- Sound Levels Pane
- Global CV Pane
- Manufacturer-Specific Pane
- Printing the Decoder Data
The Advanced Programmer
- Starting Advanced programmer
- Function Labels Pane
- Roster Media
- Expanded Basic Pane
- Motor Control Pane
- Speed Control Pane
- Speed Table Pane
- Function Mapping Pane
- Lights Pane
- Consisting Pane
- Advanced Features Pane
- Analog Controls Pane
- Sound Pane
- Sound Levels Pane
- Global CV Pane
- Manufacturer-Specific Pane
- Printing the Decoder Data
DecoderPro® Main Window
- Main Window
- Menu Overview
- File Menu
- Print Decoder Definitions...
- Print Preview Decoder Definitions...
- Quit
- Edit Menu
- Cut
- Copy
- Paste
- Preferences
- Tools Menu
- Programmers
- Tables
(not yet covered in this manual)
- Throttles
- New Throttle...
- Throttles List Window
- Save Throttle Layout...
- Load Throttle Layout...
- Save as Default Throttle Layout
- Load Default Throttle Layout
- Start Wi Throttle
- Consisting Tool...
- Clocks
- Set up Fast Clock...
- Nixie Clock
- LCD Clock
- Analog Clock
- Power Control...
- Turnout Control...
- Simple Signal Logic (not covered in this manual)
- Sensor Groups... (not covered in this manual)
- Speedometer...
- Light Control...
- Dispatcher... (not covered in this manual)
- Send DCC Packet...(not covered in this manual)
- USS CTC Tools
(not covered in this manual)
- Operations
- Programmers
- Roster Menu
- Create Entry...
- Edit Entry...
- Copy Entry...
- Import Entry...
- Export Entry...
- Delete Entry...
- Print Summary
- Print Preview Summary...
- Roster Groups
- Create Roster Group
- Set Active Roster Group
- Delete Roster Group
- Table Association
- Associate Roster Entry to Group
- Disassociation of Roster Entry to Group
- Export Complete Roster...
- Panels Menu
- New Panel
- Load Panels...
- Store Panels...
- Show History
- Show Panel
- Run Script...
- Thread Monitor
- Script Output
- Script Entry
- New Panel
- Operations
- Settings
- Tools
- Options
- Print Options
- Backup
- Restore
- Load Demo Files
- Reset Database
- Tools
- Locations
- Tools
- Preview
- Schedules
- Modify Locations by Car Type
- Show Cars
- Tools
- Cars
- Locomotives
- Routes
- Trains
- Settings
- System dependent menu
- Debug Menu
- Memory Usage Monitor
- Import Decoder File
- Import Decoder URL
- Recreate Decoder Index
- Recreate Roster Index
- Check XML File
- Validate XML File
- Check Decoder Names
- Check Programmer Names
- Load Logixs Disabled
- Log Message
- Display Message Log
- Display Log Categories
- Listed Table Access
- Listed Table Access-Direct to Routes
- PRICOM
- PRICOM Pocket Tester
- Connect
- PRICOM Flash Updater
- PRICOM Pocket Tester
- USB Input Control
- USB Device Viewer
- RailDriver Throttle
- Start Mini Web Server
- Start Wi Throttle
- Window Menu
- Minimize
(lists all DecoderPro windows that are open)
- DecoderPro
- LocoNet Traffic
- Power Control
- Help Menu
- Window Help...
- General Help...
- License...
- Locations...
- Context....
- System Console...
- Upload Debugging info...
JMRI® Operations Program
- What does Operations do?
- Settings
- Locations
- Cars
- Locomotives
- Routes
- Trains
- A Trip Through Operations
Creating a Decoder Definition
Error Messages
To give feedback on this HTML manual, ask questions about things not covered, or make suggestions for improvements to the manual or the software, join us on the JMRI users group at Groups.io.
Thanks for reading, and Let's Run Trains!
Version | Revision Date | Editors | Major Revisions |
---|---|---|---|
original | 9/4/2002 | Joe Ellis | Bethlehem-Ares Railroad, a 1:160 Corporation |
1.3 | no date | Bob Blackwell | Updated to JMRI version 1.3 |
2.4 | 2/15/2009 | Dale A. Tripp Bruce Shanks | Updated to JMRI 2.4, new sections added added Main Menu information added Decoder Definition How to added Error code page |
2.8 | 1/15/2010 | Dale A. Tripp Bruce Shanks | Updated to JMRI 2.8 Expanded Table of Contents with additional direct links Updated Comprehensive Programmer, moved Function Label pane to Advanced Programmer added Advanced Programmer features, including Roster Media pane Added Roster Group feature Updated decoder definition submission process Added Operations section |
2.12 | 9/15/2011 | Dale A. Tripp Bruce Shanks Walter Thompson |
Updated to JMRI 2.12 |
2.14.1 | 7/26/2012 | Dale A.Tripp Bruce Shanks |
Updated from JMRI 2.12 |