1
0
mirror of https://github.com/DCC-EX/CommandStation-EX.git synced 2024-11-25 09:06:13 +01:00
CommandStation-EX/version.h

129 lines
8.3 KiB
C
Raw Permalink Normal View History

2020-09-24 03:53:33 +02:00
#ifndef version_h
#define version_h
#include "StringFormatter.h"
2023-05-20 17:35:09 +02:00
#define VERSION "4.1.6"
// 4.1.6 Support DCC-EX shield
2023-02-12 20:38:03 +01:00
// 4.1.5 Bugfix LCN number parsing
// 4.1.4 Bugfix for issue #299 TurnoutDescription NULL
2022-11-04 15:39:35 +01:00
// 4.1.3 Bugfix: Ethernet init order
// 4.1.2 Bugfix: Ethernet shield W5100 does not report HW or link level
// 4.1.1 Bugfix: preserve turnout format
2022-10-21 17:57:55 +02:00
// Bugfix: parse multiple commands in one buffer string correctly (ex: <s><Q>)
// Bugfix: </> command signal status of EX-RAIL tasks or threads
2022-09-13 22:46:43 +02:00
// Bugfix: EX-RAIL read long loco addr
2022-10-21 17:57:55 +02:00
// Bugfix: Add space character after version string 4.1.1 for JMRI parsing.
// Improved display and loop time for signals make service start to be outside the DONT_TOUCH_WIFI_CONF area
2022-10-21 17:57:55 +02:00
// Improve WiFi startup by making service start to be outside the DONT_TOUCH_WIFI_CONF area
// 4.1.0 ...
// UNO Progmem optimized to allow for small EXRAIL Automation scipts
// 4.0.2 Command Station and EX-RAIL Ehancements & Additions:
// New JA, JR, JT commands availabe for Throttle Developers to obtain Route, Roster and Turnout descriptions for communications
2022-10-28 20:05:35 +02:00
// Change ACK defaults now set to LIMIT 50mA, MIN 2000uS, MAX 20000uS for more compatibility with non NMRA compliant decoders
// New Commands for the Arduino IDE Serial Monitor and JMRI DCC++ Traffic Monitor
// </RED signal_id> to turn a individual LED Signal On & Off
// </AMBER signal_id> "
// </GREEN signal_id> "
// </KILL ALL> command to stop all tasks, and Diagnostic messages when KILL is used
// <t cab> command to obtain current throttle settings
// Allow WRITE CV on PROG <W CV VALUE>
2022-10-21 17:57:55 +02:00
// Updated CV read command <R cv>. Equivalent to <V cv 0>. Uses the verify callback.
// Change callback parameters are now optional on PROG
// Code: Fix weak reference to myFilter
Servo signal (#227) Prepping for version 4.1 SERVO_SIGNAL definition in EXRAIL SERVO_SIGNAL(vpin, redpos, amberpos, greenpos) use RED/AMBER/GREEN as for led signals. * SIGNALH, ATGTE, ATLT UNTESTED * Automatic ALIAS(name) and _ in keywords * EXRAIL FORGET current loco * EXRAIL </KILL ALL> * EXRAIL VIRTUAL_TURNOUT * Cleanup version.h * Update version.h (#223) Rewrite & Updated the 4.0.0 Section * </KILL ALL> fix * Incoming LCN turnout throw. * KILLALL macro and DIAGNOSTIC messages when KILL command used. * EXRAIL PARSE * Rebuild throttle info getters UNTESTED... create different methods to obtain throttle info without being withrottle specific. Also implements turnout description of "*" as hidden. * J command parsing JA JR JT commands parsed EXRAIL sets hidden turnout state HIDDEN description macro Turnouts hidden flag bit UNO seems OK, MEGA UNTESTED * Assist notes draft & syntax tweaks * Throttle notes * uno memory saver * JA JR and <t cab> * Subtle corrections * Update version.h * I2C code corrections Corrections to I2C code: 1) I2CManager_Mega4809.h: Correct bitwise 'and' to logical 'and' - no impact. 2) I2CManager_Wire.h: Ensure that error codes from Wire subsystem are passed back to caller in queueRequest(). * RAG Ifs and cmds * IF block perf/memory * Allow negative route ids. * correct GREEN keyword * Update version.h * myFilter auto detect * Update version.h * fix weak ref to myFilter * ACK defaults now 50-2000-20000 * Update version.h * Improved SIGNALs startup and diagnostics * Update IO_PCA9685.cpp * Allow turnout id 0 * Position servo pin used as GPIO * NoPowerOff LEDS * CALLBACK parameter optional for Write * WRITE CV ON PROG <W CV VALUE> Callback parameters are now optional on PROG * Updated CV read command <R cv> Equivalent to <V cv 0> uses the verify callback. Co-authored-by: Asbelos <asbelos@btinternet.com> Co-authored-by: Kcsmith0708 <kcsmith0708@wowway.com> Co-authored-by: Neil McKechnie <neilmck999@gmail.com> Co-authored-by: Ash-4 <81280775+Ash-4@users.noreply.github.com>
2022-05-03 22:53:33 +02:00
// myFilter automatic detection (no need to call setFilter)
// Improved SIGNALs startup and diagnostics
2022-10-21 17:57:55 +02:00
// Incoming LCN turnout throw
// Allow turnout ID of "0"
// Code: struct TurnoutData to enable EEPROM in v 4.0 format
2022-10-21 17:57:55 +02:00
// Broadcast jopin after DriveAway
// Corrections to I2C code:
// 1) I2CManager_Mega4809.h: Correct bitwise 'and' to logical 'and' - no impact.
// 2) I2CManager_Wire.h: Ensure that error codes from Wire subsystem are passed back to caller in queueRequest().
// New EX-RAIL Functions to use in Automation(n), ROUTE(N) & SEQUENCE(N) scripts
// Automatically assign a name with ALIAS(name) without having to define it first
// ALIAS now has the aility to use Low underscore in keywords e.g., MY_KEYWORD
// ATGTE & ATLT wait for analog value, (At Greater Than or Equal and At Less Than a certain value)
// FADE command now works for LEDs connected on PCA9685 Servo/Signal board Output vpins
// FORGET Forgets the current loco in DCC reminder tables saving memory and wasted packets sent to the track
// "IF" signal detection with IFRED(signal_id), IFAMBER(signal_id), IFGREEN(signal_id)
// KILLALL command to stop all tasks, and Diagnostic messages when KILL is used
// PARSE <> commands in EXRAIL allows sending of DCC-EX commands from EX-RAIL
// SERVO_SIGNAL Servo signals assigned to a specific servo turnout
// SIGNALH High-On signal pins (Arduino normally handles active LOW signals. This allows for active HIGH)
// HIDDEN turnouts (hide a REAL turnout and create a VIRTUAL turnout to handle actions that happen BEFORE a turnout is thrown)
// VIRTUAL_TURNOUT definition
// README.md: removed misleading "folder/subforlders" (#218)
// README.md: fix dead link to rewrite (#217) in notes/rewrite.md
// 4.0.1 Additional EXRAIL updates
Servo signal (#227) Prepping for version 4.1 SERVO_SIGNAL definition in EXRAIL SERVO_SIGNAL(vpin, redpos, amberpos, greenpos) use RED/AMBER/GREEN as for led signals. * SIGNALH, ATGTE, ATLT UNTESTED * Automatic ALIAS(name) and _ in keywords * EXRAIL FORGET current loco * EXRAIL </KILL ALL> * EXRAIL VIRTUAL_TURNOUT * Cleanup version.h * Update version.h (#223) Rewrite & Updated the 4.0.0 Section * </KILL ALL> fix * Incoming LCN turnout throw. * KILLALL macro and DIAGNOSTIC messages when KILL command used. * EXRAIL PARSE * Rebuild throttle info getters UNTESTED... create different methods to obtain throttle info without being withrottle specific. Also implements turnout description of "*" as hidden. * J command parsing JA JR JT commands parsed EXRAIL sets hidden turnout state HIDDEN description macro Turnouts hidden flag bit UNO seems OK, MEGA UNTESTED * Assist notes draft & syntax tweaks * Throttle notes * uno memory saver * JA JR and <t cab> * Subtle corrections * Update version.h * I2C code corrections Corrections to I2C code: 1) I2CManager_Mega4809.h: Correct bitwise 'and' to logical 'and' - no impact. 2) I2CManager_Wire.h: Ensure that error codes from Wire subsystem are passed back to caller in queueRequest(). * RAG Ifs and cmds * IF block perf/memory * Allow negative route ids. * correct GREEN keyword * Update version.h * myFilter auto detect * Update version.h * fix weak ref to myFilter * ACK defaults now 50-2000-20000 * Update version.h * Improved SIGNALs startup and diagnostics * Update IO_PCA9685.cpp * Allow turnout id 0 * Position servo pin used as GPIO * NoPowerOff LEDS * CALLBACK parameter optional for Write * WRITE CV ON PROG <W CV VALUE> Callback parameters are now optional on PROG * Updated CV read command <R cv> Equivalent to <V cv 0> uses the verify callback. Co-authored-by: Asbelos <asbelos@btinternet.com> Co-authored-by: Kcsmith0708 <kcsmith0708@wowway.com> Co-authored-by: Neil McKechnie <neilmck999@gmail.com> Co-authored-by: Ash-4 <81280775+Ash-4@users.noreply.github.com>
2022-05-03 22:53:33 +02:00
// EXRAIL BROADCAST("msg")
2022-10-21 17:57:55 +02:00
// EXRAIL POWERON (only turns on MAIN)
// Remove optional EXRAIL/ENDEXRAIL from myAutomation.example.h (#215)
2022-10-21 17:57:55 +02:00
// Use "startup sequence" to describe the initial instructions
// Add description of display scroll modes
// GetLocoCallback() restructured for better readability and put broadcastPower() at right place
// 4.0.0 Major Production Release with New Functional and non-functional changes.
// Engine Driver "DriveAway" feature enhancement
// 'Discovered Server' multicast Dynamic Network Server (mDNS) displays available WiFi connections to a DCC++EX Command Station
// New EX-RAIL "Extended Railroad Automation Instruction Language" automation capability.
// EX-Rail Function commands for creating Automation, Route & Sequence Scripts
// EX-RAIL “ROSTER” Engines Id & Function key layout on Engine Driver or WiThrottle
// EX-RAIL DCC++EX Commands to Control EX-RAIL via JMRI Send pane and IDE Serial monitors
// New JMRI feature enhancements;
// Reads DCC++EX EEPROM & automatically uploades any Signals, DCC Turnouts, Servo Turnouts, Vpin Turnouts , & Output pane
// Turnout class revised to expand turnout capabilities, new commands added.
// Provides for multiple additional DCC++EX WiFi connections as accessory controllers or CS for a programming track when Motor Shields are added
// Supports Multiple Command Station connections and individual tracking of Send DCC++ Command panes and DCC++ Traffic Monitor panes
// New HAL added for I/O (digital and analogue inputs and outputs, servos etc)
// Automatically detects & connects to supported devices included in your config.h file
// Support for MCP23008, MCP23017 and PCF9584 I2C GPIO Extender modules.
// Support for PCA9685 PWM (servo) control modules.
// Support for analogue inputs on Arduino pins and on ADS111x I2C modules.
// Support for MP3 sound playback via DFPlayer module.
// Support for HC-SR04 Ultrasonic range sensor module.
// Support for VL53L0X Laser range sensor module (Time-Of-Flight).
// Added <D HAL SHOW> diagnostic command to show configured devices
// New Processor Support added
// Compiles on Nano Every and Teensy
// Native non-blocking I2C drivers for AVR and Nano architectures (fallback to blocking Wire library for other platforms).
// Can disable EEPROM code
// EEPROM layout change - deletes EEPROM contents on first start following upgrade.
// Output class now allows ID > 255.
// Configuration options to globally flip polarity of DCC Accessory states when driven from <a> command and <T> command.
// Increased use of display for showing loco decoder programming information.
2021-11-30 20:11:45 +01:00
// Can define border between long and short addresses
// Turnout and accessory states (thrown/closed = 0/1 or 1/0) can be set to match RCN-213
2021-12-21 13:26:16 +01:00
// Bugfix: one-off error in CIPSEND drop
// Bugfix: disgnostic display of ack pulses >32kus
// Bugfix: Current read from wrong ADC during interrupt
// 3.2.0 Development Release Includes all of 3.1.1 thru 3.1.7 enhancements
2021-11-07 16:04:49 +01:00
// 3.1.7 Bugfix: Unknown locos should have speed forward
2021-07-31 15:40:32 +02:00
// 3.1.6 Make output ID two bytes and guess format/size of registered outputs found in EEPROM
// 3.1.5 Fix LCD corruption on power-up
// 3.1.4 Refactor OLED and LCD drivers and remove unused code
2021-06-11 01:03:38 +02:00
// 3.1.3 Add a loop delay to give more time for sensing an Ethernet cable connection
2021-06-10 20:23:57 +02:00
// 3.1.2 Eliminate wait after write when prog is joined or prog power is off
2021-06-10 20:06:59 +02:00
// 3.1.1 SH1106 OLED Display Offset Fix
// 3.0.16 Ignore CV1 bit 7 read rejected by decoder when identifying loco id.
// 3.0.15 only send function commands once, not 4 times
// 3.0.14 gap in ack tolerant fix, prog track power management over join fix.
// 3.0.13 Functions>127 fix
// 3.0.12 Fix HOSTNAME function for STA mode for WiFi
// 3.0.11 28 speedstep support
2021-03-31 00:19:32 +02:00
// 3.0.10 Teensy Support
2021-03-30 23:01:37 +02:00
// 3.0.9 rearranges serial newlines for the benefit of JMRI.
// 3.0.8 Includes <* *> wraps around DIAGs for the benefit of JMRI.
2021-03-24 11:36:26 +01:00
// 3.0.7 Includes merge from assortedBits (many changes) and ACK manager change for lazy decoders
// 3.0.6 Includes:
// Fix Bug that did not let us transmit 5 byte sized packets like PoM
2021-03-09 03:50:11 +01:00
// 3.0.5 Includes:
// Fix Fn Key startup with loco ID and fix state change for F16-28
Nano every2 (#129) * Start adding back unowifi stuffz * Uno Wifi compiling * Fixes for compile arduino unowifi r2 * FlasString and Timers for Uno Wifi ALL these changes should be portable back to master * Remove extra timer that was already added * Changed to EveryTimerB * Add everytimerb.h * Cleanup * Linear address <a> cmd * Allow lower case keywords * Add the F define to be on safe side if it is not present in the library core code * Clean simple Timer interface Removes overkill files, puts all timer in a single small file. (DCCTimer) * Timer port * Timer working And slow wave command removed * Correcting non-portables merged from master * Wave-state machine ( part 11) * Microtuning waveform Significant reduction in code paths and call overheads * Current check cleanup * Fix no-loco id Has to handle -1 correctly * fix wrong format letter * redo flow through wifisetup again * version++ * bugfixes wifi setup * Retry harder for AP mode * Remove unued if * DIO2 replacement Currently for writing signal pins during waveform. * Drop analogReadFast (see DCCTimer) AnalogRead speed set in DCCTimer for ease of porting. Code tidy and diagnostics in MotorDriver * UNTESTED fast power,brake,fault pins * Distunguish between in/out of FASTPIN * minor performance tweaks * Config comments and example use * Config/example loading * IP/PORT on LCD * Ethernet simulated mac Plus fixed listening port * Github SHA * Committing a SHA * Fix for nano compile * Comments and a reliability fix. * UnoRev2 protection * PWM pin implementation * fix wifi setup issue * Reinstate IP_PORT * Wifi channel and code cleaninga * Reduce duplicated F() macros Compiler isn't as clever as one might expect * Committing a SHA * Update config.example.h Add comment to wifi channel section * Committing a SHA * Handle shields with common fault pins (Pololu) * Committing a SHA * remove warning * Committing a SHA * only do the sha generation on master * yaml syntax * Fast SSD1306 OLED driver Incorporate code from SSD1306Ascii library to speed up OLED screen updates, reduce memory requirements and eliminate some library dependences. * Fix auto-configure from cold boot. Add call to Wire.begin(). * Update comment for OLED_DRIVER define. * Update MotorDrivers.h Add a motor board definition for using the IBT_2 board for a high current to the main track and keep the Arduino Motor Shield for operating the programming track. * Committing a SHA * Fix missing F in motor drivers * JOIN relay pin * Swap Join Relay high/low * Hide WIFI_CONNECT_TIMEOUT This is not what the config suggests it is... The timeout is in the ES and defaults to 15 seconds. Abandoning it early leads to confused setup. * Enhance OLED/LCD speed Write one character or position command per loop entry so as not to hold up the loop. Add support for SH1106 OLED as 132x64 size option. * Enhance OLED/LCD speed * Delete comment about OLED on UNO. * Trim unwanted code * Handle display types correctly * Update comments * Speed up OLED writes Add new flushDisplay() to end any in-progress I2C transaction. Previously, an redundant command was sent that ended the in-progress transaction but also sent another complete, but unnecessary, transaction. * Comments and copyright update * Reduce RAM and flash requirement a few more bytes. * Move statics into LCDDisplay class, and reduce RAM. Some state variables were static in LCDDisplay.write(). Moved to class members. Also, types of data items like row, column & character position changed to int8_t to save a few bytes of RAM. * Type lcdCols and lcdRows to unsigned. Since lcdCols is normally 128, it needs to be uint8_t, not int8_t. * remove timeout from user config * faultpin is common only if it exists ; make code prettier * Rationalisation of SSD1306 driver Merge SSD1306AsciiWire.cpp into SSD1306Ascii.cpp and rename SSD1306AsciiWire.h as SSD1306Ascii.h. Merge allFonts.h into System5x7.h and rename as SSD1306font.h. Move all SSD1306 files into root folder to facilitate compilation in Arduino IDE. * Fix some font attributes as const. * Remove unused initialisation sequences for tiny oled screens * Add m_ to variables * Bump up I2C speed Speed was 100kHz (default). Max for OLEDis 400kHz. * Revert "Bump up I2C speed" This reverts commit 1c1168f43314d3a6855738fbc406d5654e801831. * Bump up I2C speed Speed was 100kHz (default). Max for OLEDis 400kHz. * Drop duplicate DIAG * ignore mySetup.h files * Restore uno to default_envs Restore uno (previously commented out) to default_envs. * Update objdump.bat Allows other editors as Notepad is very slow on large files * Prog Track overload during cv read * Faster LCD Driver Extract LCD driver from library; Trim unused functionality; Reduce I2C communications to minimum; Speed up I2C clock to 400kHz. * Update config.example.h Add IBT_2_WITH_ARDUINO to example config * Update config.example.h * Screen enhancements (#126) * Add I2CManager to coordinate I2C shared parameters. * Add use of I2CManager, and experimental scrolling strategies. New scrolling capability by defining SCROLLMODE in Config.h to 0 (original), 1 (by page) or 2 (by line). If not defined, defaults to 0. * Scrolling updates New scrolling capability by defining SCROLLMODE in Config.h to 0 (original), 1 (by page) or 2 (by line). If not defined, defaults to 0. Reformat. * Add I2CManager calls. Remove unnecessary delays. * Add I2CManager calls, remove unnecessary I2C delays. * SSD1306: Move methods from .h to .cpp and reformat. * Fix compiler warning in LiquidCrystal_I2C * Allow forcing of I2C clock speed. New method forceClock allows the I2C speed to be overridden. For example, if the I2C bus is long then the speed can be forced lower. It can also be forced higher to gain performance if devices are capable. * Make Config.h conditionally included. Allow for non-existence of Config.h. * Correct scrolling and allow longer messages Correct the handling of scrolling in scrollmode 1 to avoid a blank page being displayed. Also, allow MAX_MSG_SIZE to be optionally configured to override maximum message length on screens. * compiler warning on uno Co-authored-by: dexslab <dex35803@gmail.com> Co-authored-by: Asbelos <asbelos@btinternet.com> Co-authored-by: Harald Barth <haba@kth.se> Co-authored-by: Neil McKechnie <neilmck999@gmail.com> Co-authored-by: Neil McKechnie <75813993+Neil-McK@users.noreply.github.com>
2021-03-07 21:58:35 +01:00
// 3.0.4 Includes:
// Wifi startup bugfixes
2021-01-21 12:10:52 +01:00
// 3.0.3 Includes:
// <W addr> command to write loco address and clear consist
// <R> command will allow for consist address
// Startup commands implemented
2020-09-24 03:53:33 +02:00
2020-10-22 20:38:10 +02:00
#endif