From bfcfc294c8b38eff7833ae23c94d0c3b7c8ef62b Mon Sep 17 00:00:00 2001 From: "Ben V. Brown" Date: Thu, 31 Dec 2020 12:32:00 +1100 Subject: [PATCH] Preparing for rename --- Documentation/{Debug Menu.md => DebugMenu.md} | 0 Documentation/Development.md | 6 ++++ Documentation/History.md | 28 +++++++++++++++++ Documentation/Power.md | 4 +-- README.md | 31 +++++++++++-------- 5 files changed, 54 insertions(+), 15 deletions(-) rename Documentation/{Debug Menu.md => DebugMenu.md} (100%) diff --git a/Documentation/Debug Menu.md b/Documentation/DebugMenu.md similarity index 100% rename from Documentation/Debug Menu.md rename to Documentation/DebugMenu.md diff --git a/Documentation/Development.md b/Documentation/Development.md index 1dd3c2df..7cfbf184 100644 --- a/Documentation/Development.md +++ b/Documentation/Development.md @@ -18,3 +18,9 @@ To build a release instead, run the build.sh script. This will update translatio ## Updating languages To update the language translation files & associated font map, execute the `make_translation.py` code from the translations directory. + +## Building Pinecil + +I highly reccomend using the command line tools and using docker to run the compiler. +Its a bit more fussy on setup than the STM tooling and this is by far the easiest way. +If you _need_ an IDE I have used [Nuclei's IDE](https://nucleisys.com/download.php) \ No newline at end of file diff --git a/Documentation/History.md b/Documentation/History.md index 0a81bddc..007323af 100644 --- a/Documentation/History.md +++ b/Documentation/History.md @@ -1,5 +1,33 @@ # Version Changes +## V2.13 + +* First _official_ Pinecil release +* All of the wire for Pinecil releases added +* Updated Translations +* Delay accelerometer to help with entering sleep on startup +* Dual speed PWM to help with power limit control +* Improve heat up time +* Adds locking mode +* Improved docs all over the place +* Repo rename occured TS100 -> IronOS +* Hall effect sensor support added (not fitted in Pinecil but optional) +* QC 20V support for Pinecil +* CI upgrades for faster builds +* Fixed bug with accelerometer model on Pinecil +* Rework of all of the temperature curves for better accuracy + + + +## V2.12 + +* Only released as pre-release +* [TS80P] Improvements to the PD negotiation to handle a few more adapters cleanly +* Pause on the last item in a list +* Clean up the menu (removed both enables and settings, so that you can turn things off easier) +* Removing the very old single line menu style. + + ## V2.11 * First TS80P support diff --git a/Documentation/Power.md b/Documentation/Power.md index e4d3ffc2..6806f6d7 100644 --- a/Documentation/Power.md +++ b/Documentation/Power.md @@ -1,6 +1,6 @@ # Power & Performance -Both the TS100 and TS80 are PWM controlled resistive heating elements. +All of the irons 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. @@ -10,7 +10,7 @@ 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. +The resistance of the tip is fixed, ~7.5 ohms for the TS100/Pinecil and ~4.5 ohms for the TS80(P). 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. diff --git a/README.md b/README.md index 54e4bf20..e1aa0560 100644 --- a/README.md +++ b/README.md @@ -1,18 +1,18 @@ -![C/C++ CI](https://github.com/Ralim/ts100/workflows/C/C++%20CI/badge.svg) +![CI](https://github.com/Ralim/ts100/workflows/CI%20Build%20all/badge.svg) -# Flexible Soldering iron control Firmware +# IronOS - Flexible Soldering iron control Firmware -*Please Note, this repo will likely be renaming soon to unire or IronOS - See issue [#639](https://github.com/Ralim/ts100/issues/639). Old links willcontinue to work, and should redirect. So dont panic :) This is just to better account for the newer soldeing irons being added.* +*This repository was formerly known as TS100, its the same great code. Just with more supported devices* Originally concieved as an alternative firmware for the TS100, this firmware has evolved into a complex soldering iron control firmware. The firmware implements all of the standard features of a "smart" soldering iron, with lots of little extras and tweaks. -I highly reccomend reading the installation guide fully when installing on your iron. +I highly reccomend reading the installation guide fully when installing on your iron. And after install just explore the settings menu. For soldering irons that are designed to be powered by "smart" power sources (QC and PD), the firmware supports settings around the negotiated power and voltage. For soldering irons that are designed to be powered by batteries (TS100), settings for a cutoff voltage for battery protection are supported. -There are 25 languages currently supported as of present. When downloading the firmware for your soldering iron take node of the language code in the file name. +There are 25 languages currently supported as of present. When downloading the firmware for your soldering iron take note of the language code in the file name. This project is considered feature complete for use as a soldering iron, *so please suggest any feature improvements you would like!* @@ -26,15 +26,16 @@ This project is considered feature complete for use as a soldering iron, *so ple * All settings exposed in intuitive menu * (TS100) Set a voltage lower limit for Lithium batteries so you don't kill your battery pack * (TS80) Set 18W or 24W settings for your power bank -* Improved readability Fonts +* (TS80P) Automatically negotiates appropriate PD and falls back to QC mode like TS80 +* (Pinecil) Supports all 3 power modes (PD,QC, DC In). +* Improved readability Fonts, supporting multiple languages * Use hardware features to improve reliability * Can disable movement detection if desired * Boost mode lets you temporarily change the temperature when soldering (i.e. raise the temperature for short periods of time) -* (TS100) Battery charge level indicator if power source set to a lipo cell count -* (TS80) Power bank operating voltage is displayed -* [Custom boot up logo support](Documentation/Upgrading.md) +* (TS100/Pinecil) Battery charge level indicator if power source set to a lipo cell count +* (TS80/TS80P/Pinecil) Power bank operating voltage is displayed +* [Custom boot up logo support](Documentation/Flashing.md) * Automatic LCD rotation based on the orientation -* Supports both the version 1 and version 2 hardware (different accelerometers) # Menu System @@ -44,7 +45,7 @@ When on the main screen, the unit shows prompts for the two most common operatio * Pressing the button near the tip enters soldering mode * Pressing the button near the USB enters the settings menu * Holding the button near the tip will enter soldering temperature adjust mode (This is the same as the one in the soldering menu, just to let you edit before heating up) -* Holding the button near the USB end will show the firmware version details +* Holding the button near the USB end will show the [debug menu](Documentation/DebugMenu.md) Detailed operation details are over in the [Menu information.](Documentation/Menu.md) @@ -68,12 +69,16 @@ Especially to the following users, who have helped in various ways that are mass * [Agatti](https://github.com/agatti) * [Discip](https://github.com/discip) * [Paul Fertser](https://github.com/paulfertser) + +Plus the huge number of people who have contributed translations, your effort is massively appreciated. + ## Licence The code created by the community is GNU GPLv3. Unless noted elsewhere. -Other components such as FreeRTOS have their own licence. +Other components such as FreeRTOS/USB-PD have their own licence. ## Commercial Use -This software is provided as-is, so I cannot provide any commercial support for the firmware. However, you are more than welcome to distribute links to the firmware, or provide irons with this software on them. +This software is provided as-is, so I cannot provide any commercial support for the firmware. +However, you are more than welcome to distribute links to the firmware, or provide irons with this software on them. Please do not re-host the files, but rather link to this page, so that there are no old versions of the firmware scattered around.