Release Notes for JMRI 5.9.6 release

Date: November 7, 2024

From: Bob Jacobsen

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

• None yet

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

Changes since Test Release 5.9.5:

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

Hardware Support

Lenz XPressNet

• Throttles are now fully released by JMRI when not required, which resolves an issue with Roster Last Operated and Operating Duration fields not being updated.

LocoNet

• LocoNet Monitor gives better information when some responses were reporting "unrecognized message" for CV reads of LocoNet-connected Digitrax 7th-generation Accessory devices.

OpenLCB / LCC

• Fixed a bug were immediate-mode sliders would sometimes not automatically write their contents when changed, leaving people to have to push the "Write" button.
• OpenLCB and LCC connections now support "DCC Signal Decoder" Signal Heads.
• The OpenLCB and LCC implementations have started to provide a CommandStation object with limited capability.
• STL Editor: Provide an alternate view where the IQYZ tables are in a separate window. This makes it possible to see the table content while working on the STL logic.
• STL Editor: Implement a view option to provide a preview of the generated STL logic.
• STL Editor: Implement shift-click to copy a name from a table row to the current logic row.
• Improved how UTF-8 is handled in CDI display.

New / Updated decoder definitions

Digitrax

• Added new DH187, DH127 and DN167n18 models

SoundTraxx

• Athearn ECO & TSU2 add new models

TCS

• The decoder definitions for the TCS WOW Steam version 4.6 have been improved.

Control Panel Editor

• The "Scale" operation on icons has been changed to a relative scaling from the current size. For example, if you've scaled an icon by 150% already, and request a rescaling by 200%, the icon will end up at 300%. Previously, this would work inconsistently.

DecoderPro

• A problem where the Simple CV programmer would sometimes fail to display the proper options has been fixed.

Dispatcher

• Add minimum reliable operating throttle setting. Calculate adjusted throttle as throttle * factor then apply max and min limits. Use Max speed from the roster entry, if available, as default. Refactor ActivateTrain to push the final validation and train creation into dispatcher.

Layout Editor

• Fix slip turnout control circle colors when using closed/thrown colors.
• The "Scale" operation on icons has been changed to a relative scaling from the current size. For example, if you've scaled an icon by 150% already, and request a rescaling by 200%, the icon will end up at 300%. Previously, this would work inconsistently.

OperationsPro

• New feature, you can now control which caboose road names a train can use.
• New tool, "Set Locomotives", allows you to change a group of locomotives.

Panel Editor

• The "Scale" operation on icons has been changed to a relative scaling from the current size. For example, if you've scaled an icon by 150% already, and request a rescaling by 200%, the icon will end up at 300%. Previously, this would work inconsistently.

Preferences

• Linux & Mac: When finding available serial ports, JMRI now looks for symbolic links in /dev even when the purejavacomm.portnamepattern system property is not specified. Such symlinks can be used to provide a stable filename for a USB serial port. For instance:

                $ ls -l /dev/serial/by-id/
                total 0
                lrwxrwxrwx 1 root root 13 Nov  7 10:32 usb-RR-CirKits_LocoBuffer-USB_FTV8GN2E-if00-port0 -> ../../ttyUSB1
                $ sudo ln -s /dev/serial/by-id/usb-RR-CirKits_LocoBuffer-USB_FTV8GN2E-if00-port0 /dev/LocoBuffer
                

  Then the Preferences panel will present 'LocoBuffer' as an available serial port, and it will remain available even if the port is later mapped to ttyUSB2, etc.

---