Debug functionality.

Author: dani007200964

src/commander.cpp

@@ -41,6 +41,8 @@ void Commander::attachTreeFunction( API_t *API_tree_p, uint32_t API_tree_size_p
 	API_tree      = API_tree_p;
 	API_tree_size = API_tree_size_p;
 
+	dbgResponse -> printf( (const char*)"API tree attached with %d commands.\r\n", API_tree_size );
+
 }
 
 void Commander::init(){
@@ -52,7 +54,10 @@ void Commander::init(){
 	// Temporary variable, used to flip elements.
 	API_t temp;
 
+	dbgResponse -> printf( (const char*)"Commander init start\r\n" );
+
 	// Make the tree ordered by alphabet.
+	dbgResponse -> printf( (const char*)"\tCreating alphabetical order...      " );
 	for( i = 0; i < API_tree_size; i++ ){
 
 		for( j = i + 1; j < API_tree_size; j++ ){
@@ -76,11 +81,16 @@ void Commander::init(){
 		API_tree[ i ].place = i;
 
 	}
+	dbgResponse -> printf( (const char*)"[ OK ]\r\n" );
 
 	// Optimize the tree to make it balanced.
 	// It is necessary to speed up the command
 	// search phase.
+	dbgResponse -> printf( (const char*)"\tCreate balanced binary structure... " );
 	optimize_api_tree();
+	dbgResponse -> printf( (const char*)"[ OK ]\r\n" );
+
+	dbgResponse -> printf( (const char*)"Commander init finished!\r\n" );
 
 }
 
@@ -365,6 +375,18 @@ void Commander::execute( const char *cmd, Serial *resp ){
 
 }
 
+void Commander::attachDebugChannel( Serial *resp ){
+
+	dbgResponse = &serialDebugResponse;
+
+	// Select the right Serial object in the response class.
+	serialDebugResponse.select( resp );
+
+	// Enable debug messages.
+	debugEnabled = true;
+
+}
+
 #endif
 
 #ifdef COMMANDER_USE_ARDUINO_SERIAL_RESPONSE
@@ -395,6 +417,18 @@ void Commander::execute( const char *cmd, HardwareSerial *resp ){
 
 }
 
+void Commander::attachDebugChannel( HardwareSerial *resp ){
+
+	dbgResponse = &arduinoSerialDebugResponse;
+
+	// Select the right HardwareSerial object in the response class.
+	arduinoSerialDebugResponse.select( resp );
+
+	// Enable debug messages.
+	debugEnabled = true;
+
+}
+
 #endif
 
 #ifdef COMMANDER_USE_WIFI_CLIENT_RESPONSE
@@ -425,8 +459,32 @@ void Commander::execute( const char *cmd, WiFiClient *resp ){
 
 }
 
+void Commander::attachDebugChannel( WiFiClient *resp ){
+
+	dbgResponse = &WiFiClientDebugResponse;
+
+	// Select the right HardwareSerial object in the response class.
+	WiFiClientDebugResponse.select( resp );
+
+	// Enable debug messages.
+	debugEnabled = true;
+
+}
+
 #endif
 
+void Commander::enableDebug(){
+
+	debugEnabled = true;
+
+}
+
+void Commander::disableDebug(){
+
+	debugEnabled = false;
+
+}
+
 Commander::API_t* Commander::operator [] ( int i ){
 
 	// Detect wrong addressing.

src/commander.hpp

@@ -146,7 +146,6 @@ class Commander{
 	/// be visible.
 	void execute( const char *cmd );
 
-
 	#ifdef COMMANDER_USE_SERIAL_RESPONSE
 	/// Execution function for Serial response.
 	///
@@ -165,6 +164,13 @@ class Commander{
 	/// will be passed to the selected Serial
 	/// object.
 	void execute( const char *cmd, Serial *resp );
+
+	/// Debug channel for Serial.
+	///
+	/// This function attaches a Serial channel
+	/// for debug messages. It also enables
+	/// the debug functionality.
+	void attachDebugChannel( Serial *resp );
 	#endif
 
 	#ifdef COMMANDER_USE_ARDUINO_SERIAL_RESPONSE
@@ -185,6 +191,13 @@ class Commander{
 	/// will be passed to the selected Serial
 	/// object.
 	void execute( const char *cmd, HardwareSerial *resp );
+
+	/// Debug channel for Arduino Serial.
+	///
+	/// This function attaches a HardwareSerial channel
+	/// for debug messages. It also enables
+	/// the debug functionality.
+	void attachDebugChannel( HardwareSerial *resp );
 	#endif
 
 	#ifdef COMMANDER_USE_WIFI_CLIENT_RESPONSE
@@ -195,6 +208,7 @@ class Commander{
 	/// the messages from the command handler
 	/// will be passed to the selected Serial
 	/// object.
+
 	void execute( char *cmd, WiFiClient *resp );
 	/// Execution function for WiFi Client response.
 	///
@@ -204,8 +218,21 @@ class Commander{
 	/// will be passed to the selected Serial
 	/// object.
 	void execute( const char *cmd, WiFiClient *resp );
+
+	/// Debug channel for WiFiClient.
+	///
+	/// This function attaches a WiFiClient channel
+	/// for debug messages. It also enables
+	/// the debug functionality.
+	void attachDebugChannel( WiFiClient *resp );
 	#endif
 
+	/// Enables debug messages.
+	void enableDebug();
+
+	/// Disables debug messages.
+	void disableDebug();
+
 private:
 
 	/// Starting address of the API-tree.
@@ -245,6 +272,31 @@ class Commander{
 	/// points to the default response handler.
 	commandResponse *response = &defaultResponse;
 
+	/// Flag to enable or disable debug messages.
+	bool debugEnabled = false;
+
+	/// Default response handler for debug messages.
+	commandResponse defaultDebugResponse;
+
+	#ifdef COMMANDER_USE_SERIAL_RESPONSE
+	/// Serial response handler class.
+	commandResponseSerial serialDebugResponse;
+	#endif
+
+	#ifdef COMMANDER_USE_ARDUINO_SERIAL_RESPONSE
+	/// Serial response handler class.
+	commandResponseArduinoSerial arduinoSerialDebugResponse;
+	#endif
+
+	#ifdef COMMANDER_USE_WIFI_CLIENT_RESPONSE
+	/// WiFi Client response handler class.
+	commandResponseWiFiClient WiFiClientDebugResponse;
+	#endif
+
+	/// Pointer to response class. By default it
+	/// points to the default debug response handler.
+	commandResponse *dbgResponse = &defaultDebugResponse;
+
 	/// Find an API element in the tree by alphabetical place.
 	uint16_t find_api_index_by_place( uint16_t place );