Release Notes for JMRI 5.9.7 release
Date: December 2, 2024
From: Bob Jacobsen
Subject: Test Release 5.9.7 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 next in a series of 5.9.* 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 December 2024.
(See the tentative release schedule)
We are getting close to the next production release, so we would particularly
appreciate your testing of this release to make sure it works for you. That way,
if you find new problems, we can try to fix them before the production release.
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.8 release note for more warnings predating the 5.9 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.
- Since JMRI 5.7.1
Several systems have had extensive updates to their serial
support. If you have trouble connecting to your layout hardware
after installing this version, please contact us
on the JMRIusers list
for assistance.
- Since JMRI 4.7.7
If you are using a RR-CirKits LocoNet to LCC gateway
with this release, please upgrade its firmware
to version B8g or later. B8f or earlier will
have trouble updating the gateway's configuration.
Download links:
These files are located in the
JMRI 5.9.7 GitHub release.
The
full list of included changes is available from our
GitHub code repository.
Hardware Support
CBUS
- Command Station Monitor :
Button added to release JMRI-managed loco sessions,
this can be handy when developing Jython scripts that fail to release the Throttle.
Button added to launch a new JMRI Throttle for a loco session.
- STL Editor: Add store mode selections to the View menu, update help page.
- Add a Send SNIP Request button to the Send tool.
- Implement recent changes to the CDI spec underlying the node configuration display.
This will allow node implementors to make simpler configuration dialogs.
- Fixed a bug where the node configuration display would sometimes
be drawn with overlapping characters or extra white space.
New / Updated decoder definitions
Technologistic (train-O-matic)
- Added support for the FD II (version 2) function decoder family.
Dispatcher
- Speed Setting NoSignals.
- After setting speed by Sections ahead. Check Block speeds.
- If next block slower than current block set speed down before entering next block.
- Do not increase speed beyond the minimum speed of any occupied block.
- When going from automatic to manual bypass auto-engineer limts.
- Optionally use Connections Turnout Delay.
LogixNG
- A bug is fixed in the LogixNG action Signal Mast.
The options Permissive Sml Disabled
and Permissive Sml Not Disabled caused
an error when storing and loading the tables and panels
file.
Scripting
- Added "SensorFromBxpa1ShortCircuit.py" and
"SensorFromBxp88ShortCircuit.py" scripts, which can create
JMRI "Internal" sensors that "follow" the LocoNet message
information that is created when the BXPA1 and BXP88
(respectively) send "Short Circuit" event LocoNet messages.
- Updated the "SensorFromBxpa1AutoRev.py" script to do a better
job of watching for BXPA1 "Autoreverse" event LocoNet messages.
- WiThrottleList.py is a sample script that shows how to access the
WiThrottle session list.
Signals
Signal Systems
Throttle
- Added a startup action to trigger the show JMRI throttle list window action.
WiThrottle Server
- The getThrottleList() public method has been added to
jmri.jmrit.withrottle.UserInterface for Jython access.
Virtual Sound Decoder
- The limit for VSDecoders is now 8 instead of 4.
- The sound buttons sorting in the VSD Manager window is now as in config.xml.
- If the sound buttons exeed 8, a second row is displayed.
Miscellaneous
- Add Close button to menubar Window menu.
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
Maple
Marklin CS2
MERG
MQTT
MRC
NCE
Oak Tree
- Fixed a bug in the LccPro search function on large LCC networks.
- Added "Node Groups" to LccPro and the Event Table.
Powerline
RFID
Roco z21/Z21
Secsi
SPROG
TAMS
TMCC
Uhlenbrock Intellibox
Zimo MXULF
ZTC
New / Updated decoder definitions
Arnold
Bachmann
BLI
BNM Hobbies
CT Elektronik
Digikeijs (Digirails)
Digitrax
Doehler & Haas
ESU
Hornby
Kuehn
LaisDCC
Lenz
MD Electronics
MGP
Mistral Train Models
MTH
MRC
NCE
Norsk Modelljernbane (NJM)
Public Domain and DIY decoders
QSI
Rautenhaus
RR-CirKits
SoundTraxx
Tam Valley Depot
TAMS
TCS
Team Digital
Technologistic (train-O-matic)
Trix Modelleisenbahn
Uhlenbrock
Umelec
Viessmann
Wangrow
ZIMO
Miscellaneous
Control Panel Editor
Circuit Builder
Palette
CTC Tool
DecoderPro
Dispatcher
- Add the ability to use an AdHoc transit, which is created dynamically between 2 blocks
Dynamic Transits are always run "No Signals". Dynamic Transits are removed at train termination. If
they are not removed for any reason they will not be saved. Currently the route must be clear from end to end
and any flaws in the routing table will cause grief. Avoid having the train stop in them.
- Add Ghost type block. It must have a "not real" sensor, internal is best.
The sensor should not be manipulated by logix or logixNG or scripts. Auto trains will
set and clear these sensors automatically, manual run trains simply ignore them.
They are useful for adding blocks between 2 turnouts where you would normally add a tiny block with the same block
as one of the turnouts which causes errors in the routing tables. With care they can be used for placing turnouts
in their own block.
Dispatcher System
Internationalization
Layout Editor
NX - Entry/Exit Tool
LccPro
- Fixed a bug in the LccPro search function on large LCC networks.
- Added "Node Groups" to LccPro and the Event Table.
Logix
LogixNG
Meters and MeterFrames
OperationsPro
Panel Editor
Permissions
Preferences
Resources
Roster
Routes
Scripting
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
Warrants
Web Access
Web Server
Where Used
WiThrottle Server
Virtual Sound Decoder
Z21 Server
Miscellaneous