forked from kroimon/Arduino-SerialCommand
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathSerialCommand.cpp
More file actions
198 lines (180 loc) · 5.85 KB
/
Copy pathSerialCommand.cpp
File metadata and controls
198 lines (180 loc) · 5.85 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
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
/**
* 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/>.
*/
#include "SerialCommand.h"
/**
* Constructor makes sure some things are set.
*/
SerialCommand::SerialCommand()
: commandList(NULL),
commandCount(0),
defaultHandler(NULL),
term('\n'), // default terminator for commands, newline character
last(NULL)
{
strcpy(delim, " "); // strtok_r needs a null-terminated string
clearBuffer();
serial = &Serial;
}
SerialCommand::SerialCommand(Stream* serialPort)
: commandList(NULL),
commandCount(0),
defaultHandler(NULL),
term('\n'), // default terminator for commands, newline character
last(NULL)
{
strcpy(delim, " "); // strtok_r needs a null-terminated string
clearBuffer();
serial = serialPort;
}
void SerialCommand::help() {
serial->println("Available commands:");
serial->println("===================");
for (int i = 0; i < commandCount; i++) {
serial->println(commandList[i].command);
}
serial->println("===================");
}
/**
* Adds a "command" and a handler function to the list of available commands.
* This is used for matching a found token in the buffer, and gives the pointer
* to the handler function to deal with it.
*/
void SerialCommand::addCommand(const char *command, void (*function)()) {
#ifdef SERIALCOMMAND_DEBUG
serial->print("Adding command (");
serial->print(commandCount);
serial->print("): ");
serial->println(command);
#endif
commandList = (SerialCommandCallback *) realloc(commandList, (commandCount + 1) * sizeof(SerialCommandCallback));
strncpy(commandList[commandCount].command, command, SERIALCOMMAND_MAXCOMMANDLENGTH);
commandList[commandCount].function = function;
commandCount++;
}
void SerialCommand::disableEcho() {
echoEnabled = false;
}
void SerialCommand::prompt() {
if(echoEnabled) {
serial->println();
serial->print(SERIALCOMMAND_PROMPT);
}
}
/**
* This sets up a handler to be called in the event that the receveived command string
* isn't in the list of commands.
*/
void SerialCommand::setDefaultHandler(void (*function)(const char *)) {
defaultHandler = function;
}
void SerialCommand::readChar(char inChar) {
if (inChar == term) { // Check for the terminator (default '\r') meaning end of command
if(echoEnabled) {
serial->print(inChar); // Echo back to serial stream
}
#ifdef SERIALCOMMAND_DEBUG
serial->print("Received: ");
serial->println(buffer);
#endif
char *command = strtok_r(buffer, delim, &last); // Search for command at start of buffer
if (command != NULL) {
boolean matched = false;
for (int i = 0; i < commandCount; i++) {
#ifdef SERIALCOMMAND_DEBUG
serial->print("Comparing [");
serial->print(command);
serial->print("] to [");
serial->print(commandList[i].command);
serial->println("]");
#endif
if (strncmp(command, "help", 4) == 0) {
help();
matched = true;
break;
}
// Compare the found command against the list of known commands for a match
if (strncmp(command, commandList[i].command, SERIALCOMMAND_MAXCOMMANDLENGTH) == 0) {
#ifdef SERIALCOMMAND_DEBUG
serial->print("Matched Command: ");
serial->println(command);
#endif
// Execute the stored handler function for the command
(*commandList[i].function)();
matched = true;
break;
}
}
if (!matched && (defaultHandler != NULL)) {
(*defaultHandler)(command);
}
}
clearBuffer();
prompt();
} else if(inChar == 0x8 && bufPos > 0) {
if(echoEnabled) {
serial->write(0x08);
serial->print(' ');
serial->write(0x08);
}
bufPos--;
buffer[bufPos] = '\0';
} else if (isprint(inChar)) { // Only printable characters into the buffer
if(echoEnabled) {
serial->print(inChar); // Echo back to serial stream
}
if (bufPos < SERIALCOMMAND_BUFFER) {
buffer[bufPos++] = inChar; // Put character into buffer
buffer[bufPos] = '\0'; // Null terminate
} else {
#ifdef SERIALCOMMAND_DEBUG
serial->println("Line buffer is full - increase SERIALCOMMAND_BUFFER");
#endif
}
}
}
/**
* This checks the Serial stream for characters, and assembles them into a buffer.
* When the terminator character (default '\n') is seen, it starts parsing the
* buffer for a prefix command, and calls handlers setup by addCommand() member
*/
void SerialCommand::readSerial() {
while (serial->available() > 0) {
char inChar = serial->read(); // Read single available character, there may be more waiting
readChar(inChar);
}
}
/*
* Clear the input buffer.
*/
void SerialCommand::clearBuffer() {
buffer[0] = '\0';
bufPos = 0;
}
/**
* Retrieve the next token ("word" or "argument") from the command buffer.
* Returns NULL if no more tokens exist.
*/
char *SerialCommand::next() {
return strtok_r(NULL, delim, &last);
}