Release Notes for JMRI 3.2 release

Date: December 16, 2012

From: Bob Jacobsen

Subject: Production version 3.2 of JMRI/DecoderPro is available for download.

We are very pleased to announce that the 3.1 series of JMRI test releases has resulted in a version that's good enough to be recommended for general use, including by new users. We're therefore making that version, "Production version 3.2" available for download today.

Notes:

JMRI is now only available under the GNU General Public License. For more information, please see our copyright and licensing page.

New warnings for this version:

This release requires Java 1.6.

To allow use of UTF-8 characters (special characters with accents, Japanese text, etc) in XML files, particularly decoder definitions, the default file encoding has been changed to UTF-8. This requires a change to the startup scripts distributed with JMRI. If you're just using the JMRI-provided startup tools, you should be all set. This was done in JMRI 3.1.7, so if you installed that, you're OK now. If you're using your own custom startup scripts, you need to add a "-Dfile.encoding=UTF-8" option to them. If you have any problems with special characters in your existing files, please let us know as soon as possible.

Known problems with this release

This release has a problem with MS100 mode. If you have an MS100 working with an earlier release, please stay with that until a fix is announced in some later release.

Download links:

Please use these links for downloading:

Changes since production release 3.0

Dan Boudreau made the following changes to operations:

• Improved how cars are forwarded to alternate tracks. Now if the alternate track's spur becomes available during the build, cars originally sent to the alternate are now redirected to the spur.
• Made some minor improvements to the train build reports when a train departs or enters staging.
• Improved how the csv manifest counts empty cars with custom loads.
• New operations feature, you can now control if arrival or departure times are shown on your train manifests. See under "Edit Train"->Tools->Options
• You can now open a csv manifest directly from the trains window.
• When building a train, the move list is no longer in alphabetical order.
• You can now force a car or locomotive to any track when using the "Set" window.
• You can now reset the move counts for cars and locos. See under Tools->Roster in the Cars and Locomotives window.
• Train, car, and locomotive log files are now only created when there's data to save. This should eliminate empty log files.
• Fixed a bug where all cars in a kernel were being checked when selecting a track from staging. Only the lead car in the kernel should have been checked.
• The train log now includes the build failure messages
• You can now have your manifest show the departure time rather than the estimated arrival time. See Print Options for more information
• The schedules window status has been improved to show more cases where a schedule has a problem.
• The edit train window will now only launch one edit route window
• Train reset in the Trains window now checks to see if the departure staging track was allocated to another in bound train. This prevents using reset for the departure train, and then ending up with two trains on the same staging track.
• You can now allow cars to return to staging by train. The train has to be a turn, it must depart and return to the same staging location. The option can be found under Edit Train -> Tools, Train Build Options.
• New feature "Show Cars in Train" can be found under Tools in the Conductor window or from the train icon menu. Now you can see which cars are in the train at the various locations, and where picked up cars are to be placed in the train.
• New feature for trains, you can now prevent local moves even when using custom loads. You can also prevent through traffic from origin to terminal. See under Edit Train, Tools, Train Build Options.
• Now when you select a car type in the location window, the program will bring up the "Modify location by car type" window. Now you can quickly see which tracks will service the car type selected.
• Removed switch list and build report options from the Print Options window. Build report options now have their own window. Switch list options were moved the switch list window that is launched by the "Switch List" button in the Trains window.
• Increased the number of fonts available for operations. Only monospaced fonts are now available if you've selected tabular manifests and switch lists.
• Improved the train build reports. Now the build report separates each car being processed by a line break in very detailed mode.
• Fixed a problem with selecting the "Courier" font that was introduced in 3.1.5.
• Fixed a problem with the Switch List window not appearing when the default printer wasn't specified on the PC. We only know of one user that has experienced this problem, might be related to one of the newer versions of JAVA.
• Additional improvements to the train build report, a better description of location moves.

Gregory Madsen made the following changes to operations:

• Improvements to the Backup capabilities, including separate stores for "automatic" and "default" backups, dialog to select between automatic and regular backups when restoring, and a dialog to allow deleting automatic backups.

