Extracting debug functionality into separate module 'DebugUtils'

Author: aentinger

src/ConnectionManager.h

@@ -18,11 +18,19 @@
 #ifndef CONNECTION_MANAGER_H_
 #define CONNECTION_MANAGER_H_
 
-#define ARDUINO_CLOUD_DEBUG_LEVEL 2
+/******************************************************************************
+ * INCLUDES
+ ******************************************************************************/
 
 #include <Client.h>
 #include <Udp.h>
+
 #include "utility/NTPUtils.h"
+#include "utility/DebugUtils.h"
+
+/******************************************************************************
+ * TYPEDEFS
+ ******************************************************************************/
 
 enum NetworkConnectionState {
   CONNECTION_STATE_INIT,
@@ -34,6 +42,10 @@ enum NetworkConnectionState {
   CONNECTION_STATE_ERROR
 };
 
+/******************************************************************************
+ * CLASS DECLARATION
+ ******************************************************************************/
+
 class ConnectionManager {
 public:
   virtual void init() = 0;
@@ -50,7 +62,6 @@ class ConnectionManager {
 
 };
 
-
 #ifdef ARDUINO_SAMD_MKR1000
 #include <WiFi101.h>
 #define BOARD_HAS_WIFI
@@ -77,27 +88,4 @@ class ConnectionManager {
 #define NETWORK_CONNECTED GSM3_NetworkStatus_t::GPRS_READY
 #endif
 
-static int debugMessageLevel = ARDUINO_CLOUD_DEBUG_LEVEL;
-inline void debugMessage(char *_msg, int _debugLevel, bool _timestamp = true, bool _newline = true) {
-  if(_debugLevel < 0){
-    return;
-  }
-  if (_debugLevel <= debugMessageLevel) {
-    char prepend[20];
-    sprintf(prepend, "\n[ %d ] ", millis());
-    if(_timestamp){
-      Serial.print(prepend);
-    }
-    if(_newline){
-      Serial.println(_msg);
-    }else{
-      Serial.print(_msg);
-    }
-  }
-}
-
-inline void setDebugMessageLevel(int _debugLevel){
-  debugMessageLevel = _debugLevel;
-}
-
 #endif /* CONNECTION_MANAGER_H_ */

src/utility/DebugUtils.cpp

@@ -0,0 +1,52 @@
+/*
+ * This file is part of ArduinoIoTCloud.
+ *
+ * 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 [email protected].
+ */
+
+/******************************************************************************
+ * INCLUDE
+ ******************************************************************************/
+
+#include "DebugUtils.h"
+
+/******************************************************************************
+ * GLOBAL VARIABLES
+ ******************************************************************************/
+
+static int debugMessageLevel = ARDUINO_IOT_CLOUD_DEFAULT_DEBUG_LEVEL;
+
+/******************************************************************************
+ * PUBLIC FUNCTIONS
+ ******************************************************************************/
+
+void setDebugMessageLevel(int const debugLevel) {
+  debugMessageLevel = debugLevel;
+}
+
+void debugMessage(char * msg, int const debugLevel, bool const timestamp, bool const newline) {
+  if(debugLevel < 0){
+    return;
+  }
+
+  if (debugLevel <= debugMessageLevel) {
+    if(timestamp) {
+      char prepend[20];
+      sprintf(prepend, "\n[ %d ] ", millis());
+      Serial.print(prepend);
+    }
+    if  (newline) Serial.println(msg);
+    else          Serial.print  (msg);
+  }
+}

src/utility/DebugUtils.h

@@ -0,0 +1,38 @@
+/*
+ * This file is part of ArduinoIoTCloud.
+ *
+ * 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 [email protected].
+ */
+
+/******************************************************************************
+ * INCLUDE
+ ******************************************************************************/
+
+#include <Arduino.h>
+
+/******************************************************************************
+ * CONSTANTS
+ ******************************************************************************/
+
+static int const ARDUINO_IOT_CLOUD_DEFAULT_DEBUG_LEVEL = 2;
+
+/******************************************************************************
+ * PROTOTYPES
+ ******************************************************************************/
+
+void setDebugMessageLevel(int debugLevel);
+void debugMessage(char * msg, int const debugLevel, bool const timestamp = true, bool const newline = true);
+
+
+