From 3895218b2d7b10b4a475bcff1ffdd8779b300495 Mon Sep 17 00:00:00 2001 From: River B <97197236+River-b@users.noreply.github.com> Date: Wed, 24 Aug 2022 16:16:05 -0700 Subject: Clarify and add details to documents (#1383) * Update README.md * Update Menu.md Thoughts: - changing the name in display to "Calibrate Tip Offset" (currently shows Calibrate temperature) might be more clear, and then people will not get nervous and think the number displayed means temperature? since it is just a number, i.e., 765, and does not say "765 offset" I suggest changing to either "number Offset" or changing menu name to "Calibrate Tip Offset" . when people incorrectly beleive the high number is temperature, since it says "calibrate temperature?" then it leads to unwarranted concern that the pinecil or IronOS is broken. * Update Menu.md * Update Temperature.md clarify language, add punctuation. * Update HallSensor.md * Update HallSensor.md * Update HallSensor.md * Update HallSensor.md * Update HallSensor.md * Update HallSensor.md * Update HallSensor.md * Update DebugMenu.md * Update DebugMenu.md * Update DebugMenu.md * Update DebugMenu.md * Update Flashing.md * Update HallSensor.md * Update GettingStarted.md * Update DebugMenu.md * Update GettingStarted.md * Update HallSensor.md * Update HallSensor.md * Update HallSensor.md * Update HallSensor.md * Update HallSensor.md * Update Menu.md * Update Menu.md * Update Menu.md * Update Menu.md * Update Menu.md * Update Menu.md * Update Menu.md * Update Menu.md * Update Menu.md * Update Menu.md * Update Menu.md * Update Menu.md * Update Menu.md * Update Menu.md * Update Menu.md * Update Menu.md * Update Menu.md * Update Menu.md * Update Menu.md * Update Menu.md * Update Menu.md * Update Menu.md * Update Menu.md * Update Menu.md * Update Menu.md * Update Menu.md * Update History.md * Update History.md updated history with some of the Releases that were missing. * Update DebugMenu.md * Update DebugMenu.md * Update DebugMenu.md * Update DebugMenu.md * Update DebugMenu.md * Update DebugMenu.md * Update DebugMenu.md * Update README.md * Update Temperature.md * Update DebugMenu.md * Update Flashing.md * Update Flashing.md * Update Temperature.md * Update Temperature.md * Update DebugMenu.md * Update DebugMenu.md * Update Temperature.md * Update Temperature.md * Update Temperature.md * Update Temperature.md * Update README.md Co-authored-by: discip <53649486+discip@users.noreply.github.com> * Update Temperature.md * Update Troubleshooting.md In which troubleshooting conditions/symptoms would: (1) Re-calibrating tip offset temperature be appropriate? (2) Re-Calibrating Input voltage be appropriate? I think these 2 internal tests would be helpful sections for Troubleshooting, but not sure of all details to write-up. * Update GettingStarted.md Co-authored-by: discip <53649486+discip@users.noreply.github.com> --- README.md | 21 +++++++++++---------- 1 file changed, 11 insertions(+), 10 deletions(-) (limited to 'README.md') diff --git a/README.md b/README.md index 506bc213..2b7beeb1 100644 --- a/README.md +++ b/README.md @@ -11,7 +11,7 @@ Originally conceived as an alternative firmware for the TS100, this firmware has The firmware implements all of the standard features of a 'smart' soldering iron, with lots of little extras and tweaks. I highly recommend 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 'smart' power sources (PD and QC), the firmware supports settings around the negotiated power and voltage. For soldering irons that are designed to be powered by batteries (TS100 & Pinecil), settings for a cutoff voltage for battery protection are supported. There are 30 languages currently supported. When downloading the firmware for your soldering iron, take note of the language code in the file name. @@ -20,16 +20,17 @@ This project is considered feature complete for use as a soldering iron, _so ple _This firmware does **NOT** support the USB port while running for changing settings. This is done through the onscreen menu only. Logos are edited using the tool or python script and uploaded in DFU mode._ -| Device | DC | QC | PD | EPR | BLE | Battery | Recommended | -| --------: | :-: | :-: | :-: | :-: | :-: | :-----: | :---------: | -| MHP30 | ❌ | ❌ | ✔️ | ❌ | ❌ | ❌ | ✔️ | -| Pinecil | ✔️ | ✔️ | ✔️ | ❌ | ❌ | ✔️ | ✔️ | -| Pinecil 2 | ✔️ | ✔️ | ✔️ | ✔️ | ✔️ | ✔️ | ✔️ | -| TS100 | ✔️ | ❌ | ❌ | ❌ | ❌ | ✔️ | ❌ | -| TS80 | ❌ | ✔️ | ❌ | ❌ | ❌ | ✔️ | ❌ | -| TS80P | ❌ | ✔️ | ✔️ | ❌ | ❌ | ✔️ | ✔️ | -Please note that Miniware started shipping TS100's using cloned STM32 Chips. While these do work with IronOS, their DFU bootloader works terribly, and it is hard to get it to successfully flash larger firmware images like IronOS without timing out. This is the main reason why the TS100 is _no longer recommended_. +| Device | DC | QC | PD | EPR | BLE | Battery | Recommended | +|-----------:|:--:|:--:|:--:|:---:|:---:|:-------:|:-----------:| +| MHP30 |❌ | ❌ | ✔️ | ❌ | ❌ | ❌ | ✔️ | +| Pinecil V1 |✔️ | ✔️ | ✔️ | ❌ | ❌ | ✔️ | ✔️ | +| Pinecil V2 |✔️ | ✔️ | ✔️ | ✔️ | ✔️ | ✔️ | ✔️ | +| TS100 |✔️ | ❌ | ❌ | ❌ | ❌ | ✔️ | ❌ | +| TS80 |❌ | ✔️ | ❌ | ❌ | ❌ | ✔️ | ❌ | +| TS80P |❌ | ✔️ | ✔️ | ❌ | ❌ | ✔️ | ✔️ | + +*Please note that Miniware started shipping TS100's using cloned STM32 Chips. While these do work with IronOS, their DFU bootloader works terribly, and it is hard to get it to successfully flash larger firmware images like IronOS without timing out. This is the main reason why the TS100 is _no longer recommended_. ## Getting Started -- cgit v1.2.3