feat: tracking serial string water mark

Author: jasonyang-ee

Application/Inc/Serial.hpp

@@ -14,16 +14,21 @@ class Serial {
     virtual ~Serial(){};
 
     // Must be greater than protobuf payload size
-    static constexpr size_t UART_BUFFER_SIZE{512};
+    static constexpr size_t UART_BUFFER_SIZE{64};
 
     // Tx Rx Memory for DMA
-    std::array<uint8_t, UART_BUFFER_SIZE> tx;
+    std::array<uint8_t, UART_BUFFER_SIZE * 4> tx;
     std::array<uint8_t, UART_BUFFER_SIZE> rx;
 
     /// @brief Initialize Serial
     /// @param Ports Vector of UART_HandleTypeDef pointer
     void setPort(std::vector<UART_HandleTypeDef *> Ports) { ports = Ports; }
 
+	/// @brief Get high water mark
+	/// @return High water mark
+	/// @note High water mark is the maximum size of the tx_cache
+	uint16_t getHighWaterMark() { return high_water_mark; }
+
     /// @brief Send a new line character
     void sendLn() { tx_cache.append("\n"); };
 
@@ -71,6 +76,47 @@ class Serial {
         }
     }
 
+    /// @brief Sending number with message
+    /// @tparam T Data type
+    /// @param msg Message to be sent
+    /// @param value number to be buffered
+    template <class T>
+    void sendCombined(std::string msg, T value) {
+        sendString(msg);
+        sendString(":\t\t\t");
+        sendNumber(value);
+        sendLn();
+    }
+
+    /// @brief Sending 1D array with message
+    /// @tparam T Data type
+    /// @tparam N 1D array size
+    /// @param msg Message to be sent
+    /// @param elements Array to be buffered
+    /// @param value number to be buffered
+    template <class T, size_t N>
+    void sendCombined(std::string msg, std::array<T, N> elements) {
+        sendString(msg);
+        sendString(":\t\t\t");
+        sendNumber(elements);
+        sendLn();
+    }
+
+    /// @brief Sending 2D array with message
+    /// @tparam T Data type
+    /// @tparam N 2D array size
+    /// @tparam M 1D array size
+    /// @param msg Message to be sent
+    /// @param elements Array to be buffered
+    /// @param value number to be buffered
+    template <class T, size_t N, size_t M>
+    void sendCombined(std::string msg, std::array<std::array<T, M>, N> elements) {
+        sendString(msg);
+        sendString(":\t\t\t");
+        sendNumber(elements);
+        sendLn();
+    }
+
     /// @brief Buffer a protobuf payload to be sent
     /// @param msg protobuf payload
     /// @param size size of the payload
@@ -84,6 +130,7 @@ class Serial {
     /// @return True if data is sent
     bool commit() {
         if (!tx_cache.empty()) {
+			if (tx_cache.size() > high_water_mark) high_water_mark = tx_cache.size();
             if (tx_cache.size() < (UART_BUFFER_SIZE)) {
                 std::copy(tx_cache.begin(), tx_cache.end(), tx.data());
                 tx_size = tx_cache.size();
@@ -120,6 +167,9 @@ class Serial {
     // Sending buffer size
     uint16_t tx_size{};
     uint16_t pb_size{};
+
+	// High water mark
+	uint16_t high_water_mark{};
 };
 
 #endif /* CORE_INC_SERIAL */

Application/Src/Thread.cpp

@@ -74,10 +74,10 @@ void Thread::init() {
         dac.init();
         flash.Load();
         SM<Thread>::triggerEvent(Event::INIT_DONE, thread_sm);
-        serial.sendString("High Water Mark: ");
-        serial.sendNumber(uxTaskGetStackHighWaterMark(NULL));
         serial.sendString("\nCurrent Free Heap: ");
         serial.sendNumber(xPortGetFreeHeapSize());
+        serial.sendString("High Water Mark: ");
+        serial.sendNumber(uxTaskGetStackHighWaterMark(NULL));
         serial.sendString("\n\nSystem Boot OK\n");
         vTaskDelete(NULL);
     }
@@ -120,6 +120,8 @@ void Thread::telemetry() {
         serial.sendNumber(xPortGetFreeHeapSize());
         serial.sendString("\nMinimum Free Heap: ");
         serial.sendNumber(xPortGetMinimumEverFreeHeapSize());
+		serial.sendString("\nSerial High Water Mark: ");
+		serial.sendNumber(serial.getHighWaterMark());
         serial.sendLn();
 
         SM<Thread>::triggerEvent(Event::TASK_DONE, telemetry_sm);