Add ability to calibrate input DC voltage reading, V1.05

Closes #5

README.md

@@ -1,23 +1,22 @@
 # TS100
-This is a complete open source re-write of the software for the ts100 soldering iron.
+This is a complete re-write of the open source 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 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
+## Features
 * Soldering / Temperature control
 * Full PID iron temperature control
-* Adjusting temperature
+* Automatic sleep with selectable sensitivity
-* Automatic sleep
 * Motion wake support
 * Settings menu
-* Input voltage UVLO measurement
+* Input voltage UVLO measurement for battery powered use
-* Saving settings to flash for persistence
+* All settings saved
-* Improved GUI Fonts
+* Improved readability Fonts
-* Use hardware I2C for communications
+* Use hardware features to improve reliability
 * Can disable movement detection if desired
+* Calibration of the temperature offset
 
 # 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. Downloads for the hex files to flash are available on the [releases page.](https://github.com/Ralim/ts100/releases)
@@ -38,11 +37,39 @@ There is a complete device flash backup included in this repository. (Note this
 
 # New Menu System
 This new firmware uses a new menu system to allow access to the settings on the device.
-This menu can be accessed as shown in following flow chart, in the settings numbers roll over from top to bottom.
+When on the main screen, the unit shows prompts for the two most common operations.
-![TS100: Software Menu](TS100.png "Fairly easy to learn")
+-> Pressing the button near the tip enters soldering mode
+-> Pressing the button near the power input enters the settings menu.
+-> Pressing both buttons together enters the Extras menu
+## Soldering mode
+In this mode the iron works as you would expect, pressing either button will take you to a temperature change screen. Use each button to go up and down in temperature. Pressing both buttons will exit you from the temperature menu (or wait 3 seconds and it will time out).
+Pressing both buttons will also exit the soldering mode.
 
+## Settings Menu
+This menu allows you to cycle through all the options and set their values.
+The button near the tip cycles through the options, and the one near the usb changes the selected option.
+
+* UVCO -> Undervoltage cut out level, settable in 1V increments from 10-24V
+* STIME -> Sleep time, how long it takes before the unit goes to sleep
+* STMP -> The temperature the unit drops to in sleep mode
+* MOTION -> Wether motion detection is enabled or not
+* TMPUNIT -> Temperature unit, C or F
+* FLPDSP -> Flip display for left handed users
+* SENSE -> Motion Sensitivity, H is more sensitive. L is lowest sensitivity (ie takes more movement to trigger)
+
+## Extras Menu
+This menu defaults to showing the current temperature on the tip. Pressing the button near the iron tip will show the current input voltage. Pressing the button near the usb enters the temperature offset setting menu, when the iron is cold, pressing the other button will start the unit calibrating for any offset in the tip temperature.
 
 # Version Changes:
+V1.04
+	- Increased accuracy of the temperature control
+	- Improved PID response slightly
+	- Allows temperature offset calibration
+	- Nicer idle screen
+V1.03 
+	- Improved Button handling
+	- Ability to set motion sensitivity
+	- DC voltmeter page shows input voltage
 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).

workspace/ts100/inc/Analog.h

@@ -16,5 +16,5 @@ extern volatile uint16_t ADC1ConvertedValue[2];
 
 uint16_t Get_ADC1Value(uint8_t i);
 uint16_t readIronTemp(uint16_t calibration_temp, uint8_t read,uint16_t setPointTemp); //read the iron temp in C X10
-uint16_t readDCVoltage();/*Get the system voltage X10*/
+uint16_t readDCVoltage(uint16_t divFactor);/*Get the system voltage X10*/
 #endif /* ANALOG_H_ */

workspace/ts100/inc/Modes.h

