Release Notes for JMRI 4.99.3 release

Date: February 13, 2022

From: Bob Jacobsen

Subject: Test Release 4.99.3 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 4.99.* test releases to migrate JMRI to Java 11. It requires Java 11 to work. (See our page on downloading Java 11) We expect this series to end in the next JMRI 5.0 production release at the end of Spring 2022. (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 4.24, 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. 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

• ESU decoder definitions (and apparently only ESU decoder definitions) have a problem with their function CVs. If you have an ESU decoder and want to program it with DecoderPro, you should not use this version. The fix will be in JMRI 4.99.4 when it comes out.

If that affects you, please either wait for JMRI 4.99.4, due out in early March, or (once there's a fix for the problem) pick up a JMRI on Java 11 development build installer from Jenkins.

New warnings for this release:

• None yet

Older warnings

See the JMRI 4.26 release note for more warnings predating the 4.99 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 JMRI 4.20 before installing this test release.

• Since JMRI 4.99.2 Example scripts related to MQTT moved from jython directory to jython\MQTT directory. This will require an update to any start-up actions that reference their location.
• 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 4.99.1 A number of classes and methods that have been deprecated for a long time are removed in this release. These include:
  • apps.JmriPlugin
  • apps/startup/StartupActionFactory
  • Routes/Turnouts/Sensors: One form of getNextAddress
  • Handling of preferences from before JMRI 4.0; upgrade through JMRI 4.20 instead
  • ShutDownTask, AbstractShutDownTask - use call & run methods now
  • Removed JythonAutomaton, JythonAutomatonAction, JythonSiglet, JythonSigletAction unused classes. These have been made obsolete by JMRI's native scripting, and haven't been used since JMRI 1.2
  • SSL (BlockBossLogic) - change to start/stop calls
  • Various TrafficManagers.instance methods - use InstanceManager
  • Throttle.getListeners() - use getPropertyChangeListeners
  • Removed obsolete RosterRecorder class; function now available via scripting
  • Removed deprecated methods from Throttle panels
  • Manager.getSystemNameList - rework with getNamedBeanSet
  • Manager.getNamedBeanList - rework with getNamedBeanSet
  • Manager.setPropertyChangesMuted - use setPropertyChangesSilenced
  • Manager.getBeanBySystemName - use getBySystemName
  • Manager.getBeanByUserName - use getByUserName
  • FileChooserUtil
  • get/setFontFamily in SystemConsolePreferencesManager
  • throttle.FunctionPanel#changeState(..) has been replaced by #setSelected(..)
• Since JMRI 4.99.1 The PowerManager now only fires events with the id "power". Before this release, it also fired events with the id "Power". Check that your scripting code is looking for the right form.
• Since JMRI 4.99.1 This version no longer reads ZeroConf IPv4 and IPv6 preferences written with JMRI 4.16 and before. Please make sure to upgrade to JMRI 4.20 (or later) and save your preferences before updating to this version if you have configured the WiThrottle preference pane.

Download links:

Changes since Test Release 4.99.2:

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

Hardware Support

CBUS

• Lawicell devices - added RTR CAN Frame support.

LocoNet

• Updated some new IPL report messages
• Add configuration support for UR93, LNWIs. Allow updates for individual parameters.

OpenLCB / LCC

• Lawicell devices - added RTR CAN Frame support.

RFID

• Updated: Tags are recorded in a table. If there is a Car (from OperationsPro) associated with this tag, the Road name and Car number are shown. The location and Track are shown in ComboBoxes which the user can set and then click on a button to set to the new Location and Track. Another button shows the Car in the Edit Car window. If there is no associated car, a button opens a window with a list of Road names. The user can select a road name and the second list shows all car numbers for that road. Once a car number has been selected a button sets the tag in that Car. By default the only visible road names and numbers are for cars that do not have a tag. A checkbox shows all cars, including those with tags.

  The window is opened from the "RFID" menu choice (there is one for each RFID connection). The first choice opens the standard Serial Monitor Pane. This new Pane is opened from the second choice. The help screen can be viewed from the monitor pane, or via a link in the Hardware RFID connection frame.

DecoderPro

• Added accessible names to the (simple) variables displayed on programming panes.
• Decoder definitions can now add items to the main programmer-pane window menu.

Dispatcher

• Fix XCrossings allocation.
• Improve AutoEngineer. Permit unlimited number of Auto Trains.

Layout Editor

• Use the actual turnout state for the turnout circle when that option is used. This corrects the color for turnouts using the continuing route option when set to thrown.
• Tooltip support for panel icons has been changed. See Tooltips for details.
• Update the layout block occupancy sensor when the occupancy sensor for the related block has been added, removed or changed to a different sensor.

LogixNG

• The action Throttle has been updated. It now also has the child sockets Function and FunctionOnOff. These are optional. If both are connected, the Throttle action sets or resets this function. The child Function tells the function number and the child FunctionOnOff tells if the function should be On (True) or Off (False).
• A single Logix can be imported to LogixNG. See the section Logix for more information.
• The action Local Variable now supports Block and Reporter. For Memory, Block and Reporter, there is a new option Listen that selects whenether the action should listen on changes for the Memory, Block or Reporter.
• The actions Memory and Local variable and the expressions Memory and Local variable have improved support for LogixNG Tables.

Panel Editor

• Tooltips can now be edited in Panel Editor.
• Tooltip support for panel icons has been changed. See Tooltips for details.

Control Panel Editor

• Tooltip support for panel icons has been changed. See Tooltips for details.

Preferences

• Improved handling of the dirty bit, which controls whether you're prompted to save preferences.

Resources

• Inobu One provided new single-crossover icons and additional double-crossover USS icons.

Switchboard Editor

• The menu options to label a switch were enhanced to allow hiding the system name in case a user name is configured. This was suggested by Phil-Klein.

Throttle

• Restored tab and shift+tab shortcuts to browse through throttles inner windows
• Address Panel is now focused as a default when opening a new throttle

Warrants

• Additional bug fixing and enhancements to Shared Warrants. SWs are useful to animate the simultaneous operation of multiple trains. Be aware that SWs may mutually block movement that can only be resolved by aborting at least one of them. Regular warrants avoid such deadlocks due to the priority of their launch times.
  • SWs will not allocate any blocks beyond or at a "hazard" (occupation by foreign train, passage beyond a stop signal, conflict with another warrant)
  • If a ramp down to stop at a "hazard" stops before entering the next block, the restart is done automatically when the condition clears.
  • If a ramp down to stop at a "hazard" overruns into the next block, the SW will allocate the next block if that is permissible. Whether or not, i.e. the position of the train is marked yellow or blue, use the normal Control commands to restart. "Resume" if the "hazard" was occupation or a warrant, or wait for the signal change to an allowable speed.
• The messages to the status field of the warrant Table and other information can be displayed to the console by clicking the "Trace Warrants" button in Warrant Preferences.

WiThrottle Server

• Added a "TelnetTrain.py" example to run a train from the Python command line.

Web Server

• Support for display and interaction with (Control) Panel slipTurnoutIcons has been added to JMRI Web Server Panels.
  This includes double and single slips, three-way turnouts and scissors with 2 or 4 turnouts.

Miscellaneous

• Improved accessibility of throttle keyboard shortcut help.
• Developers: The Typescript and Javascript support has been updated.

---