forked from kroimon/Arduino-SerialCommand
-
Notifications
You must be signed in to change notification settings - Fork 1
Expand file tree
/
Copy pathSerialCommand.h
More file actions
103 lines (90 loc) · 3.75 KB
/
SerialCommand.h
File metadata and controls
103 lines (90 loc) · 3.75 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
/**
* SerialCommand - A Wiring/Arduino library to tokenize and parse commands
* received over a serial port.
*
* Copyright (C) 2012 Stefan Rado
* Copyright (C) 2011 Steven Cogswell <steven.cogswell@gmail.com>
* http://husks.wordpress.com
*
* Version 20120522
*
* 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 3 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 General Public License
* along with this library. If not, see <http://www.gnu.org/licenses/>.
*/
#ifndef SerialCommand_h
#define SerialCommand_h
#if defined(__AVR_ATmega1280__) || defined(__AVR_ATmega2560__)
#define __NO_SERIAL___
#endif
#if defined(WIRING) && WIRING >= 100
#pragma message ( "Found Wiring")
#include <Wiring.h>
#elif defined(__MK20DX128__) || defined(__MK20DX256__)
#include <Arduino.h>
#ifdef USB_RAWHID
#pragma message ( "Found Teensy in RawHID mode.")
#include <usb_seremu.h>
#define SOFTSERIAL_ usb_seremu_class
#else
#pragma message ( "Found Teensy in Serial mode.")
#include <usb_serial.h>
#define SOFTSERIAL_ usb_serial_class
#endif
#elif defined(ARDUINO) && ARDUINO >= 100
#pragma message ( "Found Arduino 1.0+")
#include <Arduino.h>
#include <HardwareSerial.h>
#define SOFTSERIAL_ Serial_
#else
#pragma message ( "Found old Arduino")
#include <WProgram.h>
#endif
#include <string.h>
// Size of the input buffer in bytes (maximum length of one command plus arguments)
#define SERIALCOMMAND_BUFFER 32
// Maximum length of a command excluding the terminating null
#define SERIALCOMMAND_MAXCOMMANDLENGTH 8
// Uncomment the next line to run the library in debug mode (verbose messages)
//#define SERIALCOMMAND_DEBUG
class SerialCommand {
public:
SerialCommand(HardwareSerial *serial); // Constructor
#ifndef __NO_SERIAL___
SerialCommand(SOFTSERIAL_ *serial); // Constructor
#endif
void addCommand(const char *command, void(*function)()); // Add a command to the processing dictionary.
void setDefaultHandler(void (*function)(const char *)); // A handler to call when no valid command received.
void readSerial(); // Main entry point.
void clearBuffer(); // Clears the input buffer.
char *next(); // Returns pointer to next token found in command buffer (for getting arguments to commands).
private:
// Command/handler dictionary
struct SerialCommandCallback {
char command[SERIALCOMMAND_MAXCOMMANDLENGTH + 1];
void (*function)();
}; // Data structure to hold Command/Handler function key-value pairs
SerialCommandCallback *commandList; // Actual definition for command/handler array
byte commandCount;
// Pointer to the default handler function
void (*defaultHandler)(const char *);
char delim[2]; // null-terminated list of character to be used as delimeters for tokenizing (default " ")
char term; // Character that signals end of command (default '\n')
char buffer[SERIALCOMMAND_BUFFER + 1]; // Buffer of stored characters while waiting for terminator character
byte bufPos; // Current position in the buffer
char *last; // State variable used by strtok_r during processing
HardwareSerial *_HardSerial;
#ifndef __NO_SERIAL___
SOFTSERIAL_ *_Serial;
#endif
};
#endif //SerialCommand_h