Michel2/ESPEasy
1
0
Fork 0
mirror of https://github.com/letscontrolit/ESPEasy.git synced 2026-07-28 04:07:47 +00:00
Code Issues Releases Activity

[Serial Proxy] Move plugin specific struct to .h/.cpp to support captures

Browse Source
This commit is contained in:
Gijs Noorlander
2020-03-21 11:20:21 +01:00
parent cd024b39e4
commit 698d904552
3 changed files with 405 additions and 255 deletions
Download Patch File Download Diff File Expand all files Collapse all files
src/_P087_SerialProxy.ino
+23 -255
View File
@@ -8,8 +8,10 @@
// Allows to redirect data to a controller
//
#include <ESPeasySerial.h>
#include "_Plugin_Helper.h"
#include "src/PluginStructs/P087_data_struct.h"
#include <Regexp.h>
#define PLUGIN_087
@@ -29,256 +31,6 @@
#define P087_DEFAULT_BAUDRATE 38400
#define P087_INITSTRING 0
#define P087_EXITSTRING 1
#define P087_REGEX_POS 0
#define P087_NR_CHAR_USE_POS 1
#define P087_FILTER_OFF_WINDOW_POS 2
#define P087_GLOBAL_INVERT_MATCH_POS 3
#define P087_FIRST_FILTER_POS 6
#define P087_NR_FILTERS 10
#define P87_Nlines (P087_FIRST_FILTER_POS + 3 * (P087_NR_FILTERS))
#define P87_Nchars 128
enum P087_Filter_Comp {
Equal = 0,
NotEqual = 1
};
struct P087_data_struct : public PluginTaskData_base {
P087_data_struct() : P087_easySerial(nullptr) {}
~P087_data_struct() {
reset();
}
void reset() {
if (P087_easySerial != nullptr) {
delete P087_easySerial;
P087_easySerial = nullptr;
}
}
bool init(const int16_t serial_rx, const int16_t serial_tx, unsigned long baudrate) {
if ((serial_rx < 0) && (serial_tx < 0)) {
return false;
}
reset();
P087_easySerial = new ESPeasySerial(serial_rx, serial_tx);
if (isInitialized()) {
P087_easySerial->begin(baudrate);
return true;
}
return false;
}
bool isInitialized() const {
return P087_easySerial != nullptr;
}
void sendString(const String& data) {
if (isInitialized()) {
if (data.length() > 0) {
setDisableFilterWindowTimer();
P087_easySerial->write(data.c_str());
if (loglevelActiveFor(LOG_LEVEL_INFO)) {
String log = F("Proxy: Sending: ");
log += data;
addLog(LOG_LEVEL_INFO, log);
}
}
}
}
bool loop() {
if (!isInitialized()) {
return false;
}
bool fullSentenceReceived = false;
if (P087_easySerial != nullptr) {
int available = P087_easySerial->available();
while (available > 0 && !fullSentenceReceived) {
// Look for end marker
char c = P087_easySerial->read();
--available;
if (available == 0) {
available = P087_easySerial->available();
delay(0);
}
switch (c) {
case 13:
{
const size_t length = sentence_part.length();
bool valid = length > 0;
for (size_t i = 0; i < length && valid; ++i) {
if ((sentence_part[i] > 127) || (sentence_part[i] < 32)) {
sentence_part = "";
++sentences_received_error;
valid = false;
}
}
if (valid) {
fullSentenceReceived = true;
}
break;
}
case 10:
// Ignore LF
break;
default:
sentence_part += c;
break;
}
if (max_length_reached()) { fullSentenceReceived = true; }
}
}
if (fullSentenceReceived) {
++sentences_received;
length_last_received = sentence_part.length();
}
return fullSentenceReceived;
}
void getSentence(String& string) {
string = sentence_part;
sentence_part = "";
}
void getSentencesReceived(uint32_t& succes, uint32_t& error, uint32_t& length_last) const {
succes = sentences_received;
error = sentences_received_error;
length_last = length_last_received;
}
void setMaxLength(uint16_t maxlenght) {
max_length = maxlenght;
}
void loadLines(taskIndex_t taskIndex) {
LoadCustomTaskSettings(taskIndex, _lines, P87_Nlines, 0);
}
void setLine(byte varNr, const String& line) {
if (varNr < P87_Nlines) {
_lines[varNr] = line;
}
}
String saveLines(taskIndex_t taskIndex) {
return SaveCustomTaskSettings(taskIndex, _lines, P87_Nlines, 0);
}
String getRegEx() const {
return _lines[P087_REGEX_POS];
}
uint16_t getRegExpMatchLength() const {
return _lines[P087_NR_CHAR_USE_POS].toInt();
}
uint32_t getFilterOffWindowTime() const {
return _lines[P087_FILTER_OFF_WINDOW_POS].toInt();
}
bool globalInvert() const {
return _lines[P087_GLOBAL_INVERT_MATCH_POS].toInt() == 1;
}
String getFilter(uint8_t lineNr, uint8_t& capture, P087_Filter_Comp& comparator) const
{
uint8_t varNr = lineNr * 3 + P087_FIRST_FILTER_POS;
if (varNr >= P87_Nlines) { return ""; }
capture = _lines[varNr++].toInt();
comparator = _lines[varNr++] == "1" ? P087_Filter_Comp::NotEqual : P087_Filter_Comp::Equal;
return _lines[varNr];
}
void setDisableFilterWindowTimer() {
if (getFilterOffWindowTime() == 0) {
disable_filter_window = 0;
}
else {
disable_filter_window = millis() + getFilterOffWindowTime();
}
}
bool disableFilterWindowActive() const {
if (disable_filter_window != 0) {
if (!timeOutReached(disable_filter_window)) {
// We're still in the window where filtering is disabled
return true;
}
}
return false;
}
bool matchRegexp(String& received) const {
size_t strlength = received.length();
if (strlength == 0) {
return false;
}
uint32_t regexp_match_length = getRegExpMatchLength();
if ((regexp_match_length > 0) && (strlength > regexp_match_length)) {
strlength = regexp_match_length;
}
// We need to do a const_cast here, but this only is valid as long as we
// don't call a replace function from regexp.
MatchState ms(const_cast<char *>(received.c_str()), strlength);
char result = ms.Match(_lines[P087_REGEX_POS].c_str());
if (result == REGEXP_MATCHED) {
if (loglevelActiveFor(LOG_LEVEL_DEBUG)) {
String log = F("Match at: ");
log += ms.MatchStart;
log += F(" Match Length: ");
log += ms.MatchLength;
addLog(LOG_LEVEL_DEBUG, log);
}
return true;
}
return false;
}
private:
bool max_length_reached() const {
if (max_length == 0) { return false; }
return sentence_part.length() >= max_length;
}
String _lines[P87_Nlines];
ESPeasySerial *P087_easySerial = nullptr;
String sentence_part;
uint16_t max_length = 550;
uint32_t sentences_received = 0;
uint32_t sentences_received_error = 0;
uint32_t length_last_received = 0;
unsigned long disable_filter_window = 0;
};
// Plugin settings:
// Validate:
@@ -431,7 +183,8 @@ boolean Plugin_087(byte function, struct EventStruct *event, String& string) {
{
P087_data->setLine(varNr, web_server.arg(getPluginCustomArgName(varNr)));
}
addHtmlError(P087_data->saveLines(event->TaskIndex));
addHtmlError(SaveCustomTaskSettings(event->TaskIndex, P087_data->_lines, P87_Nlines, 0));
success = true;
}
@@ -450,7 +203,7 @@ boolean Plugin_087(byte function, struct EventStruct *event, String& string) {
}
if (P087_data->init(serial_rx, serial_tx, P087_BAUDRATE)) {
P087_data->loadLines(event->TaskIndex);
LoadCustomTaskSettings(event->TaskIndex, P087_data->_lines, P87_Nlines, 0);
success = true;
if (loglevelActiveFor(LOG_LEVEL_DEBUG)) {
@@ -543,7 +296,7 @@ bool Plugin_087_match_all(taskIndex_t taskIndex, String& received)
bool res = P087_data->matchRegexp(received);
if (P087_data->globalInvert()) {
if (P087_data->invertMatch()) {
addLog(LOG_LEVEL_INFO, F("Serial Proxy: invert filter"));
return !res;
}
@@ -576,7 +329,22 @@ void P087_html_show_matchForms(struct EventStruct *event) {
addUnit(F("msec"));
addFormNote(F("0 = Do not turn off filter after sending to the connected device."));
addFormCheckBox(F("Invert match state"), getPluginCustomArgName(P087_GLOBAL_INVERT_MATCH_POS), P087_data->globalInvert(), false);
{
String options[4];
options[P087_Match_Type::Regular_Match] = F("Regular Match");
options[P087_Match_Type::Regular_Match_inverted] = F("Regular Match inverted");
options[P087_Match_Type::Global_Match] = F("Global Match");
options[P087_Match_Type::Global_Match_inverted] = F("Global Match inverted");
int optionValues[4] = { P087_Match_Type::Regular_Match,
P087_Match_Type::Regular_Match_inverted,
P087_Match_Type::Global_Match,
P087_Match_Type::Global_Match_inverted };
P087_Match_Type choice = P087_data->getMatchType();
addFormSelector(F("Match Type"), getPluginCustomArgName(P087_MATCH_TYPE_POS), 4, options, optionValues, choice, false);
addFormNote(F("Capture filter can only be used on Global Match"));
}
byte lineNr = 0;
src/src/PluginStructs/P087_data_struct.cpp
+270
View File
@@ -0,0 +1,270 @@
#include "P087_data_struct.h"
#ifdef USES_P087
P087_data_struct::P087_data_struct() : P087_easySerial(nullptr) {}
P087_data_struct::~P087_data_struct() {
reset();
}
void P087_data_struct::reset() {
if (P087_easySerial != nullptr) {
delete P087_easySerial;
P087_easySerial = nullptr;
}
}
bool P087_data_struct::init(const int16_t serial_rx, const int16_t serial_tx, unsigned long baudrate) {
if ((serial_rx < 0) && (serial_tx < 0)) {
return false;
}
reset();
P087_easySerial = new ESPeasySerial(serial_rx, serial_tx);
if (isInitialized()) {
P087_easySerial->begin(baudrate);
return true;
}
return false;
}
bool P087_data_struct::isInitialized() const {
return P087_easySerial != nullptr;
}
void P087_data_struct::sendString(const String& data) {
if (isInitialized()) {
if (data.length() > 0) {
setDisableFilterWindowTimer();
P087_easySerial->write(data.c_str());
if (loglevelActiveFor(LOG_LEVEL_INFO)) {
String log = F("Proxy: Sending: ");
log += data;
addLog(LOG_LEVEL_INFO, log);
}
}
}
}
bool P087_data_struct::loop() {
if (!isInitialized()) {
return false;
}
bool fullSentenceReceived = false;
if (P087_easySerial != nullptr) {
int available = P087_easySerial->available();
while (available > 0 && !fullSentenceReceived) {
// Look for end marker
char c = P087_easySerial->read();
--available;
if (available == 0) {
available = P087_easySerial->available();
delay(0);
}
switch (c) {
case 13:
{
const size_t length = sentence_part.length();
bool valid = length > 0;
for (size_t i = 0; i < length && valid; ++i) {
if ((sentence_part[i] > 127) || (sentence_part[i] < 32)) {
sentence_part = "";
++sentences_received_error;
valid = false;
}
}
if (valid) {
fullSentenceReceived = true;
}
break;
}
case 10:
// Ignore LF
break;
default:
sentence_part += c;
break;
}
if (max_length_reached()) { fullSentenceReceived = true; }
}
}
if (fullSentenceReceived) {
++sentences_received;
length_last_received = sentence_part.length();
}
return fullSentenceReceived;
}
void P087_data_struct::getSentence(String& string) {
string = sentence_part;
sentence_part = "";
}
void P087_data_struct::getSentencesReceived(uint32_t& succes, uint32_t& error, uint32_t& length_last) const {
succes = sentences_received;
error = sentences_received_error;
length_last = length_last_received;
}
void P087_data_struct::setMaxLength(uint16_t maxlenght) {
max_length = maxlenght;
}
void P087_data_struct::setLine(byte varNr, const String& line) {
if (varNr < P87_Nlines) {
_lines[varNr] = line;
}
}
String P087_data_struct::getRegEx() const {
return _lines[P087_REGEX_POS];
}
uint16_t P087_data_struct::getRegExpMatchLength() const {
return _lines[P087_NR_CHAR_USE_POS].toInt();
}
uint32_t P087_data_struct::getFilterOffWindowTime() const {
return _lines[P087_FILTER_OFF_WINDOW_POS].toInt();
}
P087_Match_Type P087_data_struct::getMatchType() const {
return static_cast<P087_Match_Type>(_lines[P087_MATCH_TYPE_POS].toInt());
}
bool P087_data_struct::invertMatch() const {
switch (getMatchType()) {
case Regular_Match: // fallthrough
case Global_Match:
break;
case Regular_Match_inverted: // fallthrough
case Global_Match_inverted:
return true;
}
return false;
}
bool P087_data_struct::globalMatch() const {
switch (getMatchType()) {
case Regular_Match: // fallthrough
case Regular_Match_inverted:
break;
case Global_Match: // fallthrough
case Global_Match_inverted:
return true;
}
return false;
}
String P087_data_struct::getFilter(uint8_t lineNr, uint8_t& capture, P087_Filter_Comp& comparator) const
{
uint8_t varNr = lineNr * 3 + P087_FIRST_FILTER_POS;
if (varNr >= P87_Nlines) { return ""; }
capture = _lines[varNr++].toInt();
comparator = _lines[varNr++] == "1" ? P087_Filter_Comp::NotEqual : P087_Filter_Comp::Equal;
return _lines[varNr];
}
void P087_data_struct::setDisableFilterWindowTimer() {
if (getFilterOffWindowTime() == 0) {
disable_filter_window = 0;
}
else {
disable_filter_window = millis() + getFilterOffWindowTime();
}
}
bool P087_data_struct::disableFilterWindowActive() const {
if (disable_filter_window != 0) {
if (!timeOutReached(disable_filter_window)) {
// We're still in the window where filtering is disabled
return true;
}
}
return false;
}
typedef std::pair<uint8_t, String> capture_tuple;
static std::vector<capture_tuple> capture_vector;
// called for each match
void P087_data_struct::match_callback(const char *match, const unsigned int length, const MatchState& ms)
{
char cap[10]; // must be large enough to hold captures
Serial.print("Matched: ");
Serial.write((byte *)match, length);
Serial.println();
for (byte i = 0; i < ms.level; i++)
{
Serial.print("Capture ");
Serial.print(i, DEC);
Serial.print(" = ");
ms.GetCapture(cap, i);
Serial.println(cap);
} // end of for each capture
}
bool P087_data_struct::matchRegexp(String& received) const {
size_t strlength = received.length();
if (strlength == 0) {
return false;
}
uint32_t regexp_match_length = getRegExpMatchLength();
if ((regexp_match_length > 0) && (strlength > regexp_match_length)) {
strlength = regexp_match_length;
}
// We need to do a const_cast here, but this only is valid as long as we
// don't call a replace function from regexp.
MatchState ms(const_cast<char *>(received.c_str()), strlength);
bool match_result = false;
if (globalMatch()) {
unsigned long count = ms.GlobalMatch(_lines[P087_REGEX_POS].c_str(), match_callback);
match_result = count != 0;
} else {
char result = ms.Match(_lines[P087_REGEX_POS].c_str());
if (result == REGEXP_MATCHED) {
if (loglevelActiveFor(LOG_LEVEL_DEBUG)) {
String log = F("Match at: ");
log += ms.MatchStart;
log += F(" Match Length: ");
log += ms.MatchLength;
addLog(LOG_LEVEL_DEBUG, log);
}
match_result = true;
}
}
return match_result;
}
bool P087_data_struct::max_length_reached() const {
if (max_length == 0) { return false; }
return sentence_part.length() >= max_length;
}
#endif // USES_P087
src/src/PluginStructs/P087_data_struct.h
+112
View File
@@ -0,0 +1,112 @@
#ifndef PLUGINSTRUCTS_P087_DATA_STRUCT_H
#define PLUGINSTRUCTS_P087_DATA_STRUCT_H
#include <ESPeasySerial.h>
#include "../../_Plugin_Helper.h"
#ifdef USES_P087
# include <Regexp.h>
# define P087_REGEX_POS 0
# define P087_NR_CHAR_USE_POS 1
# define P087_FILTER_OFF_WINDOW_POS 2
# define P087_MATCH_TYPE_POS 3
# define P087_FIRST_FILTER_POS 6
# define P087_NR_FILTERS 10
# define P87_Nlines (P087_FIRST_FILTER_POS + 3 * (P087_NR_FILTERS))
# define P87_Nchars 128
enum P087_Filter_Comp {
Equal = 0,
NotEqual = 1
};
enum P087_Match_Type {
Regular_Match = 0,
Regular_Match_inverted = 1,
Global_Match = 2,
Global_Match_inverted = 3
};
struct P087_data_struct : public PluginTaskData_base {
public:
P087_data_struct();
~P087_data_struct();
void reset();
bool init(const int16_t serial_rx,
const int16_t serial_tx,
unsigned long baudrate);
bool isInitialized() const;
void sendString(const String& data);
bool loop();
void getSentence(String& string);
void getSentencesReceived(uint32_t& succes,
uint32_t& error,
uint32_t& length_last) const;
void setMaxLength(uint16_t maxlenght);
void setLine(byte varNr,
const String& line);
String getRegEx() const;
uint16_t getRegExpMatchLength() const;
uint32_t getFilterOffWindowTime() const;
P087_Match_Type getMatchType() const;
bool invertMatch() const;
bool globalMatch() const;
String getFilter(uint8_t lineNr,
uint8_t & capture,
P087_Filter_Comp& comparator) const;
void setDisableFilterWindowTimer();
bool disableFilterWindowActive() const;
// called for each match
static void match_callback(const char *match,
const unsigned int length,
const MatchState & ms);
bool matchRegexp(String& received) const;
// Made public so we don't have to copy the values when loading/saving.
String _lines[P87_Nlines];
private:
bool max_length_reached() const;
ESPeasySerial *P087_easySerial = nullptr;
String sentence_part;
uint16_t max_length = 550;
uint32_t sentences_received = 0;
uint32_t sentences_received_error = 0;
uint32_t length_last_received = 0;
unsigned long disable_filter_window = 0;
};
#endif // USES_P087
#endif // PLUGINSTRUCTS_P087_DATA_STRUCT_H