2020-09-22 20:57:11 +02:00
|
|
|
////////////////////////////////////////////////////////////////////////////////////
|
|
|
|
|
// © 2020, Chris Harlow. All rights reserved.
|
|
|
|
|
//
|
|
|
|
|
// This file is a demonstattion of setting up a DCC-EX
|
|
|
|
|
// Command station to support direct connection of WiThrottle devices
|
|
|
|
|
// such as "Engine Driver". If you contriol your layout through JMRI
|
|
|
|
|
// then DON'T connect throttles to this wifi, connect them to JMRI.
|
|
|
|
|
//
|
|
|
|
|
// This is just 3 statements longer than the basic setup.
|
|
|
|
|
//
|
|
|
|
|
// THIS SETUP DOES NOT APPLY TO ARDUINO UNO WITH ONLY A SINGLE SERIAL PORT.
|
|
|
|
|
// REFER TO SEPARATE EXAMPLE.
|
|
|
|
|
////////////////////////////////////////////////////////////////////////////////////
|
|
|
|
|
|
2020-09-24 11:59:01 +02:00
|
|
|
// This defines the speed at which the Arduino will communicate with the ESP8266 module.
|
|
|
|
|
// Currently only Arduino Mega and 115200 is supported.
|
|
|
|
|
#define WIFI_SERIAL_LINK_SPEED 115200
|
|
|
|
|
|
2020-09-22 20:57:11 +02:00
|
|
|
#include "config.h"
|
|
|
|
|
#include "DCC.h"
|
|
|
|
|
#include "DIAG.h"
|
|
|
|
|
#include "DCCEXParser.h"
|
2020-09-24 03:54:01 +02:00
|
|
|
#include "version.h"
|
2020-09-23 23:54:47 +02:00
|
|
|
#if ENABLE_WIFI && (defined(ARDUINO_AVR_MEGA) || defined(ARDUINO_AVR_MEGA2560))
|
2020-09-22 20:57:11 +02:00
|
|
|
#include "WifiInterface.h"
|
|
|
|
|
#endif
|
|
|
|
|
#if ENABLE_FREE_MEM_WARNING
|
|
|
|
|
#include "freeMemory.h"
|
|
|
|
|
int ramLowWatermark = 32767; // This figure gets overwritten dynamically in loop()
|
|
|
|
|
#endif
|
|
|
|
|
|
2020-09-25 19:51:08 +02:00
|
|
|
#if defined(ARDUINO_ARCH_MEGAAVR)
|
|
|
|
|
#include <Arduino.h>
|
|
|
|
|
#endif
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
2020-09-24 03:54:01 +02:00
|
|
|
////////////////////////////////////////////////////////////////
|
|
|
|
|
//
|
|
|
|
|
// Enables an I2C 2x24 or 4x24 LCD Screen
|
2020-09-25 19:51:08 +02:00
|
|
|
#if ENABLE_LCD
|
2020-09-24 03:54:01 +02:00
|
|
|
bool lcdEnabled = false;
|
2020-09-25 19:51:08 +02:00
|
|
|
#if defined(LIB_TYPE_PCF8574)
|
|
|
|
|
LiquidCrystal_PCF8574 lcdDisplay(LCD_ADDRESS);
|
|
|
|
|
#elif defined(LIB_TYPE_I2C)
|
|
|
|
|
LiquidCrystal_I2C lcdDisplay = LiquidCrystal_I2C(LCD_ADDRESS, LCD_COLUMNS, LCD_LINES);
|
|
|
|
|
#endif
|
2020-09-24 03:54:01 +02:00
|
|
|
#endif
|
|
|
|
|
|
2020-09-22 20:57:11 +02:00
|
|
|
// this code is here to demonstrate use of the DCC API and other techniques
|
|
|
|
|
|
|
|
|
|
// myFilter is an example of an OPTIONAL command filter used to intercept < > commands from
|
|
|
|
|
// the usb or wifi streamm. It demonstrates how a command may be intercepted
|
|
|
|
|
// or even a new command created without having to break open the API library code.
|
|
|
|
|
// The filter is permitted to use or modify the parameter list before passing it on to
|
|
|
|
|
// the standard parser. By setting the opcode to 0, the standard parser will
|
|
|
|
|
// just ignore the command on the assumption that you have already handled it.
|
|
|
|
|
//
|
|
|
|
|
// The filter must be enabled by calling the DCC EXParser::setFilter method, see use in setup().
|
|
|
|
|
#if ENABLE_CUSTOM_FILTER
|
|
|
|
|
void myComandFilter(Print *stream, byte &opcode, byte ¶mCount, int p[])
|
|
|
|
|
{
|
|
|
|
|
(void)stream; // avoid compiler warning if we don't access this parameter
|
|
|
|
|
switch (opcode)
|
|
|
|
|
{
|
|
|
|
|
case '!': // Create a bespoke new command to clear all loco reminders <!> or specific locos e.g <! 3 4 99>
|
|
|
|
|
if (paramCount == 0)
|
|
|
|
|
DCC::forgetAllLocos();
|
|
|
|
|
else
|
|
|
|
|
for (int i = 0; i < paramCount; i++)
|
|
|
|
|
DCC::forgetLoco(p[i]);
|
|
|
|
|
opcode = 0; // tell parser to ignore this command as we have done it already
|
|
|
|
|
break;
|
|
|
|
|
default: // drop through and parser will use the command unaltered.
|
|
|
|
|
break;
|
|
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
// This is an OPTIONAL example of a HTTP filter...
|
|
|
|
|
// If you have configured wifi and an HTTP request is received on the Wifi connection
|
|
|
|
|
// it will normally be rejected 404 Not Found.
|
|
|
|
|
|
|
|
|
|
// If you wish to handle HTTP requests, you can create a filter and ask the WifiInterface to
|
|
|
|
|
// call your code for each detected http request.
|
|
|
|
|
|
|
|
|
|
void myHttpFilter(Print *stream, byte *cmd)
|
|
|
|
|
{
|
|
|
|
|
(void)cmd; // Avoid compiler warning because this example doesnt use this parameter
|
|
|
|
|
|
|
|
|
|
// BEWARE - As soon as you start responding, the cmd buffer is trashed!
|
|
|
|
|
// You must get everything you need from it before using StringFormatter::send!
|
|
|
|
|
|
|
|
|
|
StringFormatter::send(stream, F("HTTP/1.1 200 OK\nContent-Type: text/html\nConnnection: close\n\n"));
|
|
|
|
|
StringFormatter::send(stream, F("<html><body>This is my HTTP filter responding.<br/></body></html>"));
|
|
|
|
|
}
|
|
|
|
|
#endif
|
|
|
|
|
|
|
|
|
|
// Callback functions are necessary if you call any API that must wait for a response from the
|
|
|
|
|
// programming track. The API must return immediately otherwise other loop() functions would be blocked.
|
|
|
|
|
// Your callback function will be invoked when the data arrives from the prog track.
|
|
|
|
|
// See the DCC:getLocoId example in the setup function.
|
|
|
|
|
#if ENABLE_CUSTOM_CALLBACK
|
|
|
|
|
void myCallback(int result)
|
|
|
|
|
{
|
|
|
|
|
DIAG(F("\n getting Loco Id callback result=%d"), result);
|
|
|
|
|
}
|
|
|
|
|
#endif
|
2020-09-12 00:27:46 +02:00
|
|
|
|
|
|
|
|
// Create a serial command parser... Enables certain diagnostics and commands
|
2020-09-22 20:57:11 +02:00
|
|
|
// to be issued from the USB serial console
|
2020-09-12 00:27:46 +02:00
|
|
|
// This is NOT intended for JMRI....
|
|
|
|
|
|
2020-09-22 20:57:11 +02:00
|
|
|
DCCEXParser serialParser;
|
2020-09-12 00:27:46 +02:00
|
|
|
|
2020-09-22 20:57:11 +02:00
|
|
|
void setup()
|
|
|
|
|
{
|
2020-09-12 00:27:46 +02:00
|
|
|
|
2020-09-25 19:51:08 +02:00
|
|
|
////////////////////////////////////////////
|
|
|
|
|
//
|
|
|
|
|
// More display stuff. Need to put this in a .h file and make
|
|
|
|
|
// it a class
|
|
|
|
|
#if ENABLE_LCD
|
2020-09-24 03:54:01 +02:00
|
|
|
Wire.begin();
|
|
|
|
|
// Check that we can find the LCD by its address before attempting to use it.
|
|
|
|
|
Wire.beginTransmission(LCD_ADDRESS);
|
2020-09-25 19:51:08 +02:00
|
|
|
if (Wire.endTransmission() == 0)
|
|
|
|
|
{
|
2020-09-24 03:54:01 +02:00
|
|
|
lcdEnabled = true;
|
|
|
|
|
lcdDisplay.begin(LCD_COLUMNS, LCD_LINES);
|
|
|
|
|
lcdDisplay.setBacklight(255);
|
|
|
|
|
lcdDisplay.clear();
|
|
|
|
|
lcdDisplay.setCursor(0, 0);
|
|
|
|
|
lcdDisplay.print("DCC++ EX v");
|
|
|
|
|
lcdDisplay.print(VERSION);
|
|
|
|
|
lcdDisplay.setCursor(0, 1);
|
2020-09-25 19:51:08 +02:00
|
|
|
#if COMM_INTERFACE >= 1
|
2020-09-24 03:54:01 +02:00
|
|
|
lcdDisplay.print("IP: PENDING");
|
2020-09-25 19:51:08 +02:00
|
|
|
#else
|
2020-09-24 03:54:01 +02:00
|
|
|
lcdDisplay.print("SERIAL: READY");
|
2020-09-25 19:51:08 +02:00
|
|
|
#endif
|
|
|
|
|
#if LCD_LINES > 2
|
|
|
|
|
lcdDisplay.setCursor(0, 3);
|
|
|
|
|
lcdDisplay.print("TRACK POWER: OFF");
|
|
|
|
|
#endif
|
2020-09-24 03:54:01 +02:00
|
|
|
}
|
|
|
|
|
#endif
|
|
|
|
|
|
2020-09-12 00:27:46 +02:00
|
|
|
// The main sketch has responsibilities during setup()
|
2020-09-22 20:57:11 +02:00
|
|
|
|
|
|
|
|
// Responsibility 1: Start the usb connection for diagnostics
|
2020-09-12 00:27:46 +02:00
|
|
|
// This is normally Serial but uses SerialUSB on a SAMD processor
|
|
|
|
|
Serial.begin(115200);
|
2020-09-19 01:40:18 +02:00
|
|
|
|
2020-09-22 20:57:11 +02:00
|
|
|
// Start the WiFi interface on a MEGA, Uno cannot currently handle WiFi
|
|
|
|
|
// NOTE: References to Serial1 are for the serial port used to connect
|
|
|
|
|
// your wifi chip/shield.
|
|
|
|
|
|
|
|
|
|
// Optionally tell the command parser to use my example filter.
|
|
|
|
|
// This will intercept JMRI commands from both USB and Wifi
|
|
|
|
|
#if ENABLE_CUSTOM_FILTER
|
|
|
|
|
DCCEXParser::setFilter(myComandFilter);
|
|
|
|
|
#endif
|
|
|
|
|
|
|
|
|
|
#if ENABLE_CUSTOM_CALLBACK
|
|
|
|
|
// This is just for demonstration purposes
|
|
|
|
|
DIAG(F("\n===== DCCEX demonstrating DCC::getLocoId() call ==========\n"));
|
|
|
|
|
DCC::getLocoId(myCallback); // myCallback will be called with the result
|
|
|
|
|
DIAG(F("\n===== DCC::getLocoId has returned, but the callback wont be executed until we are in loop() ======\n"));
|
|
|
|
|
#endif
|
|
|
|
|
|
2020-09-22 22:02:11 +02:00
|
|
|
#if ENABLE_WIFI && (defined(ARDUINO_AVR_MEGA) || defined(ARDUINO_AVR_MEGA2560))
|
2020-09-22 21:20:33 +02:00
|
|
|
bool wifiUp = false;
|
2020-09-22 21:57:26 +02:00
|
|
|
const __FlashStringHelper *wifiESSID = F(WIFI_SSID);
|
|
|
|
|
const __FlashStringHelper *wifiPassword = F(WIFI_PASSWORD);
|
|
|
|
|
const __FlashStringHelper *dccex = F(WIFI_HOSTNAME);
|
2020-09-24 11:59:01 +02:00
|
|
|
const uint16_t port = IP_PORT;
|
2020-09-22 21:20:33 +02:00
|
|
|
|
2020-09-22 20:57:11 +02:00
|
|
|
Serial1.begin(WIFI_SERIAL_LINK_SPEED);
|
2020-09-22 21:57:26 +02:00
|
|
|
wifiUp = WifiInterface::setup(Serial1, wifiESSID, wifiPassword, dccex, port);
|
2020-09-22 21:20:33 +02:00
|
|
|
if (!wifiUp)
|
|
|
|
|
{
|
2020-09-22 23:15:27 +02:00
|
|
|
Serial2.begin(WIFI_SERIAL_LINK_SPEED);
|
2020-09-22 21:57:26 +02:00
|
|
|
wifiUp = WifiInterface::setup(Serial2, wifiESSID, wifiPassword, dccex, port);
|
2020-09-22 21:20:33 +02:00
|
|
|
}
|
|
|
|
|
if (!wifiUp)
|
|
|
|
|
{
|
2020-09-22 23:15:27 +02:00
|
|
|
Serial3.begin(WIFI_SERIAL_LINK_SPEED);
|
2020-09-22 21:57:26 +02:00
|
|
|
wifiUp = WifiInterface::setup(Serial3, wifiESSID, wifiPassword, dccex, port);
|
2020-09-22 21:20:33 +02:00
|
|
|
}
|
2020-09-22 20:57:11 +02:00
|
|
|
#endif
|
2020-09-12 00:27:46 +02:00
|
|
|
|
2020-09-22 20:57:11 +02:00
|
|
|
// Responsibility 3: Start the DCC engine.
|
|
|
|
|
// Note: this provides DCC with two motor drivers, main and prog, which handle the motor shield(s)
|
|
|
|
|
// Standard supported devices have pre-configured macros but custome hardware installations require
|
|
|
|
|
// detailed pin mappings and may also require modified subclasses of the MotorDriver to implement specialist logic.
|
|
|
|
|
|
|
|
|
|
// STANDARD_MOTOR_SHIELD, POLOLU_MOTOR_SHIELD, FIREBOX_MK1, FIREBOX_MK1S are pre defined in MotorShields.h
|
|
|
|
|
|
|
|
|
|
// Optionally a Timer number (1..4) may be passed to DCC::begin to override the default Timer1 used for the
|
|
|
|
|
// waveform generation. e.g. DCC::begin(STANDARD_MOTOR_SHIELD,2); to use timer 2
|
|
|
|
|
|
2020-09-24 04:49:18 +02:00
|
|
|
DCC::begin(MOTOR_SHIELD_TYPE);
|
2020-09-12 00:27:46 +02:00
|
|
|
}
|
|
|
|
|
|
2020-09-22 20:57:11 +02:00
|
|
|
void loop()
|
|
|
|
|
{
|
2020-09-12 00:27:46 +02:00
|
|
|
// The main sketch has responsibilities during loop()
|
2020-09-22 20:57:11 +02:00
|
|
|
|
2020-09-12 00:27:46 +02:00
|
|
|
// Responsibility 1: Handle DCC background processes
|
|
|
|
|
// (loco reminders and power checks)
|
2020-09-22 20:57:11 +02:00
|
|
|
DCC::loop();
|
2020-09-12 00:27:46 +02:00
|
|
|
|
|
|
|
|
// Responsibility 2: handle any incoming commands on USB connection
|
|
|
|
|
serialParser.loop(Serial);
|
|
|
|
|
|
2020-09-22 20:57:11 +02:00
|
|
|
// Responsibility 3: Optionally handle any incoming WiFi traffic
|
2020-09-22 23:15:27 +02:00
|
|
|
#if ENABLE_WIFI && (defined(ARDUINO_AVR_MEGA) || defined(ARDUINO_AVR_MEGA2560))
|
2020-09-12 00:27:46 +02:00
|
|
|
WifiInterface::loop();
|
2020-09-22 20:57:11 +02:00
|
|
|
#endif
|
2020-09-12 00:27:46 +02:00
|
|
|
|
2020-09-22 20:57:11 +02:00
|
|
|
// Optionally report any decrease in memory (will automatically trigger on first call)
|
|
|
|
|
#if ENABLE_FREE_MEM_WARNING
|
|
|
|
|
int freeNow = freeMemory();
|
|
|
|
|
if (freeNow < ramLowWatermark)
|
|
|
|
|
{
|
|
|
|
|
ramLowWatermark = freeNow;
|
|
|
|
|
DIAG(F("\nFree RAM=%d\n"), ramLowWatermark);
|
|
|
|
|
}
|
|
|
|
|
#endif
|
2020-09-12 00:27:46 +02:00
|
|
|
}
|
