diff --git a/Documentation/DebugMenu.md b/Documentation/DebugMenu.md index 49245a0b00..a0553a2401 100644 --- a/Documentation/DebugMenu.md +++ b/Documentation/DebugMenu.md @@ -13,15 +13,15 @@ Items are shown in the menu on a single line, so they use short codes and appear ### ID - This is used by Irons that have an ID and serial number to help check if the iron is authentic. All Pinecil V1 show the same ID number as this is the number programmed into the MCU. -- The new Pinecil V2 released Aug. 2, 2022 now uses BL706, which enables generating a unique ID/Serial number to every iron. This can be used to verify your Pinecil authenticity [here](https://pinecil.pine64.org/). +- The new Pinecil V2 released Aug. 2, 2022 now uses MCU BL706, which enables generating a unique ID/Serial number to every iron. This can be used to verify your [Pinecil authenticity here](https://pinecil.pine64.org/). -### UpTime +### Time -This just shows how many deciseconds the unit has been powered for. +This is just uptime; it shows how many deciseconds the unit has been powered for (600 ds = 1 minute). ### Move -This is the last timestamp of movement. When the iron is moved, this should update to match the time field (one before in the menu). +This is the last timestamp of movement. When the iron is moved, this should update to match the Time field (previous menu item). This can be used for checking performance of the movement detection code. ### ACC @@ -38,11 +38,11 @@ This indicates the accelerometer that is fitted inside the unit. ### Tip Res -This indicates the tip resistance that the device is currently using. For devices with multiple possible values to choose from (Pinecil V2), the appropriate value is set automatically. +This indicates the tip resistance that the device is currently using. For devices with multiple possible values to choose from (Pinecil V2), the appropriate value is automatically detected at every boot-up. Tip should be installed before boot-up or reading can not be done. ### RTip -This is the raw tip reading in μV. This can be used when assessing the calibration routines for example. +This is the raw tip reading in μV. Tip must be installed or reading will be high/inaccurate. At cool, the range of 700-1000 is normal for larger tips and ~1500 for smaller tips (TS80). This is used to evaluate the calibration routines. ### CTip @@ -51,17 +51,19 @@ This can be used with RTip for assessing temperature processing performance. ### CHan -This is the handle temperature in °C. This is used for cold junction compensation of the tip temperature. -This is shown in degrees Celsius x10, so 200 == 20.0 °C +This is the handle temperature or more accurately the reading of the Cold Junction Compensation (CJC) temperature sensor. This is expressed in °C x 10 (29.0 °C ambient should read as 290). Range of 200-400 (20-40 °C) is normal depending on how hot/cold the room is and how long power has been plugged in which warms the PCB further. +This is used for CJC of the tip temperature. + > If CHan is extremely high, this indicates the temperature sensor isn't reading correctly ([see Troubleshooting](/Documentation/Troubleshooting.md)) + ### CMax -This indicates the max temperature in degrees Celsius that the system estimates it can measure the tip reliably to. -This is dependent on a few factors including the handle temperature so it can move around during use. +This indicates the max temperature in °Celsius that the system estimates it can measure the tip reliably to. +This is dependent on a few factors including the handle temperature so it can move around during use. As you use the iron, the Max increases to a point. ### Vin -The input voltage as read by the internal ADC. Can be used to sanity check its being read correctly. +The input voltage as read by the internal ADC. Can be used to sanity check it is being read correctly. ### PWR @@ -71,7 +73,7 @@ This may change during power up as the sources are negotiated in turn. - **DC** input (dumb) - **QC** input (We used QC2/3 negotiation for current supply) - **PD W. VBus** input (PD subsystem is used to negotiate for current supply); and VBus is connected to your input power source -- **PD No VBus** input (PD subsystem is used to negotiate for current supply); and VBus is **NOT** connected to your input power source. If it is Not required or possible to do a special mod of your PCB (i.e. late model V1, some early Green PCB models) then 'PD No VBus' displays on screen, see details and PD Debug [below](/Documentation/DebugMenu.md#pd-debug-menu). Or if you had 'PD Vbus' displayed before and then successfully modified the Pinecil to support 24V by cutting the trace line to Vbus, then you will see 'PD No Vbus' now as a confirmation that the cut worked. +- **PD No VBus** input (PD subsystem is used to negotiate for current supply); and VBus is **NOT** connected to your input power source. If it is Not required or possible to do a special mod of your PCB (i.e. late model V1, some early Green PCB models) then [PD No VBus] displays on-screen ([see details and PD Debug section below](/Documentation/DebugMenu.md#pd-debug-menu)). ### HW G @@ -80,16 +82,16 @@ As this is a high-water mater, you should only trust this once you have walked t ### HW M -This indicates the high water mark for the stack for the movement detection thread. The smaller this number is, the less headroom we have in the stack. +This indicates the high-water mark for the stack for the movement detection thread. The smaller this number is, the less headroom we have in the stack. ### HW P -This indicates the high water mark for the stack for the PID thread. The smaller this number is, the less headroom we have in the stack. +This indicates the high-water mark for the stack for the PID thread. The smaller this number is, the less headroom we have in the stack. ### Hall This appears if your device is capable of having a hall effect sensor installed (Pinecil). -This shows the current magnetic field strength reading from the sensor. It is used to check if the sensor is operational, and for diagnostics and optimal placement of magnets on a stand (higher number is better/stronger). +This shows the current magnetic field strength reading from the sensor. It is used to check if the sensor is operational, and for diagnostics and optimal placement of magnets on a stand (higher number is better/stronger). [See Hall Sensor for details](/Documentation/HallSensor.md). # PD Debug menu @@ -102,8 +104,16 @@ The first page shows the PD negotiation stage number; which can be used for diag #### Below is a method for user modification to convert some early models of Pinecil V1 to safely support 24V on the DC5525 barrel. ⚠️ Warning: do this at your own risk, read everything in this document, and go to the [Pine64 community chat](https://wiki.pine64.org/wiki/Pinecil#Community_links) if you desire advice. An incorrect cut of the trace could render the Pinecil non-working. -Background: a simple user modification to the PCB on some models of original V1 allows it to safely use DC24V by cutting a trace line to the Vbus which held it back to 21V. You can check whether your Pinecil V1 needs the update or can benefit from it by using the PD debug menu. After a few seconds or after PD negotiates (state above 5) it will show `[No VBus]` if the VBus modification is performed correctly or not needed (i.e., late model V1). Alternately, if it shows `[VBus]`, then the mod has not been done and there is still a connection to the Vbus (and Vbus connection limits you to 21V). +Background: a simple user modification to the PCB on _some models_ of original V1 allows it to safely use DC barrel 24V by cutting a trace line to the Vbus which held it back to 21V. You can check whether your Pinecil V1 needs the update or can benefit from it by using a hidden trick in the PD debug menu. + +- Follow instructions above to enter the PD Debug menu. +- After a few seconds or after PD negotiates (state above 5) it will show `[PD No VBus]` if it is not needed (i.e., late model V1). Alternately, if it shows `[VBus]`, then the mod has not been done and there is still a connection to the Vbus (the Vbus connection limits you to 21V until you do the mod). +- If you need to do the mod, then follow the instructions/links below which have photos. Careful to only cut the trace and nothing else. +- Then use the PD debug menu again to check for `[PD No Vbus]` before attaching any 24V PSU to the DC barrel. If you do not get the message, then try cutting the trace a little deeper or using alcohol to clear the gap of copper dust. Then check PD messages again. If you need advice/tips, join the Pine64 chat room. + +The mod method is shown in the [February 2022 PINE64 community updates](https://www.pine64.org/2022/02/15/february-update-chat-with-the-machine/). Early Pinecil V1 models required cutting a trace to achieve 24V safety with DC barrel PSU. Late model V1 made sometime in 2022 came with `[No Vbus]` already displayed, and no mod is required. + +| Pinecil V2 model released Aug. 2, 2022 is an overhaul of the PCB with all relevant components capable of 28V. V2 requires no mods to support the use of 24V DC Barrel jack charger. | +:-------- -The mod method is shown in the February 2022 [PINE64 community updates](https://www.pine64.org/2022/02/15/february-update-chat-with-the-machine/). Early Pinecil V1 models required cutting a trace. Late model V1 made sometime in 2022 came with '[No Vbus]' already displayed, and no mod is required. -The V2 model released Aug. 2, 2022 is an overhaul of the PCB with all relevant components capable of 28V. V2 requires no mods to support the use of 24V DC Barrel jack charger. diff --git a/Documentation/Development.md b/Documentation/Development.md index f59779cf36..79497af531 100644 --- a/Documentation/Development.md +++ b/Documentation/Development.md @@ -96,9 +96,11 @@ To build a release instead, run the `build.sh` script. This will update translat To update the language translation files and their associated font maps, execute the `make_translation.py` code from the `Translations` directory. If you edit the translation definitions or the English translation, please also run `gen_menu_docs.py` to update the settings menu documentation automatically. -## Building Pinecil +## Building Pinecil V1 I highly recommend using the command line tools and using Docker to run the compiler. It's a bit fussier 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). Follow the same idea as the STM Cube IDE notes above. + +## Building Pinecil V2 diff --git a/Documentation/Flashing.md b/Documentation/Flashing.md index b5b50ba7f5..41376abcbf 100644 --- a/Documentation/Flashing.md +++ b/Documentation/Flashing.md @@ -90,6 +90,7 @@ Check the extension of your firmware, it should be `.RDY` now. - The MCU in V2 is Bouffalo BL706 and does *not* use usb-dfu for flashing as the previous MCU did. - The current firmware (2.18) is very fresh and no upgrade is available/needed. - When an update is released for V2, then IronOS will also include an update method to follow. +- Background on the [BL706 chipset](https://lupyuen.github.io/articles/bl706) # Pinecil V1 (Pine64) diff --git a/Documentation/GettingStarted.md b/Documentation/GettingStarted.md index 7e5ce05735..0dbcf43db9 100644 --- a/Documentation/GettingStarted.md +++ b/Documentation/GettingStarted.md @@ -16,27 +16,27 @@ By default this will show a screen similar to the one below: ![Home Screen](/Documentation/images/HomeScreen.png) -Note that this may be drawn mirrored depending on the orientation of your screen. +Note that this may be drawn mirrored depending on the orientation of your screen (detailed mode shows a different home screen). The soldering iron symbol on the screen will appear near the tip. This is here to indicate that pressing the button closest to the front of the iron will enter soldering mode. And naturally, the spanner like icon represents that pressing the button near the rear of the soldering iron will enter the settings menu. -In the settings, you can turn on an advanced idle screen instead. The buttons still function the same, however, the image will be swapped for a text telling you the current status of the iron with extra details. +In the settings, you can turn on a detailed idle screen instead. The buttons still function the same, however, the image will be swapped for a text telling you the current status of the iron with extra details. -Depending on how your device is being powered, at one end of the screen, the firmware will either draw text to show you the current-voltage your unit is being provided with, a battery icon (if battery mode is enabled) or a power plug icon. +Depending on how your device is being powered, at right side of the screen, the firmware will either show the voltage your unit is being provided with, a battery icon (if battery mode is enabled) or a power plug icon. -If you see exclamation marks (!!!) where the soldering iron should be, this indicates that the firmware can't see the tip connected. This could indicate a problem with the iron or tip if there is one inserted. First, try removing and reinstalling the tip. If the issue persists please see the [hardware issues section](/Documentation/HardwareIssues.md). +If you see an (**X**) where the soldering iron should be, this indicates that the firmware can't see the tip connected. This could indicate a problem with the iron or tip. First, try removing the tip screw and tip and gently reinstalling both; ensure that the tip is seated all the way back. If the issue persists please see the [hardware issues section](/Documentation/HardwareIssues.md). -This screen features a burn-in protection feature, where if no buttons or movement have been detected for a while it will automatically blank the screen to try and reduce burn-in if the iron is left unattended. Any movement or button press will wake the screen. +This OLED screen features burn-in protection; if no buttons or movement have been detected for a while it will automatically blank the screen to reduce burn-in when the iron is left unattended. Any movement or button press will wake the screen. ### Hidden Extras Additionally to the two icons shown, there are two "hidden" actions that can be performed on this menu. -If you press and hold on to the button near the tip of the soldering iron, this will bring up the temperature adjustment screen. Normally this is not required; but if you would like to adjust the set temperature _before_ the tip starts to heat, this can be useful. +If you press and hold the button near the tip (`+/A`), this enters the temperature adjustment screen. Normally this is not required; but if you would like to adjust the set temperature _before_ the tip starts to heat, this can be useful. -If you press and hold the button near the rear of the iron it will take you into the [debug menu](/Documentation/DebugMenu.md). +If you press and hold the button near the rear of the iron (`-/B`), it will take you into the [debug menu](/Documentation/DebugMenu.md). ## Soldering Mode @@ -58,8 +58,8 @@ In Sleep mode, the temperature of the iron automatically lowers to 150 °C (defa Simply picking up or moving the iron will wake it back up into soldering mode. You can also press any button and this will also wake the iron up. -Optional Hall Effect Feature (Pinecil only): -Pinecil has an unpopulated footprint (U14) for a hall effect sensor (Si7210). Adding the sensor and placing a strong magnet on the holder stand will trigger Pinecil to sleep after it enters the stand, and Zzzz will appear on the screen. The magnet is positioned on the stand in proximity to the sensor which then activates one of 10 user defined settings (0=off, 1=lowest sensitivity, 9=highest sensitivity). Read the Hall Sensor document for details on [installation](/Documentation/HallSensor.md). +#### Optional Hall Effect Feature (Pinecil only): +Pinecil has an unpopulated footprint (U14) for a hall effect sensor (Si7210-B-00-IV). Adding the sensor and placing a neodymium magnet on the holder stand will trigger Pinecil to sleep after it enters the stand, and Zzzz will appear on-screen. The magnet is positioned on the stand in proximity to the sensor/handle which then activates one of 10 user defined settings (0=off, 1=lowest sensitivity, 9=highest sensitivity). Read the Hall Sensor document for [details on installation](/Documentation/HallSensor.md). ### Idle Shutdown @@ -69,7 +69,7 @@ If, after entering sleep mode, the iron still does not see movement for a much l ## Settings Menu -The settings menu is the most often evolving aspect of the firmware, so each option is not documented here. However, do not panic, as every menu option has an on-screen description so you don't _need_ to come back here to figure them all out. +The settings menu is the most evolving aspect of the firmware, so each option is not documented here. However, do not panic, as every menu option has an on-screen description so you don't _need_ to come back here to figure them all out. To navigate the menu, the two buttons act separately. The rear button (`-/B`) is pressed to enter the menu and scrolls down the main options, and the other front button (`+/A`) will enter and change the current option. @@ -84,4 +84,6 @@ There is a small scrollbar that appears along the right edge of the screen to in Additionally, this scrollbar will blink rapidly when you are on the last value in a range of a sub-menu. For example, if you are in Motion Sensitivity, which has a range of 0 - 9, it will blink when you are at 9. -I highly recommend taking a few minutes to go through all of the options in the menu to get a feel for what you can change, almost every aspect of the internal system is adjustable to suit your needs. If you want to start over, simply go to Advanced settings > Restore factory settings, confirm using the front (`+/A`) button. This sets all menu items to defaults, and keeps the same version firmware. +I highly recommend taking a few minutes to go through all of the options in the menu to get a feel for what you can change, almost every aspect of the internal system is adjustable to suit your needs. + +If you want to start over, simply go to Advanced settings > Restore default settings, confirm using the front (`+/A`) button. This sets all menu items to defaults, and keeps the same version firmware. diff --git a/Documentation/HallSensor.md b/Documentation/HallSensor.md index 52e6391d36..e3e5133d14 100644 --- a/Documentation/HallSensor.md +++ b/Documentation/HallSensor.md @@ -8,15 +8,16 @@ Simply moving the iron or pressing any button will wake it back up into solderin ### Optional Hall Effect Feature (Pinecil only): -Inside the [Sleep Menu](https://github.com/Ralim/IronOS/blob/dev/Documentation/Settings.md#setting-sleep-temp) is an additional type of sleep setting. Pinecil has an unpopulated footprint (**U14**) for a hall effect sensor (**Si7210**). After installing the hall sensor, it is possible to auto-trigger Pinecil to enter sleep mode when it enters the stand, and *Zzzz* will appear (or text in detailed mode). This could be a fun enhancement for any Pinecil and adds a feature typically only found in more expensive high-end irons. The sensor is available at many electronic stores for ~$2-$6. +Inside the [Sleep Menu](https://github.com/Ralim/IronOS/blob/dev/Documentation/Settings.md#setting-sleep-temp) is an additional type of sleep setting. Pinecil has an unpopulated footprint (**U14**) for a hall effect sensor, Silicon Labs **Si7210-B-00-IV**. After installing the hall effect sensor (HES), it is possible to auto-trigger Pinecil to enter sleep mode when it enters the stand, and *Zzzz* will appear (or text in detailed mode). This could be a fun enhancement for any Pinecil and adds a feature typically only found in more expensive high-end irons. The HES is available at many electronic stores for ~$2-$6. -After installing the hall sensor, a magnet is positioned on the stand close enough to the sensor to activate one of ten user selectable settings. +After installing the HES on the PCB, place a magnet on the stand close enough to the sensor to activate one of ten user selectable settings. - 0=off, 1=1000, 2=750, 3=500, 4=250, 5=150, 6=100, 7=75, 8=50, 9=25 (9 has the highest sensitivity to magnets) - Setting of 1 might be used if you solder on PCBs with magnets and do not wish Pinecil to auto-sleep constantly. A very strong/large magnet would be required on the stand to activate the sleep mode if you use setting 1. - Setting of 9 would be useful if you only had a small magnet and are not concerned about Pinecil falsely triggering sleep mode near magnetized items/tools. - - Neodymium magnets are recommended. If using small magnets, 2-3 may be required, but too many can also be detrimental. - - Actively watch the hall number change ([see debug menu](/Documentation/DebugMenu.md)) while you slowly move the magnet around to seek the best locations & whether you have too many or too few magnets. Positioning the magnet(s) where you have the highest hall number will ensure consistent sleep mode when you place the iron in the stand. This requires some experimenting. + - Actively watch the _hall_ number change while you slowly move the magnet around to seek the best locations & whether you have too many or too few magnets. Position the magnet(s) where you have the highest hall number will ensure consistent sleep mode when you place the iron in the stand. This requires some experimenting. + - [See debug menu for how to display the _Hall_ number](/Documentation/DebugMenu.md) - Note that the sensor is physically located near the copper contacts for the tip at the front of the handle. [Reference Schematics U14](https://files.pine64.org/doc/Pinecil/Pinecil_schematic_v1.0a_20201120.pdf). - - Positioning/type/quantity of magnets is important for best results. Sometimes too many magnets breaks the effect by distorting the magnetic field [as seen in this demo video](https://www.youtube.com/shorts/afkqKwCX00I). The video shows magnets at the top of the stand, and the pinecil goes correctly into Zzzz with *only* those magnets. When more magnets are added at the side, the Pinecil did not go to sleep, which is contrary to the goal. See the PDF below for details on magnetic fields with SI7210. + - Neodymium magnets are recommended. If using small magnets, 2-3 may be required, but too many could also be detrimental. + - Positioning/type/quantity of magnets is important for best results. Sometimes too many magnets breaks the effect by distorting the magnetic field **[as seen in this demo video](https://www.youtube.com/shorts/afkqKwCX00I)**. The video shows magnets at the top of the stand, and the pinecil goes correctly into Zzzz with *only* those magnets. When more magnets are added at the side, the Pinecil did not go to sleep, which is contrary to the goal. See the PDF below for details on magnetic fields with SI7210-B. - Orientation of North and South faces of magnets is important to increase reaction of the hall sensor [see data sheet SI7210-B-00-IV](https://www.silabs.com/documents/public/application-notes/an1018-si72xx-sensors.pdf). - \ No newline at end of file + diff --git a/Documentation/HardwareIssues.md b/Documentation/HardwareIssues.md index 139093817a..423f9a0704 100644 --- a/Documentation/HardwareIssues.md +++ b/Documentation/HardwareIssues.md @@ -22,7 +22,18 @@ Generally, this means either something went very awry in the firmware, or the ch ## No tip detected -if your tip is not being detected, the most likely cause is that the heater element has been damaged from over-temperature, being dropped or bad luck. As the heater coil is part of the temperature measurement circuit neither will work if it's damaged. +If your tip is not being detected, the most likely cause is that the heater element inside the tip has been damaged from over-temperature, being dropped or bad luck. As the heater coil is part of the temperature measurement circuit neither will work if it's damaged. The best way to see if this is the case is to measure the resistance across the contacts to the tip using a multimeter. you are expecting to see measurements in the range of 4-10 ohms. Anything higher than 10 ohms is _generally_ an issue. + +## Iron will not heat up and displays a high temperature +Check the Rtip and CHan numbers ([see debug menu](/Documentation/DebugMenu.md)). Extremly high CHan is suspect to a problem with the cold junction compensation temperature sensor. + +For Pinecil V1, inspect near U10 which is the TMP36 sensor ([see issue here](https://github.com/Ralim/IronOS/issues/1234)). You may be able to reflow/resolder the TMP36 chip at U10 to correct a weak solder joint. + +If it worked on older firmware, but not on 2.16+, weak solder joints are suspect. The newer firmware runs the ADC a bit faster to keep tighter control of the tip temperature. Normally this wont cause an issue as the output from the TMP36 is powerful enough to keep up without any issue. But if you have a weak or cold solder joint this could cause issues. + +If the CHan is extremely high, and reflowing the temperature sensor does not resolve the issue; inspect the pins in the main MCU, possibly try giving them a light squeeze to the board while watching CHan. + +If you have a different device, follow the same logic and locate the temperature sensor on your device. diff --git a/Documentation/Logo.md b/Documentation/Logo.md index f115288569..097816d77b 100644 --- a/Documentation/Logo.md +++ b/Documentation/Logo.md @@ -43,9 +43,9 @@ You perform this the same way as if you were flashing a new firmware, and all th If you have flashed the `IronOS-dfu` alternative bootloader, you should use the `.dfu` files instead -### Pinecil +### Pinecil V1 -For Pinecil, we require using dfu-util to flash the logo art (Pinecil does not use hex). +For Pinecil V1, we require using dfu-util to flash the logo art (Pinecil does not use hex). [Pine64 Updater](https://github.com/pine64/pine64_updater/releases) is the easiest way to load the Bootup logo onto Pinecil as it already includes the necessary DFU library. Connect Pinecil to a PC, and open the Updater the same as updating firmware. Select Custom > Browse to the DFU image file you just made > Update to install. diff --git a/Documentation/Menu.md b/Documentation/Menu.md index d1d6ba6709..da56b56175 100644 --- a/Documentation/Menu.md +++ b/Documentation/Menu.md @@ -37,14 +37,17 @@ To calibrate your iron: 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 -### Calibrating tip offset (Set tip model) -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: +### Calibrate Tip CJC +This performs a Tip Cold Junction Calibration (CJC) ([see Temperature for details](/Documentation/Temperature.md)). This is normally not needed unless you have an issue with tip temperature or your tips are wearing out prematurely. Changing tip lengths does not necessarily mean a calibration is needed. Check first that your tips are not defective, and measured resistance is close to specifications (Pinecil/TS100 short tips 6.2 Ω, long tips 8 Ω, TS80(P) ~4.5 Ω). -1. Connect power to your iron +What this is for: 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. + +Caution: if the method below is not followed, the iron could be worse than before calibration. If you need to repeat the method, first unplug and let the handle/PCB cool down to room temperature. + +1. Connect power to your iron (tip should be installed). 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!* +4. Important warning message is shown: *Confirm the tip & device are at room temperature before starting!* 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. diff --git a/Documentation/Power.md b/Documentation/Power.md index 28c1f973ca..c6b577027e 100644 --- a/Documentation/Power.md +++ b/Documentation/Power.md @@ -1,24 +1,46 @@ # Power & Performance -All of the irons are PWM controlled resistive heating elements. +All of the irons are [PWM controlled](https://www.digikey.com/en/blog/pulse-width-modulation#) 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 provided in the tip is 100% controlled by the supply voltage used. +This *means* that the power provided in the tip is 100% controlled by the supply voltage used (higher voltage PSU = higher performance). -Both irons at their simplest are just a resistor connected to your power source via a switch. +Irons at their simplest are just a resistor (Ω) connected to your power source via a switch. -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)`. +- When the switch is on, the power in the resistor is: $P(watts) = V(volts) \times\ I(current=amps)$ +- Current through the resistor is: $I(amps) = V(volts) ÷ Ω (resistance)$ +- Combining these gives some common equations for Power + + $P(watts) = V(volts) * I(amps)$ or $P = V^2 ÷ Ω$ + +The resistance of the tip is a fixed constant in ohms (Ω): +- 6.2 Ω Pine64 short tip +- 8.0 Ω TS100/Pinecil long tip +- 4.5 Ω TS80(P) + +This means the power delivered to the soldering tip is proportional to the voltage squared. +Therefore the Pinecil and TS100 perform poorly when run off 12V power supplies and may issue a `Thermal Runaway` message (weak power supply). + +#### Use an [Ohm calculator](https://www.rapidtables.com/calc/electric/power-calculator.html#dc) to quickly derive watts. + +| Type | Volts| / | Tip Ω | = | Amps | * | Volts | = | Watts | +| :--------: | :--: |:-:| :---: |:-:|:-----:|:-:| :---: |:-:|:-----:| +| USB QC3.0 | 9V | / | 4.5 Ω | = | 2.0A | * | 9V | = | 18W | +| USB-C PD | 12V | / | 4.5 Ω | = | 3.0A | * | 12V | = | 32W | +| USB-C PD | 20V | / | 8.0 Ω | = | 2.5A | * | 20V | = | 50W | +| USB-C PD | 20V | / | 6.2 Ω | = | 3.2A | * | 20V | = | 64W | +| DC Barrel | 24V | / | 8.0 Ω | = | 3.0A | * | 24V | = | 72W | +| DC Barrel | 24V | / | 6.2 Ω | = | 3.8A | * | 24V | = | 92W | +| EPR PD3.1 | 28V | / | 8.0 Ω | = | 3.5A | * | 28V | = | 98W | +| EPR PD3.1 | 28V | / | 6.2 Ω | = | 4.5A | * | 28V | = | 126W | -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. -Therefore the TS100 performs poorly when run off 12 V power supplies. ## Output Control & Regulation -Both soldering irons use a FET to switch the power to the soldering iron tip. This is a P-MOSFET and its controlled via a small transistor circuit, which in turn is controlled via the STM32. The STM32 controls this PWM output proportional to the output from the PID control loop running in the software. +These soldering irons use a FET to switch the power to the soldering iron tip. This is a P-MOSFET and its controlled via a small transistor circuit, which in turn is controlled via the MCU (i.e., STM32). The MCU controls this PWM output proportional to the output from the PID control loop running in the software. + +To measure the tip temperature in the iron, the iron has a small op-amp connected across the terminals at the cold end of the tip. This is setup to measure the voltage across the same terminals that are used to power the tip. In order to read the very small voltage generated by the [thermocouple cold junction](/Documentation/Temperature.md), the iron's output must be turned off for a moment. + +Once the output is turned off (via the FET), the system has a recovery time as the tip capacitance discharges and the op-amp exits saturation. After this delay period, the MCU's ADC (analog-to-digital converter) samples the output of the op-amp 8 times quickly and then sets a flag to turn the PWM output back on. +This enforces a small dead time in the output signal while this occurs, so there is a balance between sampling the temperature often to maintain a stable tip temperature control and sampling less often to increase the maximum power deliverable to the tip ([see Complexity of measurement](/Documentation/Temperature.md#complexity-of-measurement)). -To measure the tip temperature in the iron, the iron has a small op-amp connected across the terminals, this is setup to measure the voltage across the same terminals that are used the power the tip. In order to be able to read the small voltage generated by the thermocouple junction, the irons output must be turned off. -Once the output is turned off (via the FET), the system has a recovery time as the tip capacitance discharges and the op-amp exits saturation. After this delay period, the STM32 ADC samples the output of the op-amp 8 times quickly and then sets a flag to turn the PWM output back on. -This enforces a small dead time in the output signal while this occurs, so there is a balance between sampling the temperature often to maintain stable tip temperature control and sampling less often to increase the maximum power deliverable to the tip diff --git a/Documentation/Settings.md b/Documentation/Settings.md index 9faaf67514..d8ca65c9e0 100644 --- a/Documentation/Settings.md +++ b/Documentation/Settings.md @@ -43,7 +43,7 @@ When the device is powered by a battery, this adjusts the low voltage threshold On device help text: -Power source. Sets cutoff voltage. (DC 10V) (S 3.3V per cell, disable power limit) +Set cutoff voltage to prevent battery over-drain. (DC 10V) (S=3.3V per cell, disable PWR limit) ### Setting: Sleep temp @@ -59,7 +59,7 @@ How long of a period without movement / button-pressing is required before the d On device help text: -Interval before "sleep mode" kicks in (S=seconds | M=minutes) +Interval before "sleep mode" starts (s=seconds | m=minutes) ### Setting: Shutdown timeout @@ -67,7 +67,7 @@ How long of a period without movement / button-pressing is required before the d On device help text: -Interval before the iron shuts down (M=minutes) +Interval before the iron shuts down (m=minutes) ### Setting: Motion sensitivity @@ -91,7 +91,7 @@ Should the device show an 'advanced' view on the idle screen. The advanced view On device help text: -Display detailed information in a smaller font on the idle screen +Display detailed info in a smaller font on idle screen ### Setting: Display orientation @@ -107,7 +107,7 @@ When the unit is in soldering mode. You can hold down the button at the front of On device help text: -Temperature used in "boost mode" +Tip temperature used in "boost mode" ### Setting: Start-up behavior @@ -115,7 +115,7 @@ When the device powers up, should it enter into a special mode. These settings s On device help text: -O=off | S=soldering temp | Z=standby at sleep temp until moved | R=standby without heating until moved +O=off | S=heat to soldering temp | Z=standby at sleep temp until moved | R=standby, heat-off until moved ### Setting: Cooldown flashing @@ -123,25 +123,25 @@ If the idle screen should blink the tip temperature for attention while the tip On device help text: -Flash the temperature reading after heating was halted while the tip is still hot +Flash temperature reading at idle if tip is hot -### Setting: Calibrate temperature? +### Setting: Calibrate tip CJC Used to calibrate the ADC+Op-amp offsets for the tip. This calibration must be performed when the tip temperature and the handle temperature are equal. Generally not required unless your device is reading more than 5°C off target. On device help text: -Start tip temperature offset calibration +Tip-temperature Cold Junction Compensation (not needed if Tip is +/- 5 C of display) -### Setting: Restore factory settings? +### Setting: Restore default settings Resets all settings and calibrations to factory defaults. Does NOT erase custom user boot up logo's. On device help text: -Reset all settings to default +Reset default settings for this firmware ver. -### Setting: Calibrate input voltage? +### Setting: Calibrate input voltage Enters an adjustment mode where you can gradually adjust the measured voltage to compensate for any unit-to-unit variance in the voltage sense resistors. @@ -155,7 +155,7 @@ Should the device show an 'advanced' soldering view. This is a text-based view t On device help text: -Display detailed information in a smaller font on soldering screen +Display detailed info in a smaller font on soldering screen ### Setting: Scrolling speed @@ -227,7 +227,7 @@ If the unit has a hall effect sensor (Pinecil), this adjusts how sensitive it is On device help text: -Sensitivity of the Hall effect sensor to detect sleep (O=off | L=low | M=medium | H=high) +Sensitivity to magnets (0=off | 1=least sensitive | ... | 9=most sensitive) ### Setting: Allow locking buttons @@ -243,7 +243,7 @@ When powered by a battery, this adjusts the minimum voltage per cell before shut On device help text: -Minimum allowed voltage per cell (3S: 3 - 3.7V | 4-6S: 2.4 - 3.7V) +Minimum allowed voltage per battery cell (3S: 3 - 3.7V | 4-6S: 2.4 - 3.7V) ### Setting: Anim. loop @@ -291,7 +291,7 @@ Display brightness. Higher values age the OLED faster due to burn-in. (However, On device help text: -Adjust the brightness of the OLED screen +Adjust the OLED screen brightness ### Setting: Invert screen @@ -299,16 +299,12 @@ Inverts the entire OLED. On device help text: -Invert the colours of the OLED screen +Invert the OLED screen colors ### Setting: Boot logo duration -Sets the duration of the boot logo from 1 second to 4 seconds. -- For static images this sets the time the logo is displayed for. -- For animations this sets the time the last frame is displayed for after the animation has been played. - -The infinity icon sets a logo or the last frame of an animation to be displayed until a button is pressed. +Sets the duration for the boot logo (S=seconds). On device help text: -Sets the duration for the boot logo (S=seconds) +Set Boot logo duration (off, s=seconds, infinity) diff --git a/Documentation/Troubleshooting.md b/Documentation/Troubleshooting.md index 5c708a4fa5..4b4d56cfa1 100644 --- a/Documentation/Troubleshooting.md +++ b/Documentation/Troubleshooting.md @@ -45,12 +45,14 @@ If `CHan` is reading low: - Check the connection from the MCU to the handle temperature sensor. - Check the power pin connection on the TMP36 - Check pullup resistor on the NTC thermistor -- Check no bridged pins or weak shorts on the signal to nearby pins on MCU or temp sensor +- Check no bridged pins or weak shorts on the signal to nearby pins on MCU or temperature sensor +- Reflow/resolder the the aforementioned components If `CHan` is reading higher - Check ground connections on the sensors -- Check no bridged pins or weak shorts on the signal to nearby pins on MCU or temp sensor +- Check no bridged pins or weak shorts on the signal to nearby pins on MCU or temperature sensor +- Reflow/resolder the the aforementioned components ## No display OR dots on the display @@ -67,7 +69,7 @@ As the OLED runs on an I2C bus, there are pull up resistors on the SDA and SCL p ## Tip heats when not in heating mode -** DISCONNECT YOUR TIP ** +⚠️ DISCONNECT YOUR TIP ⚠️ Most likely you have either a blown MOSFET or shorted pin. Check the MOSFET and also its driver transistor. @@ -75,4 +77,4 @@ The firmware will not enable the tip until you are in soldering mode. ## Accelerometer not detected -This could be that your Iron has a new accelerometer that is not supported yet (happens every year or so) OR there is a soldering issue with the accelerometer +Your Iron may have a new accelerometer that is not supported yet (happens every year or so) OR there is a soldering issue with the accelerometer (reflow/resolder). diff --git a/README.md b/README.md index 2b7beeb166..144dd88eff 100644 --- a/README.md +++ b/README.md @@ -22,15 +22,15 @@ _This firmware does **NOT** support the USB port while running for changing sett | Device | DC | QC | PD | EPR | BLE | Battery | Recommended | -|-----------:|:--:|:--:|:--:|:---:|:---:|:-------:|:-----------:| +|:----------:|:--:|:--:|:--:|:---:|:---:|:-------:|:-----------:| | MHP30 |❌ | ❌ | ✔️ | ❌ | ❌ | ❌ | ✔️ | | Pinecil V1 |✔️ | ✔️ | ✔️ | ❌ | ❌ | ✔️ | ✔️ | | Pinecil V2 |✔️ | ✔️ | ✔️ | ✔️ | ✔️ | ✔️ | ✔️ | +| TS80P |❌ | ✔️ | ✔️ | ❌ | ❌ | ✔️ | ✔️ | | 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_. +\*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 diff --git a/Translations/make_translation.py b/Translations/make_translation.py index dbb224dd8d..56df70a81b 100755 --- a/Translations/make_translation.py +++ b/Translations/make_translation.py @@ -844,7 +844,10 @@ def write_languages( symbol_conversion_table, ) font_table_text += f"}}; // font_table_data_{font}\n" - current_sym_start = combined_sym_list.index(current_sym_list[0]) + 2 + if len(current_sym_list) == 0: + current_sym_start = 0 + else: + current_sym_start = combined_sym_list.index(current_sym_list[0]) + 2 font_section_info_text += ( " {\n" f" .symbol_start = {current_sym_start},\n" diff --git a/Translations/translation_EN.json b/Translations/translation_EN.json index 6da8b9f877..10f4a9dab2 100644 --- a/Translations/translation_EN.json +++ b/Translations/translation_EN.json @@ -1,340 +1,340 @@ -{ - "languageCode": "EN", - "languageLocalName": "English", - "fonts": [ - "ascii_basic", - "latin_extended" - ], - "tempUnitFahrenheit": true, - "messages": { - "SettingsCalibrationWarning": "Please make absolutely sure the tip and handle are at room temperature before proceeding!", - "SettingsResetWarning": "Are you sure you want to restore default settings?", - "UVLOWarningString": "DC LOW", - "UndervoltageString": "Undervoltage", - "InputVoltageString": "Input V: ", - "SleepingSimpleString": "Zzzz", - "SleepingAdvancedString": "Sleeping...", - "SleepingTipAdvancedString": "Tip:", - "OffString": "Off", - "DeviceFailedValidationWarning": "Your device is most likely a counterfeit!" - }, - "messagesWarn": { - "ResetOKMessage": "Reset OK", - "SettingsResetMessage": [ - "Certain settings", - "were changed!" - ], - "NoAccelerometerMessage": [ - "No accelerometer", - "detected!" - ], - "NoPowerDeliveryMessage": [ - "No USB-PD IC", - "detected!" - ], - "LockingKeysString": "LOCKED", - "UnlockingKeysString": "UNLOCKED", - "WarningKeysLockedString": "!LOCKED!", - "WarningThermalRunaway": [ - "Thermal", - "Runaway" - ] - }, - "characters": { - "SettingRightChar": "R", - "SettingLeftChar": "L", - "SettingAutoChar": "A", - "SettingOffChar": "O", - "SettingSlowChar": "S", - "SettingMediumChar": "M", - "SettingFastChar": "F", - "SettingStartNoneChar": "O", - "SettingStartSolderingChar": "S", - "SettingStartSleepChar": "Z", - "SettingStartSleepOffChar": "R", - "SettingSensitivityOff": "O", - "SettingSensitivityLow": "L", - "SettingSensitivityMedium": "M", - "SettingSensitivityHigh": "H", - "SettingLockDisableChar": "D", - "SettingLockBoostChar": "B", - "SettingLockFullChar": "F" - }, - "menuGroups": { - "PowerMenu": { - "text2": [ - "Power", - "settings" - ], - "desc": "Power settings" - }, - "SolderingMenu": { - "text2": [ - "Soldering", - "settings" - ], - "desc": "Soldering settings" - }, - "PowerSavingMenu": { - "text2": [ - "Sleep", - "mode" - ], - "desc": "Power saving settings" - }, - "UIMenu": { - "text2": [ - "User", - "interface" - ], - "desc": "User interface settings" - }, - "AdvancedMenu": { - "text2": [ - "Advanced", - "settings" - ], - "desc": "Advanced settings" - } - }, - "menuOptions": { - "DCInCutoff": { - "text2": [ - "Power", - "source" - ], - "desc": "Power source. Sets cutoff voltage. (DC 10V) (S 3.3V per cell, disable power limit)" - }, - "SleepTemperature": { - "text2": [ - "Sleep", - "temp" - ], - "desc": "Tip temperature while in \"sleep mode\"" - }, - "SleepTimeout": { - "text2": [ - "Sleep", - "timeout" - ], - "desc": "Interval before \"sleep mode\" kicks in (s=seconds | m=minutes)" - }, - "ShutdownTimeout": { - "text2": [ - "Shutdown", - "timeout" - ], - "desc": "Interval before the iron shuts down (m=minutes)" - }, - "MotionSensitivity": { - "text2": [ - "Motion", - "sensitivity" - ], - "desc": "0=off | 1=least sensitive | ... | 9=most sensitive" - }, - "TemperatureUnit": { - "text2": [ - "Temperature", - "unit" - ], - "desc": "C=°Celsius | F=°Fahrenheit" - }, - "AdvancedIdle": { - "text2": [ - "Detailed", - "idle screen" - ], - "desc": "Display detailed information in a smaller font on the idle screen" - }, - "DisplayRotation": { - "text2": [ - "Display", - "orientation" - ], - "desc": "R=right-handed | L=left-handed | A=automatic" - }, - "BoostTemperature": { - "text2": [ - "Boost", - "temp" - ], - "desc": "Tip temperature used in \"boost mode\"" - }, - "AutoStart": { - "text2": [ - "Start-up", - "behavior" - ], - "desc": "O=off | S=heat up to soldering temp | Z=standby at sleep temp until moved | R=standby without heating until moved" - }, - "CooldownBlink": { - "text2": [ - "Cooldown", - "flashing" - ], - "desc": "Flash the temperature reading after heating was halted while the tip is still hot" - }, - "TemperatureCalibration": { - "text2": [ - "Calibrate", - "temperature" - ], - "desc": "Calibrate tip Cold Junction Compensation (not required if Delta T is < 5°C)" - }, - "SettingsReset": { - "text2": [ - "Restore factory", - "settings" - ], - "desc": "Reset all settings to default" - }, - "VoltageCalibration": { - "text2": [ - "Calibrate", - "input voltage" - ], - "desc": "Start VIN calibration (long press to exit)" - }, - "AdvancedSoldering": { - "text2": [ - "Detailed", - "solder screen" - ], - "desc": "Display detailed information in a smaller font on soldering screen" - }, - "ScrollingSpeed": { - "text2": [ - "Scrolling", - "speed" - ], - "desc": "Speed info text scrolls past at (S=slow | F=fast)" - }, - "QCMaxVoltage": { - "text2": [ - "QC", - "voltage" - ], - "desc": "Max QC voltage the iron should negotiate for" - }, - "PDNegTimeout": { - "text2": [ - "PD", - "timeout" - ], - "desc": "PD negotiation timeout in 100ms steps for compatibility with some QC chargers" - }, - "PowerLimit": { - "text2": [ - "Power", - "limit" - ], - "desc": "Maximum power the iron can use (W=watt)" - }, - "ReverseButtonTempChange": { - "text2": [ - "Swap", - "+ - keys" - ], - "desc": "Reverse assignment of buttons for temperature adjustment" - }, - "TempChangeShortStep": { - "text2": [ - "Temp change", - "short" - ], - "desc": "Temperature-change-increment on short button press" - }, - "TempChangeLongStep": { - "text2": [ - "Temp change", - "long" - ], - "desc": "Temperature-change-increment on long button press" - }, - "PowerPulsePower": { - "text2": [ - "Power", - "pulse" - ], - "desc": "Intensity of power of keep-awake-pulse (watt)" - }, - "HallEffSensitivity": { - "text2": [ - "Hall sensor", - "sensitivity" - ], - "desc": "Sensitivity of the Hall effect sensor to trigger sleep mode (0=off | 1=least sensitive | ... | 9=most sensitive)" - }, - "LockingMode": { - "text2": [ - "Allow locking", - "buttons" - ], - "desc": "While soldering, hold down both buttons to toggle locking them (D=disable | B=boost mode only | F=full locking)" - }, - "MinVolCell": { - "text2": [ - "Minimum", - "voltage" - ], - "desc": "Minimum allowed voltage per cell (3S: 3 - 3.7V | 4-6S: 2.4 - 3.7V)" - }, - "AnimLoop": { - "text2": [ - "Anim.", - "loop" - ], - "desc": "Loop icon animations in main menu" - }, - "AnimSpeed": { - "text2": [ - "Anim.", - "speed" - ], - "desc": "Pace of icon animations in menu (O=off | S=slow | M=medium | F=fast)" - }, - "PowerPulseWait": { - "text2": [ - "Power pulse", - "delay" - ], - "desc": "Delay before keep-awake-pulse is triggered (x 2.5s)" - }, - "PowerPulseDuration": { - "text2": [ - "Power pulse", - "duration" - ], - "desc": "Keep-awake-pulse duration (x 250ms)" - }, - "LanguageSwitch": { - "text2": [ - "Language:", - " EN English" - ], - "desc": "Current firmware language" - }, - "Brightness": { - "text2": [ - "Screen", - "brightness" - ], - "desc": "Adjust the brightness of the OLED screen" - }, - "ColourInversion": { - "text2": [ - "Invert", - "screen" - ], - "desc": "Invert the colours of the OLED screen" - }, - "LOGOTime": { - "text2": [ - "Boot logo", - "duration" - ], - "desc": "Sets the duration for the boot logo (s=seconds)" - } - } -} +{ + "languageCode": "EN", + "languageLocalName": "English", + "fonts": [ + "ascii_basic", + "latin_extended" + ], + "tempUnitFahrenheit": true, + "messages": { + "SettingsCalibrationWarning": "Confirm the tip & device are at room temperature before starting!", + "SettingsResetWarning": "Are you sure you want to restore default settings?", + "UVLOWarningString": "DC LOW", + "UndervoltageString": "Undervoltage", + "InputVoltageString": "Input V: ", + "SleepingSimpleString": "Zzzz", + "SleepingAdvancedString": "Sleeping...", + "SleepingTipAdvancedString": "Tip:", + "OffString": "Off", + "DeviceFailedValidationWarning": "Your device is likely a Counterfeit!" + }, + "messagesWarn": { + "ResetOKMessage": "Reset OK", + "SettingsResetMessage": [ + "Certain settings", + "were changed!" + ], + "NoAccelerometerMessage": [ + "No accelerometer", + "detected!" + ], + "NoPowerDeliveryMessage": [ + "No USB-PD IC", + "detected!" + ], + "LockingKeysString": "LOCKED", + "UnlockingKeysString": "UNLOCKED", + "WarningKeysLockedString": "!LOCKED!", + "WarningThermalRunaway": [ + "Thermal", + "Runaway" + ] + }, + "characters": { + "SettingRightChar": "R", + "SettingLeftChar": "L", + "SettingAutoChar": "A", + "SettingOffChar": "O", + "SettingSlowChar": "S", + "SettingMediumChar": "M", + "SettingFastChar": "F", + "SettingStartNoneChar": "O", + "SettingStartSolderingChar": "S", + "SettingStartSleepChar": "Z", + "SettingStartSleepOffChar": "R", + "SettingSensitivityOff": "O", + "SettingSensitivityLow": "L", + "SettingSensitivityMedium": "M", + "SettingSensitivityHigh": "H", + "SettingLockDisableChar": "D", + "SettingLockBoostChar": "B", + "SettingLockFullChar": "F" + }, + "menuGroups": { + "PowerMenu": { + "text2": [ + "Power", + "settings" + ], + "desc": "Power settings" + }, + "SolderingMenu": { + "text2": [ + "Soldering", + "settings" + ], + "desc": "Soldering settings" + }, + "PowerSavingMenu": { + "text2": [ + "Sleep", + "mode" + ], + "desc": "Power saving settings" + }, + "UIMenu": { + "text2": [ + "User", + "interface" + ], + "desc": "User interface settings" + }, + "AdvancedMenu": { + "text2": [ + "Advanced", + "settings" + ], + "desc": "Advanced settings" + } + }, + "menuOptions": { + "DCInCutoff": { + "text2": [ + "Power", + "source" + ], + "desc": "Set cutoff voltage to prevent battery over-drain. (DC 10V) (S=3.3V per cell, disable PWR limit)" + }, + "SleepTemperature": { + "text2": [ + "Sleep", + "temp" + ], + "desc": "Tip temperature while in \"sleep mode\"" + }, + "SleepTimeout": { + "text2": [ + "Sleep", + "timeout" + ], + "desc": "Interval before \"sleep mode\" starts (s=seconds | m=minutes)" + }, + "ShutdownTimeout": { + "text2": [ + "Shutdown", + "timeout" + ], + "desc": "Interval before the iron shuts down (m=minutes)" + }, + "MotionSensitivity": { + "text2": [ + "Motion", + "sensitivity" + ], + "desc": "0=off | 1=least sensitive | ... | 9=most sensitive" + }, + "TemperatureUnit": { + "text2": [ + "Temperature", + "unit" + ], + "desc": "C=Celsius | F=Fahrenheit" + }, + "AdvancedIdle": { + "text2": [ + "Detailed", + "idle screen" + ], + "desc": "Display detailed info in a smaller font on idle screen" + }, + "DisplayRotation": { + "text2": [ + "Display", + "orientation" + ], + "desc": "R=right-handed | L=left-handed | A=automatic" + }, + "BoostTemperature": { + "text2": [ + "Boost", + "temp" + ], + "desc": "Tip temperature used in \"boost mode\"" + }, + "AutoStart": { + "text2": [ + "Start-up", + "behavior" + ], + "desc": "O=off | S=heat to soldering temp | Z=standby at sleep temp until moved | R=standby, heat-off until moved" + }, + "CooldownBlink": { + "text2": [ + "Cooldown", + "flashing" + ], + "desc": "Flash temperature reading at idle if tip is hot" + }, + "TemperatureCalibration": { + "text2": [ + "Calibrate", + "tip CJC" + ], + "desc": "Tip-temperature Cold Junction Compensation (not needed if Tip is +/- 5 C of display)" + }, + "SettingsReset": { + "text2": [ + "Restore default", + "settings" + ], + "desc": "Reset default settings for this firmware ver." + }, + "VoltageCalibration": { + "text2": [ + "Calibrate", + "input voltage" + ], + "desc": "Start VIN calibration (long press to exit)" + }, + "AdvancedSoldering": { + "text2": [ + "Detailed", + "solder screen" + ], + "desc": "Display detailed info in a smaller font on soldering screen" + }, + "ScrollingSpeed": { + "text2": [ + "Scrolling", + "speed" + ], + "desc": "Speed info text scrolls past at (S=slow | F=fast)" + }, + "QCMaxVoltage": { + "text2": [ + "QC", + "voltage" + ], + "desc": "Max QC voltage the iron should negotiate for" + }, + "PDNegTimeout": { + "text2": [ + "PD", + "timeout" + ], + "desc": "PD negotiation timeout in 100ms steps for compatibility with some QC chargers" + }, + "PowerLimit": { + "text2": [ + "Power", + "limit" + ], + "desc": "Maximum power the iron can use (W=watt)" + }, + "ReverseButtonTempChange": { + "text2": [ + "Swap", + "+ - keys" + ], + "desc": "Reverse assignment of buttons for temperature adjustment" + }, + "TempChangeShortStep": { + "text2": [ + "Temp change", + "short" + ], + "desc": "Temperature-change-increment on short button press" + }, + "TempChangeLongStep": { + "text2": [ + "Temp change", + "long" + ], + "desc": "Temperature-change-increment on long button press" + }, + "PowerPulsePower": { + "text2": [ + "Power", + "pulse" + ], + "desc": "Intensity of power of keep-awake-pulse (watt)" + }, + "HallEffSensitivity": { + "text2": [ + "Hall sensor", + "sensitivity" + ], + "desc": "Sensitivity to magnets (0=off | 1=least sensitive | ... | 9=most sensitive)" + }, + "LockingMode": { + "text2": [ + "Allow locking", + "buttons" + ], + "desc": "While soldering, hold down both buttons to toggle locking them (D=disable | B=boost mode only | F=full locking)" + }, + "MinVolCell": { + "text2": [ + "Minimum", + "voltage" + ], + "desc": "Minimum allowed voltage per battery cell (3S: 3 - 3.7V | 4-6S: 2.4 - 3.7V)" + }, + "AnimLoop": { + "text2": [ + "Anim.", + "loop" + ], + "desc": "Loop icon animations in main menu" + }, + "AnimSpeed": { + "text2": [ + "Anim.", + "speed" + ], + "desc": "Pace of icon animations in menu (O=off | S=slow | M=medium | F=fast)" + }, + "PowerPulseWait": { + "text2": [ + "Power pulse", + "delay" + ], + "desc": "Delay before keep-awake-pulse is triggered (x 2.5s)" + }, + "PowerPulseDuration": { + "text2": [ + "Power pulse", + "duration" + ], + "desc": "Keep-awake-pulse duration (x 250ms)" + }, + "LanguageSwitch": { + "text2": [ + "Language:", + " EN English" + ], + "desc": "Current firmware language" + }, + "Brightness": { + "text2": [ + "Screen", + "brightness" + ], + "desc": "Adjust the OLED screen brightness" + }, + "ColourInversion": { + "text2": [ + "Invert", + "screen" + ], + "desc": "Invert the OLED screen colors" + }, + "LOGOTime": { + "text2": [ + "Boot logo", + "duration" + ], + "desc": "Set Boot logo duration (off, s=seconds, infinity)" + } + } +} \ No newline at end of file diff --git a/Translations/translations_def.js b/Translations/translations_def.js index b20f9f7967..132ee35ca4 100644 --- a/Translations/translations_def.js +++ b/Translations/translations_def.js @@ -365,7 +365,7 @@ var def = /// { "id": "HallEffSensitivity", "maxLen": 6, - "maxLen2": 8, + "maxLen2": 13, "description": "If the unit has a hall effect sensor (Pinecil), this adjusts how sensitive it is at detecting a magnet to put the device into sleep mode." }, @@ -430,4 +430,4 @@ var def = /// "description": "Sets the duration for the boot logo (S=seconds)." } ] - } \ No newline at end of file + }