@@ -18,15 +18,16 @@
 #include "Analog.h"
 enum {
 	STARTUP, 		//we are sitting on the prompt to push a button
-	SOLDERING,
+	SOLDERING, 		//Normal operating mode
-	TEMP_ADJ,
+	TEMP_ADJ,		//Adjust the set temperature
-	SETTINGS,
+	SETTINGS,		//Settings menu
-	SLEEP,
+	SLEEP,			//Iron is snoozing due to lack of use
-	COOLING,
+	COOLING,		//Iron is cooling down -> Warning screen
-	UVLOWARN,
+	UVLOWARN,		//Unit tripped low voltage
-	THERMOMETER,
+	THERMOMETER,	//Read the tip temp
-	DCINDISP,
+	DCINDISP,		//Disp the input voltage && Cal the DCin voltage divider
-	TEMPCAL,
+	TEMPCAL,		//Cal tip temp offset
+
 } operatingMode;
 
 enum {

workspace/ts100/inc/Settings.h

@@ -11,7 +11,7 @@
 #define SETTINGS_H_
 #include <stdint.h>
 #include "stm32f10x_flash.h"
-#define SETTINGSVERSION 0x03 /*Change this if you change the struct below to prevent people getting out of sync*/
+#define SETTINGSVERSION 0x04 /*Change this if you change the struct below to prevent people getting out of sync*/
 #define SETTINGSOPTIONSCOUNT 6 /*Number of settings in the settings menu*/
 #define MOTION_HIGH (0x00)
 #define MOTION_MED  (0x10)
@@ -30,6 +30,7 @@ struct {
 	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
+	uint16_t voltageDiv;			//Voltage divisor factor
 } systemSettings;
 
 void saveSettings();

workspace/ts100/src/Analog.c

@@ -10,12 +10,12 @@
 
 //Reads the dc input and returns it as X10 voltage (ie 236 = 23.6V)
 //Seems unstable below 9.5V input
-uint16_t readDCVoltage() {
+uint16_t readDCVoltage(uint16_t divFactor) {
 	uint16_t reading = 0;
 	for (u8 i = 0; i < 10; i++) {
 		reading += ADC_GetConversionValue(ADC2);
 	}
-	reading /= 144; //take the average and convert to X10 voltage
+	reading /= divFactor; //take the average and convert to X10 voltage
 	return reading; //return the read voltage
 }
 

workspace/ts100/src/Main.c

@@ -37,7 +37,7 @@ void setup() {
 	readIronTemp(systemSettings.tempCalibration, 0,0); 	//load the default calibration value
 	Init_Oled(systemSettings.flipDisplay); 				//Init the OLED display
 
-	OLED_DrawString("VER 1.04", 8); 					//
+	OLED_DrawString("VER 1.05", 8); 					//
 	delayMs(800);										//Pause to show version number
 	Start_Watchdog(1000); 								//start the system watch dog as 1 second timeout
 }

workspace/ts100/src/Modes.c

@@ -5,7 +5,7 @@
  *      Author: Ralim <ralim@ralimtek.com>
  */
 #include "Modes.h"
-uint8_t tempCalStatus = 0;
+uint8_t CalStatus = 0;
 //This does the required processing and state changes
 void ProcessUI() {
 	uint8_t Buttons = getButtons(); //read the buttons status
@@ -51,7 +51,7 @@ void ProcessUI() {
 						return;
 					}
 				}
-			uint16_t voltage = readDCVoltage(); //get X10 voltage
+			uint16_t voltage = readDCVoltage(systemSettings.voltageDiv); //get X10 voltage
 			if ((voltage / 10) < systemSettings.cutoutVoltage) {
 				operatingMode = UVLOWARN;
 				lastModeChange = millis();
@@ -180,9 +180,10 @@ void ProcessUI() {
 
 		if (Buttons == BUT_A) {
 			//Single button press, cycle over to the DC display
+			CalStatus = 0;
 			operatingMode = DCINDISP;
 		} else if (Buttons == BUT_B) {
-			tempCalStatus = 0;
+			CalStatus = 0;
 			operatingMode = TEMPCAL;
 		} else if (Buttons == (BUT_A | BUT_B)) {
 			//If the user is holding both button, exit the  screen
@@ -193,14 +194,38 @@ void ProcessUI() {
 		break;
 	case DCINDISP: {
 		//This lets the user check the input voltage
-
+		if (CalStatus == 0) {
 			if (Buttons == BUT_A) {
 				//Single button press, cycle over to the temp display
 				operatingMode = THERMOMETER;
+			} else if (Buttons == BUT_B) {
+				//dc cal mode
+				CalStatus = 1;
 			} else if (Buttons == (BUT_A | BUT_B)) {
 				//If the user is holding both button, exit the  screen
 				operatingMode = STARTUP;
 			}
+		} else {
+			//User is calibrating the dc input
+			if (Buttons == BUT_A) {
+				if (!systemSettings.flipDisplay)
+					systemSettings.voltageDiv++;
+				else
+					systemSettings.voltageDiv--;
+			} else if (Buttons == BUT_B) {
+				if (!systemSettings.flipDisplay)
+					systemSettings.voltageDiv--;
+				else
+					systemSettings.voltageDiv++;
+			} else if (Buttons == (BUT_A | BUT_B)) {
+				CalStatus = 0;
+				saveSettings();
+			}
+			if (systemSettings.voltageDiv < 120)
+				systemSettings.voltageDiv = 160;
+			else if (systemSettings.voltageDiv > 160)
+				systemSettings.voltageDiv = 120;
+		}
 
 	}
 		break;
@@ -210,13 +235,13 @@ void ProcessUI() {
 			operatingMode = THERMOMETER;
 		} else if (Buttons == BUT_A) {
 			//Try and calibrate
-			if (tempCalStatus == 0) {
+			if (CalStatus == 0) {
 				if ((readTipTemp() < 300) && (readSensorTemp() < 300)) {
-					tempCalStatus = 1;
+					CalStatus = 1;
 					systemSettings.tempCalibration = readTipTemp();
 					saveSettings();
 				} else {
-					tempCalStatus = 2;
+					CalStatus = 2;
 				}
 			}
 		} else if (Buttons == (BUT_A | BUT_B)) {
@@ -237,7 +262,7 @@ void drawTemp(uint16_t temp, uint8_t x) {
 	if (systemSettings.displayTempInF)
 		temp = (temp * 9 + 1600) / 5;/*Convert to F -> T*(9/5)+32*/
 	if (temp % 10 > 5)
-		temp += 10;//round up
+		temp += 10;		//round up
 	OLED_DrawThreeNumber(temp / 10, x);
 }
 
@@ -370,7 +395,9 @@ void DrawUI() {
 		drawTemp(temp, 5);
 		break;
 	case DCINDISP: {
-		uint16_t voltage = readDCVoltage(); //get X10 voltage
+		uint16_t voltage = readDCVoltage(systemSettings.voltageDiv); //get X10 voltage
+
+		if (CalStatus == 0 || ((millis() % 1000) > 500)) {
 			OLED_DrawString("IN", 2);
 			OLED_DrawChar((voltage / 100) % 10, 2);
 			voltage -= (voltage / 100) * 100;
@@ -380,16 +407,18 @@ void DrawUI() {
 			OLED_DrawChar(voltage % 10, 5);
 			OLED_DrawChar('V', 6);
 			OLED_DrawChar(' ', 7);
-
+		} else {
+			OLED_DrawString("IN      ", 8);
+		}
 	}
 		break;
 	case TEMPCAL: {
 
-		if (tempCalStatus == 0) {
+		if (CalStatus == 0) {
 			OLED_DrawString("CAL TEMP", 8);
-		} else if (tempCalStatus == 1) {
+		} else if (CalStatus == 1) {
 			OLED_DrawString("CAL OK  ", 8);
-		} else if (tempCalStatus == 2) {
+		} else if (CalStatus == 2) {
 			OLED_DrawString("CAL FAIL", 8);
 		}
 	}

workspace/ts100/src/Settings.c

@@ -51,6 +51,6 @@ void resetSettings() {
 	systemSettings.flipDisplay=0;				//Default to right handed mode
 	systemSettings.sensitivity=0x00;			//Default high sensitivity
 	systemSettings.tempCalibration=239;			//Default to their calibration value
-
+	systemSettings.voltageDiv=144;				//Default divider from schematic
 }