Merge pull request #25 from hideakitai/feature/support-attach-stream

Feature/support attach stream

Author: hideakitai

DebugLog.h

@@ -35,6 +35,7 @@ using DebugLogPrecision = arx::debug::LogPrecision;
 
 #ifdef ARDUINO
 #define LOG_ATTACH_SERIAL(s) DebugLog::Manager::get().attach(s)
+#define LOG_ATTACH_STREAM(s) DebugLog::Manager::get().attach(s)
 // PRINT_FILE and PRINTLN_FILE are always enabled regardless of file_level
 // PRINT_FILE and PRINTLN_FILE do NOT print to Serial
 #define PRINT_FILE(...) DebugLog::Manager::get().print_file(__VA_ARGS__)

README.md

@@ -11,7 +11,7 @@ Logging library for Arduino that can output to both Serial and File with one lin
 
 ## Feature
 
-- Output logs to `Serial` and `File` with one line at the same time
+- Output logs to `Serial` (or any other `Stream`) and `File` with one line at the same time
 - Output logs with variadic arguments
 - Assertion support (suspend program with messages if assertion fails)
 - Release Mode `#define DEBUGLOG_DISABLE_LOG` can easily disable logging (`LOG_XXXX`, `ASSERT`)
@@ -97,6 +97,24 @@ will output
 [TRACE] basic.ino L.30 setup : this is trace: log level 5
 ```
 
+### Log Destination Control
+
+You can output the log to another `Serial` easily:
+
+```cpp
+LOG_ATTACH_SERIAL(Serial2);
+```
+
+Also this library supports the log output to any `Stream` based instances. For example, you can change the log output destination to `Ethernet/WiFiClient`, `Ethernet/WiFiUDP` instead of default `Serial` as follows:
+
+```cpp
+LOG_ATTACH_STREAM(your_udp_client);
+// or
+LOG_ATTACH_STREAM(your_tcp_client);
+// or
+LOG_ATTACH_STREAM(any_other_stream);
+```
+
 ### Log Preamble Control
 
 The `LOG_PREAMBLE` macro is called every `LOG_XXXX`. It defines a string that will be printed between the `[LEVEL]` and your custom message. To override the default definition, you must define the macro **before** you `#include <DebugLog.h>`
@@ -509,6 +527,7 @@ If you use `LOG_ATTACH_FS_MANUAL`, these macros are used to flush files manually
 #define LOG_SET_BASE_RESET(b)
 // Arduino Only
 #define LOG_ATTACH_SERIAL(serial)
+#define LOG_ATTACH_STREAM(stream)
 #define LOG_FILE_IS_OPEN()
 #define LOG_FILE_GET_LEVEL()
 #define LOG_FILE_SET_LEVEL(lvl)

examples/options/options.ino

@@ -13,6 +13,9 @@ void setup() {
 
     // You can change target stream (default: Serial)
     // LOG_ATTACH_SERIAL(Serial2);
+    // LOG_ATTACH_STREAM(udp_client);
+    // LOG_ATTACH_STREAM(tcp_client);
+    // LOG_ATTACH_STREAM(any_other_stream);
 
     // You can change auto reset for base setting (default: true)
     PRINTLN("You can print variable args with bases",

library.json

@@ -1,23 +1,22 @@
 {
-    "name": "DebugLog",
-    "keywords": "assert, log, utility, serial",
-    "description": "Logging library for Arduino that can output to both Serial and File with one line",
-    "repository": {
-        "type": "git",
-        "url": "https://github.com/hideakitai/DebugLog.git"
-    },
-    "authors": {
-        "name": "Hideaki Tai",
-        "url": "https://github.com/hideakitai",
-        "maintainer": true
-    },
-    "version": "0.8.3",
-    "license": "MIT",
-    "frameworks": "*",
-    "platforms": "*",
-    "dependencies":
-    {
-        "hideakitai/ArxContainer": ">=0.6.0",
-        "hideakitai/ArxTypeTraits": "*"
-    }
+	"name": "DebugLog",
+	"keywords": "assert, log, utility, serial",
+	"description": "Logging library for Arduino that can output to both Serial and File with one line",
+	"repository": {
+		"type": "git",
+		"url": "https://github.com/hideakitai/DebugLog.git"
+	},
+	"authors": {
+		"name": "Hideaki Tai",
+		"url": "https://github.com/hideakitai",
+		"maintainer": true
+	},
+	"version": "0.8.4",
+	"license": "MIT",
+	"frameworks": "*",
+	"platforms": "*",
+	"dependencies": {
+		"hideakitai/ArxContainer": ">=0.6.0",
+		"hideakitai/ArxTypeTraits": "*"
+	}
 }

library.properties

@@ -1,5 +1,5 @@
 name=DebugLog
-version=0.8.3
+version=0.8.4
 author=hideakitai
 maintainer=hideakitai
 sentence=Logging library for Arduino that can output to both Serial and File with one line