mirror of
https://github.com/DCC-EX/CommandStation-EX.git
synced 2024-12-24 21:21:24 +01:00
139 lines
5.0 KiB
C++
139 lines
5.0 KiB
C++
/*
|
|
* © 2020, Chris Harlow. All rights reserved.
|
|
*
|
|
* This file is part of Asbelos DCC API
|
|
*
|
|
* 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/>.
|
|
*/
|
|
|
|
|
|
|
|
#include "DCC.h"
|
|
#include "DIAG.h"
|
|
#include "DCCEXParser.h"
|
|
#include "WifiInterface.h"
|
|
|
|
// 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().
|
|
|
|
void myFilter(Print & stream, byte & opcode, byte & paramCount, int p[]) {
|
|
(void)stream; // avoid compiler warning if we don't access this parameter
|
|
switch (opcode) {
|
|
case 'F': // Invent new command to call the new Loco Function API <F cab func 1|0>
|
|
DIAG(F("Setting loco %d F%d %S"),p[0],p[1],p[2]?F("ON"):F("OFF"));
|
|
DCC::setFn(p[0],p[1],p[2]==1);
|
|
opcode=0; // tell parser to ignore this command
|
|
break;
|
|
case '$': // Diagnose parser <$....>
|
|
DIAG(F("$ paramCount=%d\n"),paramCount);
|
|
for (int i=0;i<paramCount;i++) DIAG(F("p[%d]=%d (0x%x)\n"),i,p[i],p[i]);
|
|
opcode=0; // Normal parser wont understand $,
|
|
break;
|
|
default: // drop through and parser will use the command unaltered.
|
|
break;
|
|
}
|
|
}
|
|
|
|
// 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.
|
|
|
|
|
|
void myCallback(int result) {
|
|
DIAG(F("\n getting Loco Id callback result=%d"),result);
|
|
}
|
|
|
|
|
|
// Create a serial command parser... This is OPTIONAL if you don't need to handle JMRI type commands
|
|
// from the Serial port.
|
|
DCCEXParser serialParser;
|
|
|
|
|
|
// Try monitoring the memory
|
|
#include "freeMemory.h"
|
|
// TODO: this should be automated instead of ifdef
|
|
#if defined(ARDUINO_AVR_MEGA2560)
|
|
int minMemory=32767;
|
|
#elif defined(ARDUINO_AVR_UNO)
|
|
int minMemory=2048;
|
|
#else
|
|
#error CANNOT COMPILE - Unkown board, can not determine amount of RAM available.
|
|
#endif
|
|
|
|
void setup() {
|
|
|
|
// The main sketch has responsibilities during setup()
|
|
|
|
// Responsibility 1: Start the usb connection for diagnostics and possible JMRI input
|
|
Serial.begin(115200);
|
|
|
|
// Responsibility 2: Start the DCC engine.
|
|
DCC::begin();
|
|
|
|
// Responsibility 3: Optionally Start the WiFi interface if required.
|
|
// 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.
|
|
// setup(serial, F(router name), F(password) , port)
|
|
//
|
|
#ifdef WIFI
|
|
Serial1.begin(115200);
|
|
WifiInterface::setup(Serial1, F("BTHub5-M6PT"), F("49de8d4862"),3532); // (3532 is 0xDCC decimal... )
|
|
#endif
|
|
|
|
// This is just for demonstration purposes
|
|
DIAG(F("\n===== CVReader 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"));
|
|
|
|
// Optionally tell the command parser to use my example filter.
|
|
// This will intercept JMRI commands from both USB and Wifi
|
|
DCCEXParser::setFilter(myFilter);
|
|
|
|
DIAG(F("\nReady for JMRI commands\n"));
|
|
|
|
}
|
|
|
|
void loop() {
|
|
// The main sketch has responsibilities during loop()
|
|
|
|
// Responsibility 1: Handle DCC background processes
|
|
// (loco reminders and power checks)
|
|
DCC::loop();
|
|
|
|
// Responsibility 2: handle any incoming commands on USB connection
|
|
serialParser.loop(Serial);
|
|
|
|
// Responsibility 3: Optionally handle any incoming WiFi traffic
|
|
#ifdef WIFI
|
|
WifiInterface::loop(Serial1);
|
|
#endif
|
|
|
|
// Your additional code e.g. Report any decrease in memory
|
|
int freeNow=freeMemory();
|
|
if (freeNow<minMemory) {
|
|
minMemory=freeNow;
|
|
DIAG(F("\nFree memory=%d"),minMemory);
|
|
}
|
|
}
|