Renaming module ArduinoDebugUtils to Arduino_DebugUtils and the external instance from ArduinoDebugUtils to Debug

Author: aentinger

examples/Arduino_Debug_Basic/Arduino_Debug_Basic.ino

@@ -1,16 +1,14 @@
-#include "ArduinoDebugUtils.h"
+#include "Arduino_DebugUtils.h"
 
 void setup() {
   Serial.begin(9600);
-
-  ArduinoDebugUtils.timestampOn();
+  Debug.timestampOn();
 }
 
 int i = 0;
 
 void loop() {
-
-  ArduinoDebugUtils.debugPrint(DEBUG_LVL_INFO, "i = %d", i);
+  Debug.debugPrint(DEBUG_LVL_INFO, "i = %d", i);
   i++;
   delay(1000);
 }

keywords.txt

@@ -1,12 +1,12 @@
 #######################################
-# Syntax Coloring Map For ArduinoDebugUtils
+# Syntax Coloring Map For Arduino_DebugUtils
 #######################################
 
 #######################################
 # Class (KEYWORD1)
 #######################################
 
-ArduinoDebugUtils	KEYWORD1
+Debug	KEYWORD1
 
 #######################################
 # Methods and Functions (KEYWORD2)

src/ArduinoDebugUtils.cpp renamed to src/Arduino_DebugUtils.cpp

@@ -19,7 +19,7 @@
    INCLUDE
  ******************************************************************************/
 
-#include "ArduinoDebugUtils.h"
+#include "Arduino_DebugUtils.h"
 
 /******************************************************************************
    NAMESPACE
@@ -38,7 +38,7 @@ namespace impl {
      CTOR/DTOR
    ******************************************************************************/
 
-  ArduinoDebugUtils::ArduinoDebugUtils() {
+  Arduino_DebugUtils::Arduino_DebugUtils() {
     timestampOff();
     setDebugLevel(DEFAULT_DEBUG_LEVEL);
     setDebugOutputStream(DEFAULT_OUTPUT_STREAM);
@@ -48,23 +48,23 @@ namespace impl {
      PUBLIC MEMBER FUNCTIONS
    ******************************************************************************/
 
-  void ArduinoDebugUtils::setDebugLevel(int const debug_level) {
+  void Arduino_DebugUtils::setDebugLevel(int const debug_level) {
     _debug_level = debug_level;
   }
 
-  void ArduinoDebugUtils::setDebugOutputStream(Stream * stream) {
+  void Arduino_DebugUtils::setDebugOutputStream(Stream * stream) {
     _debug_output_stream = stream;
   }
 
-  void ArduinoDebugUtils::timestampOn() {
+  void Arduino_DebugUtils::timestampOn() {
     _timestamp_on = true;
   }
 
-  void ArduinoDebugUtils::timestampOff() {
+  void Arduino_DebugUtils::timestampOff() {
     _timestamp_on = false;
   }
 
-  void ArduinoDebugUtils::debugPrint(int const debug_level, const char * fmt, ...) {
+  void Arduino_DebugUtils::debugPrint(int const debug_level, const char * fmt, ...) {
     if (debug_level >= DEBUG_LVL_ERROR   &&
         debug_level <= DEBUG_LVL_VERBOSE &&
         debug_level <= _debug_level) {
@@ -85,7 +85,7 @@ namespace impl {
      PRIVATE MEMBER FUNCTIONS
    ******************************************************************************/
 
-  void ArduinoDebugUtils::vDebugPrint(char const * fmt, va_list args) {
+  void Arduino_DebugUtils::vDebugPrint(char const * fmt, va_list args) {
     static size_t const MSG_BUF_SIZE = 120;
     char msg_buf[MSG_BUF_SIZE] = {0};
 
@@ -104,4 +104,4 @@ namespace impl {
    CLASS INSTANTIATION
  ******************************************************************************/
 
-impl::ArduinoDebugUtils ArduinoDebugUtils;
+impl::Arduino_DebugUtils Debug;

src/ArduinoDebugUtils.h renamed to src/Arduino_DebugUtils.h

@@ -47,11 +47,11 @@ namespace impl {
      CLASS DECLARATION
    ******************************************************************************/
 
-  class ArduinoDebugUtils {
+  class Arduino_DebugUtils {
 
     public:
 
-      ArduinoDebugUtils();
+      Arduino_DebugUtils();
 
       void setDebugLevel(int const debug_level);
       void setDebugOutputStream(Stream * stream);
@@ -82,6 +82,6 @@ namespace impl {
    EXTERN
  ******************************************************************************/
 
-extern impl::ArduinoDebugUtils ArduinoDebugUtils;
+extern impl::Arduino_DebugUtils Debug;
 
 #endif /* ARDUINO_DEBUG_UTILS_H_ */