Release Notes for JMRI 5.11.5 release
Date: MM DDD, 2025
From: release pumpkin
Subject: Test Release 5.11.4 of JMRI/DecoderPro is available for download.
This is a draft release note only; the download links do not yet work
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 next in a series of 5.11.* test releases.
It requires at least Java 11 to work.
We recommend that you use Java 17.
(See our page on downloading Java)
We expect this series to end in the next JMRI production release in June 2025.
(See the tentative release schedule)
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.10 release note for more warnings predating the 5.11 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
This test release, and all subsequent ones, require the use of
Java 11 or later.
We recommend that you use Java 17.
Java 8 is explicitly not supported.
There's more information on this migration on the
JMRI Tech Road Map and
JVM Capabilities pages.
- 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.
- Since JMRI 5.11.3
There's been a change to how OpenLCB turnouts are
addressed when using the MTT addressing short cut.
Turnouts 253,254,255, 510, 511, 512, 765, 766 and 767
will be addressed differently. If you're using any of these
via e.g. MTT253, you will need to change the address. If you've
been having trouble getting those addresses to work, this change should
fix that.
Download links:
During development leading to the actual release, you can find test download files on the
continuous integration build page.
These are development files, and might not be working at any particular time.
The
full list of included changes is available from our
GitHub code repository.
Hardware Support
Acela CTI
Anyma DMX512
Bachrus Speedo
CBUS
C/MRI
DCC++ and DCC-EX
DCC4pc
Direct
ESU
Hornby
Internal
IPOCSMR
JMRI Simple Server/JMRI Client
KPF-Zeller
Lenz XPressNet
LocoNet
- Added a Configure LocoIO Modules tool, accessible from the LocoNet menu, that lists all
connected LocoIO (LNSV1) boards and allows opening a matching programmer, akin to the LNCV pane.
- DecoderPro OpsMode LNSV1 programming has been refactored to use the new Lnsv1MessageContents class
instead of locoio.sendRead/.sendWrite it was still using.
- The LocoIO pane that was deprecated since 4.12 has been removed. The LocoIO configuration
documentation is retained under html LocoNet help.
Maple
Marklin CS2
- Added support for TCP (in addition to UDP) connections to the CS2.
MERG
MQTT
MRC
NCE
Oak Tree
- Improved how Event with Payload messages are displayed in the monitor.
- Enabled the Abort button in the Update Firmware window.
- Backup files are now written with dotted-hex event ID values,
whether or not an event name is available. This makes them more reliable
and more portable.
- Update the STL Editor to support "event names".
- When available, event names will be displayed in the IQYZ tables.
- The load from backup process will handle event names in older CDI backups.
If the event name is no longer in the name store, a temporary event id will
be created.
- Existing event names can be entered in the event columns of the IQYZ tables.
Creating new event names is NOT supported.
- Correctly decode events-with-payload
- First implementation of LCC Location Services which will decode analog-carrying
location services reports to drive volt and amp meters.
- Update the STL Editor to support importing a group_logic.csv file
that has been modified by a spreadsheet program.
- Improve how datagram data is represented in the Monitor
- Add sensor events to the event-entry field popup menu
Powerline
RFID
Roco z21/Z21
Secsi
SPROG
SRCP
TAMS
TMCC
Uhlenbrock Intellibox
Zimo MXULF
ZTC
New / Updated decoder definitions
AE Model
Arnold
Bachmann
BLI
BNM Hobbies
CT Elektronik
DCC Concepts
Digikeijs (Digirails)
Digitrax
Doehler & Haas
ESU
Hattoms
Hornby
Kuehn
LaisDCC
Lenz
MD Electronics
MGP
Mistral Train Models
MTH
MRC
NCE
Norsk Modelljernbane (NJM)
Piko
- Add Decoder and Project CVs
Public Domain and DIY decoders
QSI
Rampino Elektronic
Rautenhaus
RR-CirKits
SoundTraxx
Tam Valley Depot
TAMS
TCS
Team Digital
Technologistic (train-O-matic)
Trix Modelleisenbahn
Uhlenbrock
Umelec
Viessmann
Wangrow
ZIMO
- Added pane and CVs for "Zimo Scripting".
- Added decoder types MS591N18 and MS540E24
Miscellaneous
Control Panel Editor
Circuit Builder
Palette
CTC Tool
DecoderPro
- Added DecoderIndexFile access to a decoder definition's
<programming><mode>, allowing a check of supported modes from a DecoderFile using
getProgrammingModes()
- DecoderPro OpsMode LNSV1 programming has been refactored to use the new Lnsv1MessageContents class
instead of locoio.sendRead/.sendWrite it was still using.
Dispatcher
Dispatcher System
Internationalization
Layout Editor
- Added a TurnoutCircleTransparency.py script to change the
color and transparency of Layout Editor turnout circles
NX - Entry/Exit Tool
LccPro
Logix
LogixNG
Meters and MeterFrames
OperationsPro
- New feature, when building a train, the program now warns for set out
and pick up conflicts between trains when using aggressive mode.
Panel Editor
Permissions
Preferences
Resources
Roster
- New Roster Entries hold the decoder's programming mode, if defined, to use as a filter similar to
e.g. ProductID.
Routes
Scripting
- Added a TurnoutCircleTransparency.py script to change the
color and transparency of Layout Editor turnout circles
Signals
Signal Systems
Signal Heads
Signal Masts
Signal Groups
Cab Signals
Simple Signal Logic
USS CTC Logic
Switchboard Editor
Throttle
Timetable
Tracker
Turnouts, Lights, Sensors and other elements
- Fixed a bug that was putting the wrong information in
a Turnout's comment when a SignalHead was created using that Turnout.
Warrants
Web Access
Web Server
Where Used
WiThrottle Server
Virtual Sound Decoder
- Added the OpenAL EFX reverb effect to tunnel tracks.
Can be activated using "Advanced Location Following"
and a LayoutEditor panel with a TrackSegment decorated as Tunnel.
Z21 Server
Miscellaneous
- There's a new "DarkLAF HC" dark-mode setting for the display.
To use it, select Settings then Display, then click the
button for "DarkLAF HC". Save preferences and restart. Note that this
puts a dark background with light text on all JMRI windows.
You may have to rework your panels for them to look good
in this mode.
