Updating documentation

PULL_REQUEST_TEMPLATE.md

@@ -2,11 +2,9 @@
 Please try and fill out this template where possible, not all fields are required and can be removed.
 
 * **Please check if the PR fulfills these requirements**
-- [ ] The commit message make sense
-- [ ] The changes have been tested locally
-- [ ] New features have been documented in the Wiki
-- [ ] I'm willing to maintain this in the future (Totally Optional)
-
+- [] The commit message make sense
+- [] The changes have been tested locally
+- [] Are there any breaking changes
 
 * **What kind of change does this PR introduce?** 
 (Bug fix, feature, docs update, ...)

Translation.md

@@ -3,4 +3,4 @@ If you would like to contribute a translation, use the [Translation Editor](http
 
 [Open a reference language file and optionally a target language file](https://github.com/Ralim/ts100/tree/master/Translation%20Editor).
 
-You can create an issue with your updated json translation, or make your own pull request. If you make a pull request, also run `python3 make_translation.py` to regenerate the source file.
+You can create a pull request with the new / updated json configuration file, and this will include this language into the new builds for the firmware

development.md

@@ -0,0 +1,21 @@
+# Development
+
+Building this software can be performed two ways, using the STMCubeIDE or using command line tools.
+
+## STM Cube IDE
+
+The repository is setup to try and make this painless, when starting the IDE you can import the project by pointing the internal search to the workspace folder of this repository. If you start with a fresh installation, close the welcome screen tab, and then in the left sidebar, there is an optiom to "import". Select General -> Import existing projects -> Set the top location option to this repositories workspace -> Should find the TS100 project.
+
+## Developing with command line tools & building a release
+
+In the `workspace/TS100` folder there is a makefile that can be used to build the repository using command line tools.
+when running the `make` command, specify which model of the device & the language you would like to use.
+
+`make -J8 lang=EN model=TS80`
+
+To build a release instead, run the build.sh script. This will update translations and also build every language for both TS100 and TS80 models.
+
+## Updating languages
+
+To update the language translation files & associated font map, execute the `make_translation.py` code from the translations directory.
+

power.md

@@ -0,0 +1,24 @@
+# Power & Performance
+
+Both the TS100 and TS80 are PWM controlled resistive heating elements.
+This means that the electronics in the handle can only turn the heating element on and off.
+This *means* that the power proivded in the tip is 100% controlled by the supply voltage used.
+
+Both irons at their simplest are just a resistor connected to your power source via a switch.
+
+When the switch is on, the power in the resistor is `Current (I) times Volts (V)`. 
+Current through the resistor is `Volts (V) divided by Resistance (R)`.
+Combining these two gives the common equation, power is `Volts (V) squared / Resistance (R)`.
+
+The resistance of the tip is fixed, 8.5 ohms for the TS100 and 4.5 ohms for the TS80.
+
+This means that for both irons, the power delivered to the soldering tip is proportional to the voltage used, squared.
+This is why the TS100 performs poorly when run off 12V power supplies.
+
+## Output Control & Regulation
+
+Both soldering irons use a FET to switch the power to the soldering iron tip. This is a P-MOSFET and its controlled via a small transistor circuit, which in turn is controlled via the STM32. The STM32 controls this PWM output proportional to the output from the PID control loop running in the software.
+
+To measure the tip temperature in the iron, the iron has a small op-amp connected across the terminals, this is setup to measure the voltage across the same terminals that are used the power the tip. In order to be able to read the small voltage generated by the thermocouple junction, the irons output must be turned off.
+Once the output is turned off (via the FET), the system has a recovery time as the tip capacitance discharges and the op-amp exits saturation. After this delay period, the STM32 ADC samples the output of the op-amp 8 times quickly and then sets a flag to turn the PWM output back on.
+This enforces a small dead time in the output signal while this occurs, so there is a balance between sampling the temperature often to maintain stable tip temperature control and sampling less often to increase the maximum power deliverable to the tip