2020-09-25 22:14:20 +02:00
|
|
|
/*
|
2022-05-17 12:06:08 +02:00
|
|
|
* © 2022 Paul M Antoine
|
2022-01-07 02:28:35 +01:00
|
|
|
* © 2021 Neil McKechnie
|
|
|
|
|
* © 2021 Mike S
|
|
|
|
|
* © 2021 Fred Decker
|
2022-10-02 22:53:35 +02:00
|
|
|
* © 2020-2022 Harald Barth
|
2022-01-07 02:28:35 +01:00
|
|
|
* © 2020-2021 Chris Harlow
|
|
|
|
|
*
|
|
|
|
|
* 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/>.
|
|
|
|
|
*
|
|
|
|
|
*/
|
2020-09-25 22:14:20 +02:00
|
|
|
|
2021-08-22 23:23:08 +02:00
|
|
|
#ifndef DEFINES_H
|
|
|
|
|
#define DEFINES_H
|
2021-08-23 11:46:12 +02:00
|
|
|
// defines.h relies on macros defined in config.h
|
2021-08-23 12:55:42 +02:00
|
|
|
// but it may have already been included (for cosmetic convenence) by the .ino
|
|
|
|
|
#ifndef MOTOR_SHIELD_TYPE
|
|
|
|
|
#if __has_include ( "config.h")
|
|
|
|
|
#include "config.h"
|
|
|
|
|
#else
|
|
|
|
|
#include "config.example.h"
|
|
|
|
|
#endif
|
2021-08-23 11:46:12 +02:00
|
|
|
#endif
|
|
|
|
|
|
2022-07-06 18:05:34 +02:00
|
|
|
////////////////////////////////////////////////////////////////////////////////
|
|
|
|
|
// Create a cpu type we can share and
|
|
|
|
|
// figure out if we have enough memory for advanced features
|
|
|
|
|
// so define HAS_ENOUGH_MEMORY until proved otherwise.
|
|
|
|
|
#define HAS_ENOUGH_MEMORY
|
2022-08-06 10:53:14 +02:00
|
|
|
#undef USB_SERIAL // Teensy has this defined by default...
|
2022-07-08 16:52:46 +02:00
|
|
|
#define USB_SERIAL Serial
|
2022-07-06 18:05:34 +02:00
|
|
|
|
|
|
|
|
#if defined(ARDUINO_AVR_UNO)
|
|
|
|
|
#define ARDUINO_TYPE "UNO"
|
|
|
|
|
#undef HAS_ENOUGH_MEMORY
|
|
|
|
|
#elif defined(ARDUINO_AVR_NANO)
|
|
|
|
|
#define ARDUINO_TYPE "NANO"
|
|
|
|
|
#undef HAS_ENOUGH_MEMORY
|
|
|
|
|
#elif defined(ARDUINO_AVR_MEGA)
|
|
|
|
|
#define ARDUINO_TYPE "MEGA"
|
|
|
|
|
#elif defined(ARDUINO_AVR_MEGA2560)
|
|
|
|
|
#define ARDUINO_TYPE "MEGA"
|
|
|
|
|
#elif defined(ARDUINO_ARCH_MEGAAVR)
|
|
|
|
|
#define ARDUINO_TYPE "MEGAAVR"
|
2022-07-07 00:46:00 +02:00
|
|
|
#undef HAS_ENOUGH_MEMORY
|
2022-08-06 10:53:14 +02:00
|
|
|
#elif defined(ARDUINO_TEENSY31)
|
|
|
|
|
#define ARDUINO_TYPE "TEENSY3132"
|
|
|
|
|
#undef USB_SERIAL
|
|
|
|
|
#define USB_SERIAL SerialUSB
|
|
|
|
|
#ifndef DISABLE_EEPROM
|
|
|
|
|
#define DISABLE_EEPROM
|
|
|
|
|
#endif
|
|
|
|
|
// Teensy support for native I2C is awaiting development
|
|
|
|
|
#ifndef I2C_NO_INTERRUPTS
|
|
|
|
|
#define I2C_NO_INTERRUPTS
|
|
|
|
|
#endif
|
2022-07-06 18:05:34 +02:00
|
|
|
#elif defined(ARDUINO_TEENSY35)
|
|
|
|
|
#define ARDUINO_TYPE "TEENSY35"
|
2022-08-06 10:53:14 +02:00
|
|
|
#undef USB_SERIAL
|
|
|
|
|
#define USB_SERIAL SerialUSB
|
|
|
|
|
// Teensy support for I2C is awaiting development
|
|
|
|
|
#ifndef DISABLE_EEPROM
|
|
|
|
|
#define DISABLE_EEPROM
|
|
|
|
|
#endif
|
|
|
|
|
// Teensy support for native I2C is awaiting development
|
|
|
|
|
#ifndef I2C_NO_INTERRUPTS
|
|
|
|
|
#define I2C_NO_INTERRUPTS
|
|
|
|
|
#endif
|
2022-07-06 18:05:34 +02:00
|
|
|
#elif defined(ARDUINO_TEENSY36)
|
|
|
|
|
#define ARDUINO_TYPE "TEENSY36"
|
2022-08-06 10:53:14 +02:00
|
|
|
#undef USB_SERIAL
|
|
|
|
|
#define USB_SERIAL SerialUSB
|
|
|
|
|
#ifndef DISABLE_EEPROM
|
|
|
|
|
#define DISABLE_EEPROM
|
|
|
|
|
#endif
|
|
|
|
|
// Teensy support for native I2C is awaiting development
|
|
|
|
|
#ifndef I2C_NO_INTERRUPTS
|
|
|
|
|
#define I2C_NO_INTERRUPTS
|
|
|
|
|
#endif
|
2022-07-06 18:05:34 +02:00
|
|
|
#elif defined(ARDUINO_TEENSY40)
|
|
|
|
|
#define ARDUINO_TYPE "TEENSY40"
|
2022-08-06 10:53:14 +02:00
|
|
|
#undef USB_SERIAL
|
|
|
|
|
#define USB_SERIAL SerialUSB
|
|
|
|
|
#ifndef DISABLE_EEPROM
|
|
|
|
|
#define DISABLE_EEPROM
|
|
|
|
|
#endif
|
|
|
|
|
// Teensy support for native I2C is awaiting development
|
|
|
|
|
#ifndef I2C_NO_INTERRUPTS
|
|
|
|
|
#define I2C_NO_INTERRUPTS
|
|
|
|
|
#endif
|
2022-07-06 18:05:34 +02:00
|
|
|
#elif defined(ARDUINO_TEENSY41)
|
|
|
|
|
#define ARDUINO_TYPE "TEENSY41"
|
2022-08-06 10:53:14 +02:00
|
|
|
#undef USB_SERIAL
|
|
|
|
|
#define USB_SERIAL SerialUSB
|
|
|
|
|
#ifndef DISABLE_EEPROM
|
|
|
|
|
#define DISABLE_EEPROM
|
|
|
|
|
#endif
|
|
|
|
|
// Teensy support for native I2C is awaiting development
|
|
|
|
|
#ifndef I2C_NO_INTERRUPTS
|
|
|
|
|
#define I2C_NO_INTERRUPTS
|
|
|
|
|
#endif
|
2022-07-06 18:05:34 +02:00
|
|
|
#elif defined(ARDUINO_ARCH_ESP8266)
|
|
|
|
|
#define ARDUINO_TYPE "ESP8266"
|
2022-10-14 14:20:32 +02:00
|
|
|
#warning "ESP8266 platform untested, you are on your own"
|
2022-07-06 18:05:34 +02:00
|
|
|
#elif defined(ARDUINO_ARCH_ESP32)
|
|
|
|
|
#define ARDUINO_TYPE "ESP32"
|
2022-10-14 14:20:32 +02:00
|
|
|
#ifndef DISABLE_EEPROM
|
|
|
|
|
#define DISABLE_EEPROM
|
|
|
|
|
#endif
|
2022-07-06 18:13:59 +02:00
|
|
|
#elif defined(ARDUINO_ARCH_SAMD)
|
|
|
|
|
#define ARDUINO_TYPE "SAMD21"
|
2022-07-08 16:52:46 +02:00
|
|
|
#undef USB_SERIAL
|
|
|
|
|
#define USB_SERIAL SerialUSB
|
2022-08-06 11:51:13 +02:00
|
|
|
// SAMD no EEPROM by default
|
2022-08-06 10:53:14 +02:00
|
|
|
#ifndef DISABLE_EEPROM
|
|
|
|
|
#define DISABLE_EEPROM
|
|
|
|
|
#endif
|
|
|
|
|
#elif defined(ARDUINO_ARCH_STM32)
|
|
|
|
|
#define ARDUINO_TYPE "STM32"
|
|
|
|
|
// STM32 no EEPROM by default
|
2022-07-08 11:46:52 +02:00
|
|
|
#ifndef DISABLE_EEPROM
|
|
|
|
|
#define DISABLE_EEPROM
|
|
|
|
|
#endif
|
2022-08-06 10:53:14 +02:00
|
|
|
// STM32 support for native I2C is awaiting development
|
2022-07-08 11:46:52 +02:00
|
|
|
#ifndef I2C_NO_INTERRUPTS
|
|
|
|
|
#define I2C_NO_INTERRUPTS
|
|
|
|
|
#endif
|
|
|
|
|
|
2022-07-07 00:46:00 +02:00
|
|
|
|
|
|
|
|
/* TODO when ready
|
|
|
|
|
#elif defined(ARDUINO_ARCH_RP2040)
|
|
|
|
|
#define ARDUINO_TYPE "RP2040"
|
|
|
|
|
*/
|
|
|
|
|
|
2022-07-06 18:05:34 +02:00
|
|
|
#else
|
|
|
|
|
#define CPU_TYPE_ERROR
|
|
|
|
|
#endif
|
|
|
|
|
|
2022-12-16 14:14:48 +01:00
|
|
|
// replace board type if provided by compiler
|
|
|
|
|
#ifdef BOARD_NAME
|
|
|
|
|
#undef ARDUINO_TYPE
|
|
|
|
|
#define ARDUINO_TYPE BOARD_NAME
|
|
|
|
|
#endif
|
|
|
|
|
|
2020-09-25 22:14:20 +02:00
|
|
|
////////////////////////////////////////////////////////////////////////////////
|
|
|
|
|
//
|
|
|
|
|
// WIFI_ON: All prereqs for running with WIFI are met
|
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
|
|
|
// Note: WIFI_CHANNEL may not exist in early config.h files so is added here if needed.
|
2020-10-04 17:31:24 +02:00
|
|
|
|
2021-11-22 00:41:47 +01:00
|
|
|
#if ENABLE_WIFI
|
2022-07-06 18:05:34 +02:00
|
|
|
#if defined(HAS_ENOUGH_MEMORY)
|
2021-11-22 00:41:47 +01:00
|
|
|
#define WIFI_ON true
|
|
|
|
|
#ifndef WIFI_CHANNEL
|
|
|
|
|
#define WIFI_CHANNEL 1
|
|
|
|
|
#endif
|
|
|
|
|
#else
|
2021-12-05 13:24:46 +01:00
|
|
|
#define WIFI_WARNING
|
2021-11-22 00:41:47 +01:00
|
|
|
#define WIFI_ON false
|
|
|
|
|
#endif
|
2020-10-04 17:29:48 +02:00
|
|
|
#else
|
2021-11-22 00:41:47 +01:00
|
|
|
#define WIFI_ON false
|
2020-09-25 22:14:20 +02:00
|
|
|
#endif
|
|
|
|
|
|
2021-11-22 00:41:47 +01:00
|
|
|
#if ENABLE_ETHERNET
|
2022-07-06 18:05:34 +02:00
|
|
|
#if defined(HAS_ENOUGH_MEMORY)
|
2021-11-22 00:41:47 +01:00
|
|
|
#define ETHERNET_ON true
|
|
|
|
|
#else
|
2021-12-05 13:24:46 +01:00
|
|
|
#define ETHERNET_WARNING
|
2021-11-22 00:41:47 +01:00
|
|
|
#define ETHERNET_ON false
|
|
|
|
|
#endif
|
2020-10-30 14:00:02 +01:00
|
|
|
#else
|
2021-11-22 00:41:47 +01:00
|
|
|
#define ETHERNET_ON false
|
2020-10-30 14:00:02 +01:00
|
|
|
#endif
|
2021-03-11 14:58:58 +01:00
|
|
|
|
|
|
|
|
#if WIFI_ON && ETHERNET_ON
|
|
|
|
|
#error Command Station does not support WIFI and ETHERNET at the same time.
|
|
|
|
|
#endif
|
|
|
|
|
|
2020-09-25 22:14:20 +02:00
|
|
|
////////////////////////////////////////////////////////////////////////////////
|
|
|
|
|
//
|
|
|
|
|
// This defines the speed at which the Arduino will communicate with the ESP8266 module.
|
|
|
|
|
// Currently only devices which can communicate at 115200 are supported.
|
|
|
|
|
//
|
|
|
|
|
#define WIFI_SERIAL_LINK_SPEED 115200
|
2021-08-03 23:12:25 +02:00
|
|
|
|
2021-11-22 00:41:47 +01:00
|
|
|
#if __has_include ( "myAutomation.h")
|
2022-07-06 18:05:34 +02:00
|
|
|
#if defined(HAS_ENOUGH_MEMORY) || defined(DISABLE_EEPROM)
|
2022-01-30 18:31:26 +01:00
|
|
|
#define EXRAIL_ACTIVE
|
2021-11-22 00:41:47 +01:00
|
|
|
#else
|
2021-12-15 21:08:24 +01:00
|
|
|
#define EXRAIL_WARNING
|
2021-11-22 00:41:47 +01:00
|
|
|
#endif
|
2021-08-03 23:12:25 +02:00
|
|
|
#endif
|
2021-08-22 23:23:08 +02:00
|
|
|
|
2021-11-08 02:07:21 +01:00
|
|
|
#endif
|
