me/IronOS
1
0
Fork 1
mirror of https://github.com/Ralim/IronOS.git synced 2025-02-26 07:53:55 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

Clarify and add details to documents (#1383)

Browse Source 
* 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>
This commit is contained in:
River B
2022-08-24 16:16:05 -07:00
committed by GitHub
parent 67d2eda7de
commit 3895218b2d
9 changed files with 156 additions and 105 deletions
Download Patch File Download Diff File Expand all files Collapse all files

59
Documentation/Menu.md
View File

@@ -1,29 +1,30 @@
# Menu System
In this firmware for these soldering irons, all settings are adjustable on the device itself. This means you do **not** require a computer to change any settings.
In this firmware for these soldering irons, all settings are adjustable on the device itself. This means a computer is **not** required to change any setting.
## Soldering mode
In this mode the iron works as you would expect, pressing either button will take you to a temperature change screen.
Use each button to go up and down in temperature. Pressing both buttons will exit you from the temperature menu (or wait 3 seconds and it will time out).
Pressing both buttons or holding the button near the USB will exit the soldering mode.
Holding the button at the front of the iron will enter boost mode (if enabled).
- Use each button to go up/down in temperature. Pressing both buttons exits the temperature menu (or wait 3 seconds and it will time out).
- Pressing both buttons or holding the rear button (`-/B`) will exit Soldering Mode.
- Holding the front button (`+/A`) will enter [Boost mode](/Documentation/Menu.md#boost-mode) (if enabled).
## Settings Menu
This menu allows you to cycle through all the options and set their values.
The button near the USB cycles through the options, and the one near the tip changes the selected option.
Note that settings are not saved until you exit the menu.
If you leave the unit alone (i.e., don't press any buttons) on a setting, after 3 seconds the screen will scroll a rough description of the setting.
## Settings mode
This mode allows you to cycle through all the options and set custom values.
The menu is arranged so that the most often used settings are first.
With submenus being selected to enter using the front button (as if you were going to change the setting).
Scrolling through the submenu will return you back to its entry location after you scroll through all of the options.
- The rear button (`-/B`) cycles through the main options.
- The front button (`+/A`) changes the selected option.
- Note that settings are not saved until you exit the menu.
- If you idle on a setting (i.e., don't press any buttons), after 3 seconds, the screen scrolls a brief description (mini help guide).
- Enter submenus using the front button (`+/A`) if you are going to change it or wish to view it.
- Scrolling through the all options of a submenu will return you back to its entry location.
### Calibrating input voltage
Due to the tolerance on the resistors used for the input voltage divider, some irons can be up to 0.6 V out on the voltage measurement.
Please calibrate your iron if you have any issues with the cutoff voltage.
Please calibrate your iron if you have any issues with the cutoff voltage. This calibration is not required if you have no issues.
Note that cutoff messages can also be triggered by using a power supply that is too weak and fails under the load of the iron.
To calibrate your iron:
@@ -31,29 +32,29 @@ To calibrate your iron:
1. Measure the input voltage with a multimeter and note it down.
2. Connect the input to your iron.
3. Enter the settings menu
4. Under the advanced submenu
4. Under the Advanced submenu
5. Select the calibrate voltage option
6. Use the front and back buttons to adjust the displayed voltage to minimize the error to your original measurement
7. Press both buttons at the same time to save and exit to the menu
7. Press both buttons at the same time to Save and Exit to the menu
### Calibrating tip offset (Set tip model)
Some tips will have an offset on their readings, to calibrate this out perform the following steps:
This is normally not needed unless you have an issue with your temperature or your tips are wearing out prematurely. Changing tip lengths does not necessarily mean a calibration is needed. If the method below is not followed, the iron could be worse than before calibration, repeat the method.
Some tips have an offset on their readings which causes issues, i.e., the actual temperature of the tip is much higher than displayed. To calibrate this out, perform the following steps:
1. Connect power to your iron
2. Make sure the tip is at room temperature (i.e., wait for a fair while after using the iron before calibration)
3. Enter the settings menu
4. Scroll down to the advanced menu, and then the temperature calibration
5. Press the button to change the option (tip button)
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* and it will display a number, this is your offset number. You generally don't need it unless debugging issues
10. Calibration is done, just exit the settings menu as normal
11. You're done, enjoy your iron!
2. **Critical: make sure the tip & handle is at room temperature** (wait a good while after using the iron before calibration)
3. Using (`-/B`) scroll down to Advanced settings > press (`+/A`) to select > then (`-/B`) to scroll to Calibrate temperature? > press (`+/A`)
4. Important warning message is shown: *Please ensure the tip is at room temperature before proceeding!*
5. Press the (`+/A`) button to confirm (tip/handle are at ambient temperature).
6. Display shows **`....`** for a short time as the unit measures and compares the tip and handle temperatures.
7. The display then goes back to *TMP CAL* and displays your *Offset number*. You generally don't need this offset unless debugging issues.
8. After you see an Offset number, calibration is done, just exit the settings menu normally, use (`-/B`).
9. You're done, enjoy your iron!
Note: offsets are dependant on your tip, temperature sensor, and the MCU. It's the culmination of tolerances at rest. Typical values are 700-1000 range. This is only designed to be used at boot while cold (ambient room temperature), as temperatures drift apart as soon as power is connected. Doing this reading repeatedly could result in wide varience of the offset number and/or incorrect calibration.
### 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.
This allows you to change the front button (`+/A`) to become a boost button when you hold it for > 2 seconds. A boost button changes the soldering temperature for short periods. For example, when soldering a big joint and you need a much higher temperature, hold the (`+/A`) button down and it will temporarily increase the temperature to your 'boost' setting. When you release the button, the temperature will gradually go back to the normal set temperature.
The boost temperature is set in the settings menu.
The boost temperature is set in Soldering settings.