Release Notes for JMRI 5.3.6 release

Date: May 6, 2023

From: Bob Jacobsen

Subject: Test Release 5.3.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.3.* 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.4 production release in June 2023. (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.

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

• Since JMRI 4.99.1 There's a problem locating and operating ECoS sensors. The fix will be available in JMRI 5.3.7
• Since JMRI 5.3.4 DecoderPro improperly displays function names in the Function Map pane for certain ESU decoders. The fix will be available in JMRI 5.3.7.

If any of those affect you, please either wait for JMRI 5.3.7, or (once there's a fix for the problem) pick up a JMRI development build installer from Jenkins.

New warnings for this release:

• None yet

Older warnings

See the JMRI 5.2 release note for more warnings predating the 5.3 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 5.3.2 Some images in the resources/icons folder have been renamed. Spaces have been changed to underscore. It's images in the resources/icons/ItalianSignals/ACEI, resources\icons\ItalianSignals\Prototypical, resources/icons/smallschematics/aspects/NW-1981, resources/icons/smallschematics/aspects/NYC-1956, xml/signals/FS-1987, xml/signals/NW-1981, xml/signals/NYC-1956 and resources/icons/SNCF/Small folders that have been renamed. If you are using these images directly, you will need to update the reference.
• Since JMRI 5.1.7 The way defaults for some LocoNet connections are handled has changed. Existing LocoNet connections might give a "The Defaults preferences are invalid" warning when saving preferences. In that case, click "yes" and then go set all the default radio buttons on the "Defaults" pane to the LocoNet connection. (You can also click "no", but you'll get the message next time you store too)
• 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.3.3 The code for Loconet programming operations was significantly changed. If you encounter any (new) troubles programming via Loconet, please get in touch on the JMRIusers list.

Download links:

Changes since Test Release 5.3.5:

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

Hardware Support

CBUS

• Improved Node Manager configuratiuon of MERG CANSERVO8C / CANMIO-SVO / CANACC4

C/MRI

• Improve handling of poll options for network connections.
• Remove extraneous ERROR message when network connections.

DCC++ and DCC-EX

• New script in DCC-EX folder, RosterExportToDCC-EX.py, which outputs all JMRI roster entries in format suitable for copying into myAutomation.h.

Lenz XPressNet

• Clarify some internal implementation terminology.
• Add support for up to Fn68 when the Lenz hardware is version 4.0 or later.

LocoNet

• Fixed a problem introduced in JMRI 5.3.3 that caused certain ops-mode programming operations to fail.
• LocoNet connections now support decoder functions up to F68
• Improved handling of BXP88 messages

MQTT

• Added support for variable Lights.

OpenLCB / LCC

• Update OpenLCB_Java library through PR #228 which includes
  • Add a factory reset option to the configuration More... menu,
  • Limited retry of CDI reads in case of errors.
• Fix an NPE from incorrect input when making a Sensor or Turnout.
• Allow an alternate user name format for accessing DCC turnouts connected through a bridge: MTT123 (note 2nd T) will generate the appropriate events to throw and close DCC turnout 123.

New / Updated decoder definitions

Digitrax

• Added a decoder definition for the PM74 board.
• Added decoder definitions for the SFX Sound Decoders - Series 7

Kuehn

• Improve the ZTC217 decoder definition.

Piko decoders

• Add Decoder file for Piko SUSI Decoder (Light decoder)

Viessmann

• Decoder definition Tillig double slip turnout: Address label added and typos corrected

DecoderPro

• Added tooltips to the CV Pane that will show a brief summary of where the CV is being used.
• Significant roster table UI speed improvements.
• Added progress dialog for roster index recreation.
• Added progress dialog for decoder index recreation.

Layout Editor

• Tooltips have been enabled for turnouts and slips on Layout Editor panels. The tooltip displays the name of the assigned turnout. The format is system or user (system). For slips, both turnout names are displayed. If a turnout has not been assigned to a turnout or slip, the internal TOnn or SLnn id will be displayed. The tooltips are shown based on the Options ⇒ Show Icon tooltips settings used by the regular icon tooltips. Custom tooltips are not available.
• Add a scale item to popup menu.

Logix

• Recognize Logix user name changes for Conditional Logix Actions. This is an action that can be used to enable or disable a different Logix.

PanelPro

• Add clickable table of contents to Panel File display/print capability (when you open a panel xml file via the JMRI web server)

Switchboard Editor

• Change the way user names are displayed in the cell contents. This allows word breaks onto additional lines in the display.

Throttle

• Some minor internal cleanup.
• If you select a roster entry, the throttle displays functions up to the least of the number of functions available from the layout connection, or the maximum function in the decoder definition. For most decoders, this will be 28, but there are a few definitions that are larger or smaller.

Turnouts, Lights, Sensors and other elements

• ID Tag Tables - Speed improvements when working with large numbers of Tags.

Miscellaneous

• Add clickable table of contents to Panel File display/print capability (when you open a panel xml file via the JMRI web server)
• New AnyRailBuildBlockSensorList.py script and associated README.md file.
• Add the CreateJmriApps.sh script to the Linux install. The script creates the JMRI application definitions used by the Linux application launchers. It also has an option (--desktop or -d) to create desktop icons.

---