Kevin Dickerson made the following changes

• Hardware Support
  
  • Added in initial support for the M%auml;rklin Command Station 2 System with help from Jean-Francois
  • ESU ECOS - Only update the throttle speed on the reply of the last throttle message which has been sent and ignore the event messages until all set speed messages have been processed, otherwise the throttle speed value jumps up and down like a yoyo until the last message is proceed.
  • ESU ECOS - Update the loco import to blank out disabled functions and set non-descript function labels to be Fx.
  • ESU ECOS - Update some of the back end code relating to the Ecos loco database
  • ESU ECOS - Update throttle code to allow 14/28/128 speed steps
  • ESU ECOS - Update some of the back end code relating to the turnout and throttle control
  • ESU ECOS added support for multi-protocol throttle
  • NCE USB - Updated the throttle so that speed step 1 (as shown in the GUI) actually sets the loco speed.
  • Updated the backend of the Connection Configuration to remove some limitations on the numbers of settings per connection
  • Tweaked some of the GUI settings relating to the connection details
  • Added back in the PR3 Standalone option in the connection details
• DecoderPro3 / Roster
  
  • Fixed an issue where the splash screen was not displayed at startup and the buttons added at Startup were not displayed.
  • Added the option to suppress the quitting application message.
  • Fixed an issue in DP3 that caused an issue with the preference file
  • Roster - Fix an issue that corrupted the roster index if the roster was saved while a newly created unsaved roster entry was open.
  • Decoder Selection Tree - Decoder family groups are now kept together within the Manufacturer list
  • Programming - Fix an issue whereby the code doesn't wait for a reply to a programming command and other messages are sent/processed. This happens if no message is required to put the command station into programming mode.
• Throttles
  
  • Provide support for systems that can handle multi-protocols for throttle control and extend this to cover decoders and roster entries. Additional supported protocols now include
    • Motorola
    • Selectrix
    • MFX
    The change is only seen if the system that controls the throttle supports multiple protocols.
  • Throttles - Provide a method to create a throttle by passing the Roster Entry rather than the DCC Address
  • Throttles/Roster Entries - Records the duration that the loco has been operating for, along with the last time last was used, the information is stored as an attribute against the roster entry and can be viewed in the media pane.
• Tables
  
  • User set column widths, order, sorting etc is now saved between sessions
  • Added a "Copy User Name" item to the mouse popup menu
  • Remove the un-necessary question when adding a username to an item for the first time if the item has yet to be used.
  • Fixed a potential error that could occur when loading a panel file if the turnout table was already open.
  • Turnout Table - The feedback sensor selection is now done via a drop down list rather
  • Block Table - The unit length is now remembered between sessions
• Editors
  
  • Fix an issue where memory icons that load with an empty string value, the saved background color is ignored and subsequently lost
  • Provided a method for external code to add menu items to the popupmenus of icons on the panel
  • Layout Editor - Fixed an issue with the SSL Logic for a slip icon that resulted in a diverging route not being set for limited speed correctly.
• Auto Dispatcher
  
  • If a train has been created using a roster entry, the roster entry is now passed to the throttle manager rather than just the address, this allows use roster entries and systems that support multiple protocols, it also allows the use of the loco to be recorded in the roster entry
  • Fix a couple of Index Out Of Bounds Exceptions
  • Fix an issue where a loco set to a paused state would never restart
• Entry Exit (NX)
  
  • Added the option to set the action when the NX sensors are selected a second time.
  • The cancel/clear route option can now be accessed via mouse pop-up on the source sensor icon in a panel
• When setting a sensor in a block, if that sensor has a reporter associated against it the user is asked if they wish to use the reporter on that block.
• Logix - Fix bug 3565824 - create Logix button staying disabled.
• Abstract Automation - Assign the name to the thread to help identify any issues caused by the thread

Steve Todd made the following changes:

• added a new JmriFaceless app for linux installs, and modified WiThrottle server and Loconet simulator to not show a window when JMRI is running in headless mode.
• added the binaries needed by the Raspbian hard-float distro (for the Raspberry Pi).

