Release Notes for JMRI 5.9.4 release

Date: September 13, 2024

From: Bob Jacobsen

Subject: Test Release 5.9.4 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)

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:

1. 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.

2. 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.
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.
4. 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.
5. 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

• LogixNG Timers configured to fire when JMRI starts do not work properly in this release. It will be fixed in 5.9.5 and 5.10.
• WiThrottle Server does not work properly in this release. (crashes when sending Turnouts or Routes), It will be fixed in 5.9.5 and 5.10. Workaround is to disable Turnouts and Routes under Preferences, WiThrottle Server, Allowed Controls

New warnings for this release:

• None Yet

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.4 GitHub release.

Changes since Test Release 5.9.3:

The full list of included changes is available from our GitHub code repository.

Hardware Support

OpenLCB / LCC

• OpenLCB_Java lib updated to release 0.8.1, which includes:
  • Better GUI for the node selection tool, which improves layout of the firmware upgrade window, send tool window, memory tool window and other places.
  • Event ID fields now have a contextual menu to assist in specifying well-known events, time (clock) events, and DCC accessory decoder events. These are also available from the "More..." buttons on the CDI window.
• Improve memory tools:
  • Allow selection of space 0 - 255 in Memory R/W tool and Send Frame Tool, with data entry in either hex or decimal
  • Improve display of available spaces by omitting missing spaces to reduce length of display
• Send Frame tool will no longer allow you to access CDI if there's no CDI in the node. This prevents you from accidentally getting into a confusing situation.
• Firmware Upgrade Tool and Memory Tool now let you select the memory space with a decimal or hexadecimal number.
• Implements the slider and action button proposal in CDI. There are no products using this, but we'll be ready when they're introduced.

New / Updated decoder definitions

ESU

• Added LokPilot 5 micro DCC Direct
• Added LokPilot 5 nano DCC
• Added LokSound 5 micro DCC Direct Atlas S2
• Added LokSound 5 nano DCC Next18
• Updated LokPilot 5 L and 5L DCC productIDs

DecoderPro

• Will now show decoder family and model comments if you hover your mouse over the decoder selection tree.

Dispatcher

• For trains with HEAD ONLY detection release sections by length.
• When train exits section leave coloured as allocated until released.

Layout Editor

• Enable control circle colors and the fill option for slip turnouts.

OperationsPro

• New feature, print or preview trains serving a location or track.
• Locos set out to a spur or interchange now obey which train or routes service the track.
• Cabooses and cars with FRED without a final destination can now use staging that only allows cars with an final destination.
• There's now an option to leave cars in staging for trains that return to the same staging track. See "Allow cars to return to staging" for more details.
• There's a new Manifest feature that allows you group all "Moves" together. See "Manifest Print Options".
• The program now issues a warning during a build when removing a final destination due to track space issues.

Preferences

• Added text to "start Up" Preferences to note that optimal XML file loading should be done before "Opening" any "Table".

Routes

• When you're editing a Route, the window will now close when you hit Update. This makes this edit window behave like other ones.

Scripting

• The Jython library has been updated to version 2.7.4

Miscellaneous

• Permissions, which was added in JMRI 5.9.3, had a serious bug. If the user doesn't have permission to store, it can still store when JMRI shutdown. That bug is now fixed.
• New Permission user names are now case-insensitive and stored using lower case. Existing Permission user names are unaffected by this change.
• Trying to log in as 'guest' is now returned with a dialog.
• Protected against an uncommon error that can happen when loading a file at startup on Windows.

---