Created Logo Editor (markdown)

Ben V. Brown
2017-08-11 14:50:18 +10:00
parent fc4f8e3187
commit 01994ed6d4

39
Logo-Editor.md Normal file

@@ -0,0 +1,39 @@
With this software build, the built in USB flash drive emulation was removed. This mostly driven by the use of open source compilers that could not quite fit the emulated flash disk on the image. As well as the drive being made mostly redundant by the menu structure being added to the iron.
The big loss when removing the USB flash drive was the loss of the custom boot up logo that users loved. This allows you to brand your unit as yours and have a nice logo.
To bring back the logo support without having to code a smaller version of the USB drive optimization, the software automatically looks in the second last sector of flash to see if a bootup image is programmed there and if so the software will display this on startup. The only catch to this is, how to get the image in the right location initially.
## The logo editor
This is a small application written in C# that allows you to load up an image, and it will convert the image to B&W and export a .HEX file. This file can then be programmed to your iron using the DFU mode, the same as upgrading your firmware.
### Windows
The .exe file can be downloaded from the releases page and should run on a modern windows machine without any issue. It requires .Net 4.0 which most newer windows OS's include.
### Linux
The GUI can be launched directly with mono (`mono TS100.Logo.Editor.exe`). You can also compile it from the sources with `xbuild "TS100 Logo Editor.csproj"`. Depending on your Mono version, if you get `The predefined type ... is not defined or imported` errors, you will have to change `TargetFrameworkVersion` in `TS100 Logo Editor.csproj` to match yours, e.g. from 4.0 to 4.5.
### Mac
The logo editor should run under mono on Mac, similar to Linux.
### Using the software
1. On the [releases page](https://github.com/Ralim/ts100/releases) you will need to download the latest copy of the GUI Tool (*TS100.Logo.Editor.exe*).
2. Launch the TS100 Logo Editor, see above
3. On the tool open the source image that you would like to use as your bootup screen. A resolution of 96x16 is ideal, but you can fill or stretch your logo to fit
4. Colour images are okay, the software will convert them to B&W for you.
5. You can also invert colours if you would prefer.
6. Save the created file as a *.hex* file somewhere.
7. Connect your iron to your computer in DFU mode (same as you would to upgrade firmware).
8. Drag the created .hex file for the logo onto the iron to update it with the file.
9. You should be good to go.
10. The image will stay through future updates, but if it ever won't I will put a large warning in the update download on the releases page. This will only occur if the firmware grows significantly larger than it currently is.