Use set/clear logic on buttons

README.md

@@ -1,27 +1,28 @@
 # TS100
 This is a complete open source re-write of the software for the ts100 soldering iron.
+This project is feature complete for use as a soldering iron, but is still open to ideas and suggestions.
 
-This was started to remove the need for USB for changing system settings.
 
-The software has similar functionality to the original firmware.
+This project was started to remove the need for USB for changing system settings.
+In the latest official firmware they have also added a settings menu system, so it is still worth comparing the two firmwares to select your preferred option.
 
 ## Features Working
 * Soldering / Temperature control
-* Full PID Iron Temp
+* Full PID iron temperature control
 * Adjusting temperature
 * Automatic sleep
 * Motion wake support
-* Basic settings menu
+* Settings menu
 * Input voltage UVLO measurement
 * Saving settings to flash for persistence
-* Improved GUI
+* Improved GUI Fonts
 * Use hardware I2C for communications
 * Can disable movement detection if desired
-## Features still to be implemented
-* Manual Temp Calibration
 
 # Upgrading your ts100 iron
-This is completely safe, if it goes wrong just put the .hex file from the official website onto the unit and your back to the old firmware :)
+This is completely safe, if it goes wrong just put the .hex file from the official website onto the unit and your back to the old firmware. Downloads for the hex files to flash are available on the [releases page.](https://github.com/Ralim/ts100/releases)
+**You will need a windows computer (7,8,10 tested), using the normal windows explorer to load the firmware.
+The bootloader does not appear to work under mac or linux at the moment.**
 
 1. Hold the button closest to the tip, and plug in the USB to the computer.
 2. The unit will appear as a USB drive.
@@ -29,9 +30,11 @@ This is completely safe, if it goes wrong just put the .hex file from the offici
 4. The unit will disconnect and reconnect.
 5. The filename will have changed to end in .RDY or .ERR .
 6. If it ends with .RDY your done! Otherwise something went wrong.
-7. If it went wrong try on a windows computer, some Mac / Linux machines do not play well with their boot loader.
+7. Disconnect the USB and power up the iron. You're good to go.
 
-There is also a complete device flash backup included in this repository. (Note this includes the bootloader, so will need a SWD programmer to load onto the unit).
+For the more adventurerous out there, you can also load this firmware onto the device using a SWD programmer.
+On the bottom of the MCU riser pcb, there are 4 pads for programming.
+There is a complete device flash backup included in this repository. (Note this includes the bootloader, so will need a SWD programmer to load onto the unit). Please do not use the backup of the bootloader for anything malicious, its only saved here for those who are tinkering with their iron and decide to replace it.
 
 # New Menu System
 This new firmware uses a new menu system to allow access to the settings on the device.
@@ -42,4 +45,4 @@ This menu can be accessed as shown in following flow chart, in the settings numb
 # Version Changes:
 V1.02
 	- Adds hold both buttons on IDLE to access the therometer mode.
-	- Changes the exit soldering mode to be holding both buttons (Like original firmware).
+	- Changes the exit soldering mode to be holding both buttons (Like original firmware).

workspace/ts100/inc/MMA8652FC.h

@@ -15,7 +15,7 @@
 #define __MMA8652FC__H
 
 
-void StartUp_Accelerometer(void);//This is the only function we expose
+void StartUp_Accelerometer(uint8_t sensitivity);//This is the only function we expose
 
 //--------------MMA8652 Device ID----------------------------------------------//
 

workspace/ts100/inc/Modes.h

@@ -25,11 +25,17 @@ enum {
 	COOLING,
 	UVLOWARN,
 	THERMOMETER,
+	DCINDISP,
 } operatingMode;
 
 enum {
-	UVCO = 0, SLEEP_TEMP, SLEEP_TIME, MOTIONDETECT, TEMPDISPLAY, LEFTY
+	UVCO = 0,
-
+	SLEEP_TEMP,
+	SLEEP_TIME,
+	MOTIONDETECT,
+	MOTIONSENSITIVITY,
+	TEMPDISPLAY,
+	LEFTY,
 } settingsPage;
 
 void ProcessUI();

workspace/ts100/inc/Settings.h

@@ -11,20 +11,25 @@
 #define SETTINGS_H_
 #include <stdint.h>
 #include "stm32f10x_flash.h"
-#define SETTINGSVERSION 0x02 /*Change this if you change the struct below to prevent people getting out of sync*/
+#define SETTINGSVERSION 0x03 /*Change this if you change the struct below to prevent people getting out of sync*/
-#define SETTINGSOPTIONSCOUNT 5 /*Number of settings in the settings menu*/
+#define SETTINGSOPTIONSCOUNT 6 /*Number of settings in the settings menu*/
+#define MOTION_HIGH (0x00)
+#define MOTION_MED  (0x10)
+#define MOTION_LOW  (0x20)
 /*
  * This struct must be a multiple of 2 bytes as it is saved / restored from flash in uint16_t chunks
  */
 struct {
-	uint32_t SolderingTemp; 	//current setpoint for the iron
+	uint32_t SolderingTemp; 		//current setpoint for the iron
-	uint32_t SleepTemp; 		//temp to drop to in sleep
+	uint32_t SleepTemp; 			//temp to drop to in sleep
-	uint8_t version;			//Used to track if a reset is needed on firmware upgrade
+	uint8_t version;				//Used to track if a reset is needed on firmware upgrade
-	uint8_t SleepTime; 			//minutes timeout to sleep
+	uint8_t SleepTime; 				//minutes timeout to sleep
-	uint8_t cutoutVoltage; 		//The voltage we cutout at for undervoltage
+	uint8_t cutoutVoltage:5; 		//The voltage we cutout at for undervoltage
-	uint8_t movementEnabled;	//If movement is enabled
+	uint8_t movementEnabled:1;		//If movement is enabled
-	uint8_t displayTempInF;		//If we need to convert the C reading to F
+	uint8_t displayTempInF:1;		//If we need to convert the C reading to F
-	uint8_t flipDisplay;		//If true we want to invert the display for lefties
+	uint8_t flipDisplay:1;			//If true we want to invert the display for lefties
+	uint8_t sensitivity:7;			//Sensitivity of accelerometer
+	uint16_t tempCalibration;		//Temperature calibration value
 } systemSettings;
 
 void saveSettings();

workspace/ts100/src/Interrupt.c

@@ -53,7 +53,7 @@ void TIM3_IRQHandler(void) {
 //used for buttons and movement
 void EXTI9_5_IRQHandler(void) {
 //we are interested in line 9 and line 6 for buttons
-	//Lien 5 == movement
+	//Line 5 == movement
 	if (EXTI_GetITStatus(EXTI_Line9) != RESET) {
 		if (GPIO_ReadInputDataBit(GPIOA, KEY_A) == SET)
 			keyState &= ~(BUT_A);

workspace/ts100/src/MMA8652FC.c

@@ -29,15 +29,15 @@ uint8_t I2C_RegisterRead(uint8_t reg) {
 	return tx_data[0];
 }
 
-void StartUp_Accelerometer(void) {
+void StartUp_Accelerometer(uint8_t sensitivity) {
 	I2C_RegisterWrite(CTRL_REG2, 0); //Normal mode
 	I2C_RegisterWrite( CTRL_REG2, 0x40);	// Reset all registers to POR values
 	delayMs(2);		// ~1ms delay
 	I2C_RegisterWrite(FF_MT_CFG_REG, 0x78);	// Enable motion detection for X and Y axis, latch enabled
-	I2C_RegisterWrite(FF_MT_THS_REG, 0x0F);		// Set threshold
+	I2C_RegisterWrite(FF_MT_THS_REG, sensitivity|0x0F);		// Set threshold
 	I2C_RegisterWrite(FF_MT_COUNT_REG, 0x01);	// Set debounce to 100ms
 
 	I2C_RegisterWrite( CTRL_REG4, 0x04);		// Enable motion interrupt
-	I2C_RegisterWrite( CTRL_REG5, 0x04);// Route motion interrupts to INT1 ->PB5 ->EXTI
+	I2C_RegisterWrite( CTRL_REG5, 0x04);// Route motion interrupts to INT1 ->PB5 ->EXTI5
 	I2C_RegisterWrite( CTRL_REG1, 0x19);		// ODR=100 Hz, Active mode
 }

workspace/ts100/src/Main.c

@@ -14,29 +14,30 @@ void setup();
 int main(void) {
 	setup();/*Setup the system*/
 	while (1) {
-		Clear_Watchdog(); //reset the Watchdog timer
+		Clear_Watchdog(); //reset the Watch dog timer
 		ProcessUI();
 		DrawUI();
 		delayMs(50); //Slow the system down a little bit
 	}
 }
 void setup() {
-	RCC_Config(); 						//setup system clock
+	RCC_Config(); 										//setup system clock
-	NVIC_Config(0x4000); //this shifts the NVIC table to be offset, for the usb bootloader's size
+	NVIC_Config(0x4000); 								//this shifts the NVIC table to be offset, for the usb bootloader's size
-	GPIO_Config(); 						//setup all the GPIO pins
+	GPIO_Config(); 										//setup all the GPIO pins
-	Init_EXTI(); 						//init the EXTI inputs
+	Init_EXTI(); 										//init the EXTI inputs
-	Init_Timer3(); 						//Used for the soldering iron tip
+	Init_Timer3(); 										//Used for the soldering iron tip
-	Adc_Init(); 						//init adc and dma
+	Adc_Init(); 										//init adc and dma
-	I2C_Configuration();				//Start the I2C hardware
+	I2C_Configuration();								//Start the I2C hardware
-	GPIO_Init_OLED();					//Init the GPIO ports for the OLED
+	GPIO_Init_OLED();									//Init the GPIO ports for the OLED
-	StartUp_Accelerometer(); 			//start the accelerometer
+	restoreSettings();									//Load settings
 
-	setupPID(); 						//init the PID values
+	StartUp_Accelerometer(systemSettings.sensitivity); 	//start the accelerometer
-	readIronTemp(239, 0); 				//load the default calibration value
-	restoreSettings();					//Load settings
-	Init_Oled(systemSettings.flipDisplay);//init the OLED display
 
-	OLED_DrawString("VER 1.03",8);
+	setupPID(); 										//init the PID values
-	delayMs(800);
+	readIronTemp(239, 0); 								//load the default calibration value
-	Start_Watchdog(1000); 		//start the system watchdog as 1 seconds timeout
+	Init_Oled(systemSettings.flipDisplay); 				//init the OLED display
+
+	OLED_DrawString("VER 1.03", 8); 					//1.settings version as of current
+	delayMs(800);										//Pause to show version number
+	Start_Watchdog(1000); 								//start the system watch dog as 1 second timeout
 }

workspace/ts100/src/Modes.c

@@ -9,45 +9,36 @@
 void ProcessUI() {
 	uint8_t Buttons = getButtons(); //read the buttons status
 	static uint32_t lastModeChange = 0;
-	if (millis() - getLastButtonPress() < 200)
+	if (millis() - getLastButtonPress() < 30)
 		Buttons = 0;
+	else if (Buttons != 0) {
+		resetLastButtonPress();
+		resetButtons();
+	}
 	//rough prevention for de-bouncing and allocates settling time
 
 	switch (operatingMode) {
 	case STARTUP:
-		if ((millis() - getLastButtonPress() > 1000)) {
+		if (Buttons == (BUT_A | BUT_B)) {
-			if (Buttons == (BUT_A | BUT_B)) {
+			operatingMode = THERMOMETER;
-				operatingMode = THERMOMETER;
+		} else if (Buttons == BUT_A) {
-				resetLastButtonPress();
+			//A key pressed so we are moving to soldering mode
-				resetButtons();
+			operatingMode = SOLDERING;
-			} else if (Buttons == BUT_A) {
+		} else if (Buttons == BUT_B) {
-				//A key pressed so we are moving to soldering mode
+			//B Button was pressed so we are moving to the Settings menu
-				operatingMode = SOLDERING;
+			operatingMode = SETTINGS;
-				resetLastButtonPress();
-				resetButtons();
-			} else if (Buttons == BUT_B) {
-				//B Button was pressed so we are moving to the Settings menu
-				operatingMode = SETTINGS;
-				resetLastButtonPress();
-				resetButtons();
-			}
 		}
-		//Nothing else to check here
 		break;
 	case SOLDERING:
 		//We need to check the buttons if we need to jump out
 		if (Buttons == BUT_A || Buttons == BUT_B) {
 			//A or B key pressed so we are moving to temp set
 			operatingMode = TEMP_ADJ;
-			resetLastButtonPress();
-			resetButtons();
 		} else if (Buttons == (BUT_A | BUT_B)) {
-			if (millis() - getLastButtonPress() > 1000) {
+
-				//Both buttons were pressed, exit back to the cooling screen
+			//Both buttons were pressed, exit back to the cooling screen
-				operatingMode = COOLING;
+			operatingMode = COOLING;
-				resetLastButtonPress();
+
-				resetButtons();
-			}
 		} else {
 			//We need to check the timer for movement in case we need to goto idle
 			if (systemSettings.movementEnabled)
@@ -62,32 +53,29 @@ void ProcessUI() {
 			uint16_t voltage = readDCVoltage(); //get X10 voltage
 			if ((voltage / 10) < systemSettings.cutoutVoltage) {
 				operatingMode = UVLOWARN;
-				resetLastButtonPress();
-				resetButtons();
 				lastModeChange = millis();
 			}
-			//If no buttons pushed we need to perform the PID loop for the iron temp
+			//Update the PID Loop
 			int32_t newOutput = computePID(systemSettings.SolderingTemp);
-
 			setIronTimer(newOutput);
-
 		}
 		break;
 	case TEMP_ADJ:
-		if (Buttons & BUT_A) {
+		if (Buttons == BUT_A) {
 			//A key pressed so we are moving down in temp
-			resetLastButtonPress();
+
 			if (systemSettings.SolderingTemp > 1000)
 				systemSettings.SolderingTemp -= 100;
-		} else if (Buttons & BUT_B) {
+		} else if (Buttons == BUT_B) {
 			//B key pressed so we are moving up in temp
-			resetLastButtonPress();
 			if (systemSettings.SolderingTemp < 4500)
 				systemSettings.SolderingTemp += 100;
 		} else {
 			//we check the timeout for how long the buttons have not been pushed
 			//if idle for > 3 seconds then we return to soldering
-			if (millis() - getLastButtonPress() > 3000) {
+			//Or if both buttons pressed
+			if ((millis() - getLastButtonPress() > 2000)
+					|| Buttons == (BUT_A | BUT_B)) {
 				operatingMode = SOLDERING;
 				saveSettings();
 			}
@@ -96,11 +84,8 @@ void ProcessUI() {
 	case SETTINGS:
 		//Settings is the mode with the most logic
 		//Here we are in the menu so we need to increment through the sub menus / increase the value
-		if (millis() - getLastButtonPress() < 300)
-			return;
 
 		if (Buttons & BUT_A) {
-			resetLastButtonPress();
 			//A key iterates through the menu
 			if (settingsPage == SETTINGSOPTIONSCOUNT) {
 				//Roll off the end
@@ -139,6 +124,12 @@ void ProcessUI() {
 				break;
 			case LEFTY:
 				systemSettings.flipDisplay = !systemSettings.flipDisplay;
+				break;
+			case MOTIONSENSITIVITY:
+				systemSettings.sensitivity += 0x10;
+				if (systemSettings.sensitivity > 0x20)
+					systemSettings.sensitivity = 0;		//reset to high on wrap
+
 				break;
 			default:
 				break;
@@ -150,14 +141,10 @@ void ProcessUI() {
 		if (Buttons & BUT_A) {
 			//A Button was pressed so we are moving back to soldering
 			operatingMode = SOLDERING;
-			resetLastButtonPress();
-			resetButtons();
 			return;
 		} else if (Buttons & BUT_B) {
 			//B Button was pressed so we are moving back to soldering
 			operatingMode = SOLDERING;
-			resetLastButtonPress();
-			resetButtons();
 			return;
 		} else if (systemSettings.movementEnabled)
 			if (millis() - getLastMovement() < 1000) {//moved in the last second
@@ -166,9 +153,7 @@ void ProcessUI() {
 			}
 		//else if nothing has been pushed we need to compute the PID to keep the iron at the sleep temp
 		int32_t newOutput = computePID(systemSettings.SleepTemp);
-
 		setIronTimer(newOutput);
-
 		break;
 	case COOLING: {
 		setIronTimer(0); //turn off heating
@@ -176,13 +161,9 @@ void ProcessUI() {
 		uint16_t temp = readIronTemp(0, 1); //take a new reading as the heater code is not taking new readings
 		if (temp < 400) { //if the temp is < 40C then we can go back to IDLE
 			operatingMode = STARTUP;
-			resetLastButtonPress();
-			resetButtons();
 		} else if (Buttons & (BUT_A | BUT_B)) { //we check if the user has pushed a button to ack
 			//Either button was pushed
 			operatingMode = STARTUP;
-			resetLastButtonPress();
-			resetButtons();
 		}
 	}
 		break;
@@ -195,13 +176,28 @@ void ProcessUI() {
 		break;
 	case THERMOMETER: {
 		//This lets the user check the tip temp without heating the iron.. And eventually calibration will be added here
-		if ((millis() - getLastButtonPress() > 1000))
+
-			if (Buttons == (BUT_A | BUT_B)) {
+		if ((Buttons == BUT_A) | (Buttons == BUT_B)) {
-				//If the user is holding both button, exit the temp screen
+			//Single button press, cycle over to the DC display
-				operatingMode = STARTUP;
+			operatingMode = DCINDISP;
-				resetLastButtonPress();
+		} else if (Buttons == (BUT_A | BUT_B)) {
-				resetButtons();
+			//If the user is holding both button, exit the  screen
-			}
+			operatingMode = STARTUP;
+		}
+
+	}
+		break;
+	case DCINDISP: {
+		//This lets the user check the input voltage
+
+		if ((Buttons == BUT_A) | (Buttons == BUT_B)) {
+			//Single button press, cycle over to the temp display
+			operatingMode = THERMOMETER;
+		} else if (Buttons == (BUT_A | BUT_B)) {
+			//If the user is holding both button, exit the  screen
+			operatingMode = STARTUP;
+		}
+
 	}
 		break;
 	default:
@@ -304,6 +300,23 @@ void DrawUI() {
 			else
 				OLED_DrawString("FLPDSP F", 8);
 			break;
+		case MOTIONSENSITIVITY:
+			switch (systemSettings.sensitivity) {
+			case MOTION_HIGH:
+				OLED_DrawString("SENSE H ", 8);
+				break;
+			case MOTION_MED:
+				OLED_DrawString("SENSE M ", 8);
+				break;
+			case MOTION_LOW:
+				OLED_DrawString("SENSE L ", 8);
+				break;
+			default:
+				OLED_DrawString("SENSE   ", 8);
+				break;
+			}
+
+			break;
 		default:
 			break;
 		}
@@ -323,10 +336,24 @@ void DrawUI() {
 		OLED_DrawString("LOW VOLT", 8);
 		break;
 	case THERMOMETER:
-		temp = readIronTemp(0, 1);//Force a reading as heater is off
+		temp = readIronTemp(0, 1);		//Force a reading as heater is off
 		OLED_DrawString("TEMP ", 5);//extra one to it clears the leftover 'L' from IDLE
 		drawTemp(temp, 5);
 		break;
+	case DCINDISP: {
+		uint16_t voltage = readDCVoltage(); //get X10 voltage
+		OLED_DrawString("IN", 2);
+		OLED_DrawChar((voltage / 100) % 10, 2);
+		voltage -= (voltage / 100) * 100;
+		OLED_DrawChar((voltage / 10) % 10, 3);
+		voltage -= (voltage / 10) * 10;
+		OLED_DrawChar('.', 4);
+		OLED_DrawChar(voltage % 10, 5);
+		OLED_DrawChar('V', 6);
+		OLED_DrawChar(' ', 7);
+
+	}
+		break;
 	default:
 		break;
 	}

workspace/ts100/src/Oled.c

@@ -142,7 +142,7 @@ void GPIO_Init_OLED(void) {
 }
 /*******************************************************************************
  Function: Init_Oled
- Description: Initalizes the Oled screen
+ Description: Initializes the Oled screen
  *******************************************************************************/
 void Init_Oled(uint8_t leftHanded) {
 	u8 param_len;

workspace/ts100/src/Settings.c

@@ -49,5 +49,8 @@ void resetSettings() {
 	systemSettings.version = SETTINGSVERSION;	//Store the version number to allow for easier upgrades
 	systemSettings.displayTempInF =0;			//default to C
 	systemSettings.flipDisplay=0;				//Default to right handed mode
+	systemSettings.sensitivity=0x00;			//Default high sensitivity
+	systemSettings.tempCalibration=239;			//Default to their calibration value
+
 }