Release Notes for JMRI 5.17.1 release
Date: July 16, 2026
From: Bob Jacobsen
Subject: Test Release 5.17.1 of JMRI/DecoderPro is available for download.
Notes:
This is a test release. Please
post a note
if you encounter any new or old bugs!
And please back up your JMRI files before installing this, in case you want to go
back to an earlier version.
This is the first in a series of 5.17.* test releases.
It requires at least Java 11 to work.
We recommend that you use Java 21 if possible.
(See our page on downloading Java)
We expect this series to result in the next JMRI production release in December 2026.
(See the tentative release schedule)
Some of the changes involved are quite extensive.
They may require a certain amount of experience before they are working well.
Therefore, this test release should be considered experimental.
We would appreciate your feedback on it.
JMRI is now only available under the
GNU General Public License. For more information, please
see our
copyright and licensing page.
Update From Older JMRI Versions
If you are currently using a version older than JMRI 5.0, please follow these instructions carefully:
- Is your current version older than JMRI 4.12?
If so, then update to JMRI 4.12 first, and ensure everything works correctly: check
start-up, check things you need to be working, and check the JMRI log as well) before doing anything else.
Store your configuration and panel files under a new name and use those from now on.
Then continue with step 2.
If you are currently using JMRI 4.7.3 or earlier on Linux or macOS (Windows doesn't need this),
then it's very important
that you update to JMRI 4.12 and
carrying out the migration process described in the JMRI 4.12 release note
before updating to any later release.
- Is your current version older than JMRI 4.20?
Then update to JMRI 4.20 first, and ensure that works correctly (check
start-up, check things you need to be working, and check the JMRI log as well) before doing anything else.
Save your preferences again.
Store your configuration and panel files under a new name, use those from now on, and go on to step 3.
- Is your current version older than JMRI 4.24?
Then update to JMRI 4.24 first, and ensure that works correctly (check
start-up, check things you need to be working, and check the JMRI log as well) before doing anything else.
Save your preferences again.
Store your configuration and panel files under a new name and use those from now on.
- Is your current version older than JMRI 5.0?
Then update to JMRI 5.0 first, and ensure that works correctly (check
start-up, check things you need to be working, and check the JMRI log as well) before doing anything else.
Save your preferences again.
Store your configuration and panel files under a new name and use those from now on.
- You can then install this release.
Following this multi-step order of updating via stable major releases safeguards you against possible migration issues
that can arise from skipping these versions.
New problems with this release
New warnings for this release:
Older warnings
See the
JMRI 5.16 release note
for more warnings predating the 5.17 development series,
including pointers to various migration issues.
These may be relevant to you if you're updating from an earlier version;
we strongly recommend you update to at least
JMRI 5.0
before installing this test release.
See
instructions above.
- Since JMRI 4.99.1
If you're using a Firefox web browser and opening JMRI
help files locally (not over the web), a Firefox bug
can sometimes cause it to enter a loop. There's a
workaround in
this JMRIusers post.
Download links:
These files are located in the
JMRI 5.17.1 GitHub release.
The
full list of included changes is available from our
GitHub code repository.
Hardware Support
DCC-EX
- DCC-EX turnouts and lights now support a CS VPIN mode that
drives a VPIN directly via the <z> command (DCC-EX v4.2.35+), with no
pre-configuration required on the command station. Set the hardware address to
the VPIN number and select "CS VPIN" as the feedback mode (turnouts) or mode
(lights). The Mode column in the Light Table only appears when a DCC-EX
connection is active. Requires EX-CommandStation firmware v4.2.35 or later.
DecoderPro
- Add the ability to export a backup of a single Roster Group.
LogixNG
- The LogixNG clipboard window now has the menu item
Clear clipboard in the Tools
menu. It allows you to clear the entire clipboard.
- The action For each roster has been added.
OperationsPro
- Improvements to the "Two Column" Manifest format for locomotives.
- Users can now customize font size, color and bold text for location, train, and route location comments. For monospaced fonts, single words can now be colored or in bold.
- Improvements to the automation "Run Automation". Now the acton shows the status of the automation to run.
- "Show Schedules by Load" now shows the which mode (Match or Sequential) was selected for the schedule.
- The system console now shows the name and length of the longest model name for a locomotive.
- When selecting "On Time" mode for the first time, the program now automatically brings up the tool "Modify Locations Quick Service".
- Improved Manifest and switch list CSV files to only show route comments when they exist.
- Users can now adjust the position of the horizontal lines in Manifests and switch lists.
Scripting
- Added a "ClearBlockValues.py" sample script for clearing block contents. See
comments within it for more info on how to use it.
- Added two scripts to show how to start logging of an LCC or LocoNet
connection as the program starts up
Throttle
- Power buttons do not error when displaying the Idle state.
Warrants
- It's now possible to listen on Warrant.getRunningMessage()
by listening on the property PROPERTY_RUNNING_MESSAGE.
Where Used
- Improved frame layout so that long names won't cause the selector to disappear.
Miscellaneous
- The standard SortedProperties class has been put in place
of the custom jmri.util.OrderedProperties class, which in
turn has been deprecated for removal.
- Improve caching of user preferences files when node-specific profile info is present.
- Added a new black sensor icon to the smallschematics/LEDs group.