From acb97f1d464346d6b00f85078780160fa0f2affa Mon Sep 17 00:00:00 2001 From: "Ben V. Brown" Date: Mon, 3 Oct 2016 01:18:23 +1100 Subject: [PATCH] Documentation Updates Update documentation to include menu flow diagram from my website. Remove old firmware version as it is no longer relivant. Remove System Design as it is complete. --- README.md | 6 ++++++ SystemDesign.md | 21 --------------------- VERSION.txt | 25 ------------------------- 3 files changed, 6 insertions(+), 46 deletions(-) delete mode 100644 SystemDesign.md delete mode 100644 VERSION.txt diff --git a/README.md b/README.md index 71e7cf9a..d658bd14 100644 --- a/README.md +++ b/README.md @@ -30,3 +30,9 @@ This is completely safe, if it goes wrong just put the .hex file from the offici 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. + + +# 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. +![TS100: Software Menu](http://ralimtek.com/images/TS100.png "Fairly easy to learn") diff --git a/SystemDesign.md b/SystemDesign.md deleted file mode 100644 index 655e08e5..00000000 --- a/SystemDesign.md +++ /dev/null @@ -1,21 +0,0 @@ -# System Design - -# Movement Detection -The unit has a MMA8652FC Accelerometer on the small sub board along with the STM32. -This is used for motion detection of the soldering iron. - -# USB Disk -When the unit is plugged into the computer, it presents a FAT device to the operating system over the usb connection. -This is implemented using a ram buffer for the disk. - - - - -# Future improvements to be made -These features are things I would like to add to the firmware - -* Use the sysTick hardware for timing of events -* Move all the settings to an on device menu system instead of usb link -* Move error codes into a unified struct -* Rewrite most of the OLED stack to not require hardcoded values -* Rework the modes of the unit to be neater diff --git a/VERSION.txt b/VERSION.txt deleted file mode 100644 index 76b1be1e..00000000 --- a/VERSION.txt +++ /dev/null @@ -1,25 +0,0 @@ -v2.11 update (2015/08/03) -1, optimizing the key for delay; -2, optimized display processing -3, optimization of high-temperature alarm; -4, to increase the maximum voltage alarm; -5, the newly added screen protection, enter standby interface for some time, the screen will shut itself down, or move the iron screen button will automatically light up; -6, optimizing the movement decision - -v2.10 update (2015/07/14) -1, temperature calibration is not refresh bug; -2, Cancel USB-powered thermometer into the function; - ----Original -- -v2.11 更新内容(20150803) -1、 优化按键延时处理； -2、 优化显示处理 -3、 优化高温报警； -4、 提高报警的最高电压； -5、 新加入屏幕保护功能，进入待机界面一段时间后，屏幕会自己关闭，按键或者移动烙铁屏幕会自动点亮； -6、 优化移动判定 - -v2.10 更新内容(20150714) -1、 温度校准时没有刷新的bug； -2、 取消USB供电时进入温度计的功能； -