Adjustable serial output verbosity

stnkl · stnkl · commit 9be9040d2941 · 2021-05-26T15:32:32.000+02:00
diff --git a/ESPEssentials.cpp b/ESPEssentials.cpp
@@ -1,5 +1,10 @@
 #include "ESPEssentials.h"
 
+#include "Wifi.h"
+#include "OTA.h"
+#include "SerialOut.h"
+#include "WebServer.h"
+
 void handleESPEssentials()
 {
 	Wifi.process();
@@ -10,7 +15,7 @@ void handleESPEssentials()
 void initESPEssentials(String projectName, int baudRate, String otaPassword)
 {
 	Serial.begin(baudRate);
-	Serial.println("");
+	PRINTLN("");
 
 	if(Wifi.autoConnect((projectName + " Setup").c_str()))
 	{
diff --git a/ESPEssentials.h b/ESPEssentials.h
@@ -1,14 +1,16 @@
 #ifndef ESPESSENTIALS_H
 #define ESPESSENTIALS_H
 
-#include "Wifi.h"
 #include "OTA.h"
 #include "WebServer.h"
+#include "Wifi.h"
+
+#include <Arduino.h>
 
 #define ESSENTIALS_BAUD 115200
 
 void handleESPEssentials();
 void initESPEssentials(String projectName, int baudRate = ESSENTIALS_BAUD, String otaPassword = "");
 void initESPEssentials(String projectName, String otaPassword);
 
-#endif
+#endif
diff --git a/OTA.cpp b/OTA.cpp
@@ -1,4 +1,5 @@
 #include "OTA.h"
+#include "SerialOut.h"
 
 void OTAClass::init(char const *hostname, char const *password, uint16_t port)
 {
@@ -11,42 +12,42 @@ void OTAClass::init(char const *hostname, char const *password, uint16_t port)
 
 	onStart([]()
 	{
-		Serial.println("[OTA] Start");
+		PRINTLN("[OTA] Start");
 	});
 	onEnd([]()
 	{
-		Serial.println("\n[OTA] End");
+		PRINTLN("\n[OTA] End");
 	});
 	onProgress([](unsigned int progress, unsigned int total)
 	{
-		Serial.printf("[OTA] Progress: %u%%\r", (progress / (total / 100)));
+		PRINTF("[OTA] Progress: %u%%\r", (progress / (total / 100)));
 	});
 	onError([](ota_error_t error)
 	{
-		Serial.printf("[OTA] Error[%u]: ", error);
+		PRINTF("[OTA] Error[%u]: ", error);
 
 		switch(error)
 		{
 			case OTA_AUTH_ERROR:
-				Serial.println("Auth Failed");
+				PRINTLN("Auth Failed");
 				break;
 			case OTA_BEGIN_ERROR:
-				Serial.println("Begin Failed");
+				PRINTLN("Begin Failed");
 				break;
 			case OTA_CONNECT_ERROR:
-				Serial.println("Connect Failed");
+				PRINTLN("Connect Failed");
 				break;
 			case OTA_RECEIVE_ERROR:
-				Serial.println("Receive Failed");
+				PRINTLN("Receive Failed");
 				break;
 			case OTA_END_ERROR:
-				Serial.println("End Failed");
+				PRINTLN("End Failed");
 				break;
 		}
 	});
 
 	begin();
-	Serial.println("[OTA] OTA started");
+	PRINTLN("[OTA] OTA started");
 }
 
-OTAClass OTA;
+OTAClass OTA;
diff --git a/OTA.h b/OTA.h
@@ -13,4 +13,4 @@ class OTAClass : public ArduinoOTAClass
 
 extern OTAClass OTA;
 
-#endif
+#endif
diff --git a/SerialOut.h b/SerialOut.h
@@ -0,0 +1,28 @@
+#include <Arduino.h>
+
+#ifdef SERIAL_OUT_SILENT
+
+#define PRINT(s)
+#define PRINT_VERBOSE(s)
+#define PRINTLN(s)
+#define PRINTLN_VERBOSE(s)
+#define PRINTF(s, ...)
+#define PRINTF_VERBOSE(s, ...)
+
+#else
+
+#define PRINT(s) Serial.print(s)
+#define PRINTLN(s) Serial.println(s)
+#define PRINTF(s, ...) Serial.printf(s, ##__VA_ARGS__)
+
+#ifdef SERIAL_OUT_VERBOSE
+#define PRINT_VERBOSE(s) Serial.print(s)
+#define PRINTLN_VERBOSE(s) Serial.println(s)
+#define PRINTF_VERBOSE(s, ...) Serial.printf(s, ##__VA_ARGS__)
+#else
+#define PRINT_VERBOSE(s)
+#define PRINTLN_VERBOSE(s)
+#define PRINTF_VERBOSE(s, ...)
+#endif
+
+#endif
diff --git a/WebServer.cpp b/WebServer.cpp
@@ -1,4 +1,9 @@
 #include "WebServer.h"
+#include "SerialOut.h"
+
+#include <ESP8266WiFi.h>
+#include <FS.h>
+#include <WiFiUdp.h>
 
 WebServerClass::WebServerClass(int port = 80) : ESP8266WebServer(port)
 {
@@ -13,7 +18,7 @@ void WebServerClass::init()
 {
 	if (!SPIFFS.begin())
 	{
-		Serial.println("[Storage] Couldn't mount file system.");
+		PRINTLN("[Storage] Couldn't mount file system.");
 		return;
 	}
 
@@ -60,7 +65,7 @@ void WebServerClass::init()
 	{
 		if(!handleFileRead(uri()))
 		{
-			Serial.println("[Storage] Couldn't find file at \'" + uri() + "\'" + ".");
+			PRINTLN("[Storage] Couldn't find file at \'" + uri() + "\'" + ".");
 			send(404, "text/plain", "Oops, file not found!");
 		}
 	});
@@ -105,7 +110,7 @@ String WebServerClass::getContentType(String filename)
 
 bool WebServerClass::handleFileRead(String path)
 {
-	Serial.println("[Storage] File read: " + path);
+	PRINTLN_VERBOSE("[Storage] File read: " + path);
 
 	webserverBusy = true;
 	if(path.endsWith("/")) path += "index.htm";
@@ -141,7 +146,7 @@ void WebServerClass::handleFileUpload()
 		String filename = _upload.filename;
 		if(!filename.startsWith("/"))
 			filename = "/" + filename;
-		Serial.println("[Storage] Uploading file: " + filename);
+		PRINTLN("[Storage] Uploading file: " + filename);
 
 		fsUploadFile = SPIFFS.open(filename, "w");
 		filename = String();
@@ -155,7 +160,7 @@ void WebServerClass::handleFileUpload()
 	{
 		if(fsUploadFile)
 			fsUploadFile.close();
-		Serial.println("[Storage] Received total: " + formatBytes(_upload.totalSize));
+		PRINTLN("[Storage] Received total: " + formatBytes(_upload.totalSize));
 	}
 }
 
@@ -165,7 +170,7 @@ void WebServerClass::handleFileDelete()
 		return send(500, "text/plain", "BAD ARGS");
 
 	String path = arg(0);
-	Serial.println("[Storage] Deleting file: " + path);
+	PRINTLN("[Storage] Deleting file: " + path);
 
 	if(path == "/")
 		return send(500, "text/plain", "BAD PATH");
@@ -184,7 +189,7 @@ void WebServerClass::handleFileCreate()
 		return send(500, "text/plain", "BAD ARGS");
 
 	String path = arg(0);
-	Serial.println("[Storage] Creating file: " + path);
+	PRINTLN("[Storage] Creating file: " + path);
 
 	if(path == "/")
 		return send(500, "text/plain", "BAD PATH");
@@ -240,7 +245,7 @@ void WebServerClass::handleUpdate()
 	{
 		Serial.setDebugOutput(true);
 		WiFiUDP::stopAll();
-		Serial.printf("Update: %s\n", _upload.filename.c_str());
+		PRINTF("Update: %s\n", _upload.filename.c_str());
 		uint32_t maxSketchSpace = (ESP.getFreeSketchSpace() - 0x1000) & 0xFFFFF000;
 		if(!Update.begin(maxSketchSpace))
 		{
@@ -257,7 +262,7 @@ void WebServerClass::handleUpdate()
 	{
 		if(Update.end(true))
 		{
-			Serial.printf("Update Success: %u\nRebooting...\n", _upload.totalSize);
+			PRINTF("Update Success: %u\nRebooting...\n", _upload.totalSize);
 		}
 		else
 		{
@@ -268,4 +273,4 @@ void WebServerClass::handleUpdate()
 	yield();
 }
 
-WebServerClass WebServer(80);
+WebServerClass WebServer(80);
diff --git a/WebServer.h b/WebServer.h
@@ -3,9 +3,6 @@
 
 #include <Arduino.h>
 #include <ESP8266WebServer.h>
-#include <ESP8266WiFi.h>
-#include <FS.h>
-#include <WiFiUdp.h>
 
 class WebServerClass : public ESP8266WebServer
 {
@@ -35,4 +32,4 @@ class WebServerClass : public ESP8266WebServer
 
 extern WebServerClass WebServer;
 
-#endif
+#endif
diff --git a/Wifi.cpp b/Wifi.cpp
@@ -5,4 +5,4 @@ WifiClass::WifiClass()
 	setConfigPortalBlocking(false);
 }
 
-WifiClass Wifi;
+WifiClass Wifi;
diff --git a/Wifi.h b/Wifi.h
@@ -11,4 +11,4 @@ class WifiClass : public WiFiManager
 
 extern WifiClass Wifi;
 
-#endif
+#endif

Original file line number	Diff line number	Diff line change
`@@ -1,5 +1,10 @@`
`1`	`1`	`#include "ESPEssentials.h"`
`2`	`2`
	`3`	`+#include "Wifi.h"`
	`4`	`+#include "OTA.h"`
	`5`	`+#include "SerialOut.h"`
	`6`	`+#include "WebServer.h"`
	`7`	`+`
`3`	`8`	`void handleESPEssentials()`
`4`	`9`	`{`
`5`	`10`	`Wifi.process();`
`@@ -10,7 +15,7 @@ void handleESPEssentials()`
`10`	`15`	`void initESPEssentials(String projectName, int baudRate, String otaPassword)`
`11`	`16`	`{`
`12`	`17`	`Serial.begin(baudRate);`
`13`		`- Serial.println("");`
	`18`	`+ PRINTLN("");`
`14`	`19`
`15`	`20`	`if(Wifi.autoConnect((projectName + " Setup").c_str()))`
`16`	`21`	`{`
Original file line number	Diff line number	Diff line change
`@@ -13,4 +13,4 @@ class OTAClass : public ArduinoOTAClass`
`13`	`13`
`14`	`14`	`extern OTAClass OTA;`
`15`	`15`
`16`		`-#endif`
	`16`	`+#endif`
Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,9 @@`
`1`	`1`	`#include "WebServer.h"`
	`2`	`+#include "SerialOut.h"`
	`3`	`+`
	`4`	`+#include <ESP8266WiFi.h>`
	`5`	`+#include <FS.h>`
	`6`	`+#include <WiFiUdp.h>`
`2`	`7`
`3`	`8`	`WebServerClass::WebServerClass(int port = 80) : ESP8266WebServer(port)`
`4`	`9`	`{`
`@@ -13,7 +18,7 @@ void WebServerClass::init()`
`13`	`18`	`{`
`14`	`19`	`if (!SPIFFS.begin())`
`15`	`20`	`{`
`16`		`- Serial.println("[Storage] Couldn't mount file system.");`
	`21`	`+ PRINTLN("[Storage] Couldn't mount file system.");`
`17`	`22`	`return;`
`18`	`23`	`}`
`19`	`24`
`@@ -60,7 +65,7 @@ void WebServerClass::init()`
`60`	`65`	`{`
`61`	`66`	`if(!handleFileRead(uri()))`
`62`	`67`	`{`
`63`		`- Serial.println("[Storage] Couldn't find file at \'" + uri() + "\'" + ".");`
	`68`	`+ PRINTLN("[Storage] Couldn't find file at \'" + uri() + "\'" + ".");`
`64`	`69`	`send(404, "text/plain", "Oops, file not found!");`
`65`	`70`	`}`
`66`	`71`	`});`
`@@ -105,7 +110,7 @@ String WebServerClass::getContentType(String filename)`
`105`	`110`
`106`	`111`	`bool WebServerClass::handleFileRead(String path)`
`107`	`112`	`{`
`108`		`- Serial.println("[Storage] File read: " + path);`
	`113`	`+ PRINTLN_VERBOSE("[Storage] File read: " + path);`
`109`	`114`
`110`	`115`	`webserverBusy = true;`
`111`	`116`	`if(path.endsWith("/")) path += "index.htm";`
`@@ -141,7 +146,7 @@ void WebServerClass::handleFileUpload()`
`141`	`146`	`String filename = _upload.filename;`
`142`	`147`	`if(!filename.startsWith("/"))`
`143`	`148`	`filename = "/" + filename;`
`144`		`- Serial.println("[Storage] Uploading file: " + filename);`
	`149`	`+ PRINTLN("[Storage] Uploading file: " + filename);`
`145`	`150`
`146`	`151`	`fsUploadFile = SPIFFS.open(filename, "w");`
`147`	`152`	`filename = String();`
`@@ -155,7 +160,7 @@ void WebServerClass::handleFileUpload()`
`155`	`160`	`{`
`156`	`161`	`if(fsUploadFile)`
`157`	`162`	`fsUploadFile.close();`
`158`		`- Serial.println("[Storage] Received total: " + formatBytes(_upload.totalSize));`
	`163`	`+ PRINTLN("[Storage] Received total: " + formatBytes(_upload.totalSize));`
`159`	`164`	`}`
`160`	`165`	`}`
`161`	`166`
`@@ -165,7 +170,7 @@ void WebServerClass::handleFileDelete()`
`165`	`170`	`return send(500, "text/plain", "BAD ARGS");`
`166`	`171`
`167`	`172`	`String path = arg(0);`
`168`		`- Serial.println("[Storage] Deleting file: " + path);`
	`173`	`+ PRINTLN("[Storage] Deleting file: " + path);`
`169`	`174`
`170`	`175`	`if(path == "/")`
`171`	`176`	`return send(500, "text/plain", "BAD PATH");`
`@@ -184,7 +189,7 @@ void WebServerClass::handleFileCreate()`
`184`	`189`	`return send(500, "text/plain", "BAD ARGS");`
`185`	`190`
`186`	`191`	`String path = arg(0);`
`187`		`- Serial.println("[Storage] Creating file: " + path);`
	`192`	`+ PRINTLN("[Storage] Creating file: " + path);`
`188`	`193`
`189`	`194`	`if(path == "/")`
`190`	`195`	`return send(500, "text/plain", "BAD PATH");`
`@@ -240,7 +245,7 @@ void WebServerClass::handleUpdate()`
`240`	`245`	`{`
`241`	`246`	`Serial.setDebugOutput(true);`
`242`	`247`	`WiFiUDP::stopAll();`
`243`		`- Serial.printf("Update: %s\n", _upload.filename.c_str());`
	`248`	`+ PRINTF("Update: %s\n", _upload.filename.c_str());`
`244`	`249`	`uint32_t maxSketchSpace = (ESP.getFreeSketchSpace() - 0x1000) & 0xFFFFF000;`
`245`	`250`	`if(!Update.begin(maxSketchSpace))`
`246`	`251`	`{`
`@@ -257,7 +262,7 @@ void WebServerClass::handleUpdate()`
`257`	`262`	`{`
`258`	`263`	`if(Update.end(true))`
`259`	`264`	`{`
`260`		`- Serial.printf("Update Success: %u\nRebooting...\n", _upload.totalSize);`
	`265`	`+ PRINTF("Update Success: %u\nRebooting...\n", _upload.totalSize);`
`261`	`266`	`}`
`262`	`267`	`else`
`263`	`268`	`{`
`@@ -268,4 +273,4 @@ void WebServerClass::handleUpdate()`
`268`	`273`	`yield();`
`269`	`274`	`}`
`270`	`275`
`271`		`-WebServerClass WebServer(80);`
	`276`	`+WebServerClass WebServer(80);`
Original file line number	Diff line number	Diff line change
`@@ -5,4 +5,4 @@ WifiClass::WifiClass()`
`5`	`5`	`setConfigPortalBlocking(false);`
`6`	`6`	`}`
`7`	`7`
`8`		`-WifiClass Wifi;`
	`8`	`+WifiClass Wifi;`
Original file line number	Diff line number	Diff line change
`@@ -11,4 +11,4 @@ class WifiClass : public WiFiManager`
`11`	`11`
`12`	`12`	`extern WifiClass Wifi;`
`13`	`13`
`14`		`-#endif`
	`14`	`+#endif`