Release Notes for JMRI 4.15.5 release

Date: April 19, 2019

From: Bob Jacobsen

Subject: Test Release 4.15.5 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 test releases. We expect this series to end in the next JMRI production release during early Summer 2019. (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 JMRI 4.11.9 or earlier, we strongly recommend that you update to JMRI 4.12 and make sure that's running OK before updating to this test release. Once you have JMRI 4.12 running OK, store your configuration and panel files and use those from then on. There have been a number of changes in serial port support, panel file format and configuration options since those earlier releases, and moving to the stable JMRI 4.12 release is a good way to work through any possible problems.

If you are currently using JMRI 4.7.3 or earlier on Linux or macOS (Windows doesn't need this), you must update to JMRI 4.12 and carrying out the migration process described in the JMRI 4.12 release note before updating to this release.

Known problems with this release

• None

New warnings for this release:

• Since JMRI 4.15.5 The handling of Turnout system names has been updated to be (more, hopefully completely) consistent with the planned approach. Specifically, case now (generally) matters in system names:
  • You can now have an internal turnout named "ITsome lower case name".
  • But note you can no longer refer to "ITSOME LOWER CASE NAME" or "ITSome LoWeR cAse Name" and get the same one.
  This should not require any migration for stored configurations or panel files, as they have been automatically been being kept consistent since JMRI 4.8. But you might have case errors in i.e. scripts which will fixing inconsistent references in your scripts.

  Of course, bugs are always possible. If you find a place where names seem to be handled inconsistently, please let us know!

Older warnings

See the JMRI 4.14 release note for more warnings predating the 4.15 development series. These may be relevant to you if you're updating from an earlier version.

Since JMRI 4.15.4 The calculation of Turnout Addresses for the Direct DCC Accessory Command ("a" command) mode has been fixed (commands are now sent to the correct accessory address rather than 4 less than the nominated hardware address). For pre-existing panels, changes will need to be made to either the actual decoder address or the panel. If help is required, ask on the jmriusers group.

Since JMRI 4.15.3 The prefix that identifies a layout connection should be a single letter, like "N" or "L", or a letter and some digits, like "K2" or "D3". Some older systems used to have longer "legacy system prefixes" like "DX", "DCCPP", "DP", "MR", "MC", "PI", and "TM". Those legacy system prefixes will now cause JMRI to issues a warning at startup. In this release, JMRI will still work with those prefixes, but they will need to be migrated to the proper form soon; JMRI 4.17.1 and later will require that this have been fixed. Therefore, this warning can't be suppressed without migrating the prefix in the connection configuration (and any associated panel files and scripts). If you're getting this warning and therefore need to do that migration, migration page.

Since JMRI 4.11.4 There are issues with the Pi-SPROG One command station operation. A number of workarounds should be applied:

• Do not turn on the track power until the power supply to the Pi-SPROG ONE is turned on
• Do not enable extra debugging through default.lcf, nor open the system console window
• Do not open the SPROG console window
• Disable power conversion (CV 29) in all locos
• If connecting via VNC (or similar), setup the screen layout before turning on the track power

Pi-SPROG One with version 2.4 or earlier firmware will cause a timeout after a track short circuit. A dialog box will open to inform the user of this. The track power will be turned off and must be turned on again using the power control.

Download links:

Please note that the download links in this and future JMRI releases link to Github servers. People are welcome to distribute the download files further via other websites, etc. If you want to check that you've received original, unmodified versions, please check the files against the checksums shown below.

Changes since Test release 4.15.4:

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

Hardware Support

LocoNet

• JMRI's support for the Digitrax PR4 has been updated to reflect the PR4's inability to provide "LocoNet Data Signal termination". since 4.15.5

  This is a correction to JMRI's previous implementation of PR4 functionality. It reflects a a more-accurate understanding of PR4 features by the JMRI development team.

  When configuring a JMRI "connection" for the PR4, the "Command station type" of "Stand-alone LocoNet" is no longer available. Users with an existing PR4 connection which has been configured for a "Command station type" of "Stand-alone LocoNet" should change their "Command station type" to some other selection, such as "DCS100", and save the configuration profile.

  Because LocoNet requires some source of "LocoNet Data Signal termination", and because the PR4 is not capable of providing that feature, it will be necessary to provide it using some other piece of LocoNet hardware. Both commercially-available and do-it-yourself options are available, as described in the " LocoNet Data Signal termination" section of the JMRI Standalone LocoNet" help page.

MERG CBUS

• CBUS Node Manager provides a Node Table with further Node Configuration tools.
• CBUS Event Table name import from MERG FCU file has moved to the Node Manager, where a file preview and further import tools are now available.
• Track Current meter avaiable for supported Command Stations via PanelPro > Tools > Track Current Meter
• Fixed issue with Roster speed-profiling

MQTT

• The updated MQTT support in this release
  • allows you to change the topic string used for publishing and subscribing and
  • allows changing the payload of MqttTurnouts, i.e. to use JSON instead of fixed strings.
  For more information, see the description at the bottom of the MQTT page.

New / Updated decoder definitions

ESU

• ESU LokSound decoder users can now read the loaded Sound Project Name (and other decoder information) on the Information Pane.
  
  This allows cross-referencing to the ESU website (copy the "Loco Name" to search the Projects section) in order to find the ESU bulletin and hence determine Sound Slot and Function Key names. (Dave Heap)

TCS

• Add Trim CV to Basic Speed Control pane Add WOW Ver 4 Prime decoder (Michael Mosher)

DecoderPro

• Changes to Split Variables.
  • More than 2 CVs can be specified for splitVal and the other new types, using a new notation format.
  • A new splitHexVal type for hexadecimal entry/display.
  • A new splitDateTimeVal type for Date/Time information stored across CVs (e.g. dates in the RailCom® CV page).
  • A new splitTextVal type for entry and display of text strings stored across CVs .
  For more information see Advanced Decoder Definitions. (Dave Heap)

Panel Editors

CTC Tool

• A new CTC tool has been added to JMRI. An Editor component uses a set of screens to define the CTC system. The resulting data can be used to create a US&S CTC Panel (Panel Editor) with all of the levers, indicators, and a minimal track plan with turnouts and signals. A run time component uses the configuration to implement prototype CTC logic with no scripting or Logix.

Turnouts, Lights, Sensors and other elements

• The handling of Turnout system names has been updated to be (more, hopefully completely) consistent with the planned approach. Specifically, case now (generally) matters in system names:
  • You can now have an internal turnout named "ITsome lower case name".
  • But note you can no longer refer to "ITSOME LOWER CASE NAME" or "ITSome LoWeR cAse Name" and get the same one.
  This should not require any migration for stored configurations or panel files, as they have been automatically been being kept consistent since JMRI 4.8. But you might have case errors in i.e. scripts which will fixing inconsistent references in your scripts.

Signals

Signal Masts

• Better messages when a Turnout Signal Mast encounters errors due to part of its configuration not completed.
• Better reporting of issues when Signal Mast Logic encounters a problem with a Signal Mast

USS CTC Logic

• Updated how lock information is stored in the 'logging memory' so that it can be displayed e.g. on a panel. For more info, see the help page

Warrants

• The throttle settings generated for down ramps used by NXWarrants or speed changes required by signals, occupancy conditions or user interventions has been modified. The last throttle interval now is always the throttle interval as specified in Warrant Preferences. Accuracy of the position where the train stops should be improved.
• A bug where looped routes ending at an adjacent block could be missed by the Find Route algorithm has been fixed.
• A stop button to halt execution of the Find Route Operation has been added.
• The dynamic recording of speeds during sessions has been extended. A weighted average of the speed over a block is recorded to the session speed profile.
• A bug where a Halt at zero speed would not restart has been fixed. Scripts now resume at any command where the user does a Halt.
• The "Run Warrant" command linking warrants now executes for all cases.
• A bug when dragging an unnamed Portal icon in CircuitBuilder might cause a freeze has been fixed.
• Deleting an OBlock will also delete all other elements (Portals and Paths using the block). Previously when saved after such editing, warrants referencing the block would re-register the OBlock when the panel was re-loaded. Now such warrants are loaded, but will indicate that editing is needed to establish a correct route for them.

• Down ramps used by NXWarrants and are also used when speed changes required by signals, occupancy conditions or user interventions occur. The throttle settings generated for down ramps have been modified. The throttle setting is increased by 10% at each time interval. Also, the last throttle interval now is always the throttle interval as specified in Warrant Preferences. Accuracy of the position where the train stops should be improved.
• A bug where looped routes ending at an adjacent block could be missed by the Find Route algorithm has been fixed.
• A stop button to halt execution of the Find Route Operation has been added.
• The dynamic recording of speeds during sessions has been extended. A weighted average of the speed over a block is recorded to the session speed profile. These speeds may be edited and merger into the Roster SpeedProfile according to the settings selected in WarrantPreferences.
• A bug where a Halt at zero speed would not restart has been fixed. Scripts now resume at any command where the user does a Halt.
• The "Run Warrant" command linking warrants now executes for all cases.
• A bug when dragging an unnamed Portal icon in CircuitBuilder might cause a freeze has been fixed.
• Deleting an OBlock will also delete all other elements (Portals and Paths using the block). Previously when saved after such editing, any warrants referencing the deleted block would re-register the OBlock when the panel was re-loaded. Now such warrants are loaded, but will indicate that editing is needed to establish a correct route for them.
• A checkBox to suppress the generation of sound commands has been added to the create NXWarrant window.
• TextFields have been added to the create NXWarrant window so ramp parameters can be modified.
• Missing help pages have been added to the sidebar index.

Miscellaneous

• JSON protocol documentation updated. (#6777)
• JSON services no longer automatically listen for changes to objects provided to a client unless the client explicitly requests the object. (#6777)
• NamedBeans now allow property change listeners to listen only to specified properties. (#6777)

---