Added pulse mode for local buttons

Author: Ultrawipf

CHANGELOG.md

@@ -1,4 +1,7 @@
 ### Changes this version:
+- Added local button pulse mode
+
+### Changes since v1.14.0
 - Save TMC space vector PWM mode in flash. Should be usually on for BLDC motors if the star point is isolated.
 - Allow using the motors flux component to dissipate energy with the TMC4671 instead of the brake resistor. May cause noticable braking in the motor but takes stress off the resistor.
 - Axis speed limiter usable and saved in flash.

Configurator

@@ -8,7 +8,7 @@
  * For more settings see target_constants.h in a target specific folder
  */
 
-static const uint8_t SW_VERSION_INT[3] = {1,14,1}; // Version as array. 8 bit each!
+static const uint8_t SW_VERSION_INT[3] = {1,14,2}; // Version as array. 8 bit each!
 #define MAX_AXIS 2 // ONLY USE 2 for now else screws HID Reports
 #define FLASH_VERSION 0 // Counter to increase whenever a full flash erase is required.
 

Firmware/FFBoard/Inc/constants.h

@@ -17,18 +17,23 @@
 
 class LocalButtons: public ButtonSource,CommandHandler{
 	enum class LocalButtons_commands : uint32_t{
-		mask,polarity,pins,values,
+		mask,polarity,pins,values,pulse
 	};
 private:
-	uint32_t mask = 0xff;
+	uint32_t mask = 0xff; // Can have 16 bits stored
+	uint32_t pulsemask = 0;
+	static constexpr uint32_t pulseTimeout = 50; // Update only every 50 ms
+	uint32_t lastPulseTime = 0;
 	void setMask(uint32_t mask);
 	bool polarity = false;
 	static const std::array<InputPin,BUTTON_PINS> button_pins;
-
+	uint64_t lastOutputs = 0;
+	uint64_t lastButtons = 0;
 public:
 	LocalButtons();
 	virtual ~LocalButtons();
 	uint8_t readButtons(uint64_t* buf);
+	uint8_t getButtonInputs(uint64_t* buf,bool pol);
 
 	const ClassIdentifier getInfo();
 	static ClassIdentifier info;

Firmware/FFBoard/UserExtensions/Inc/LocalButtons.h

@@ -1,23 +1,23 @@
 /*		
- * eeprom_addresses.h
- *
- *  Created on: 24.01.2020
- *  Author: Yannick
- *
- *	/!\ Generated from the file memory_map.csv
-   / ! \ DO NOT EDIT THIS DIRECTLY !!!
- */
+ * eeprom_addresses.h		
+ *		
+ *  Created on: 24.01.2020		
+ *  Author: Yannick		
+ *		
+ *	/!\ Generated from the file memory_map.csv 
+   / ! \ DO NOT EDIT THIS DIRECTLY !!!	
+ */			
 
 #ifndef EEPROM_ADDRESSES_H_
 #define EEPROM_ADDRESSES_H_
 
 #include "main.h"
 // Change this to the amount of currently registered variables
-#define NB_OF_VAR 147
+#define NB_OF_VAR 148
 extern const uint16_t VirtAddVarTab[NB_OF_VAR];
 
 // Amount of variables in exportable list
-#define NB_EXPORTABLE_ADR 132
+#define NB_EXPORTABLE_ADR 133
 extern const uint16_t exportableFlashAddresses[NB_EXPORTABLE_ADR];
 
 
@@ -50,11 +50,12 @@ uint16_t EE_ReadVariable(uint16_t VirtAddress, uint16_t* Data) will return 1 if
 // Button Sources:
 #define ADR_SPI_BTN_1_CONF 0x201
 #define ADR_SHIFTERANALOG_CONF 0x202
-#define ADR_LOCAL_BTN_CONF 0x203
-#define ADR_LOCAL_BTN_CONF_2 0x204
+#define ADR_LOCAL_BTN_CONF 0x203 // Pin mask
+#define ADR_LOCAL_BTN_CONF_2 0x204 // Misc settings
 #define ADR_SPI_BTN_2_CONF 0x205
 #define ADR_SPI_BTN_1_CONF_2 0x206
 #define ADR_SPI_BTN_2_CONF_2 0x207
+#define ADR_LOCAL_BTN_CONF_3 0x208 // Pulse mask
 // Local encoder
 #define ADR_ENCLOCAL_CPR 0x210
 #define ADR_ENCLOCAL_OFS 0x211

Firmware/FFBoard/UserExtensions/Inc/eeprom_addresses.h

@@ -258,6 +258,11 @@ bool FFBHIDMain::getFfbActive(){
  * Sends periodic gamepad reports of buttons and analog axes
  */
 void FFBHIDMain::send_report(){
+	// Check if HID command interface wants to send something and allow that if we did not skip too many reports
+	if(!tud_hid_n_ready(0) ||  (reportSendCounter++ < usb_report_rate*2 && this->hidCommands->waitingToSend())){
+		return;
+	}
+	//Try semaphore
 	if(!sourcesSem.Take(10)){
 		return;
 	}
@@ -302,10 +307,7 @@ void FFBHIDMain::send_report(){
 	/*
 	 * Only send a new report if actually changed since last time or timeout and hid is ready
 	 */
-	if( (reportSendCounter++ > 100/usb_report_rate || (memcmp(&lastReportHID,&reportHID,sizeof(reportHID_t)) != 0) )
-		&& tud_hid_n_ready(0)
-		&& !(reportSendCounter < usb_report_rate*2 && this->hidCommands->waitingToSend())
-		) // Check if HID command interface wants to send something and allow that if we did not skip too many reports
+	if( (reportSendCounter > 100/usb_report_rate || (memcmp(&lastReportHID,&reportHID,sizeof(reportHID_t)) != 0) ))
 	{
 
 

Firmware/FFBoard/UserExtensions/Src/FFBHIDMain.cpp

@@ -21,6 +21,7 @@ LocalButtons::LocalButtons() : CommandHandler("dpin",CLSID_BTN_LOCAL,0) {
 	registerCommand("polarity", LocalButtons_commands::polarity, "Pin polarity",CMDFLAG_GET | CMDFLAG_SET);
 	registerCommand("pins", LocalButtons_commands::pins, "Available pins",CMDFLAG_GET | CMDFLAG_SET);
 	registerCommand("values", LocalButtons_commands::values, "pin values",CMDFLAG_GET);
+	registerCommand("pulse", LocalButtons_commands::pulse, "Toggle to pulse mode mask",CMDFLAG_GET | CMDFLAG_SET);
 }
 
 LocalButtons::~LocalButtons() {
@@ -42,12 +43,12 @@ void LocalButtons::setMask(uint32_t mask){
 	}
 }
 
-uint8_t LocalButtons::readButtons(uint64_t* buf){
+uint8_t LocalButtons::getButtonInputs(uint64_t* buf,bool pol){
 	uint8_t cur_btn = 0;
 	for(uint8_t i = 0;i<this->maxButtons;i++){
 		if(mask & (0x1 << i)){
 			bool b{readButton(i)};
-			if(this->polarity){ // positive polarity
+			if(pol){ // positive polarity
 				*buf |= b << cur_btn++;
 			}else{	// Negative polarity (normal)
 				*buf |= !b << cur_btn++;
@@ -57,12 +58,40 @@ uint8_t LocalButtons::readButtons(uint64_t* buf){
 	return this->btnnum;
 }
 
+uint8_t LocalButtons::readButtons(uint64_t* buf){
+
+	uint64_t tBuf = 0;
+	getButtonInputs(&tBuf,this->polarity);
+
+	// TODO processing should really be done in a general button handler class to be shared
+	if(pulsemask){
+		uint64_t pulsebtns = (lastButtons ^ tBuf) & pulsemask; // Momentary mode
+		if(HAL_GetTick() - lastPulseTime > pulseTimeout || pulsebtns){ // If timeout or something is high
+			lastPulseTime = HAL_GetTick();
+			// Update pulses
+			*buf |= pulsebtns;
+		}else{
+			*buf |= (lastOutputs & pulsemask); // Normal buttons immediate. Pulsed stored
+		}
+		*buf |= (tBuf & ~pulsemask);
+		lastOutputs = *buf;
+	}else{
+		*buf |= tBuf;
+	}
+	lastButtons = tBuf;
+
+	return this->btnnum;
+}
+
 void LocalButtons::saveFlash(){
 	uint16_t dat = this->mask & 0xffff;
 	Flash_Write(ADR_LOCAL_BTN_CONF, dat);
 
 	uint16_t dat2 = this->polarity & 0x01;
 	Flash_Write(ADR_LOCAL_BTN_CONF_2, dat2);
+
+	uint16_t dat3 = this->pulsemask & 0xffff;
+	Flash_Write(ADR_LOCAL_BTN_CONF_3, dat3);
 }
 
 void LocalButtons::restoreFlash(){
@@ -74,6 +103,10 @@ void LocalButtons::restoreFlash(){
 	if(Flash_Read(ADR_LOCAL_BTN_CONF_2,&dat)){
 		this->polarity = dat & 0x01;
 	}
+
+	if(Flash_Read(ADR_LOCAL_BTN_CONF_3,&dat)){
+		this->pulsemask = (dat & 0xffff);
+	}
 }
 
 CommandStatus LocalButtons::command(const ParsedCommand& cmd,std::vector<CommandReply>& replies){
@@ -110,13 +143,23 @@ CommandStatus LocalButtons::command(const ParsedCommand& cmd,std::vector<Command
 	case LocalButtons_commands::values:
 		if(cmd.type == CMDtype::get){
 			uint64_t buf = 0;
-			readButtons(&buf);
+			getButtonInputs(&buf,this->polarity);
 			replies.emplace_back(buf);
 		}else{
 			return CommandStatus::ERR;
 		}
 	break;
 
+	case LocalButtons_commands::pulse:
+		if(cmd.type == CMDtype::set){
+			this->pulsemask = cmd.val;
+		}else if(cmd.type == CMDtype::get){
+			replies.emplace_back(this->pulsemask);
+		}else{
+			return CommandStatus::ERR;
+		}
+	break;
+
 	default:
 		return CommandStatus::NOT_FOUND;
 	}

Firmware/FFBoard/UserExtensions/Src/LocalButtons.cpp

@@ -1,12 +1,12 @@
 /*		
- * eeprom_addresses.c
- *
- *  Created on: 24.01.2020
- *  Author: Yannick
- *
- *	/!\ Generated from the file memory_map.csv
-   / ! \ DO NOT EDIT THIS DIRECTLY !!!
- */
+ * eeprom_addresses.c		
+ *		
+ *  Created on: 24.01.2020		
+ *  Author: Yannick		
+ *		
+ *	/!\ Generated from the file memory_map.csv 
+   / ! \ DO NOT EDIT THIS DIRECTLY !!!	
+ */		
 
 #include "eeprom_addresses.h"		
 
@@ -32,11 +32,12 @@ const uint16_t VirtAddVarTab[NB_OF_VAR] =
 // Button Sources:
 	ADR_SPI_BTN_1_CONF,
 	ADR_SHIFTERANALOG_CONF,
-	ADR_LOCAL_BTN_CONF,
-	ADR_LOCAL_BTN_CONF_2,
+	ADR_LOCAL_BTN_CONF, // Pin mask
+	ADR_LOCAL_BTN_CONF_2, // Misc settings
 	ADR_SPI_BTN_2_CONF,
 	ADR_SPI_BTN_1_CONF_2,
 	ADR_SPI_BTN_2_CONF_2,
+	ADR_LOCAL_BTN_CONF_3, // Pulse mask
 // Local encoder
 	ADR_ENCLOCAL_CPR,
 	ADR_ENCLOCAL_OFS,
@@ -193,8 +194,8 @@ const uint16_t VirtAddVarTab[NB_OF_VAR] =
 };
 
 /**		
- * Variables to be included in a flash dump
- */
+ * Variables to be included in a flash dump		
+ */		
 const uint16_t exportableFlashAddresses[NB_EXPORTABLE_ADR] =		
 {
 // System variables
@@ -212,11 +213,12 @@ const uint16_t exportableFlashAddresses[NB_EXPORTABLE_ADR] =
 // Button Sources:
 	ADR_SPI_BTN_1_CONF,
 	ADR_SHIFTERANALOG_CONF,
-	ADR_LOCAL_BTN_CONF,
-	ADR_LOCAL_BTN_CONF_2,
+	ADR_LOCAL_BTN_CONF, // Pin mask
+	ADR_LOCAL_BTN_CONF_2, // Misc settings
 	ADR_SPI_BTN_2_CONF,
 	ADR_SPI_BTN_1_CONF_2,
 	ADR_SPI_BTN_2_CONF_2,
+	ADR_LOCAL_BTN_CONF_3, // Pulse mask
 // Local encoder
 	ADR_ENCLOCAL_CPR,
 	ADR_ENCLOCAL_OFS,
@@ -370,4 +372,4 @@ const uint16_t exportableFlashAddresses[NB_EXPORTABLE_ADR] =
 	ADR_ADS111X_MAX_2,
 	ADR_ADS111X_MIN_3,
 	ADR_ADS111X_MAX_3,
-};
+};

Firmware/FFBoard/UserExtensions/Src/eeprom_addresses.c

@@ -14,11 +14,12 @@ Section comment,Name,Value,Comment on key,VirtAddVarTab,exportableFlashAddresses
 // Button Sources:,,,,,
 ,ADR_SPI_BTN_1_CONF,0x201,,1,1
 ,ADR_SHIFTERANALOG_CONF,0x202,,1,1
-,ADR_LOCAL_BTN_CONF,0x203,,1,1
-,ADR_LOCAL_BTN_CONF_2,0x204,,1,1
+,ADR_LOCAL_BTN_CONF,0x203,// Pin mask,1,1
+,ADR_LOCAL_BTN_CONF_2,0x204,// Misc settings,1,1
 ,ADR_SPI_BTN_2_CONF,0x205,,1,1
 ,ADR_SPI_BTN_1_CONF_2,0x206,,1,1
 ,ADR_SPI_BTN_2_CONF_2,0x207,,1,1
+,ADR_LOCAL_BTN_CONF_3,0x208,// Pulse mask,1,1
 // Local encoder,,,,,
 ,ADR_ENCLOCAL_CPR,0x210,,1,1
 ,ADR_ENCLOCAL_OFS,0x211,,1,1