Below is the change list for this version of firmware. This change list is relative to the last full release, v1.1. The numbers in () refer to issues in our issue tracker:
https://github.com/IowaScaledEngineering/mrbw-cst/issues?q=
The items marked with (^) are explained in more detail below.
New Features:
Added Special Functions menu.
(^)Added Brake Test / Pressure gauge special function.
Added ability to toggle eStop with soft key (#70).
Added brake test menu shortcut to soft keys (#82).
Added CENTERED function that is active when reverser is centered (#76).
Added strict sleep preference bit to enable (or disable) reverser position checking when going to sleep (#85).
(^)Added alerter capability with programmable timeout and function activation.
Momentarily activate functions using the horn lever when in the Force Functions menu (#86)
Updated MRBus EEPROM commands to accept multiple bytes
Added COMM CFG -> ACCEPT DOWNLOAD menu
Improvements:
Extended fast clock timeout (#84)
Added 10s timeout to ENGINE menu, triggered only after pressing a button to start or stop the prime mover.
Moved TX Interval and TX Holdoff to COMM menu (#74).
Reduced engine start/stop delay from 5s to 2s.
Allow engine to be restarted when already started (#66).
Bug Fixes:
Prevent a button press on one menu from spilling over to the next (#79).
Internal Changes (not externally visible):
Refactored function handling code.
Pulled function and EEPROM code into separate files.
Improved EEPROM handling functions.
Refactored LCD special character handling code.
Reworked fast clock timeout code (#75).
Jump automatically to factory reset with fresh EEPROM
Changed EEPROM write and read packet types to address entire memory and handle multiple bytes
Brake Test
The brake test mode simulates pumping of the air and allows the ProtoThrottle operator to perform a brake test, such as after coupling onto a cut of cars. This function can be found under the SPECIAL FUNCS menu.
Upon entering the brake test screen, the pressure gauge and pressure begins rising. It begins at a random pressure around 65 PSI and ends at a random pressure from 89-92 PSI. The pumping rate can be set by PREFS -> PUMP RATE. At any point (though typically after the pressure reaches ~90 PSI) you can perform a brake test by applying a 26 PSI reduction. This is done by moving the brake handle. Note that, while in the brake test mode, the normal operation of the brake handle is disabled. (+++ The reaction of the brake pipe pressure is now (hopefully) more realistic, based on some conversations with a 1:1 locomotive engineer and some additional reading on the topic. +++)
The CONFIG FUNC -> COMPRSR function is activated when in the brake test mode. This should be assigned to a function that activates the compressor on the decoder. For Loksound, consult your decoder manual or function mapping in the Lokprogrammer. For Tsunami2 decoders, this is Brake Select, typically F12. (+++ The compressor stop option (introduced in v1.1.97) has been removed since it was no longer needed after some refactoring of the code and the corresponding state machine +++)
The pumping time can be varied between ~8 seconds and 2min 45sec using the PREFS -> PUMP RATE setting. The default setting of PUMP RATE = 4 (~35sec) works well for Tsunami2 decoders as that matches the ~30 second initial run time of the compressor (and prime mover) sound on the decoder.
The CONFIG FUNC -> BRK TEST function is activated when moving the brake handle while in the brake test mode. This would typically be assigned to a function that creates an air release sound. For Loksound, again consult your decoder manual or the function mapping in the Lokprogrammer. For Tsunami2 decoders, this would be the brake function, typically F11.
For the diehard users, you can assign the UP or DOWN buttons on the main screen as a shortcut into the brake test mode. When setting the button function in CONFIG FUNC, scroll all the way up where you'll find EMRG BRK and BRK TEST options.
To exit the brake test mode, press the MENU or SELECT button.
Alerter
The alerter function is activated by changing PREFS -> ALERTER DLY from OFF to a time value. The alerter time can be set in 15s increments up to 900s. An optional function can also be configured in CONFIG FUNC -> ALERTER. Note that you should set the throttle's sleep delay to a value greater than the alerter time.
The alerter is active whenever the reverser is in the forward or reverse position. When no control on the throttle has been moved for the alerter time minus 10s, the backlight on the LCD screen will begin flashing rapidly and the ALERTER function will be activated. This function could activate the bell or another attention getting sound on the locomotive decoder. Moving a control, or pressing a button, on the throttle will cancel the alerter and reset the timer. If the alerter time expires with no movement of controls on the throttle, the locomotive speed will be set to zero and the BRAKE function will be activated. The LCD will display ALRT where the locomotive number is normally displayed. At this point, the only way to cancel the alerter is to put the throttle in idle and center the reverser.