[Serial Console] Fix outputting data to USBCDC port for ESP32S2

See: espressif/arduino-esp32#12178

Author: TD-er

src/src/ESPEasyCore/ESPEasy_Console_Port.cpp

@@ -18,10 +18,10 @@
 
 
 #ifdef ESP32
-#define CONSOLE_INPUT_BUFFER_SIZE          1280
+# define CONSOLE_INPUT_BUFFER_SIZE          1280
 #else
-#define CONSOLE_INPUT_BUFFER_SIZE          128
-#endif
+# define CONSOLE_INPUT_BUFFER_SIZE          128
+#endif // ifdef ESP32
 
 
 /*
@@ -31,19 +31,20 @@
  */
 
 EspEasy_Console_Port::EspEasy_Console_Port(LogDestination log_destination)
-: _serialWriteBuffer(log_destination) 
+  : _serialWriteBuffer(log_destination)
 {
-  InputBuffer_Serial = (char*)calloc(1, CONSOLE_INPUT_BUFFER_SIZE);
+  InputBuffer_Serial = (char *)calloc(1, CONSOLE_INPUT_BUFFER_SIZE);
 }
 
 EspEasy_Console_Port::~EspEasy_Console_Port()
 {
 #if FEATURE_DEFINE_SERIAL_CONSOLE_PORT
+
   if (_serial != nullptr) {
     delete _serial;
     _serial = nullptr;
   }
-#endif
+#endif // if FEATURE_DEFINE_SERIAL_CONSOLE_PORT
   free(InputBuffer_Serial);
 }
 
@@ -111,14 +112,36 @@ void EspEasy_Console_Port::endPort()
   }
 }
 
-
 bool EspEasy_Console_Port::process_serialWriteBuffer()
 {
   if (_serial != nullptr) {
 #ifdef ESP32
-    if (!xPortCanYield()) return false;
-#endif
-    return _serialWriteBuffer.process(_serial, _serial->availableForWrite());
+
+    if (!xPortCanYield()) { return false; }
+#endif // ifdef ESP32
+    size_t availableForWrite = _serial->availableForWrite();
+
+    if (availableForWrite == 0) { return false; }
+
+    if (availableForWrite == 1) {
+      // For only a single byte, just write it directly
+      return _serialWriteBuffer.process(_serial, availableForWrite);
+    }
+
+    if (availableForWrite > 64) {
+      // Set to max. of 64 bytes as this is the optimum 'chunk size' for most
+      // serial ports, like the CDC ports and I2C to UART.
+      // Also it is relatively fast to allocate.
+      availableForWrite = 64;
+    }
+
+    PrintToString str;
+    str.reserve(availableForWrite);
+
+    if (_serialWriteBuffer.process(&str, availableForWrite)) {
+      _serial->write(str.get().c_str(), str.length());
+      return true;
+    }
   }
   return false;
 }
@@ -147,7 +170,7 @@ bool EspEasy_Console_Port::process_consoleInput(uint8_t SerialInByte)
       Logging.consolePrintln(concat('>', cmd));
 #endif
 
-      ExecuteCommand_all({EventValueSource::Enum::VALUE_SOURCE_SERIAL, std::move(cmd)}, true);
+      ExecuteCommand_all({ EventValueSource::Enum::VALUE_SOURCE_SERIAL, std::move(cmd) }, true);
       SerialInByteCounter   = 0;
       InputBuffer_Serial[0] = 0; // serial data processed, clear buffer
       return true;

src/src/Helpers/LogStreamWriter.cpp

@@ -14,7 +14,7 @@ void LogStreamWriter::clear()
   _readpos   = 0;
 }
 
-bool LogStreamWriter::process(Stream*stream, size_t availableForWrite)
+bool LogStreamWriter::process(Print*stream, size_t availableForWrite)
 {
   if (stream == nullptr) { return false; }
   return write(*stream, availableForWrite) != 0;
@@ -30,7 +30,7 @@ uint32_t LogStreamWriter::getNrMessages() const
   return Logging.getNrMessages(_log_destination);
 }
 
