Release Notes for JMRI 5.7.1 release

Date: December 17, 2023

From: Bob Jacobsen

Subject: Test Release 5.7.1 of JMRI/DecoderPro is available for download.

Notes:

This release has significant problems with C/MRI, Lenz and DCC++ communications. If you use one or the other of those systems, please don't update to this release. Please use Production Release 5.6, Test Release 5.7.2 or later.

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.7.* test releases. It requires Java 11 to work. (See our page on downloading Java 11) We expect this series to end in the next JMRI 5.8 production release in June 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

• DCC++ serial connections don't work in this test release.
• Lenz serial connections don't work in this test release.
• Some C/MRI modules don't work with this test release.

If this effects you, please update to JMRI 5.7.2.

New warnings for this release:

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

Older warnings

See the JMRI 5.6 release note for more warnings predating the 5.7 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. 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.5.3 LocoNet Server and LocoNet Client have been removed. If you are using these, you need to change the connection to LocoNet over TCP instead.
• Since JMRI 5.5.3 Scripts that output Logging statements with log4jv1.x ( org.apache.log4j ) imports will stop working from JMRI 5.5.4 and should be updated to use SLF4J logging.
  See here for some examples on how to do this.
• Since JMRI 5.5.4 Custom default.lcf Logging Control Files will cease to take effect from JMRI 5.5.4
  To create a custom default_lcf.xml in the new Logging Configuration format, see JMRI Debugging and Logging
• Since JMRI 5.5.5 XML files with table contents and panels have been changed in JMRI 5.5.5. It's therefore not possible to load an xml file with tables and panels that has been created with JMRI 5.5.5 or later with a JMRI version pre 5.5.5.
• Since JMRI 5.5.5 MQTT Connection - Throttle loco address and function placeholders in MQTT topics have changed from $address and $function to {0} and {1} for consistency with other objects.

Download links:

These files are located in the JMRI 5.7.1 GitHub release.

Changes since Production Release 5.6:

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

Hardware Support

CBUS

• CBUS serial connections have been updated to use a new serial library.
• Console - Improved Statistics display

C/MRI

• C/MRI serial connections have been updated to use a new serial library.

EasyDCC

• EasyDCC serial connections have been updated to use a new serial library.

Lenz XPressNet

• Lenz XPressNet connections have been updated to use a new serial library.

LocoNet

• LocoNet serial connections have been updated to use a new serial library.

MERG

• MERG CAN serial connections have been updated to use a new serial library.

MRC

• MERG CAN serial connections have been updated to use a new serial library.

NCE

• Support for PH5 added

  This required rewriting how memory addresses were managed for all NCE systems. This required significant code changes for anything where JMRI is addressing memory in the command stations.

• NCE Packet Monitor - added new baud rate selection for new version of device.

OpenLCB / LCC

• OpenLCB/LCC serial connections have been updated to use a new serial library.
• Fixed an index exception while the Event Table is writing a CSV file.

Powerline

• Powerline connections have been updated to use a new serial library.

RFID

• RFID connections have been updated to use a new serial library.

SPROG

• SPROG serial connections have been updated to use a new serial library. This should fix the incompatibility with recent macOS versions.

TMCC

• TMCC serial connections have been updated to use a new serial library.

Zimo MXULF

• ZIMO serial connections have been updated to use a new serial library.

New / Updated decoder definitions

Logic Rail Technology

• Added a definition for the LightEFX16.

Technologistic (train-O-matic)

• Added Lokommander II Next18 decoder used in NMJ Skd224 models

PanelPro

• The path for the backupPanels directory has been fixed so that it now refers to the user files location instead of the profile location. This only affects the backup files location when user data is shared by multiple profiles.
• The File ⇒ Show file history content has been enhanced. The app entries show the JMRI version. The Store entries show the name of the file that was created.

Signals

Signal Systems

• The FS-1987 signal system was updated to have better aspect ordering.

Throttle

• Throttle Save menu entry behaviour was updated. Documentation updated accordingly.
• Default Throttle UI on a new JMRI setup are now using icons and colors, can be reverted to classic in Preferences (see “Enable button icons when available“ and “Use large speed slider and control buttons“ throttle preferences entry )

Where Used

• Add Logix, LogixNG and Panels to the Reporter where used.

Web Server

• Add browser WebSocket support message to About page

Miscellaneous

• Added a SPI mechanism for extending the Tools menu.
• The Linux and macOS application launchers and the Ant build process have been updated to allow access to jar files in the settings:lib/ directory. This gives creators of JMRI plug-ins a way to distribute their code separate from JMRI.
• The Windows application launcher has been updated to allow access to jar files in the settings:lib/ directory. This gives creators of JMRI plug-ins a way to distribute their code separate from JMRI.
• Plugins can now have help files, including images and css files, withing the JAR file. See PR #12705 and JmriPlugin for example and documentation.
• Improve how JMRI avoids opening a new window on top of an existing one.
• JMRI is now using a new serial library. See the above hardware section for which types of connections have been migrated to this new library.

---