Added debug printouts with debug compiler flag

Author: Ultrawipf

Firmware/FFBoard/Inc/ClassChooser.h

@@ -129,7 +129,7 @@ class ClassChooser {
 	 */
 	void replyAvailableClasses(std::vector<CommandReply>& replies,int16_t ignoredCreatableId = 255){
 		for(class_entry<T> cls : class_registry){
-			if(cls.info.visibility == ClassVisibility::hidden || (cls.info.visibility == ClassVisibility::debug && !SystemCommands::allowDebugCommands)){
+			if(cls.info.visibility == ClassVisibility::hidden || (cls.info.visibility == ClassVisibility::debug && !SystemCommands::debugMode)){
 				if(ignoredCreatableId != cls.selectionId)
 					continue;
 			}

Firmware/FFBoard/Inc/CommandHandler.h

@@ -143,6 +143,7 @@ class CommandHandler {
 	virtual std::string getCsvHelpstring(); // Returns a list of the commands helpstrings formatted for csv
 
 	static void logSerial(std::string string);	//!< Send a log formatted sequence
+	static void logSerialDebug(std::string string);	//!< Send a log formatted sequence if debug is on
 
 	void broadcastCommandReply(CommandReply reply, uint32_t cmdId,CMDtype type);
 	void sendCommandReplyAsync(CommandReply reply, uint32_t cmdId,CMDtype type,CommandInterface* interface = nullptr);

Firmware/FFBoard/Inc/SystemCommands.h

@@ -31,7 +31,7 @@ class SystemCommands : public CommandHandler {
 	static void replyFlashDump(std::vector<CommandReply>& replies);
 	static void replyErrors(std::vector<CommandReply>& replies);
 
-	static bool allowDebugCommands; // Global flag that controls the debug mode
+	static bool debugMode; // Global flag that controls the debug mode
 
 	static bool errorPrintingEnabled;
 	static SystemCommands* systemCommandsInstance;

Firmware/FFBoard/Inc/constants.h

@@ -15,6 +15,7 @@ static const uint8_t SW_VERSION_INT[3] = {1,8,7}; // Version as array. 8 bit eac
 
 #define MAX_AXIS 2 // ONLY USE 2 for now else screws HID Reports
 
+//#define DEBUGLOG // Uncomment to enable some debug printouts
 
 #ifndef CANBUS
 #undef ODRIVE

Firmware/FFBoard/Src/CommandHandler.cpp

@@ -186,7 +186,7 @@ void CommandHandler::registerCommands(){
  */
 CmdHandlerCommanddef* CommandHandler::getCommandFromName(const std::string& cmd,uint32_t ignoredFlags){
 	for(CmdHandlerCommanddef& cmdItem : registeredCommands){
-		if(cmdItem.cmd == cmd && !(cmdItem.flags & ignoredFlags) && (SystemCommands::allowDebugCommands || !(cmdItem.flags & CMDFLAG_DEBUG))){
+		if(cmdItem.cmd == cmd && !(cmdItem.flags & ignoredFlags) && (SystemCommands::debugMode || !(cmdItem.flags & CMDFLAG_DEBUG))){
 			return &cmdItem;
 		}
 	}
@@ -199,7 +199,7 @@ CmdHandlerCommanddef* CommandHandler::getCommandFromName(const std::string& cmd,
  */
 CmdHandlerCommanddef* CommandHandler::getCommandFromId(const uint32_t id,uint32_t ignoredFlags){
 	for(CmdHandlerCommanddef& cmdItem : registeredCommands){
-		if(cmdItem.cmdId == id && !(cmdItem.flags & ignoredFlags) && (SystemCommands::allowDebugCommands || !(cmdItem.flags & CMDFLAG_DEBUG))){
+		if(cmdItem.cmdId == id && !(cmdItem.flags & ignoredFlags) && (SystemCommands::debugMode || !(cmdItem.flags & CMDFLAG_DEBUG))){
 			return &cmdItem;
 		}
 	}
@@ -383,7 +383,7 @@ bool CommandHandler::isInHandlerList(CommandHandler* handler){
  */
 bool CommandHandler::isValidCommandId(uint32_t cmdid,uint32_t ignoredFlags,uint32_t requiredFlags){
 	for(CmdHandlerCommanddef& cmd : registeredCommands){
-		if(cmd.cmdId == cmdid && !(cmd.flags & ignoredFlags) && ((cmd.flags & requiredFlags) == requiredFlags) && (SystemCommands::allowDebugCommands || !(cmd.flags & CMDFLAG_DEBUG))){
+		if(cmd.cmdId == cmdid && !(cmd.flags & ignoredFlags) && ((cmd.flags & requiredFlags) == requiredFlags) && (SystemCommands::debugMode || !(cmd.flags & CMDFLAG_DEBUG))){
 			return true;
 		}
 	}
@@ -445,6 +445,16 @@ void CommandHandler::logSerial(std::string string){
 
 }
 
+/**
+ * Sends log info back via cdc if debug mode is on
+ */
+void CommandHandler::logSerialDebug(std::string string)
+{
+	if(SystemCommands::debugMode){
+		logSerial(string);
+	}
+}
+
 /**
  * Returns a description of this class
  */

Firmware/FFBoard/Src/HidFFB.cpp

@@ -92,7 +92,6 @@ void HidFFB::hidOut(uint8_t report_id, hid_report_type_t report_type, uint8_t co
 	const uint8_t* report = buffer;
 	uint8_t event_idx = report_id - FFB_ID_OFFSET;
 
-
 	// -------- Out Reports --------
 	switch(event_idx)
 	{
@@ -196,10 +195,16 @@ uint16_t HidFFB::hidGet(uint8_t report_id, hid_report_type_t report_type,uint8_t
 }
 
 void HidFFB::start_FFB(){
+#ifdef DEBUGLOG
+	CommandHandler::logSerialDebug("FFB on");
+#endif
 	this->set_FFB(true);
 }
 
 void HidFFB::stop_FFB(){
+#ifdef DEBUGLOG
+	CommandHandler::logSerialDebug("FFB off");
+#endif
 	this->set_FFB(false);
 }
 
@@ -221,7 +226,7 @@ void HidFFB::set_filters(FFB_Effect *effect){
 }
 
 void HidFFB::ffb_control(uint8_t cmd){
-	//printf("Got Control signal: %d\n",cmd);
+
 	if(cmd & 0x01){ //enable
 		start_FFB();
 	}if(cmd & 0x02){ //disable
@@ -260,12 +265,17 @@ void HidFFB::new_effect(FFB_CreateNewEffect_Feature_Data_t* effect){
 	uint8_t index = find_free_effect(effect->effectType); // next effect
 	if(index == 0){
 		blockLoad_report.loadStatus = 2;
-		//CommandHandler::logSerial("Can't allocate a new effect");
+#ifdef DEBUGLOG
+		CommandHandler::logSerialDebug("Can't allocate a new effect");
+#endif
 		return;
 	}
 	FFB_Effect new_effect;
 	new_effect.type = effect->effectType;
 	this->effects_calc->logEffectType(effect->effectType);
+#ifdef DEBUGLOG
+	CommandHandler::logSerialDebug("New effect type:" + std::to_string(effect->effectType) + " idx: " + std::to_string(index-1));
+#endif
 
 	set_filters(&new_effect);
 
@@ -311,7 +321,7 @@ void HidFFB::set_effect(FFB_SetEffect_t* effect){
 	if(!ffb_active)
 		start_FFB();
 	sendStatusReport(effect->effectBlockIndex); // TODO required?
-	//CommandHandler::logSerial("Setting Effect: " + std::to_string(effect->effectType) +  " at " + std::to_string(index) + "\n");
+	//CommandHandler::logSerialDebug("Setting Effect: " + std::to_string(effect->effectType) +  " at " + std::to_string(index) + "\n");
 }
 
 void HidFFB::set_condition(FFB_SetCondition_Data_t *cond){
@@ -346,21 +356,27 @@ void HidFFB::set_effect_operation(FFB_EffOp_Data_t* report){
 	uint8_t id = report->effectBlockIndex-1;
 	if(report->state == 3){
 		effects[id].state = 0; //Stop
-		//CommandHandler::logSerial("Stop" + std::to_string(id));
+#ifdef DEBUGLOG
+		CommandHandler::logSerialDebug("Stop effect: " + std::to_string(id));
+#endif
+
 	}else{
 
 		// 1 = start, 2 = start solo
 		if(report->state == 2){
-			//CommandHandler::logSerial("Start solo" + std::to_string(id));
+#ifdef DEBUGLOG
+			CommandHandler::logSerialDebug("Start solo: " + std::to_string(id));
+#endif
 			for(FFB_Effect& effect : effects){
 				effect.state = 0; // Stop all other effects
 			}
 		}
 		if(effects[id].state != 1){
 			set_filters(&effects[id]);
 		}
-
-		//CommandHandler::logSerial("Start" + std::to_string(id));
+#ifdef DEBUGLOG
+		CommandHandler::logSerialDebug("Start effect: " + std::to_string(id));
+#endif
 		effects[id].startTime = HAL_GetTick() + effects[id].startDelay; // + effects[id].startDelay;
 		effects[id].state = 1; //Start
 

Firmware/FFBoard/Src/SystemCommands.cpp

@@ -17,7 +17,7 @@ extern ClassChooser<FFBoardMain> mainchooser;
 extern FFBoardMain* mainclass;
 //extern static const uint8_t SW_VERSION_INT[3];
 
-bool SystemCommands::allowDebugCommands = false;
+bool SystemCommands::debugMode = false;
 bool SystemCommands::errorPrintingEnabled = true;
 SystemCommands* SystemCommands::systemCommandsInstance = nullptr;
 
@@ -121,7 +121,7 @@ CommandStatus SystemCommands::internalCommand(const ParsedCommand& cmd,std::vect
 		}
 
 		case FFBoardMain_commands::debug:
-			return handleGetSet(cmd, replies, SystemCommands::allowDebugCommands);
+			return handleGetSet(cmd, replies, SystemCommands::debugMode);
 
 		case FFBoardMain_commands::vext:
 		{