1
0
mirror of https://github.com/DCC-EX/CommandStation-EX.git synced 2024-12-04 13:25:03 +01:00
CommandStation-EX/config.example.h

328 lines
14 KiB
C
Raw Normal View History

2021-04-14 22:46:29 +02:00
/*
2022-10-24 05:12:56 +02:00
* © 2022 Paul M. Antoine
2022-01-07 02:28:35 +01:00
* © 2021 Neil McKechnie
2023-06-03 22:01:14 +02:00
* © 2020-2023 Harald Barth
2022-01-07 02:28:35 +01:00
* © 2020-2021 Fred Decker
* © 2020-2021 Chris Harlow
* © 2023 Nathan Kellenicki
2021-04-14 22:46:29 +02:00
*
* This file is part of CommandStation-EX
*
* This is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
*
* It is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with CommandStation. If not, see <https://www.gnu.org/licenses/>.
*/
2021-04-14 22:46:29 +02:00
/**********************************************************************
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
The configuration file for DCC-EX Command Station
**********************************************************************/
2023-06-03 22:01:14 +02:00
/////////////////////////////////////////////////////////////////////////////////////
// If you want to add your own motor driver definition(s), add them here
// For example MY_SHIELD with display name "MINE":
// (remove comment start and end marker if you want to edit and use that)
/*
#define MY_SHIELD F("MINE"), \
new MotorDriver( 3, 12, UNUSED_PIN, 9, A0, 5.08, 3000, A4), \
new MotorDriver(11, 13, UNUSED_PIN, 8, A1, 5.08, 1500, A5)
*/
/////////////////////////////////////////////////////////////////////////////////////
// NOTE: Before connecting these boards and selecting one in this software
// check the quick install guides!!! Some of these boards require a voltage
// generating resistor on the current sense pin of the device. Failure to select
// the correct resistor could damage the sense pin on your Arduino or destroy
// the device.
//
2023-06-03 22:01:14 +02:00
// DEFINE MOTOR_SHIELD_TYPE BELOW. THESE ARE EXAMPLES. FULL LIST IN MotorDrivers.h
//
2020-09-26 22:56:35 +02:00
// STANDARD_MOTOR_SHIELD : Arduino Motor shield Rev3 based on the L298 with 18V 2A per channel
// POLOLU_MOTOR_SHIELD : Pololu MC33926 Motor Driver (not recommended for prog track)
// FUNDUMOTO_SHIELD : Fundumoto Shield, no current sensing (not recommended, no short protection)
// FIREBOX_MK1 : The Firebox MK1
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
// FIREBOX_MK1S : The Firebox MK1S
// IBT_2_WITH_ARDUINO : Arduino Motor Shield for PROG and IBT-2 for MAIN
2023-06-03 22:01:14 +02:00
// EX8874_SHIELD : DCC-EX TI DRV8874 based motor shield
2020-09-26 22:56:35 +02:00
// |
// +-----------------------v
//
2020-09-26 22:56:35 +02:00
#define MOTOR_SHIELD_TYPE STANDARD_MOTOR_SHIELD
//
/////////////////////////////////////////////////////////////////////////////////////
//
// If you want to restrict the maximum current LOWER than what your
// motor shield can provide, you can do that here. For example if you
// have a motor shield that can provide 5A and your power supply can
// only provide 2.5A then you should restict the maximum current to
// 2.25A (90% of 2.5A) so that DCC-EX does shut off the track before
// your PS does shut DCC-EX. MAX_CURRENT is in mA so for this example
// it would be 2250, adjust the number according to your PS. If your
// PS has a higher rating than your motor shield you do not need this.
// You can use this as well if you are cautious and your trains do not
// need full current.
// #define MAX_CURRENT 2250
//
/////////////////////////////////////////////////////////////////////////////////////
//
// The IP port to talk to a WIFI or Ethernet shield.
//
#define IP_PORT 2560
/////////////////////////////////////////////////////////////////////////////////////
//
// NOTE: Only supported on Arduino Mega
// Set to false if you not even want it on the Arduino Mega
//
#define ENABLE_WIFI true
/////////////////////////////////////////////////////////////////////////////////////
//
// DEFINE WiFi Parameters (only in effect if WIFI is on)
//
2020-11-17 15:16:45 +01:00
// If DONT_TOUCH_WIFI_CONF is set, all WIFI config will be done with
2020-11-14 13:17:47 +01:00
// the <+> commands and this sketch will not change anything over
2020-11-17 15:16:45 +01:00
// AT commands and the other WIFI_* defines below do not have any effect.
//#define DONT_TOUCH_WIFI_CONF
2020-11-14 13:17:47 +01:00
//
2020-11-18 23:42:37 +01:00
// WIFI_SSID is the network name IF you want to use your existing home network.
// Do NOT change this if you want to use the WiFi in Access Point (AP) mode.
//
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
// If you do NOT set the WIFI_SSID and do NOT set the WIFI_PASSWORD,
// then the WiFi chip will first try to connect to the previously
// configured network and if that fails fall back to Access Point mode.
// The SSID of the AP will be automatically set to DCCEX_*.
// If you DO set the WIFI_SSID then the WiFi chip will try to connect
// to that (home) network in station (client) mode. If a WIFI_PASSWORD
// is set (recommended), that password will be used for AP mode.
// The AP mode password must be at least 8 characters long.
2020-11-18 23:42:37 +01:00
//
// Your SSID may not contain ``"'' (double quote, ASCII 0x22).
#define WIFI_SSID "Your network name"
2020-11-17 15:16:45 +01:00
//
// WIFI_PASSWORD is the network password for your home network or if
// you want to change the password from default AP mode password
// to the AP password you want.
// Your password may not contain ``"'' (double quote, ASCII 0x22).
#define WIFI_PASSWORD "Your network passwd"
2020-11-17 15:16:45 +01:00
//
// WIFI_HOSTNAME: You probably don't need to change this
#define WIFI_HOSTNAME "dccex"
2020-11-21 23:23:27 +01:00
//
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
// WIFI_CHANNEL: If the line "#define ENABLE_WIFI true" is uncommented,
// WiFi will be enabled (Mega only). The default channel is set to "1" whether
// this line exists or not. If you need to use an alternate channel (we recommend
// using only 1,6, or 11) you may change it here.
#define WIFI_CHANNEL 1
//
// WIFI_FORCE_AP: If you'd like to specify your own WIFI_SSID in AP mode, set this
// true. Otherwise it is assumed that you'd like to connect to an existing network
// with that SSID.
#define WIFI_FORCE_AP false
/////////////////////////////////////////////////////////////////////////////////////
//
// ENABLE_ETHERNET: Set to true if you have an Arduino Ethernet card (wired). This
// is not for Wifi. You will then need the Arduino Ethernet library as well
//
//#define ENABLE_ETHERNET true
/////////////////////////////////////////////////////////////////////////////////////
//
// DEFINE STATIC IP ADDRESS *OR* COMMENT OUT TO USE DHCP
//
//#define IP_ADDRESS { 192, 168, 1, 200 }
/////////////////////////////////////////////////////////////////////////////////////
//
// DEFINE LCD SCREEN USAGE BY THE BASE STATION
//
// Note: This feature requires an I2C enabled LCD screen using a Hitachi HD44780
// controller and a commonly available PCF8574 based I2C 'backpack'.
// To enable, uncomment one of the #define lines below
// define LCD_DRIVER for I2C address 0x27, 16 cols, 2 rows
// #define LCD_DRIVER 0x27,16,2
2023-03-09 16:59:25 +01:00
//OR define OLED_DRIVER width,height[,address] in pixels (address auto detected if not supplied)
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
// 128x32 or 128x64 I2C SSD1306-based devices are supported.
// Use 132,64 for a SH1106-based I2C device with a 128x64 display.
// #define OLED_DRIVER 0x3c,128,32
// Define scroll mode as 0, 1 or 2
// * #define SCROLLMODE 0 is scroll continuous (fill screen if poss),
// * #define SCROLLMODE 1 is by page (alternate between pages),
// * #define SCROLLMODE 2 is by row (move up 1 row at a time).
#define SCROLLMODE 1
// In order to avoid wasting memory the current scroll buffer is limited
// to 8 lines. Some users wishing to display additional information
// such as TrackManager power states have requested additional rows aware
// of the warning that this will take extra RAM. if you wish to include additional rows
// uncomment the following #define and set the number of lines you need.
//#define MAX_CHARACTER_ROWS 12
/////////////////////////////////////////////////////////////////////////////////////
2021-11-30 19:56:09 +01:00
// DISABLE EEPROM
//
// If you do not need the EEPROM at all, you can disable all the code that saves
// data in the EEPROM. You might want to do that if you are in a Arduino UNO
2023-04-19 23:08:11 +02:00
// and want to use the EXRAIL automation. Otherwise you do not have enough RAM
// to do that. Of course, then none of the EEPROM related commands work.
2021-11-30 19:56:09 +01:00
//
2022-10-14 14:20:32 +02:00
// EEPROM does not work on ESP32. So on ESP32, EEPROM will always be disabled,
// at least until it works.
//
2021-11-30 19:56:09 +01:00
// #define DISABLE_EEPROM
2023-04-19 23:08:11 +02:00
/////////////////////////////////////////////////////////////////////////////////////
// DISABLE PROG
//
// If you do not need programming capability, you can disable all programming related
// commands. You might want to do that if you are using an Arduino UNO and still want
// to use EXRAIL automation, as the Uno is lacking in RAM and Flash to run both.
//
// Note this disables all programming functionality, including EXRAIL.
//
// #define DISABLE_PROG
2023-11-23 22:14:24 +01:00
/////////////////////////////////////////////////////////////////////////////////////
// DISABLE / ENABLE VDPY
//
// The Virtual display "VDPY" feature is by default enabled everywhere
// but on Uno and Nano. If you think you can fit it (for example
// having disabled some of the features above) you can enable it with
// ENABLE_VDPY. You can even disable it on all other CPUs with
// DISABLE_VDPY
//
// #define DISABLE_VDPY
// #define ENABLE_VDPY
/////////////////////////////////////////////////////////////////////////////////////
// DISABLE / ENABLE DIAG
//
// To diagose different errors, you can turn on differnet messages. This costs
// program memory which we do not have enough on the Uno and Nano, so it is
// by default DISABLED on those. If you think you can fit it (for example
// having disabled some of the features above) you can enable it with
// ENABLE_DIAG. You can even disable it on all other CPUs with
// DISABLE_DIAG
//
// #define DISABLE_DIAG
// #define ENABLE_DIAG
2021-11-30 19:56:09 +01:00
/////////////////////////////////////////////////////////////////////////////////////
// REDEFINE WHERE SHORT/LONG ADDR break is. According to NMRA the last short address
// is 127 and the first long address is 128. There are manufacturers which have
// another view. Lenz CS for example have considered addresses long from 100. If
// you want to change to that mode, do
//#define HIGHEST_SHORT_ADDR 99
// If you want to run all your locos addressed long format, you could even do a
//#define HIGHEST_SHORT_ADDR 0
// We do not support to use the same address, for example 100(long) and 100(short)
// at the same time, there must be a border.
2024-01-09 01:41:29 +01:00
/////////////////////////////////////////////////////////////////////////////////////
// Some newer 32bit microcontrollers boot very quickly, so powering on I2C and other
// peripheral devices at the same time may result in the CommandStation booting too
// quickly to detect them.
// To work around this, uncomment the STARTUP_DELAY line below and set a value in
// milliseconds that works for your environment, default is 3000 (3 seconds).
// #define STARTUP_DELAY 3000
/////////////////////////////////////////////////////////////////////////////////////
//
// DEFINE TURNOUTS/ACCESSORIES FOLLOW NORM RCN-213
//
// According to norm RCN-213 a DCC packet with a 1 is closed/straight
// and one with a 0 is thrown/diverging. In DCC++ Classic, and in previous
// versions of DCC++EX, a turnout throw command was implemented in the packet as
// '1' and a close command as '0'. The #define below makes the states
// match with the norm. But we don't want to cause havoc on existent layouts,
// so we define this only for new installations. If you don't want this,
// don't add it to your config.h.
//#define DCC_TURNOUTS_RCN_213
// By default, the driver which defines a DCC accessory decoder
// does send out the same state change on the DCC packet as it
// receives. This means a VPIN state=1 sends D=1 (close turnout
// or signal green) in the DCC packet. This can be reversed if
// necessary.
//#define HAL_ACCESSORY_COMMAND_REVERSE
// If you have issues with that the direction of the accessory commands is
// reversed (for example when converting from another CS to DCC-EX) then
// you can use this to reverse the sense of all accessory commmands sent
// over DCC++. This #define likewise inverts the behaviour of the <a> command
// for triggering DCC Accessory Decoders, so that <a addr subaddr 0> generates a
// DCC packet with D=1 (close turnout) and <a addr subaddr 1> generates D=0
// (throw turnout).
//#define DCC_ACCESSORY_RCN_213
2021-12-05 13:08:59 +01:00
//
// HANDLING MULTIPLE SERIAL THROTTLES
// The command station always operates with the default Serial port.
// Diagnostics are only emitted on the default serial port and not broadcast.
2022-10-24 05:12:56 +02:00
// Other serial throttles may be added to the Serial1, Serial2, Serial3, Serial4,
// Serial5, and Serial6 ports which may or may not exist on your CPU. (Mega has 3,
// SAMD/SAMC and STM32 have up to 6.)
2021-12-05 13:08:59 +01:00
// To monitor a throttle on one or more serial ports, uncomment the defines below.
// NOTE: do not define here the WiFi shield serial port or your wifi will not work.
//
2022-01-23 18:55:00 +01:00
//#define SERIAL1_COMMANDS
//#define SERIAL2_COMMANDS
//#define SERIAL3_COMMANDS
2022-10-24 05:12:56 +02:00
//#define SERIAL4_COMMANDS
//#define SERIAL5_COMMANDS
//#define SERIAL6_COMMANDS
//
// BLUETOOTH SERIAL ON ESP32
// On ESP32 you have the possibility to use the builtin BT serial to connect to
// the CS.
//
// The CS shows up as a pairable BT Clasic device. Name is "DCCEX-hexnumber".
// BT is as an additional serial port, debug messages are still sent over USB,
// not BT serial.
//
// If you enable this there are some implications:
// 1. WiFi will sleep more (as WiFi and BT share the radio. So WiFi performance
// may suffer
// 2. The app will be bigger that 1.2MB, so the default partition scheme will not
// work any more. You need to choose a partition scheme with 2MB (or bigger).
// For example "NO OTA (2MB APP, 2MB SPIFFS)" in the Arduino IDE.
// 3. There is no securuity (PIN) implemented. Everyone in radio range can pair
// with your CS.
//
//#define SERIAL_BT_COMMANDS
// BOOSTER PIN INPUT ON ESP32
// On ESP32 you have the possibility to define a pin as booster input
// Arduio pin D2 is GPIO 26 on ESPDuino32
//
//#define BOOSTER_INPUT 26
// SABERTOOTH
//
// This is a very special option and only useful if you happen to have a
// sabertooth motor controller from dimension engineering configured to
// take commands from and ESP32 via serial at 9600 baud from GPIO17 (TX)
// and GPIO16 (RX, currently unused).
// The number defined is the DCC address for which speed controls are sent
// to the sabertooth controller _as_well_. Default: Undefined.
//
//#define SABERTOOTH 1
/////////////////////////////////////////////////////////////////////////////////////