Stephen Lowens:

• updated decoder definitions for Digitrax sound/motor decoders. This version adds CV144 (Dynamic brake volume) and moves Con-cor Zephyr definitions to new file
• provided decoder definitions for Con-cor MP54 and Zephyr models. These use Digitrax SDH164D and/or SDN144PS with unique programming and/or sound projects.

D Heap:

LokSound V4.0 Decoder CV249 (Min Steam Chuff Distance) was inadvertently assigned to CV248 instead of CV249. Also some others I wanted were missing, so I added CVs 47,48,51,122,123,129,130,133,250,255, which were the ones missing but present in LokProgrammer 4.3.3 and present in LokSound V4.0 Instruction manual 4. Edition, May 2012 from firmware 4.6. CV131 appears to be obsolete but I did not remove it. Had to move a few option numbers up and down to fit all on to existing panes.

John Crellin updated several MRC decoders and provided a new definition for the MRC 1905.

Pete Cressman made the following changes:

• TextLabels, LocoIcons, SensorIcons in text display mode, MemoryDisplayIcons can be rotated to any angle along with any margin or border decorations they have.
• LocoIcons may have a "docking location" specified.
• Sensor overlay bug fixed.
• Picklist will retain user's location.

Steve Todd made the following changes:

• add initial /panel/ servlet support for Layout Editor and Control Panel panels.
• add a web page for drawing panels in the browser (supports only limited number of elements now)

Several additional features have been added to the OpenLCB support, including:

• an updated node browser that directly lets you configure boards
• improvements to the specific configuration tools
• added a built-in hub for Internet access to your OpenLCB. Start the hub from the OpenLCB menu or a startup item, the connect your iPhone via port 12021.
• support in JMRI throttles for access to an OpenLCB command station
• the OpenLCB monitor now shows formatted messages.
• If you define a sensor for OpenLCB using just one event, it will work in a momentary fashion.

Mike Mosher:

• contributed a decoder definition for the MTH Expanded DCC decoder.
• did a major update to the QSI Version 8 decoder definitions
• updated the ESU LokSound Select decoder definitions, and the SoundTraxx MC IMRC and Genesis decoder definitions.

Jack Shall contributed an update to the Tsunami diesel decoder definition to add the GN1000 series and EMD 645 (non_turbo)

Clint Taylor improved the LocoNet slot monitor.

• added code to allow function buttons to work within the Loconet Slot Monitor.
• Loconet Slot monitor will refresh if cmd station ops sw 36, 37, 38, or 39 is set to closed 'c'. This is Feature Request 1876188 which specifically asked for Ops SW 36, but there is no reason to limit to sw 36, since 39 will erase all slots memory.
• The Loconet Slot monitor function Key were active for System Slots. This could have caused Command Station configuration issues. As a result of this change Function Keys F1-F8, E Stop button, and Free button will not longer work for the reserved system slots which are above slot 120.

Steve Todd made the following changes:

• fixed issue with xmlio server which was preventing multiple clients from getting updates.
• added layoutblocks to /panel servlet
• added signalhead list and monitoring to /xmlio servlet
• multiple enhancements to showPanel.js, now handles majority of panel widgets
• corrected outdated help regarding JMRI Web Server and added details of new and modified components.

Bob Bucklew contributed a set of six wider lever icons that use the same graphic but are placed on a wider transparent background. These are easier to use with touch panels, but also work well with mouse or trackball clicks. The larger target is especially useful when used with a 3 position multi sensor icon. They are available in the /resources/icons/USS/plate/levers/ directory.

Robin Becker:

• contributed a set of code buttons to match Bob Bucklew's wider lever icons.
• fixed a nasty, long-standing problem with how various complicated variable definitions in DecoderPro interacted. This could, under the right circumstances, cause reading or writing of the decoder to hang permanently.
• provided a new Tam Valley Quad Ln decoder definition.
• added xxx-blink-web.gif icons with correct frame delays and dimensions for web and panel use.

Dick Bronson provided signal definitions for the Norfolk Southern Corporation 2008 operating rule book (NORAC).

