forked from kroimon/Arduino-SerialCommand
-
Notifications
You must be signed in to change notification settings - Fork 1
/
StreamCommand.cpp
207 lines (193 loc) · 6.41 KB
/
StreamCommand.cpp
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
199
200
201
202
203
204
205
206
207
/**
* StreamCommand - A Wiring/Arduino library to tokenize and parse commands
* received over a stream port.
*
* Copyright (C) 2014 Mauricio Jabur
*
* SerialCommand:
* Copyright (C) 2014 Craig Versek
* Copyright (C) 2012 Stefan Rado
* Copyright (C) 2011 Steven Cogswell <[email protected]>
* http://husks.wordpress.com
*
* Version 20140419
*
* Updated for blank line support by DeKay, Feb 2014
* 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 "StreamCommand.h"
/**
* Constructor makes sure some things are set.
*/
StreamCommand::StreamCommand(Stream *stream,
byte maxCommands
)
: _stream(stream),
_commandList(NULL),
_commandCount(0),
_defaultHandler(NULL),
_nullHandler(NULL),
_term('\r'), // default terminator for commands, CR character
_last(NULL)
{
_maxCommands = maxCommands;
strcpy(_delim, " "); // strtok_r needs a null-terminated string
clearBuffer();
//allocate memory for the command list
_commandList = (StreamCommandCallback *) calloc(maxCommands, sizeof(StreamCommandCallback));
}
/**
* Constructor makes sure some things are set.
*/
StreamCommand::StreamCommand(
byte maxCommands
)
: _stream(&Serial),
_commandList(NULL),
_commandCount(0),
_defaultHandler(NULL),
_nullHandler(NULL),
_term('\r'), // default terminator for commands, CR character
_last(NULL)
{
_maxCommands = maxCommands;
strcpy(_delim, " "); // strtok_r needs a null-terminated string
clearBuffer();
//allocate memory for the command list
_commandList = (StreamCommandCallback *) calloc(maxCommands, sizeof(StreamCommandCallback));
}
/**
* Selects which Stream will be used (e.g.a hardware or software serial port)
*/
void StreamCommand::setStream(Stream *_stream){
_stream = _stream;
}
/**
* 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 StreamCommand::addCommand(const char *command, void(*function)()) {
#ifdef STREAMCOMMAND_DEBUG
_stream->print("Adding command (");
_stream->print(_commandCount);
_stream->print("): ");
_stream->println(command);
#endif
if (_commandCount >= _maxCommands){
#ifdef STREAMCOMMAND_DEBUG
_stream->println("Error: maxCommands was exceeded");
#endif
return;
}
//make a new callback
struct StreamCommandCallback new_callback;
new_callback.command = command;
new_callback.function = function;
_commandList[_commandCount] = new_callback;
_commandCount++;
}
/**
* This sets up a handler to be called in the event that the received command string
* isn't in the list of commands.
*/
void StreamCommand::setDefaultHandler(void (*function)(const char *)) {
_defaultHandler = function;
}
/**
* This sets up a handler to be called in the event that the user hits enter on a
* blank line
*/
void StreamCommand::setNullHandler(void (*function)()) {
_nullHandler = function;
}
/**
* This checks the 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 set up by addCommand() member
*/
void StreamCommand::readStream() {
while (_stream->available() > 0) {
char inChar = _stream->read(); // Read single available character, there may be more waiting
#ifdef STREAMCOMMAND_DEBUG
_stream->print(inChar); // Echo back to stream
#endif
if (inChar == _term) { // Check for the terminator (default '\r') meaning end of command
#ifdef STREAMCOMMAND_DEBUG
_stream->print("Received: ");
_stream->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 STREAMCOMMAND_DEBUG
_stream->print("Comparing [");
_stream->print(command);
_stream->print("] to [");
_stream->print(_commandList[i].command);
_stream->println("]");
#endif
// Compare the found command against the list of known commands for a match
if (strcmp(command, _commandList[i].command) == 0) {
#ifdef STREAMCOMMAND_DEBUG
_stream->print("Matched Command: ");
_stream->println(command);
#endif
// Execute the stored handler function for the command
(*_commandList[i].function)();
matched = true;
break;
}
}
if (!matched && (_defaultHandler != NULL)) {
(*_defaultHandler)(command);
}
} else if (_nullHandler != NULL) {
(*_nullHandler)();
}
clearBuffer();
}
else if (isprint(inChar)) { // Only printable characters into the buffer
if (_bufPos < STREAMCOMMAND_BUFFER) {
_buffer[_bufPos++] = inChar; // Put character into buffer
_buffer[_bufPos] = '\0'; // Null terminate
} else {
#ifdef STREAMCOMMAND_DEBUG
_stream->println("Line buffer is full - increase STREAMCOMMAND_BUFFER");
#endif
}
}
}
}
/*
* Clear the input buffer.
*/
void StreamCommand::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 *StreamCommand::next() {
return strtok_r(NULL, _delim, &_last);
}
/**
* forward all writes to the encapsulated "port" Stream object
*/
size_t StreamCommand::write(uint8_t val) {
return _stream->write(val);
}