V1.7.25.Az - Updates

- Added ring buffer for collecting logs via Serial. Unfortunately, memory constraints make this less useful, we need to reduce the overall number of debug spew statements

Author: ClutchplateDude

Software/Arduino code/OpenAstroTracker/Globals.hpp

@@ -15,7 +15,7 @@
 #define DEC_Stepper_TYPE  0    // 28BYJ-48 = 0   |   NEMA = 1
 
 // Are we supporting the Azimuth PA motor?
-#define AZIMUTH_MOTOR 1
+#define AZIMUTH_MOTOR 0
 
 // Make some variables in the sketch files available to the C++ code.
 extern bool inSerialControl;
@@ -30,6 +30,14 @@ extern float DECStepsPerRevolution;
 extern int DecPulleyTeeth;
 
 // Debugging output control
+// Debug log output is tricky, since if we simply send it out via Serial and a client is connected via Serial (USB), 
+// the debug spew will interfere the protocol and confuse the client. To still be able to get access to debug logs in 
+// this scenario, you can collect the debug logs in a memory ring buffer instead of sending them to Serial by
+// enabling the setting below
+// Use the Meade extension command :XGO# to retrieve the logs
+#define BUFFER_LOGS 0
+
+// The level of debugging spew is controlled by setting DEBUG_LEVEL to a combination of the bit flags below.
 // Each bit in the debug level specifies a kind of debug to enable. 
 #define DEBUG_NONE           0x00
 #define DEBUG_INFO           0x01
@@ -50,16 +58,15 @@ extern int DecPulleyTeeth;
 //  4  DEBUG_MOUNT_VERBOSE  Verbose mount processing (coordinates, etc)
 //  5  DEBUG_GENERAL        Other misc. output
 //  6  DEBUG_MEADE          Meade command handling output
+//  7  DEBUG_VERBOSE        other verbose debug output
+//  7  DEBUG_ANY            all debug output
 
-// Set this to specify the amount of debug output OAT should send to the serial port.
-// Note that if you use an app to control OAT, ANY debug output will likely confuse that app.
-// Debug output is useful if you are using Wifi to control the OAT or if you are issuing
-// manual commands via a terminal.
-//
+// Set this to specify the amount of debug output OAT should generate.
 // #define DEBUG_LEVEL (DEBUG_SERIAL|DEBUG_WIFI|DEBUG_INFO|DEBUG_MOUNT|DEBUG_GENERAL)
 // #define DEBUG_LEVEL (DEBUG_ANY)
 // #define DEBUG_LEVEL (DEBUG_INFO|DEBUG_MOUNT|DEBUG_GENERAL)
 // #define DEBUG_LEVEL (DEBUG_WIFI|DEBUG_MEADE|DEBUG_INFO|DEBUG_GENERAL)
+// #define DEBUG_LEVEL (DEBUG_MEADE|DEBUG_INFO|DEBUG_GENERAL)
 #define DEBUG_LEVEL (DEBUG_NONE)
 
 // Set this to 1 to run a key diagnostic. No tracker functions are on at all.

Software/Arduino code/OpenAstroTracker/MeadeCommandProcessor.cpp

