Release Notes for JMRI 4.7.3 release
Date: mmm dd, 2017
Subject: Test Release 4.7.3 of JMRI/DecoderPro is available for download.
This is a draft release note only; the download links do not yet work
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 second in a series of test releases. We expect this series to end in the next JMRI production release around the middle of 2017. (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.
Known problems with this release
New warnings for this release:
- (none at this time)
Older warningsSee the JMRI 4.6 release note for warnings predating the 4.6 development series. These may be relevant to you if you're updating from an earlier version.
(Since JMRI 4.7.1) JMRI no longer supports the portable paths
were deprecated in JMRI 2.13. When loading a panel, an error message will be displayed
if the panel contains a path that starts with
resource: and the panel will
not load until changed using an external editor. Paths starting with
cannot be automatically flagged because JMRI allows file: URLs.
(Since JMRI 4.7.1) JMRI applications will not load a panel file that fails XML validation; an error will be shown that should explains the error, allowing it to be fixed using an editor. (The explainations remain a work in progress.)
(Since JMRI 4.5.6) As part of fixing the TMCC throttle issue, the handling of TMCC preferences was changed. If you have a TMCC connection configured, please go to the "Defaults" pane in the Preferences window and make sure that the TMCC connection is selected for the appropriate device types.
(Since JMRI 4.5.2)This and future releases of JMRI may not function on OS X if the Java SE 6 provided by Apple is installed. OS X operating system updates routinely remove this version of Java SE 6. Please raise any issues concerning this on the user's group.
To remove Java SE 6 from OS X, follow these steps (these steps assume JMRI is installed in the folder /Applications/JMRI, if not, adjust the following paths as needed):
- Open Terminal.app.
El Capitan only: Reboot into Recovery Mode by restarting your Mac and pressing Cmd-R until the Apple logo appears. Once in Recovery Mode, select Terminal from the Utilities menu.
- Run the command
/Applications/JMRI/PanelPro.app/Contents/Resources/uninstall-java6.shIt can take up to a half hour to complete. Wait for the message Removed Apple Java SE6.
El Capitan only: Run the command
bash /Volumes/Macintosh\ HD/Applications/JMRI/PanelPro.app/Contents/Resources/uninstall-java6.sh /Volumes/Macintosh\ HDIt can take up to a half hour to complete. Wait for the message Removed Apple Java SE6.
- El Capitan only: Restart your Mac.
(Since JMRI 4.5.2)Support for directly executing AppleScript within JMRI has been removed due to changes in macOS and Java outside our control. If you require the ability to use AppleScript, you may be able to add this capability on your own by visiting JMRI AppleScript Support, but please be aware that this may not work on upcoming releases of macOS or Java.
(Since JMRI 4.5.1)Internal turnouts and sensors need to have complete, individual system names. The names "IT" and "IS" (without any suffix) are no longer permitted: "IT12" is fine, but just "IT" is not. Most panel files that contain these should automatically migrate them to new names when saved, but in some cases you might need to manually update them.
(Since JMRI 4.3.3) You can now set the order of your startup items: If you're opening panel files, running scripts, etc as the program starts up, there's a preferences pane that lets you easily set the order in which those happen. If you've set the order manually (e.g. by editing configuration files) in the past, please check this preference to make sure it's set the way you want.
(Since JMRI 4.1.2) Jython has been upgraded to version 2.7.0 with the following potentially breaking changes:
- The decodeJmriFilename() function is no longer available by default. Use the FileUtil.getExternalFilename() method instead.
- The simple propertyListener object is no longer available by default. Create your own, following the examples provided in the jython folder in the JMRI distribution.
- jmri_defaults.py included in the JMRI distribution is no longer executed by default, but will be executed before any other Jython scipts if included in your User Files location.
- The default behavior of python.cachedir.skip is now true. If using a custom python.properties file, include "python.cachedir.skip=false" in that file.
- Certain Python scripts are too large to be evaluated in Jython. If a script fails with the
java.io.IOException: Mark invaliderror, set "jython.exec=true" in a custom python.properties file or rewrite the script to be less than 100,000 characters per file. Note that when using "jython.exec=true" it may be desirable to run the included script jmri_bindings.py as a startup action to emulate the evaluation environment used when jython.exec=false.
(Since JMRI 4.1.1) Decoder definitions that use the "ivariable" form are now deprecated. Definitions included with this release have been converted to the new form. If you have decoder definitions with the older "ivariable" form, they will no longer validate, but can still be used for the first couple of test releases in this series. Please ask on the JMRI users Yahoo group for help converting them, or just drop them and use the current definitions.
During development leading to the actual release, you can find test download files on the continuous integration build page. These are development files, and might not be working at any particular time.
Changes since production release 4.7.2:The list of included commits is available from our GitHub code repository.
Programming capability facades are little tools that are used to handle things like indexed CVs, special ways to write upper-address CVs not supported by a command station, etc. Previously, these would have trouble recovering when they encountered multiple errors. (This came up in the context of the time that the DCS240 command station takes to do writes, which JMRI thought was an error) This has now been greatly improved.
- The Digitrax DCS240 command station sometimes takes a long time to write CVs It's thought that this is happening because it's doing a read-after-write to ensure the right value was stored in the right place. In any case, it takes so long that JMRI was timing out and and retrying while waiting for it to complete. This has now been improved. It's still slow, excruciatingly slow if writing indexed CVs, but the timing is properly handled.
JMRI Simple Server/JMRI Client
New / Updated decoder definitions
programming capability facade
for handling indexed CVs has been improved to reduce the number of times that
it has to write values to the "PI" and "SI" index CVs. Some decoders require that e.g.
you write a value to CV31, then another value to CV32, then finally access the specific
CV you're looking for. This can take a long time, especially when using a command station
that writes slowly (see comment about DCS240 above)
The indexed CV support has been updated to skip writes when the previous
operation was to an indexed CV with the exact same indexed values, and the command
station didn't report any errors. This speeds things up greatly (can save over an hour when reading
an ESU LokSound V4 decoder with a DCS240).
It can be turned on and off in each decoder definition. Due to concerns about whether it will cause problems for people who's DCC systems don't reliably write CVs, it's currently turned off in all decoder definitions shipped with JMRI. But it's there if somebody wants to turn it on later, see the documentation page.
Doehler & Haas
Norsk Modelljernbane (NJM)
New Options menu items:
Tool bar changes:
Turnouts, Lights and other elements
- Greg McCartney provided new definitions for the Southern 1981 system
NX Entry/Exit Logic
- Much more Danish translation from Sonnys Hansen
Virtual Sound Decoder
- The naming scheme for JMRI builds has changed slightly. Build metadata (the building user, build date/time, and git revision at time of build) are now deliniated using plus (+) signs instead of hyphens. The build date/time is now ISO 8601 parsable. (#3253)