Migrate Wiki -> Markdown pages

3 files changed, 89 insertions, 19 deletions

diff --git a/Documentation/Flashing.md b/Documentation/Flashing.md
index 0ee9f5f0..2a13a6dd 100644
--- a/Documentation/Flashing.md
+++ b/Documentation/Flashing.md
@@ -1,5 +1,23 @@
 # Flashing / Upgrading your iron

 

+## Downloading source file

+

+### Main release

+

+Main releases are made to the [releases page](/releases).

+Download the zip file that matches your model of soldering iron, and extract it.

+You then need to use the appropriate file type for your unit, in general Miniware irons are `.hex` and Pinecil is `.bin.`

+Flash according to details below

+

+### Bleeding edge / latest

+

+For the _latest_ code, you will need to download the zip file from the artefacts page on the build for what you want.

+Head to the [Actions](/actions) page and then select the run for the appropriate branch you would like.

+In general you probably want `master`.

+

+Once you click on a run, scroll down to the "Artifacts" section and then click on your model to download a zip file.

+Then this works the same as a production release (use the correct file).

+

 ## Miniware irons (TS100, TS80, TS80P)

 

 This is completely safe, but if it goes wrong just put the .hex file from the official website onto the unit and you're back to the old firmware. Downloads for the hex files to flash are available on the [releases page.](https://github.com/Ralim/ts100/releases) The file you want is called *(MODEL)_EN.hex* unless you want the translations, they are (MODEL)_*language short name*.hex. Where (MODEL) is either TS100 or TS80.