@@ -752,6 +752,9 @@ String MeadeCommandProcessor::handleMeadeExtraCommands(String inCmd) {
     else if (inCmd[1] == 'M') {
       return String(_mount->getMountHardwareInfo()) + "#";
     }
+    else if (inCmd[1] == 'O') {
+      return getLogBuffer();
+    }
     else if (inCmd[1] == 'H') {
       char scratchBuffer[10];
       sprintf(scratchBuffer, "%02d%02d%02d#", _mount->HA().getHours(), _mount->HA().getMinutes(), _mount->HA().getSeconds());

Software/Arduino code/OpenAstroTracker/Utility.cpp

@@ -12,6 +12,86 @@ unsigned long RealTime::_suspendStart = 0;
 int RealTime::_suspended = 0;
 #endif
 
+#if BUFFER_LOGS
+#define LOG_BUFFER_SIZE 512
+char logBuffer[LOG_BUFFER_SIZE];
+int bufferWritePos = 0;
+int bufferStartPos = 0;
+
+int scanForNextNewLine(int bufPos) {
+	for (int i = bufPos; i < LOG_BUFFER_SIZE; i++) {
+		if (logBuffer[i] == '\n') {
+			return i;
+		}
+  }
+
+	for (int i = 0; i < LOG_BUFFER_SIZE; i++) {
+		if (logBuffer[i] == '\n') {
+			return i;
+		}
+	}
+	// WTF?
+	return 0;
+}
+
+void addToLogBuffer(String s) {
+	s += '\n';
+	int charsToWrite = s.length();
+	if (bufferWritePos + charsToWrite > LOG_BUFFER_SIZE) {
+		int charsToWriteAtEndOfBuffer = LOG_BUFFER_SIZE - bufferWritePos;
+		memcpy(logBuffer + bufferWritePos,  s.c_str(),  charsToWriteAtEndOfBuffer);
+		charsToWrite -= charsToWriteAtEndOfBuffer;
+		memcpy(logBuffer, s.c_str() + charsToWriteAtEndOfBuffer, charsToWrite);
+		bufferWritePos = charsToWrite;
+		logBuffer[bufferWritePos] = '\0';
+		bufferStartPos = scanForNextNewLine(bufferWritePos);
+	}
+	else {
+		memcpy(logBuffer + bufferWritePos, s.c_str(), charsToWrite);
+		if (bufferStartPos > bufferWritePos) {
+			bufferWritePos += charsToWrite;
+			bufferStartPos = scanForNextNewLine(bufferWritePos);
+		}
+		else {
+			bufferWritePos += charsToWrite;
+		}
+	}
+}
+
+class MyString : public String {
+public: 
+  void setLen(unsigned int newLen) { len = newLen ; }
+};
+
+String getLogBuffer() {
+  MyString result;
+  unsigned int len = (bufferStartPos > bufferWritePos) ? LOG_BUFFER_SIZE - bufferStartPos : 0;
+	len += bufferWritePos;
+  result.reserve(len + 2);
+  char* buffer = result.begin();
+
+  if (bufferStartPos > bufferWritePos) {
+		for (int i = bufferStartPos;i < LOG_BUFFER_SIZE; i++)
+		{
+			*buffer++ = (logBuffer[i] == '#') ? '%' : logBuffer[i];
+		}
+	}
+
+	for (int i = 0; i < bufferWritePos; i++)
+	{
+			*buffer++ = (logBuffer[i] == '#') ? '%' : logBuffer[i];
+	}
+
+  *buffer++ = '#';
+  *buffer = '\0';
+  result.setLen(buffer - result.begin());
+  return result;
+}
+#else
+String getLogBuffer() {
+  return "Debugging disabled.#";
+}
+#endif
 
 // Adjust the given number by the given adjustment, wrap around the limits.
 // Limits are inclusive, so they represent the lowest and highest valid number.
@@ -174,24 +254,18 @@ String format(const char *input, ...)
   return ret;
 }
 
-// void log(const char* input) {
-//   Serial.println(input);
-//   Serial.flush();
-// }
-
-// void log(String input) {
-//   Serial.println(input);
-//   Serial.flush();
-// }
-
 void logv(int levelFlags, const char *input, ...)
 {
   if ((levelFlags & DEBUG_LEVEL) != 0)
   {
     va_list argp;
     va_start(argp, input);
-    Serial.println(formatArg(input, argp));
-    Serial.flush();
+    #if BUFFER_LOGS
+      addToLogBuffer(formatArg(input, argp));
+    #else
+      Serial.println(formatArg(input, argp));
+      Serial.flush();
+    #endif
     va_end(argp);
   }
 }

Software/Arduino code/OpenAstroTracker/Utility.hpp

@@ -12,8 +12,11 @@
 #define btnSELECT 4
 #define btnNONE   5
 
+String getLogBuffer();
+
 #if DEBUG_LEVEL>0
 
+
 #define LOGV1(level,a) logv((level),(a))
 #define LOGV2(level,a,b) logv((level),(a),(b))
 #define LOGV3(level,a,b,c) logv((level),(a),(b),(c))