Ken Cameron made the following changes:

• NCE Cab Monitor - Converted to using table format for the cab detail display

Pete Cressman made the following changes:

• Added ability to draw shapes (rectangles, circles etc) in ControlPanelEditor. Note: Use Shift key to select for dragging or popup (expected usage is to overlay panel items).
• Added let Warrants run automated trains without them occupying the starting block - thus warrants can be chained dynamically.

Dave Heap improved the ESU LokSoundV4.0 and LokSound Select decoder definitions.

Nigel Cliffe provided definition files for two Harman DIY decoders.

Dick Bronson updated the RR-CirKits LNCP definition file.

Randall Wood made the following changes:

• Added JSON server at port 2056
• Added JSON WebSocket services to the web server

Steve Todd made the following changes:

• Changed Linux startup script to distinguish hard vs. soft float arm libraries.
• Added Operations data to json servers (trains, locations, engines, cars).
• Initial version of browser-based Operations functions (train list and manifest).
• Fixed issue with WiThrottle handling of wildcard multi-throttles (seen with EngineDriver only).
• Added signalmast list and monitoring to xmlio server, added memory and signalmast to json servers
• Added signalmast aspect image list to /panel servlet

Enzo Fortuna provided an full Italian translation. (There are still a few bits of English that will require some code changes)

Fixed a problem where CAN interfaces might pick up the wrong protocol name in the preferences.

To allow use of UTF-8 characters (special characters with accents, Japanese text, etc) in XML files, particularly decoder definitions, the default file encoding has been changed to UTF-8. This requires a change to the startup scripts distributed with JMRI. If you're using your own custom startup scripts, you need to add a "-Dfile.encoding=UTF-8" option to them.

Added RailStars Limited to the list of decoder manufacturers (company has been around for a while, but the NMRA C&I Department hasn't updated their list in more than 18 months).

Tighe Kuykendall provided some documentation updates and fixes.

Ken Cameron edited the BN-1989 signal mast set to have required specific aspects and a basic set of aspect mapping.

James Koretsky submitted icon files for the BN-1989 and aspects.

Mark Underwood submitted the following changes to Virtual Sound Decoder

• Sound will now follow the locomotive if you use one of the following location tracking systems:
  • Digitrax Transponding (verified)
  • RPS (not verified)
  • RFID (not verified)
  • Dcc4PC (not verified)
  • ECoS (not verified)
• Listener position does not have to be the origin now.
• Roster "Save" button on the VSD window now saves to the file on disk
• New Diesel engine model (still under development)

If you have one of the location reporting hardware systems listed above as "not verified", and would like to help verify correct operation, please contact Mark (user "twindadrails") on the JMRI Users Group.

Stephen Lowens provided a decoder definition for the Tsunami for Rapido FP9A.

Nigel Cliffe and Mark Waters added some new Zimo Unified Software decoder definitions.

Gert Muller fixed a problem preventing the help page from showing for the preference pane.

Bob Milhaupt removed OpSw 36 from the DCS51 configuration page, as it's not supported by that command station.

Bryan Vianco provided two MRC decoder definitions

Layout Editor - The click area for turnouts now increases to match larger turnout circle sizes (Steve Todd)

Nigel Cliffe updated the Zimo programming script for additional functions

Matthew Harris made the following changes:

• Updated the About dialog to now incorporate the application name in the title bar and to include copyright information in the window itself.
• Following input from Dave Merrill, updated the audio documentation to better clarify the use of velocity with audio sources.

Mark Waters updated the Zimo version 28, 30 and 31 decoders.

Mark Underwood made changes to Virtual Sound Decoder:

• New, consolidated user interface keeps all decoders in one window
• New locations manager makes setting physical locations easier
• New, smoother sounding Diesel engine model
• Numerous bug fixes in various areas (and, likely, new bugs!)
• Usability improvements including tool tips
• "Load VSD Files" window remembers the last folder you visited
• New Listener model handles listener location and orientation
• New Validator catches errors in VSD files when the file is loaded

Dan Boudreau fixed a problem with window size on Mac OS X

---