You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
94 lines
4.4 KiB
94 lines
4.4 KiB
/*******************************************************************************
|
|
SerialCommand - An Arduino library to tokenize and parse commands received over
|
|
a serial port.
|
|
Copyright (C) 2011-2013 Steven Cogswell <steven.cogswell@gmail.com>
|
|
http://awtfy.com
|
|
|
|
Version 20131021A.
|
|
|
|
Version History:
|
|
May 11 2011 - Initial version
|
|
May 13 2011 - Prevent overwriting bounds of SerialCommandCallback[] array in addCommand()
|
|
defaultHandler() for non-matching commands
|
|
Mar 2012 - Some const char * changes to make compiler happier about deprecated warnings.
|
|
Arduino 1.0 compatibility (Arduino.h header)
|
|
Oct 2013 - SerialCommand object can be created using a SoftwareSerial object, for SoftwareSerial
|
|
support. Requires #include <SoftwareSerial.h> in your sketch even if you don't use
|
|
a SoftwareSerial port in the project. sigh. See Example Sketch for usage.
|
|
Oct 2013 - Conditional compilation for the SoftwareSerial support, in case you really, really
|
|
hate it and want it removed.
|
|
|
|
This library is free software; you can redistribute it and/or
|
|
modify it under the terms of the GNU Lesser General Public
|
|
License as published by the Free Software Foundation; either
|
|
version 2.1 of the License, or (at your option) any later version.
|
|
|
|
This library 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
|
|
Lesser General Public License for more details.
|
|
|
|
You should have received a copy of the GNU Lesser General Public
|
|
License along with this library; if not, write to the Free Software
|
|
Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
|
|
***********************************************************************************/
|
|
#ifndef SerialCommand_h
|
|
#define SerialCommand_h
|
|
|
|
|
|
#include "Arduino.h"
|
|
|
|
|
|
// If you want to use SerialCommand with the hardware serial port only, and want to disable
|
|
// SoftwareSerial support, and thus don't have to use "#include <SoftwareSerial.h>" in your
|
|
// sketches, then uncomment this define for SERIALCOMMAND_HARDWAREONLY, and comment out the
|
|
// corresponding #undef line.
|
|
//
|
|
// You don't have to use SoftwareSerial features if this is not defined, you can still only use
|
|
// the Hardware serial port, just that this way lets you get out of having to include
|
|
// the SoftwareSerial.h header.
|
|
#define SERIALCOMMAND_HARDWAREONLY 1
|
|
//#undef SERIALCOMMAND_HARDWAREONLY
|
|
|
|
|
|
|
|
#include <string.h>
|
|
|
|
|
|
#define SERIALCOMMANDBUFFER 16
|
|
#define MAXSERIALCOMMANDS 10
|
|
#define MAXDELIMETER 2
|
|
|
|
#define SERIALCOMMANDDEBUG 1
|
|
#undef SERIALCOMMANDDEBUG // Comment this out to run the library in debug mode (verbose messages)
|
|
|
|
class SerialCommand
|
|
{
|
|
public:
|
|
SerialCommand(); // Constructor
|
|
|
|
void clearBuffer(); // Sets the command buffer to all '\0' (nulls)
|
|
char *next(); // returns pointer to next token found in command buffer (for getting arguments to commands)
|
|
void readSerial(); // Main entry point.
|
|
void addCommand(const char *, void(*)()); // Add commands to processing dictionary
|
|
void addDefaultHandler(void (*function)()); // A handler to call when no valid command received.
|
|
|
|
private:
|
|
char inChar; // A character read from the serial stream
|
|
char buffer[SERIALCOMMANDBUFFER]; // Buffer of stored characters while waiting for terminator character
|
|
int bufPos; // Current position in the buffer
|
|
char delim[MAXDELIMETER]; // null-terminated list of character to be used as delimeters for tokenizing (default " ")
|
|
char term; // Character that signals end of command (default '\r')
|
|
char *token; // Returned token from the command buffer as returned by strtok_r
|
|
char *last; // State variable used by strtok_r during processing
|
|
typedef struct _callback {
|
|
char command[SERIALCOMMANDBUFFER];
|
|
void (*function)();
|
|
} SerialCommandCallback; // Data structure to hold Command/Handler function key-value pairs
|
|
int numCommand;
|
|
SerialCommandCallback CommandList[MAXSERIALCOMMANDS]; // Actual definition for command/handler array
|
|
void (*defaultHandler)(); // Pointer to the default handler function
|
|
int usingSoftwareSerial; // Used as boolean to see if we're using SoftwareSerial object or not
|
|
};
|
|
|
|
#endif //SerialCommand_h
|
|
|