-size_t LogStreamWriter::write(Stream& stream, size_t nrBytesToWrite)
+size_t LogStreamWriter::write(Print& stream, size_t nrBytesToWrite)
 {
   size_t bytesWritten = 0;
 
@@ -45,7 +45,7 @@ size_t LogStreamWriter::write(Stream& stream, size_t nrBytesToWrite)
   return bytesWritten;
 }
 
-size_t LogStreamWriter::write_single_item(Stream& stream,
+size_t LogStreamWriter::write_single_item(Print& stream,
                                           size_t  nrBytesToWrite)
 {
   const size_t res = write_item(stream, nrBytesToWrite);
@@ -54,7 +54,7 @@ size_t LogStreamWriter::write_single_item(Stream& stream,
   return res;
 }
 
-size_t LogStreamWriter::write_item(Stream& stream,
+size_t LogStreamWriter::write_item(Print& stream,
                                    size_t  nrBytesToWrite)
 {
   size_t bytesWritten = 0;
@@ -103,7 +103,7 @@ size_t LogStreamWriter::write_item(Stream& stream,
       ++_readpos;
     } else {
       if ((bytesWritten + 2) > nrBytesToWrite) { return bytesWritten; }
-      bytesWritten += stream.println();
+      bytesWritten += stream.print(F("\r\n")); // stream.println();
 
       // Done with entry, cleanup and leave
       clear();
@@ -113,6 +113,6 @@ size_t LogStreamWriter::write_item(Stream& stream,
   return bytesWritten;
 }
 
-size_t LogStreamWriter::write_skipping(Stream& stream) { return 0; }
+size_t LogStreamWriter::write_skipping(Print& stream) { return 0; }
 
 void   LogStreamWriter::prepare_prefix()               {}

src/src/Helpers/LogStreamWriter.h

@@ -11,7 +11,7 @@ class LogStreamWriter
 
   virtual ~LogStreamWriter() {}
 
-  virtual bool     process(Stream* stream, size_t availableForWrite);
+  virtual bool     process(Print* stream, size_t availableForWrite);
 
   // Only use this from derived classes, as we need a Stream to further process
   virtual bool     process();
@@ -24,20 +24,20 @@ class LogStreamWriter
 
   // Write continuously until either nrBytesToWrite was reached or no new messages were available to process.
   // @retval Number of bytes written. Zero when no new message was available to process.
-  virtual size_t write(Stream& stream,
+  virtual size_t write(Print& stream,
                        size_t  nrBytesToWrite);
 
   // Write single item and clear() on return.
   // This way each call starts with a new item and long messages may get truncated based on nrBytesToWrite
   // @retval Number of bytes written. Zero when no new message was available to process.
-  virtual size_t write_single_item(Stream& stream,
+  virtual size_t write_single_item(Print& stream,
                                    size_t  nrBytesToWrite);
 
-  virtual size_t write_item(Stream& stream,
+  virtual size_t write_item(Print& stream,
                             size_t  nrBytesToWrite);
 
 
-  virtual size_t write_skipping(Stream& stream);
+  virtual size_t write_skipping(Print& stream);
 
   virtual void   prepare_prefix();
 

src/src/Helpers/SerialWriteBuffer.cpp

@@ -34,14 +34,10 @@ String SerialWriteBuffer_t::colorize(const String& str) const {
 }
 
 
-size_t SerialWriteBuffer_t::write_skipping(Stream& stream)
+size_t SerialWriteBuffer_t::write_skipping(Print& stream)
 {
-  size_t bytesWritten{};
-
   // Mark with empty line we skipped the rest of the message.
-  bytesWritten += stream.println(F(" ..."));
-  bytesWritten += stream.println();
-  return bytesWritten;
+  return stream.print(F(" ...\r\n\r\n"));
 }
 
 void SerialWriteBuffer_t::prepare_prefix()

src/src/Helpers/SerialWriteBuffer.h

@@ -14,7 +14,7 @@ class SerialWriteBuffer_t : public LogStreamWriter {
 
 private:
 
-  size_t write_skipping(Stream& stream) override;
+  size_t write_skipping(Print& stream) override;
 
   void prepare_prefix() override;