Initial commit of ArduinoDebugUtils

Author: aentinger

src/ArduinoDebugUtils.cpp

@@ -0,0 +1,91 @@
+/*
+   This file is part of ArduinoDebugUtils.
+
+   Copyright 2019 ARDUINO SA (http://www.arduino.cc/)
+
+   This software is released under the GNU General Public License version 3,
+   which covers the main part of arduino-cli.
+   The terms of this license can be found at:
+   https://www.gnu.org/licenses/gpl-3.0.en.html
+
+   You can be released from the requirements of the above licenses by purchasing
+   a commercial license. Buying such a license is mandatory if you want to modify or
+   otherwise use the software for commercial activities involving the Arduino
+   software without disclosing the source code of your own applications. To purchase
+   a commercial license, send an email to license@arduino.cc.
+*/
+
+/******************************************************************************
+   INCLUDE
+ ******************************************************************************/
+
+#include "ArduinoDebugUtils.h"
+
+/******************************************************************************
+   CTOR/DTOR
+ ******************************************************************************/
+
+ArduinoDebugUtils::ArduinoDebugUtils()
+{
+  timestampOff();
+  setDebugLevel(DEFAULT_DEBUG_LEVEL);
+  setDebugOutputStream(DEFAULT_OUTPUT_STREAM);
+}
+
+/******************************************************************************
+   PUBLIC MEMBER FUNCTIONS
+ ******************************************************************************/
+
+void ArduinoDebugUtils::setDebugLevel(DebugLevel const debug_level)
+{
+  _debug_level = debug_level;
+}
+
+void ArduinoDebugUtils::setDebugOutputStream(Stream * stream)
+{
+  _debug_output_stream = stream;
+}
+
+void ArduinoDebugUtils::timestampOn()
+{
+  _timestamp_on = true;
+}
+
+void ArduinoDebugUtils::timestampOff()
+{
+  _timestamp_on = false;
+}
+
+void ArduinoDebugUtils::debugPrint(DebugLevel const debug_level, const char * fmt, ...)
+{
+  if (debug_level >= DebugLevel::Error   &&
+      debug_level <= DebugLevel::Verbose &&
+      debug_level <= _debug_level)
+  {
+    if(_timestamp_on)
+    {
+      char timestamp[20];
+      snprintf(timestamp, 20, "[ %lu ] ", millis());
+      debug_output_stream->print(timestamp);
+    }
+
+    va_list args;
+    va_start(args, fmt);
+    vDebugPrint(fmt, args);
+    va_end(args);
+  }
+}
+
+/******************************************************************************
+   PRIVATE MEMBER FUNCTIONS
+ ******************************************************************************/
+
+void ArduinoDebugUtils::vDebugPrint(char const * fmt, va_list args)
+{
+  static size_t const MSG_BUF_SIZE = 120;
+  char msg_buf[MSG_BUF_SIZE] = {0};
+
+  vsnprintf(msg_buf, MSG_BUF_SIZE, fmt, args);
+
+  _debug_output_stream->println(msg_buf);
+}

src/ArduinoDebugUtils.h

@@ -0,0 +1,75 @@
+/*
+   This file is part of ArduinoDebugUtils.
+
+   Copyright 2019 ARDUINO SA (http://www.arduino.cc/)
+
+   This software is released under the GNU General Public License version 3,
+   which covers the main part of arduino-cli.
+   The terms of this license can be found at:
+   https://www.gnu.org/licenses/gpl-3.0.en.html
+
+   You can be released from the requirements of the above licenses by purchasing
+   a commercial license. Buying such a license is mandatory if you want to modify or
+   otherwise use the software for commercial activities involving the Arduino
+   software without disclosing the source code of your own applications. To purchase
+   a commercial license, send an email to license@arduino.cc.
+*/
+
+#ifndef ARDUINO_DEBUG_UTILS_H_
+#define ARDUINO_DEBUG_UTILS_H_
+
+/******************************************************************************
+   INCLUDE
+ ******************************************************************************/
+
+#include <Arduino.h>
+
+/******************************************************************************
+   TYPEDEF
+ ******************************************************************************/
+
+enum class DebugLevel : int {
+  None    = -1,
+  Error   =  0,
+  Warning =  1,
+  Info    =  2,
+  Debug   =  3,
+  Verbose =  4
+};
+
+/******************************************************************************
+   CLASS DECLARATION
+ ******************************************************************************/
+
+class ArduinoDebugUtils
+{
+
+public:
+
+  ArduinoDebugUtils();
+
+  void setDebugLevel(DebugLevel const debug_level);
+  void setDebugOutputStream(Stream * stream);
+
+  void timestampOn();
+  void timestampOff();
+
+  void debugPrint(DebugLevel const debug_level, const char * fmt, ...);
+
+
+private:
+
+  bool          _timestamp_on;
+  DebugLevel    _debug_level;
+  Stream     *  _debug_output_stream = &Serial;
+
+
+  static DebugLevel const DEFAULT_DEBUG_LEVEL   = DebugLevel::Info;
+  static Stream *         DEFAULT_OUTPUT_STREAM = &Serial;
+
+
+  void vDebugPrint(char const * fmt, va_list args);
+
+};
+
+#endif /* ARDUINO_DEBUG_UTILS_H_ */