@@ -27,6 +45,47 @@ There is a complete device flash backup included in this repository. (Note this
 

 For the TS80 the SWD pins are used for the QC negotiation, so you can actually connect to the SWD power via the USB connector.

 

+

+# Mac

+

+sgr1ff1n (Shane) commented in [issue 11](https://github.com/Ralim/ts100/issues/11) that upgrading worked on their Mac as per normal:

+

+> I just wanted to say that I was able to update the firmware on my ts100 from the stock version to 1.08 found in this repository using my Mac. I simply followed the same steps however through Finder. I have a MacBook Pro (13-inch, Mid 2012) running Sierra 10.12.4 (16E195).

+

+# Linux

+

+While in past there were reports of unreliable upgrades, the consensus in [issue 11](https://github.com/Ralim/ts100/issues/11) is that things work mostly as expected in Linux.

+

+@awigen has contributed a script [flash_ts100_linux.sh](https://raw.githubusercontent.com/Ralim/ts100/master/Flashing/flash_ts100_linux.sh) that works on Ubuntu 16.04 as well as other distro's.

+

+If you want to do it manually (or if the script does not work for some reason) the general procedure is the same as for Windows, the differences are in the way to mount the unit and copy the firmware.

+Remember that after flashing, the firmware filename will have changed to end in `.RDY` or `.ERR` or `.NOT` and only `.RDY` means the flashing was successful!

+

+* The unit has to be mounted as ```msdos``` type (thanks @balrog-kun for having spotted it). You may disable automount, but unmounting the automounted drive and remounting as `msdos` works fine.  You do not need to turn off automounting, but you do need to unmount the device with `umount`.

+* It is recommended to use an all-caps filename for the firmware, even if successful flashing were done with lower case names.

+* Avoid USB hubs, plug directly in your computer.

+* If it fails, try again several times without unplugging. Just let it remount.

+

+Example, to be run as root, once the unit has been plugged in DFU mode and auto-mounted:

+

+```bash

+FW=ts100.hex

+unset NAME

+eval $(lsblk -P -p -d --output NAME,MODEL|grep "DFU Disk")

+[ -z ${NAME+x} ] && exit 1  # Could not find DFU device

+umount "$NAME"

+mkdir /tmp/mntdfu

+mount -t msdos "$NAME" /tmp/mntdfu

+cp "$FW" "/tmp/mntdfu/$(basename $FW|tr a-z A-Z)"

+sync

+umount /tmp/mntdfu

+rmdir /tmp/mntdfu

+```

+

+Device will reboot and automount will rerun if not disabled.

+Check the extension of your firmware, it should be `.RDY` now.

+

+

 ## Pinecil (Pine64)

 

 The MCU used in the Pinecil supports usb-dfu.

diff --git a/Documentation/Logo.md b/Documentation/Logo.md
new file mode 100644
index 00000000..1581d518
--- /dev/null
+++ b/Documentation/Logo.md
@@ -0,0 +1,29 @@
+# Startup Logos

+

+This firmware supports a user created bootup logo.

+By default there is _not_ one included in the firmware, as this means that once flashed they generally stay.

+

+## Generating the Logo files

+

+The [Python script](https://github.com/Ralim/ts100/blob/master/Bootup%20Logo/python_logo_converter/img2ts100.py) converts an image passed into it on the command line to a HEX file to be uploaded to the iron in DFU mode (similar to the process described above). The image can be in color and any size, but it will be resized and converted to 1-bit color. However, it looks best if you create a 96x16 image in an image editor and color the pixels black or white manually.

+

+The converter requires at least Python 3 and Pillow (if you don't have it, it will tell you to install PIL, which is an old version of the same thing). See [this page](https://stackoverflow.com/a/20061019/6705343) on StackOverflow about installing it.

+

+What works can vary, but this command may work:

+

+`python3 -m pip install Pillow`

+

+Then, to convert an image:

+

+`python3 img2ts100.py infile.png outfile.hex`

+

+Run `python3 img2ts100.py --help` to see available options.

+

+## Flashing the Logo

+

+### Miniware (TS100/TS80/TS80P)

+

+Upload the HEX file to the iron in DFU mode and, if the file's extension changes to .RDY, your custom splash screen should show up on startup.

+You perform this the same way as if you were flashing a new firmware, and all of the existing notes around this apply.

+

+### Pinecil
\ No newline at end of file
diff --git a/Documentation/Menu.md b/Documentation/Menu.md
index 71c882ba..86c49994 100644
--- a/Documentation/Menu.md
+++ b/Documentation/Menu.md
@@ -36,11 +36,6 @@ To calibrate your iron:
 6. Use the front and back buttons to adjust the displayed voltage to minimize the error to your original measurement
 7. Hold both buttons to save and exit to the menu
 
-### Tip Model Selection
-
-The menu now lets you select which tip you are using with your iron. This lets the unit know which gain value to use for your tip, this varies slightly between models and can help with temperature accuracy.
-There is also an option for a *custom* tip. This basically means that you will tune the tip parameters yourself.
-
 ### Calibrating tip offset (Set tip model)
 
 Some tips will have an offset on their readings, to calibrate this out perform the following steps:
@@ -53,23 +48,10 @@ Some tips will have an offset on their readings, to calibrate this out perform t
 6. The display will start to scroll a warning message to check that the tip is at ambient temperature!
 7. Press the button near the tip of the iron to confirm
 8. The display will go to "...." for a short period of time as the unit measures the tip temperature and the handle temperature and compares them
-9. The display will then go back to *TMP CAL*
+9. The display will then go back to *TMP CAL* and it will display a number, this is your offset number. You generally dont need it unless debugging issues
 10. Calibration is done, just exit the settings menu as normal
 11. You're done, enjoy your iron!
 
-### Calibration of custom tip
-
-There are two methods to calibrate the tip, the simple mode which requires boiling water, and an advanced mode that requires a method of measuring the actual tip of the tip.
-
-Advanced mode is preffered.
-
-In simple mode you first need to have the tip at room temperature to start, and then when prompted place the tip into a cup of boiling water, wait a few seconds and then press a button to confirm.
-
-In advanced mode, follow instructions on the screen, you will need to adjust the ranges to find two calibration points by measuring the tip temperature directly. This tends to be significantly more accurate.
-
-If you do calibrate your own values for a tip because it's missing from the menu or because you think the one in the menu is really wrong, raise an issue on github and I'll be happy to look at adding it or revising the existing settings.
-
-
 ### Boost mode
 
 This allows you to change the front key (one near the tip) to become a boost button when you hold it for > 2 seconds. This allows you to set this button to change the soldering temperature for short periods. For example when soldering a big joint and you want to boost the temperature a bit.