VE.Direct: collect serial input into buffer and print

should help debug issues for users.

Author: schlimmchen

lib/VeDirectFrameHandler/VeDirectFrameHandler.cpp

@@ -70,6 +70,7 @@ VeDirectFrameHandler::VeDirectFrameHandler() :
 	_name(""),
 	_value(""),
 	_tmpFrame(),
+	_debugIn(0),
 	_lastByteMillis(0),
 	_lastUpdate(0)
 {
@@ -82,6 +83,18 @@ void VeDirectFrameHandler::init(int8_t rx, int8_t tx, Print* msgOut)
 	_msgOut = msgOut;
 }
 
+void VeDirectFrameHandler::dumpDebugBuffer() {
+	_msgOut->printf("[VE.Direct] serial input:");
+	for (int i = 0; i < _debugIn; ++i) {
+		if (i % 16 == 0) {
+			_msgOut->printf("\r\n[VE.Direct] ");
+		}
+		_msgOut->printf("%02x ", _debugBuffer[i]);
+	}
+	_msgOut->println("");
+	_debugIn = 0;
+}
+
 void VeDirectFrameHandler::loop()
 {
 	while ( VedirectSerial.available()) {
@@ -94,6 +107,7 @@ void VeDirectFrameHandler::loop()
 	// to decode a new frame once more data arrives.
 	if (IDLE != _state && _lastByteMillis + 500 < millis()) {
 		_msgOut->printf("[VE.Direct] Resetting state machine (was %d) after timeout\r\n", _state);
+		dumpDebugBuffer();
 		_checksum = 0;
 		_state = IDLE;
 		_tmpFrame = { };
@@ -107,6 +121,12 @@ void VeDirectFrameHandler::loop()
  */
 void VeDirectFrameHandler::rxData(uint8_t inbyte)
 {
+	_debugBuffer[_debugIn] = inbyte;
+	_debugIn = (_debugIn + 1) % _debugBuffer.size();
+	if (0 == _debugIn) {
+		_msgOut->println("[VE.Direct] ERROR: debug buffer overrun!");
+	}
+
 	//if (mStop) return;
 	if ( (inbyte == ':') && (_state != CHECKSUM) ) {
 		_prevState = _state; //hex frame can interrupt TEXT
@@ -268,6 +288,9 @@ void VeDirectFrameHandler::textRxEvent(char * name, char * value) {
  *  is created in the public buffer.
  */
 void VeDirectFrameHandler::frameEndEvent(bool valid) {
+	// TODO this should be toggled by a "verbose logging" switch
+	dumpDebugBuffer();
+
 	if ( valid ) {
 		_tmpFrame.P = _tmpFrame.V * _tmpFrame.I;
 

lib/VeDirectFrameHandler/VeDirectFrameHandler.h

@@ -12,6 +12,7 @@
 #pragma once
 
 #include <Arduino.h>
+#include <array>
 
 #ifndef VICTRON_PIN_TX
 #define VICTRON_PIN_TX 21      // HardwareSerial TX Pin
@@ -101,6 +102,7 @@ class VeDirectFrameHandler {
 
 private:
     void setLastUpdate();                     // set timestampt after successful frame read
+    void dumpDebugBuffer();
     void rxData(uint8_t inbyte);              // byte of serial data
     void textRxEvent(char *, char *);
     void frameEndEvent(bool);                 // copy temp struct to public struct
@@ -117,6 +119,8 @@ class VeDirectFrameHandler {
     char _value[VE_MAX_VALUE_LEN];             // buffer for the field value
     veStruct _tmpFrame{};                        // private struct for received name and value pairs
     MovingAverage<double, 5> _efficiency;
+    std::array<uint8_t, 512> _debugBuffer;
+    unsigned _debugIn;
     uint32_t _lastByteMillis;
     uint32_t _lastUpdate;
 };