2020-07-03 18:35:02 +02:00
|
|
|
/*
|
|
|
|
|
* © 2020, Chris Harlow. All rights reserved.
|
|
|
|
|
*
|
2020-08-26 14:18:34 +02:00
|
|
|
* This file is a demonstattion of calling the DCC-EX API
|
2020-07-03 18:35:02 +02:00
|
|
|
*/
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
2020-05-24 17:07:16 +02:00
|
|
|
#include "DCC.h"
|
2020-05-24 00:02:54 +02:00
|
|
|
#include "DIAG.h"
|
2020-06-04 21:55:18 +02:00
|
|
|
#include "DCCEXParser.h"
|
2020-06-11 14:35:16 +02:00
|
|
|
#include "WifiInterface.h"
|
2020-05-24 00:22:12 +02:00
|
|
|
|
2020-08-19 14:12:39 +02:00
|
|
|
|
2020-08-17 16:30:25 +02:00
|
|
|
#ifdef ARDUINO_AVR_UNO
|
|
|
|
|
#include <SoftwareSerial.h>
|
2020-08-28 15:44:06 +02:00
|
|
|
SoftwareSerial Serial1(15,16); // YOU must get these pins correct to use Wifi on a UNO
|
2020-08-17 16:30:25 +02:00
|
|
|
#define WIFI_BAUD 9600
|
|
|
|
|
#else
|
|
|
|
|
#define WIFI_BAUD 115200
|
|
|
|
|
#endif
|
|
|
|
|
|
2020-06-22 11:54:57 +02:00
|
|
|
// this code is here to demonstrate use of the DCC API and other techniques
|
2020-05-24 00:22:12 +02:00
|
|
|
|
2020-06-19 11:45:08 +02:00
|
|
|
// 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
|
2020-06-22 11:54:57 +02:00
|
|
|
// 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
|
2020-06-28 11:21:27 +02:00
|
|
|
// the standard parser. By setting the opcode to 0, the standard parser will
|
2020-06-19 11:45:08 +02:00
|
|
|
// 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().
|
|
|
|
|
|
2020-08-19 14:12:39 +02:00
|
|
|
void myComandFilter(Print * stream, byte & opcode, byte & paramCount, int p[]) {
|
2020-06-29 12:37:05 +02:00
|
|
|
(void)stream; // avoid compiler warning if we don't access this parameter
|
2020-06-23 21:01:43 +02:00
|
|
|
switch (opcode) {
|
2020-07-30 16:34:56 +02:00
|
|
|
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
|
2020-06-22 11:54:57 +02:00
|
|
|
break;
|
2020-06-19 11:45:08 +02:00
|
|
|
default: // drop through and parser will use the command unaltered.
|
|
|
|
|
break;
|
|
|
|
|
}
|
|
|
|
|
}
|
2020-05-24 17:07:16 +02:00
|
|
|
|
2020-08-19 14:12:39 +02:00
|
|
|
|
|
|
|
|
// 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>"));
|
|
|
|
|
}
|
|
|
|
|
|
2020-06-19 11:45:08 +02:00
|
|
|
// 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.
|
2020-06-28 11:21:27 +02:00
|
|
|
// See the DCC:getLocoId example in the setup function.
|
|
|
|
|
|
2020-05-26 13:44:02 +02:00
|
|
|
|
2020-06-07 17:29:53 +02:00
|
|
|
void myCallback(int result) {
|
2020-06-08 14:04:47 +02:00
|
|
|
DIAG(F("\n getting Loco Id callback result=%d"),result);
|
2020-06-07 17:29:53 +02:00
|
|
|
}
|
2020-05-24 00:02:54 +02:00
|
|
|
|
2020-06-18 20:36:37 +02:00
|
|
|
|
2020-06-23 18:43:50 +02:00
|
|
|
// Create a serial command parser... This is OPTIONAL if you don't need to handle JMRI type commands
|
2020-06-19 11:45:08 +02:00
|
|
|
// from the Serial port.
|
2020-06-11 14:35:16 +02:00
|
|
|
DCCEXParser serialParser;
|
2020-06-10 18:31:26 +02:00
|
|
|
|
2020-06-23 18:43:50 +02:00
|
|
|
|
|
|
|
|
// Try monitoring the memory
|
|
|
|
|
#include "freeMemory.h"
|
2020-07-24 14:46:23 +02:00
|
|
|
int ramLowWatermark=32767; // This figure gets overwritten dynamically in loop()
|
2020-06-23 18:43:50 +02:00
|
|
|
|
2020-05-24 00:02:54 +02:00
|
|
|
void setup() {
|
2020-06-28 11:21:27 +02:00
|
|
|
|
|
|
|
|
// The main sketch has responsibilities during setup()
|
|
|
|
|
|
|
|
|
|
// Responsibility 1: Start the usb connection for diagnostics and possible JMRI input
|
2020-07-24 13:00:07 +02:00
|
|
|
// DIAGSERAL is normally Serial but uses SerialUSB on a SAMD processor
|
2020-08-17 16:30:25 +02:00
|
|
|
DIAGSERIAL.begin(115200);
|
|
|
|
|
while(!DIAGSERIAL);
|
|
|
|
|
|
2020-08-15 12:32:32 +02:00
|
|
|
// Responsibility 2: 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.
|
2020-08-19 14:12:39 +02:00
|
|
|
|
|
|
|
|
// STANDARD_MOTOR_SHIELD, POLOLU_MOTOR_SHIELD, FIREBOX_MK1, FIREBOX_MK1S are pre defined in MotorShields.h
|
2020-08-28 13:34:58 +02:00
|
|
|
|
|
|
|
|
// 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-08-19 14:12:39 +02:00
|
|
|
|
2020-08-15 15:10:56 +02:00
|
|
|
DCC::begin(STANDARD_MOTOR_SHIELD);
|
2020-06-28 11:21:27 +02:00
|
|
|
|
2020-08-17 16:30:25 +02:00
|
|
|
// Responsibility 3: **Optionally** Start the WiFi interface if required.
|
2020-06-28 11:21:27 +02:00
|
|
|
// NOTE: On a Uno you will have to provide a SoftwareSerial
|
|
|
|
|
// configured for the pins connected to the Wifi card
|
|
|
|
|
// and a 9600 baud rate.
|
2020-08-26 14:18:34 +02:00
|
|
|
// setup(serial, F(router name) or NULL, F(router password), F(hostname), F(AcessPoint name) or NULL , port)
|
2020-08-17 16:30:25 +02:00
|
|
|
// (port 3532 is 0xDCC decimal.)
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Serial1.begin(WIFI_BAUD);
|
2020-08-26 14:18:34 +02:00
|
|
|
WifiInterface::setup(Serial1, F("BTHub5-M6PT"), F("49de8d4862"),F("DCCEX"),3532);
|
|
|
|
|
|
2020-08-19 14:12:39 +02:00
|
|
|
// Optionally tell the Wifi parser to use my http filter.
|
|
|
|
|
// This will intercept http commands from Wifi.
|
|
|
|
|
WifiInterface::setHTTPCallback(myHttpFilter);
|
|
|
|
|
|
2020-06-28 11:21:27 +02:00
|
|
|
// This is just for demonstration purposes
|
2020-06-08 14:04:47 +02:00
|
|
|
DIAG(F("\n===== CVReader demonstrating DCC::getLocoId() call ==========\n"));
|
|
|
|
|
DCC::getLocoId(myCallback); // myCallback will be called with the result
|
2020-06-28 11:21:27 +02:00
|
|
|
DIAG(F("\n===== DCC::getLocoId has returned, but the callback wont be executed until we are in loop() ======\n"));
|
2020-06-19 11:45:08 +02:00
|
|
|
|
2020-06-28 11:21:27 +02:00
|
|
|
// Optionally tell the command parser to use my example filter.
|
|
|
|
|
// This will intercept JMRI commands from both USB and Wifi
|
2020-08-19 14:12:39 +02:00
|
|
|
DCCEXParser::setFilter(myComandFilter);
|
|
|
|
|
|
2020-06-28 11:21:27 +02:00
|
|
|
|
2020-06-19 11:45:08 +02:00
|
|
|
DIAG(F("\nReady for JMRI commands\n"));
|
2020-06-23 18:43:50 +02:00
|
|
|
|
2020-05-24 00:02:54 +02:00
|
|
|
}
|
|
|
|
|
|
2020-06-11 14:35:16 +02:00
|
|
|
void loop() {
|
2020-06-28 11:21:27 +02:00
|
|
|
// The main sketch has responsibilities during loop()
|
|
|
|
|
|
|
|
|
|
// Responsibility 1: Handle DCC background processes
|
|
|
|
|
// (loco reminders and power checks)
|
|
|
|
|
DCC::loop();
|
2020-05-26 13:44:02 +02:00
|
|
|
|
2020-06-28 11:21:27 +02:00
|
|
|
// Responsibility 2: handle any incoming commands on USB connection
|
2020-07-24 13:00:07 +02:00
|
|
|
serialParser.loop(DIAGSERIAL);
|
2020-06-19 11:45:08 +02:00
|
|
|
|
2020-06-28 11:21:27 +02:00
|
|
|
// Responsibility 3: Optionally handle any incoming WiFi traffic
|
2020-08-01 17:32:16 +02:00
|
|
|
WifiInterface::loop();
|
2020-06-23 18:43:50 +02:00
|
|
|
|
2020-08-17 16:30:25 +02:00
|
|
|
// Your additional loop code
|
2020-07-24 14:46:23 +02:00
|
|
|
|
2020-08-17 16:30:25 +02:00
|
|
|
// Optionally report any decrease in memory (will automatically trigger on first call)
|
2020-06-23 18:43:50 +02:00
|
|
|
int freeNow=freeMemory();
|
2020-07-24 14:46:23 +02:00
|
|
|
if (freeNow<ramLowWatermark) {
|
|
|
|
|
ramLowWatermark=freeNow;
|
|
|
|
|
DIAG(F("\nFree RAM=%d\n"),ramLowWatermark);
|
2020-06-23 18:43:50 +02:00
|
|
|
}
|
2020-05-26 00:03:11 +02:00
|
|
|
}
|
