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

Update definitions and regenerate output

Browse Source
This commit is contained in:
Ben V. Brown
2022-01-19 20:49:04 +11:00
parent 8479991b6c
commit 8c29347c26
2 changed files with 42 additions and 42 deletions
Download Patch File Download Diff File Expand all files Collapse all files

42
Documentation/Settings.md
View File

@@ -14,11 +14,11 @@ Menu for settings related to power. Main settings to do with the input voltage.
### Category: Soldering settings
Setttings for soldering mode, such as tip temperature, boost temps, sleep temps.
Settings for soldering mode, such as boost temps, the increment used when pressing buttons and if button locking is enabled.
### Category: Sleep mode
Settings to do with power saving, such as sleep mode and shutdown modes.
Settings to do with power saving, such as sleep mode,sleep temps, and shutdown modes.
### Category: User interface
@@ -26,7 +26,7 @@ User interface related settings, such as Units.
### Category: Advanced settings
Advanced settings. Misc catchall for settings that dont fit anywhere else or settings that require some thought before use.
Advanced settings. Misc catchall for settings that don't fit anywhere else or settings that require some thought before use.
## Settings
@@ -39,7 +39,7 @@ This is the "on device help text".
### Setting: Power source
When device is powered by a battery, adjusts the low voltage threshold for when the unit turns off the heater to protect the battery.
When device is powered by a battery,this adjusts the low voltage threshold for when the unit should turns off the heater to protect the battery.
On device help text:
@@ -55,7 +55,7 @@ Tip temperature while in "sleep mode"
### Setting: Sleep timeout
How long after inactivity the device drops down to the sleep temperature.
How long of a period of movement/button pressing inactivity is required before the device drops down to the sleep temperature.
On device help text:
@@ -63,7 +63,7 @@ Interval before "sleep mode" kicks in (S=seconds | M=minutes)
### Setting: Shutdown timeout
How long after the unit enters sleep mode before it turns off the heater and exists soldering mode.
How long of a period of movement/button pressing inactivity is required before the device turns of the tip heater completely and returns to the main idle screen.
On device help text:
@@ -119,7 +119,7 @@ O=off | S=soldering temp | Z=standby at sleep temp until moved | R=standby witho
### Setting: Cooldown blink
If the idle screen should blink the tip temperature for attention when the device tip is over 50C. Intended as a 'tip is hot' warning.
If the idle screen should blink the tip temperature for attention when the device tip is over 50C. Intended as a 'tip is still hot' warning.
On device help text:
@@ -135,7 +135,7 @@ Start tip temperature offset calibration
### Setting: Factory reset?
Resets all settings and calibrations to factory defaults. Does NOT erase custom user bootup logo's
Resets all settings and calibrations to factory defaults. Does NOT erase custom user bootup logo's.
On device help text:
@@ -143,7 +143,7 @@ Reset settings to default
### 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
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.
On device help text:
@@ -175,7 +175,7 @@ Max QC voltage the iron should negotiate for
### Setting: PD timeout
How long until firmware stops trying to negotiate for USB-PD and tries QC instead. Longer times may help dodgy/old PD adapters, faster times move onto PD quickly. Units of 100ms. Reccomended to keep small.
How long until firmware stops trying to negotiate for USB-PD and tries QC instead. Longer times may help dodgy/old PD adapters, faster times move onto PD quickly. Units of 100ms. Recommended to keep small.
On device help text:
@@ -183,7 +183,7 @@ PD negotiation timeout in 100ms steps for compatibility with some QC chargers
### Setting: Power limit
Allows setting a custom Wattage for the iron to aim to keep the AVERAGE power below. The Iron cant control its peak power no matter how you set this. (Except for MHP30 which will regulate nicely to this). If USB-PD is in use, the limit will be set to the lower of this and the supplies advertised wattage.
Allows setting a custom wattage for the iron to aim to keep the AVERAGE power below. The Iron cant control its peak power no matter how you set this. (Except for MHP30 which will regulate nicely to this). If USB-PD is in use, the limit will be set to the lower of this and the supplies advertised wattage.
On device help text:
@@ -191,7 +191,7 @@ Maximum power the iron can use (W=watt)
### Setting: Reverse + - keys
Swaps which button increments and decrements the temperature on temperature change screens.
Swaps which button increments and decrements on temperature change screens.
On device help text:
@@ -223,7 +223,7 @@ Intensity of power of keep-awake-pulse (watt)
### Setting: Hall sensor sensitivity
If unit has a hall effect (Pinecil), how sensitive it is at detecting a magnet to put the iron into sleep mode.
If the unit has a hall effect sensor (Pinecil), this adjusts how sensitive it is at detecting a magnet to put the iron into sleep mode.
On device help text:
@@ -231,7 +231,7 @@ Sensitivity of the Hall effect sensor to detect sleep (O=off | L=low | M=medium
### Setting: Allow locking buttons
If the locking mode for the buttons is enabled. Allows locking the buttons from accidental presses.
If locking the buttons against accidental presses is enabled.
On device help text:
@@ -239,7 +239,7 @@ While soldering, hold down both buttons to toggle locking them (D=disable | B=bo
### Setting: Minimum voltage
When powered by a battery, sets the minimum voltage per cell that is allowed. This is multiplied by the cell count.
When powered by a battery, this adjust sets the minimum voltage per cell before shutdown. (This is multiplied by the cell count.)
On device help text:
@@ -247,7 +247,7 @@ Minimum allowed voltage per cell (3S: 3 - 3.7V | 4-6S: 2.4 - 3.7V)
### Setting: Anim. loop
Should the menu animations loop.
Should the menu animations loop. Only visible if the animation speed is not turned turn to "Off"
On device help text:
@@ -255,7 +255,7 @@ Loop icon animations in main menu
### Setting: Anim. speed
How fast should the menu animations loop.
How fast should the menu animations loop, or if they should not loop at all.
On device help text:
@@ -263,7 +263,7 @@ Pace of icon animations in menu (O=off | S=slow | M=medium | F=fast)
### Setting: Power pulse delay
How long of a time interval between power pulses.
Adjusts the time interval between power pulses. Longer gaps reduce undesired heating of the tip, but needs to be fast enough to keep your power bank awake.
On device help text:
@@ -271,7 +271,7 @@ Delay before keep-awake-pulse is triggered (x 2.5s)
### Setting: Power pulse duration
How long should the power pulse go for.
How long should the power pulse go for. Some power banks require seeing the power draw be sustained for a certain duration to keep awake. Should be kept as short as possible to avoid wasting power / undesired heating of the tip.
On device help text:
@@ -279,7 +279,7 @@ Keep-awake-pulse duration (x 250ms)
### Setting: Language: EN English
Changes the device language on multi-lingual builds
Changes the device language on multi-lingual builds.
On device help text:
@@ -287,7 +287,7 @@ Current firmware language
### Setting: Screen contrast
Display brightness. Higher values age the OLED faster but are brighter.
Display brightness. Higher values age the OLED faster due to burn in. (However, it is notable that most of these screens die from other causes first.)
On device help text:

42
Translations/translations_def.js
View File

@@ -182,13 +182,13 @@ var def =
"id": "SolderingMenu",
"maxLen": 5,
"maxLen2": 11,
"description":"Setttings for soldering mode, such as tip temperature, boost temps, sleep temps."
"description":"Settings for soldering mode, such as boost temps, the increment used when pressing buttons and if button locking is enabled."
},
{
"id": "PowerSavingMenu",
"maxLen": 5,
"maxLen2": 11,
"description":"Settings to do with power saving, such as sleep mode and shutdown modes."
"description":"Settings to do with power saving, such as sleep mode,sleep temps, and shutdown modes."
},
{
"id": "UIMenu",
@@ -200,7 +200,7 @@ var def =
"id": "AdvancedMenu",
"maxLen": 5,
"maxLen2": 11,
"description":"Advanced settings. Misc catchall for settings that dont fit anywhere else or settings that require some thought before use."
"description":"Advanced settings. Misc catchall for settings that don't fit anywhere else or settings that require some thought before use."
}
],
"menuOptions": [
@@ -208,7 +208,7 @@ var def =
"id": "DCInCutoff",
"maxLen": 5,
"maxLen2": 11,
"description":"When device is powered by a battery, adjusts the low voltage threshold for when the unit turns off the heater to protect the battery."
"description":"When device is powered by a battery,this adjusts the low voltage threshold for when the unit should turns off the heater to protect the battery."
},
{
"id": "SleepTemperature",
@@ -220,13 +220,13 @@ var def =
"id": "SleepTimeout",
"maxLen": 4,
"maxLen2": 9,
"description":"How long after inactivity the device drops down to the sleep temperature."
"description":"How long of a period of movement/button pressing inactivity is required before the device drops down to the sleep temperature."
},
{
"id": "ShutdownTimeout",
"maxLen": 5,
"maxLen2": 11,
"description":"How long after the unit enters sleep mode before it turns off the heater and exists soldering mode."
"description":"How long of a period of movement/button pressing inactivity is required before the device turns of the tip heater completely and returns to the main idle screen."
},
{
"id": "MotionSensitivity",
@@ -268,7 +268,7 @@ var def =
"id": "CooldownBlink",
"maxLen": 6,
"maxLen2": 13,
"description":"If the idle screen should blink the tip temperature for attention when the device tip is over 50C. Intended as a 'tip is hot' warning."
"description":"If the idle screen should blink the tip temperature for attention when the device tip is over 50C. Intended as a 'tip is still hot' warning."
},
{
"id": "TemperatureCalibration",
@@ -280,13 +280,13 @@ var def =
"id": "SettingsReset",
"maxLen": 8,
"maxLen2": 16,
"description":"Resets all settings and calibrations to factory defaults. Does NOT erase custom user bootup logo's"
"description":"Resets all settings and calibrations to factory defaults. Does NOT erase custom user bootup logo's."
},
{
"id": "VoltageCalibration",
"maxLen": 8,
"maxLen2": 16,
"description":"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"
"description":"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."
},
{
"id": "AdvancedSoldering",
@@ -310,20 +310,20 @@ var def =
"id": "PDNegTimeout",
"maxLen": 8,
"maxLen2": 16,
"description":"How long until firmware stops trying to negotiate for USB-PD and tries QC instead. Longer times may help dodgy/old PD adapters, faster times move onto PD quickly. Units of 100ms. Reccomended to keep small."
"description":"How long until firmware stops trying to negotiate for USB-PD and tries QC instead. Longer times may help dodgy/old PD adapters, faster times move onto PD quickly. Units of 100ms. Recommended to keep small."
},
{
"id": "PowerLimit",
"maxLen": 5,
"maxLen2": 11,
"description":"Allows setting a custom Wattage for the iron to aim to keep the AVERAGE power below. The Iron cant control its peak power no matter how you set this. (Except for MHP30 which will regulate nicely to this). If USB-PD is in use, the limit will be set to the lower of this and the supplies advertised wattage."
"description":"Allows setting a custom wattage for the iron to aim to keep the AVERAGE power below. The Iron cant control its peak power no matter how you set this. (Except for MHP30 which will regulate nicely to this). If USB-PD is in use, the limit will be set to the lower of this and the supplies advertised wattage."
},
{
"id": "ReverseButtonTempChange",
"maxLen": 6,
"maxLen2": 16,
"description":"Swaps which button increments and decrements the temperature on temperature change screens."
"description":"Swaps which button increments and decrements on temperature change screens."
},
{
"id": "TempChangeShortStep",
@@ -347,55 +347,55 @@ var def =
"id": "HallEffSensitivity",
"maxLen": 6,
"maxLen2": 8,
"description":"If unit has a hall effect (Pinecil), how sensitive it is at detecting a magnet to put the iron into sleep mode."
"description":"If the unit has a hall effect sensor (Pinecil), this adjusts how sensitive it is at detecting a magnet to put the iron into sleep mode."
},
{
"id": "LockingMode",
"maxLen": 6,
"maxLen2": 13,
"description":"If the locking mode for the buttons is enabled. Allows locking the buttons from accidental presses."
"description":"If locking the buttons against accidental presses is enabled."
},
{
"id": "MinVolCell",
"maxLen": 4,
"maxLen2": 9,
"description":"When powered by a battery, sets the minimum voltage per cell that is allowed. This is multiplied by the cell count."
"description":"When powered by a battery, this adjust sets the minimum voltage per cell before shutdown. (This is multiplied by the cell count.)"
},
{
"id": "AnimLoop",
"maxLen": 6,
"maxLen2": 13,
"description":"Should the menu animations loop."
"description":"Should the menu animations loop. Only visible if the animation speed is not turned turn to \"Off\""
},
{
"id": "AnimSpeed",
"maxLen": 6,
"maxLen2": 13,
"description":"How fast should the menu animations loop."
"description":"How fast should the menu animations loop, or if they should not loop at all."
},
{
"id": "PowerPulseWait",
"maxLen": 6,
"maxLen2": 13,
"description":"How long of a time interval between power pulses."
"description":"Adjusts the time interval between power pulses. Longer gaps reduce undesired heating of the tip, but needs to be fast enough to keep your power bank awake."
},
{
"id": "PowerPulseDuration",
"maxLen": 6,
"maxLen2": 13,
"description":"How long should the power pulse go for."
"description":"How long should the power pulse go for. Some power banks require seeing the power draw be sustained for a certain duration to keep awake. Should be kept as short as possible to avoid wasting power / undesired heating of the tip."
},
{
"id": "LanguageSwitch",
"maxLen": 7,
"maxLen2": 15,
"description":"Changes the device language on multi-lingual builds"
"description":"Changes the device language on multi-lingual builds."
},
{
"id": "Brightness",
"maxLen": 7,
"maxLen2": 15,
"description":"Display brightness. Higher values age the OLED faster but are brighter."
"description":"Display brightness. Higher values age the OLED faster due to burn in. (However, it is notable that most of these screens die from other causes first.)"
},
{
"id": "ColourInversion",