From ee5216ce3b52a7a1744f438cca640be78c5ffcf9 Mon Sep 17 00:00:00 2001 From: "Ben V. Brown" Date: Tue, 18 Jan 2022 20:33:57 +1100 Subject: [PATCH 01/40] Update translation editor to show descriptions and add said descriptions to settings Working on #1092 --- Translations/TranslationEditor.html | 1026 ++++++++++++++++----------- Translations/translations_def.js | 129 ++-- 2 files changed, 679 insertions(+), 476 deletions(-) diff --git a/Translations/TranslationEditor.html b/Translations/TranslationEditor.html index 2b57d344..2fb41065 100644 --- a/Translations/TranslationEditor.html +++ b/Translations/TranslationEditor.html @@ -1,440 +1,640 @@ + + + IronOS Translation Editor + + + + - - - - - - + constraintWholeScreenMessage: function (valMap, id, prop) { + return ( + "len <= " + this.getWholeScreenMessageMaxLen(valMap, id, prop) + ); + }, -
-

IronOS Translation Editor - {{ current.languageLocalName }} [{{current.languageCode}}]

- - - - - - - - - - - - - - - - - - - - - -
Referent Language - - {{ referent.languageLocalName }} [{{referent.languageCode}}] -
Current Language - - {{ current.languageLocalName }} [{{current.languageCode}}] -
Local Language Code
Local Language Name
Font tables to use
("ascii_basic" must be first)		 -
    -
  • - {{ font }} -
    • -
- - -
- -
+ isSmall: function (v) { + return v instanceof Array; + }, -
- - -
- -
-

Obsolete

- - - - - -
{{entry.id}}
{{entry.value}}
-
+ convertToLarge: function (valMap, id, prop) { + var v = prop ? valMap[id][prop] : valMap[id]; + var message = v[0] + (v[1] !== "" ? " " + v[1] : ""); + if (prop) { + valMap[id][prop] = message; + } else { + valMap[id] = message; + } + }, -

Messages and Strings

- - - - - -
{{message.id}}
 -
{{constraintString(message)}}
-
{{referent.messages[message.id]}}
-
{{message.note}}
-
-
+ convertToSmall: function (valMap, id, prop) { + var v = prop ? valMap[id][prop] : valMap[id]; + var message = [v, ""]; + if (prop) { + valMap[id][prop] = message; + } else { + valMap[id] = message; + } + }, -

Warning Messages

- - - - - -
{{message.id}}
 -
{{constraintWholeScreenMessage(current.messagesWarn, message.id)}}
-
{{referent.messagesWarn[message.id]}}
-
{{message.note}}
-
- - - -
-
- - -
-
+ removeFont: function (i) { + this.current.fonts.splice(i, 1); + }, -

Characters

- - - - - -
{{char.id}}
 -
{{constraintString(char)}}
-
{{referent.characters[char.id]}}
-
-
+ addFont: function () { + this.current.fonts.push(this.fontToAdd); + }, + }, + }); + app.def = def; + copyArrayToMap(app.def.messages, defMap); + copyArrayToMap(app.def.messagesWarn, defMap); + copyArrayToMap(app.def.characters, defMap); + copyArrayToMap(app.def.menuGroups, defMap); + copyArrayToMap(app.def.menuOptions, defMap); + } -

Menu Groups

- - - - - -
{{menu.id}}
 -
Menu Name
-
{{constraintWholeScreenMessage(current.menuGroups, menu.id, 'text2')}}
-
{{referent.menuGroups[menu.id].text2}}
-
- - - -
-
- - -
-
Description
-
{{referent.menuGroups[menu.id].desc}}
-
-
+ window.onload = loaded; + -

Menu Options

- - - - - -
{{menu.id}}
 -
-
Menu Name
-
{{constraintWholeScreenMessage(current.menuOptions, menu.id, 'text2')}}
-
{{referent.menuOptions[menu.id].text2}}
-
- - - -
-
- - -
-
-
Description
-
{{referent.menuOptions[menu.id].desc}}
-
-
+ + -
- - -
-
-
- + +
+

+ IronOS Translation Editor + - {{ current.languageLocalName }} [{{current.languageCode}}] +

+ + + + + + + + + + + + + + + + + + + + + +
Reference Language + + {{ referent.languageLocalName }} + [{{referent.languageCode}}] +
Current Language + + {{ current.languageLocalName }} [{{current.languageCode}}] +
Local Language Code + +
Local Language Name + +
+ Font tables to use
("ascii_basic" must be first) + 		+
    +
  • + + {{ font }} +
    • +
+ + +
+ +
+
+ + +
+ +
+

Obsolete

+ + + + + +
{{entry.id}}
{{entry.value}}
+
+ +

Messages and Strings

+ + + + + +
{{message.id}}
 +
{{constraintString(message)}}
+
{{referent.messages[message.id]}}
+
{{message.note}}
+
+ +
+
+ +

Warning Messages

+ + + + + +
{{message.id}}
 +
+ {{constraintWholeScreenMessage(current.messagesWarn, + message.id)}} +
+
{{referent.messagesWarn[message.id]}}
+
{{message.note}}
+
+ + + +
+
+ + +
+
+ +

Characters

+ + + + + +
{{char.id}}
 +
{{constraintString(char)}}
+
{{referent.characters[char.id]}}
+
+ +
+
+ +

Menu Groups

+ + + + + +
{{menu.id}}
 +
Menu Name
+
+ {{constraintWholeScreenMessage(current.menuGroups, menu.id, + 'text2')}} +
+
{{referent.menuGroups[menu.id].text2}}
+
+ + + +
+
+ + +
+
Description
+
{{referent.menuGroups[menu.id].desc}}
+
+ +
+
+ +

Menu Options

+ + + + + +
{{menu.id}}
 +
+
Menu Name
+
+ {{constraintWholeScreenMessage(current.menuOptions, menu.id, + 'text2')}} +
+
Setting Description
+
{{menu.description}}
+
Reference
+
{{referent.menuOptions[menu.id].text2}}
+
+ + + +
+
+ + +
+
+
Description
+
{{referent.menuOptions[menu.id].desc}}
+
+ +
+
+ +
+ + +
+
+
+ diff --git a/Translations/translations_def.js b/Translations/translations_def.js index b5027678..edbc4b86 100644 --- a/Translations/translations_def.js +++ b/Translations/translations_def.js @@ -32,31 +32,6 @@ var def = "id": "SleepingTipAdvancedString", "maxLen": 6 }, - { - "id": "IdleTipString", - "lenSum": - { - "fields": ["IdleTipString", "IdleSetString"], - "maxLen": 10 - } - }, - { - "id": "IdleSetString", - "lenSum": - { - "fields": ["IdleTipString", "IdleSetString"], - "maxLen": 10 - }, - "note": "Preferably start with a space" - }, - { - "id": "TipDisconnectedString", - "maxLen": 16 - }, - { - "id": "SolderingAdvancedPowerPrompt", - "maxLen": null - }, { "id": "OffString", "maxLen": 3 @@ -164,11 +139,6 @@ var def = "len": 1, "default": "F" }, - { - "id": "SettingNAChar", - "len": 3, - "default": "N/A" - } ], "menuGroups": [ { @@ -201,168 +171,201 @@ var def = { "id": "DCInCutoff", "maxLen": 5, - "maxLen2": 11 + "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." }, { "id": "SleepTemperature", "maxLen": 4, - "maxLen2": 9 + "maxLen2": 9, + "description":"Temperature the device will drop down to while asleep. Typically around halfway between off and soldering temperature." }, { "id": "SleepTimeout", "maxLen": 4, - "maxLen2": 9 + "maxLen2": 9, + "description":"How long after inactivity the device drops down to the sleep temperature." }, { "id": "ShutdownTimeout", "maxLen": 5, - "maxLen2": 11 + "maxLen2": 11, + "description":"How long after the unit enters sleep mode before it turns off the heater and exists soldering mode." }, { "id": "MotionSensitivity", "maxLen": 6, - "maxLen2": 13 + "maxLen2": 13, + "description":"Scale of how sensitive the device is to movement. Higher numbers == more sensitive. 0 == motion detection turned off." }, { "id": "TemperatureUnit", "maxLen": 6, - "maxLen2": 13 + "maxLen2": 13, + "description":"If the device shows temperatures in C or F" }, { "id": "AdvancedIdle", "maxLen": 6, - "maxLen2": 13 + "maxLen2": 13, + "description":"Should the device show an 'advanced' view on the idle screen. Advanced view uses text to show more details than the typical icons." }, { "id": "DisplayRotation", "maxLen": 6, - "maxLen2": 13 + "maxLen2": 13, + "description":"If the display should rotate automatically or if it should be fixed into Left or Right handed mode." }, { "id": "BoostTemperature", "maxLen": 4, - "maxLen2": 9 + "maxLen2": 9, + "description":"When the unit is in soldering mode. You can hold down the button at the front of the device to temporarily override the soldering temperature to this value. This SETS the temperature, it does not ADD to it." }, { "id": "AutoStart", "maxLen": 6, - "maxLen2": 13 + "maxLen2": 13, + "description":"When the device powers up, should it enter into a special mode. These settings set it to either start into: Soldering mode, sleeping mode, Auto mode (Enters into soldering mode on first movement)." }, { "id": "CooldownBlink", "maxLen": 6, - "maxLen2": 13 + "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." }, { "id": "TemperatureCalibration", "maxLen": 8, - "maxLen2": 16 + "maxLen2": 16, + "description":"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 5C off target." }, { "id": "SettingsReset", "maxLen": 8, - "maxLen2": 16 + "maxLen2": 16, + "description":"Resets all settings and calibrations to factory defaults. Does NOT erase custom user bootup logo's" }, { "id": "VoltageCalibration", "maxLen": 8, - "maxLen2": 16 + "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" }, { "id": "AdvancedSoldering", "maxLen": 6, - "maxLen2": 13 + "maxLen2": 13, + "description":"" }, { "id": "ScrollingSpeed", "maxLen": 6, - "maxLen2": 11 + "maxLen2": 11, + "description":"How fast the description text scrolls when hovering on a menu. Faster speeds may induce tearing but allow reading the whole description faster." }, { "id": "QCMaxVoltage", "maxLen": 8, - "maxLen2": 16 + "maxLen2": 16, + "description":"This adjusts the maximum voltage the QC negotiation will adjust to. Does NOT affect USB-PD. Should be set safely based on the current rating of your power supply." }, { "id": "PDNegTimeout", "maxLen": 8, - "maxLen2": 16 + "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." }, { "id": "PowerLimit", "maxLen": 5, - "maxLen2": 11 + "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." }, { "id": "ReverseButtonTempChange", "maxLen": 6, - "maxLen2": 16 + "maxLen2": 16, + "description":"Swaps which button increments and decrements the temperature on temperature change screens." }, { "id": "TempChangeShortStep", "maxLen": 8, - "maxLen2": 16 + "maxLen2": 16, + "description":"How much the temperature is increased with a quick press of the buttons." }, { "id": "TempChangeLongStep", "maxLen": 6, - "maxLen2": 16 + "maxLen2": 16, + "description":"How much the temperature is increased with a long hold of the buttons." }, { "id": "PowerPulsePower", "maxLen": 6, - "maxLen2": 16 + "maxLen2": 16, + "description":"Enables and sets the wattage of the power pulse. Power pulse causes the iron to briefly turn on the heater to draw power to avoid power banks going to sleep." }, { "id": "HallEffSensitivity", "maxLen": 6, - "maxLen2": 8 + "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." }, { "id": "LockingMode", "maxLen": 6, - "maxLen2": 13 + "maxLen2": 13, + "description":"If the locking mode for the buttons is enabled. Allows locking the buttons from accidental presses." }, { "id": "MinVolCell", "maxLen": 4, - "maxLen2": 9 + "maxLen2": 9, + "description":"When powered by a battery, sets the minimum voltage per cell that is allowed. This is multiplied by the cell count." }, { "id": "AnimLoop", "maxLen": 6, - "maxLen2": 13 + "maxLen2": 13, + "description":"Should the menu animations loop." }, { "id": "AnimSpeed", "maxLen": 6, - "maxLen2": 13 + "maxLen2": 13, + "description":"How fast should the menu animations loop." }, { "id": "PowerPulseWait", "maxLen": 6, - "maxLen2": 13 + "maxLen2": 13, + "description":"How long of a time interval between power pulses." }, { "id": "PowerPulseDuration", "maxLen": 6, - "maxLen2": 13 + "maxLen2": 13, + "description":"How long should the power pulse go for." }, { "id": "LanguageSwitch", "maxLen": 7, - "maxLen2": 15 + "maxLen2": 15, + "description":"Changes the device language on multi-lingual builds" }, { "id": "Brightness", "maxLen": 7, - "maxLen2": 15 + "maxLen2": 15, + "description":"Display brightness. Higher values age the OLED faster but are brighter." }, { "id": "ColourInversion", "maxLen": 7, - "maxLen2": 15 + "maxLen2": 15, + "description":"Inverts the entire OLED." } ] } From 992706e954094b07ed3aa8216dc6190915b1c7fa Mon Sep 17 00:00:00 2001 From: "Ben V. Brown" Date: Tue, 18 Jan 2022 20:58:03 +1100 Subject: [PATCH 02/40] Update translation_EN.json --- Translations/translation_EN.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/Translations/translation_EN.json b/Translations/translation_EN.json index 7c7bb4f3..628d6f7e 100644 --- a/Translations/translation_EN.json +++ b/Translations/translation_EN.json @@ -5,7 +5,7 @@ "tempUnitFahrenheit": true, "messages": { "SettingsCalibrationWarning": "Please ensure the tip is at room temperature, before proceeding!", - "SettingsResetWarning": "Sure you want to restore default settings?", + "SettingsResetWarning": "Are you sure you want to restore default settings?", "UVLOWarningString": "DC LOW", "UndervoltageString": "Undervoltage", "InputVoltageString": "Input V: ", From 3826c2d2fedc88c689ff2586cdfca7d219ad9cb5 Mon Sep 17 00:00:00 2001 From: "Ben V. Brown" Date: Tue, 18 Jan 2022 20:58:32 +1100 Subject: [PATCH 03/40] Use the nicer settings reset message in menu --- source/Core/Src/gui.cpp | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/source/Core/Src/gui.cpp b/source/Core/Src/gui.cpp index c72b6ea0..be2918b4 100644 --- a/source/Core/Src/gui.cpp +++ b/source/Core/Src/gui.cpp @@ -601,7 +601,7 @@ static void settings_displayCoolingBlinkEnabled(void) { static bool settings_setResetSettings(void) { if (userConfirmation(translatedString(Tr->SettingsResetWarning))) { resetSettings(); - warnUser(translatedString(Tr->ResetOKMessage), 2 * TICKS_SECOND); + warnUser(translatedString(Tr->SettingsResetMessage), 10 * TICKS_SECOND); } return false; } From 686657a418bf2e4c31be533997704a6eb14e2811 Mon Sep 17 00:00:00 2001 From: "Ben V. Brown" Date: Tue, 18 Jan 2022 21:00:33 +1100 Subject: [PATCH 04/40] Adding descriptions to all fields --- Translations/translations_def.js | 120 ++++++++++++++++++++----------- 1 file changed, 78 insertions(+), 42 deletions(-) diff --git a/Translations/translations_def.js b/Translations/translations_def.js index edbc4b86..0790792d 100644 --- a/Translations/translations_def.js +++ b/Translations/translations_def.js @@ -2,169 +2,205 @@ var def = { "messages": [ { - "id": "SettingsCalibrationWarning" + "id": "SettingsCalibrationWarning", + "description":"Confirmation message shown before performing an offset calibration. Should warn user to make sure tip and handle are at the same temperature." }, { - "id": "SettingsResetWarning" + "id": "SettingsResetWarning", + "description":"Confirmation message shown before confirming a settings reset." }, { "id": "UVLOWarningString", - "maxLen": 8 + "maxLen": 8, + "description":"Warning text shown when the unit turns off due to undervoltage in simple mode." }, { "id": "UndervoltageString", - "maxLen": 16 + "maxLen": 16, + "description":"Warning text shown when the unit turns off due to undervoltage in advanced mode." }, { "id": "InputVoltageString", "maxLen": 11, - "note": "Preferably end with a space" + "note": "Preferably end with a space", + "description":"Prefix text for 'Input Voltage' shown before showing the input voltage reading" }, { "id": "SleepingSimpleString", - "maxLen": 4 + "maxLen": 4, + "description":"The text shown to indicate the unit is in sleep mode when advanced view is NOT on" }, { "id": "SleepingAdvancedString", - "maxLen": 16 + "maxLen": 16, + "description":"The text shown to indicate the unit is in sleep mode when advanced view is turned on" }, { "id": "SleepingTipAdvancedString", - "maxLen": 6 + "maxLen": 6, + "description":"The prefix text shwon before tip temperature when the unit is sleeping with advanced view on." }, { "id": "OffString", - "maxLen": 3 + "maxLen": 3, + "description":"Shown when a setting is turned off" } ], "messagesWarn": [ { - "id": "ResetOKMessage" + "id": "SettingsResetMessage", + "description":"Shown when the settings are reset to factory defaults either by user or by incompatible firmware changes." }, { - "id": "SettingsResetMessage" + "id": "NoAccelerometerMessage", + "description":"No accelerometer could be communicated with. This means that either the devices accelerometer is broken or unknown to IronOS. All motion based settings are disabled and motion based features will not work." }, { - "id": "NoAccelerometerMessage" + "id": "NoPowerDeliveryMessage", + "description":"The IC required for USB-PD could not be communicated with. This is an error warning that USB-PD WILL NOT FUNCTION. Generally indicative of either a hardware or software issues." }, { - "id": "NoPowerDeliveryMessage" + "id": "LockingKeysString", + "description":"Shown when keys are locked" }, { - "id": "LockingKeysString" + "id": "UnlockingKeysString", + "description":"Shown when keys are unlocked" }, { - "id": "UnlockingKeysString" + "id": "WarningKeysLockedString", + "description":"Warning shown when imput is ignored due to key lock being on" }, { - "id": "WarningKeysLockedString" - }, - { - "id": "WarningThermalRunaway" + "id": "WarningThermalRunaway", + "description":"Warning text shown when the software has disabled the heater as a safety precaution as the temperature reading didnt react as expected." } ], "characters": [ { "id": "SettingRightChar", - "len": 1 + "len": 1, + "description":"Shown for fixed Right-handed display rotation." }, { "id": "SettingLeftChar", - "len": 1 + "len": 1, + "description":"Shown for fixed Left-handed display rotation." }, { "id": "SettingAutoChar", - "len": 1 + "len": 1, + "description":"Shown for automatic display rotation." }, { "id": "SettingFastChar", - "len": 1 + "len": 1, + "description":"Shown when a setting is set to a fast value i.e. animation speed" }, { "id": "SettingSlowChar", - "len": 1 + "len": 1, + "description":"Shown when a setting is set to a slow value i.e. animation speed" }, { "id": "SettingMediumChar", - "len": 1 + "len": 1, + "description":"Shown when a setting is set to a medium value i.e. animation speed" }, { "id": "SettingOffChar", - "len": 1 + "len": 1, + "description":"Shown when a setting is turned off" }, { "id": "SettingStartSolderingChar", - "len": 1 + "len": 1, + "description":"Shown when the auto start mode is set to go straight to soldering." }, { "id": "SettingStartSleepChar", - "len": 1 + "len": 1, + "description":"Shown when the auto start mode is to start in sleep mode." }, { "id": "SettingStartSleepOffChar", - "len": 1 + "len": 1, + "description":"Shown when the auto start state is set to go to an off state but on movement wake into soldering mode." }, { "id": "SettingStartNoneChar", - "len": 1 + "len": 1, + "description":"Shown when auto start state is to do nothing and go to a normal boot" }, { "id": "SettingSensitivityOff", - "len": 1 + "len": 1, + "description":"Shown when a sensitivity (hall effect) is disabled. Turning off the sensor." }, { "id": "SettingSensitivityLow", - "len": 1 + "len": 1, + "description":"Shown when a sensitivity (hall effect) is not very sensitive" }, { "id": "SettingSensitivityMedium", - "len": 1 + "len": 1, + "description":"Shown when a sensitivity (hall effect) is average sensitive" }, { "id": "SettingSensitivityHigh", - "len": 1 + "len": 1, + "description":"Shown when a sensitivity (hall effect) is highly sensitive" }, { "id": "SettingLockDisableChar", "len": 1, - "default": "D" + "default": "D", + "description":"Shown when locking mode is turned off" }, { "id": "SettingLockBoostChar", "len": 1, - "default": "B" + "default": "B", + "description":"Shown when the locking mode is set to lock all buttons except for boost mode." }, { "id": "SettingLockFullChar", "len": 1, - "default": "F" + "default": "F", + "description":"Shown when the locking mode is set to lock all buttons." }, ], "menuGroups": [ { "id": "PowerMenu", "maxLen": 5, - "maxLen2": 11 + "maxLen2": 11, + "description":"" }, { "id": "SolderingMenu", "maxLen": 5, - "maxLen2": 11 + "maxLen2": 11, + "description":"" }, { "id": "PowerSavingMenu", "maxLen": 5, - "maxLen2": 11 + "maxLen2": 11, + "description":"" }, { "id": "UIMenu", "maxLen": 5, - "maxLen2": 11 + "maxLen2": 11, + "description":"" }, { "id": "AdvancedMenu", "maxLen": 5, - "maxLen2": 11 + "maxLen2": 11, + "description":"" } ], "menuOptions": [ From b64c4f3d5364f7dec0198698b548e4aad424d714 Mon Sep 17 00:00:00 2001 From: "Ben V. Brown" Date: Tue, 18 Jan 2022 21:06:06 +1100 Subject: [PATCH 05/40] Show descriptions for all fields --- Translations/TranslationEditor.html | 14 +++++++++++++- Translations/translations_def.js | 10 +++++----- 2 files changed, 18 insertions(+), 6 deletions(-) diff --git a/Translations/TranslationEditor.html b/Translations/TranslationEditor.html index 2fb41065..a68cfcf8 100644 --- a/Translations/TranslationEditor.html +++ b/Translations/TranslationEditor.html @@ -413,6 +413,9 @@
{{message.id}}
{{constraintString(message)}}
+
Description
+
{{message.description}}
+
Reference
{{referent.messages[message.id]}}
{{message.note}}
@@ -439,6 +442,9 @@ {{constraintWholeScreenMessage(current.messagesWarn, message.id)}}
+
Description
+
{{message.description}}
+
Reference
{{referent.messagesWarn[message.id]}}
{{message.note}}
{{char.id}}
{{constraintString(char)}}
+
Description
+
{{char.description}}
+
Reference
{{referent.characters[char.id]}}
+
Description
+
{{menu.description}}
+
Reference
{{referent.menuGroups[menu.id].text2}}
-
Setting Description
+
Description
{{menu.description}}
Reference
{{referent.menuOptions[menu.id].text2}}
diff --git a/Translations/translations_def.js b/Translations/translations_def.js index 0790792d..0a536c8d 100644 --- a/Translations/translations_def.js +++ b/Translations/translations_def.js @@ -176,31 +176,31 @@ var def = "id": "PowerMenu", "maxLen": 5, "maxLen2": 11, - "description":"" + "description":"Menu for settings related to power. Main settings to do with the input voltage." }, { "id": "SolderingMenu", "maxLen": 5, "maxLen2": 11, - "description":"" + "description":"Setttings for soldering mode, such as tip temperature, boost temps, sleep temps." }, { "id": "PowerSavingMenu", "maxLen": 5, "maxLen2": 11, - "description":"" + "description":"Settings to do with power saving, such as sleep mode and shutdown modes." }, { "id": "UIMenu", "maxLen": 5, "maxLen2": 11, - "description":"" + "description":"User interface related settings, such as Units." }, { "id": "AdvancedMenu", "maxLen": 5, "maxLen2": 11, - "description":"" + "description":"Advanced settings. Misc catchall for settings that dont fit anywhere else or settings that require some thought before use." } ], "menuOptions": [ From 1e065f0868cffd13c47e63ca0abaed6aaf1feb9d Mon Sep 17 00:00:00 2001 From: "Ben V. Brown" Date: Tue, 18 Jan 2022 21:15:47 +1100 Subject: [PATCH 06/40] Update header file to remove the unused settings --- Translations/translations_def.js | 2 +- source/Core/Inc/Translation.h | 8 +------- 2 files changed, 2 insertions(+), 8 deletions(-) diff --git a/Translations/translations_def.js b/Translations/translations_def.js index 0a536c8d..76854afa 100644 --- a/Translations/translations_def.js +++ b/Translations/translations_def.js @@ -169,7 +169,7 @@ var def = "len": 1, "default": "F", "description":"Shown when the locking mode is set to lock all buttons." - }, + } ], "menuGroups": [ { diff --git a/source/Core/Inc/Translation.h b/source/Core/Inc/Translation.h index c9b9a259..645bf0b8 100644 --- a/source/Core/Inc/Translation.h +++ b/source/Core/Inc/Translation.h @@ -76,13 +76,8 @@ struct TranslationIndexTable { uint16_t SleepingSimpleString; uint16_t SleepingAdvancedString; uint16_t SleepingTipAdvancedString; - uint16_t IdleTipString; - uint16_t IdleSetString; - uint16_t TipDisconnectedString; - uint16_t SolderingAdvancedPowerPrompt; uint16_t OffString; - uint16_t ResetOKMessage; uint16_t SettingsResetMessage; uint16_t NoAccelerometerMessage; uint16_t NoPowerDeliveryMessage; @@ -109,7 +104,6 @@ struct TranslationIndexTable { uint16_t SettingLockDisableChar; uint16_t SettingLockBoostChar; uint16_t SettingLockFullChar; - uint16_t SettingNAChar; uint16_t SettingsDescriptions[static_cast(SettingsItemIndex::NUM_ITEMS)]; uint16_t SettingsShortNames[static_cast(SettingsItemIndex::NUM_ITEMS)]; @@ -118,7 +112,7 @@ struct TranslationIndexTable { }; extern const TranslationIndexTable *Tr; -extern const char * TranslationStrings; +extern const char *TranslationStrings; struct TranslationData { TranslationIndexTable indices; From d7b21c213ea0cb7446a04978a9e22696ea035d28 Mon Sep 17 00:00:00 2001 From: "Ben V. Brown" Date: Tue, 18 Jan 2022 21:44:33 +1100 Subject: [PATCH 07/40] Update Translation.h --- source/Core/Inc/Translation.h | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/source/Core/Inc/Translation.h b/source/Core/Inc/Translation.h index 645bf0b8..0bfca9f4 100644 --- a/source/Core/Inc/Translation.h +++ b/source/Core/Inc/Translation.h @@ -112,7 +112,8 @@ struct TranslationIndexTable { }; extern const TranslationIndexTable *Tr; -extern const char *TranslationStrings; + +extern const char *TranslationStrings; struct TranslationData { TranslationIndexTable indices; From b0dfeec6f2a00fc6e15505bcccfaa644607b676a Mon Sep 17 00:00:00 2001 From: "Ben V. Brown" Date: Tue, 18 Jan 2022 23:04:24 +1100 Subject: [PATCH 08/40] Update translations_def.js --- Translations/translations_def.js | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/Translations/translations_def.js b/Translations/translations_def.js index 76854afa..4a49bd04 100644 --- a/Translations/translations_def.js +++ b/Translations/translations_def.js @@ -292,7 +292,7 @@ var def = "id": "AdvancedSoldering", "maxLen": 6, "maxLen2": 13, - "description":"" + "description":"Should the device show an 'advanced' soldering view. This is a text based view that shows more information at the cost of no nice graphics." }, { "id": "ScrollingSpeed", From 3ed6b52a1ed8d90a4c8918ab68c2b4a8fed77e9d Mon Sep 17 00:00:00 2001 From: "Ben V. Brown" Date: Tue, 18 Jan 2022 23:06:36 +1100 Subject: [PATCH 09/40] Create script to automatically generate a settings menu help file --- Documentation/Development.md | 28 +++++++-- Translations/gen_menu_docs.py | 112 ++++++++++++++++++++++++++++++++++ 2 files changed, 135 insertions(+), 5 deletions(-) create mode 100755 Translations/gen_menu_docs.py diff --git a/Documentation/Development.md b/Documentation/Development.md index 65e50955..1a60f781 100644 --- a/Documentation/Development.md +++ b/Documentation/Development.md @@ -20,54 +20,71 @@ Use the following steps to set up a build environment for IronOS on the command 1. [Follow steps 1 – 3 here to install the toolchain](https://github.com/glegrain/STM32-with-macOS#0---installing-the-toolchain) needed to compile for STM32 microcontrollers. 2. Install `python`: + ``` brew install python ``` + 3. (Optional) Update `pip` so it doesn't warn you about being out-of-date: + ``` python3 -m pip install --upgrade pip ``` + 4. Change to the `source` directory: + ``` cd source ``` + 5. Create a Python virtual environment for IronOS named `ironos-venv` to keep your Python installation clean: + ``` python3 -m venv ironos-venv ``` + 6. Activate the Python virtual environment: + ``` source ironos-venv/bin/activate ``` + 7. Install the dependencies required to run `make-translation.py`: + ``` pip install bdflib ``` + 8. All done! See some examples below for how you can build your own IronOS. ### Examples -To build a single language Simplified Chinese firmware for the TS80P with 8 simultaneous jobs: +To build a single language Simplified Chinese firmware for the TS80P with 8 simultaneous jobs: + ``` make -j8 model=TS80P firmware-ZH_CN ``` -To build a European multi-language firmware for the Pinecil with as many simultaneous jobs as there are logical processors on Linux: +To build a European multi-language firmware for the Pinecil with as many simultaneous jobs as there are logical processors on Linux: + ``` make -j$(nproc) model=Pinecil firmware-multi_European ``` -To build a Cyrillic compressed multi-language firmware for the Pinecil with as many simultaneous jobs as there are logical processors on macOS: +To build a Cyrillic compressed multi-language firmware for the Pinecil with as many simultaneous jobs as there are logical processors on macOS: + ``` make -j$(sysctl -n hw.logicalcpu) model=Pinecil firmware-multi_compressed_Bulgarian+Russian+Serbian+Ukrainian ``` -To build a custom multi-language firmware including English and Simplified Chinese for the TS80: +To build a custom multi-language firmware including English and Simplified Chinese for the TS80: + ``` make -j8 model=TS80 custom_multi_langs="EN ZH_CN" firmware-multi_Custom ``` -To build a custom compressed multi-language firmware including German, Spanish, and French for the TS100 (note if `model` is unspecified, it will default to `TS100`): +To build a custom compressed multi-language firmware including German, Spanish, and French for the TS100 (note if `model` is unspecified, it will default to `TS100`): + ``` make -j8 custom_multi_langs="DE ES FR" firmware-multi_compressed_Custom ``` @@ -77,6 +94,7 @@ To build a release instead, run the `build.sh` script. This will update translat ## Updating languages 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 diff --git a/Translations/gen_menu_docs.py b/Translations/gen_menu_docs.py new file mode 100755 index 00000000..c0593da2 --- /dev/null +++ b/Translations/gen_menu_docs.py @@ -0,0 +1,112 @@ +#!/usr/bin/env python3 + +import argparse +import functools +import hashlib +import json +import logging +import os +import sys +from dataclasses import dataclass +from pathlib import Path +from typing import Dict, List + +logging.basicConfig(stream=sys.stdout, level=logging.DEBUG) + +HERE = Path(__file__).resolve().parent +TRANSLATION_DEFS_PATH = os.path.join(HERE, "translations_def.js") +ENGLISH_TRANSLATION_PATH = os.path.join(HERE, "translation_EN.json") +MENU_DOCS_FILE_PATH = os.path.join(HERE.parent, "Documentation/Settings.md") + +# Loading a single JSON file +def load_json(filename: str, skip_first_line: bool) -> dict: + with open(filename) as f: + if skip_first_line: + f.readline() + return json.loads(f.read()) + + +def write_header(filep): + """ + Writes the markdown constant header area out + """ + constant_header = """ + +# IronOS Settings Menu + +The below breaks down the menu's and what each setting means. + """ + filep.write(constant_header) + + +def write_menu_categories(filep, defs, translation_data): + """ + Writes the menu categories section out + """ + menu_cat_pretense = """ +## Menu Categories + +In the menu there are a few main categories that are used to keep the list manageable. +""" + filep.write(menu_cat_pretense) + for menu in defs.get("menuGroups", {}): + menu_id = menu.get("id", "") + entry = translation_data.get("menuGroups", {}).get(menu_id, "") + name = " ".join(entry.get("text2", [])) + desc = menu.get("description", "") + section = f""" +### Category: {name} + +{desc} +""" + filep.write(section) + + +def write_menu_entries(filep, defs, translation_data): + """ + Writes the menu entries section out + """ + menu_entries_pretense = """ +## Settings + +These are all off the settings possible in the menu. +Not all settings are visible for all devices. +For example, the TS100 does not have USB-PD settings. + +When using the device, if unsure you can pause (press nothing) on a setting and after a short delay help text will scroll across the screen. +This is the "on device help text". +""" + filep.write(menu_entries_pretense) + for menu in defs.get("menuOptions", {}): + menu_id = menu.get("id", "") + entry = translation_data.get("menuOptions", {}).get(menu_id, "") + name = " ".join(entry.get("text2", [])) + desc = menu.get("description", "") + on_device_desc = entry.get("desc", "") + section = f""" +### Setting: {name} + +{desc} + +On device help text: + +{on_device_desc} +""" + filep.write(section) + + +def main() -> None: + json_dir = HERE + print(json_dir) + logging.info("Loading translation definitions") + defs = load_json(TRANSLATION_DEFS_PATH, True) + eng_translation = load_json(ENGLISH_TRANSLATION_PATH, False) + with open(MENU_DOCS_FILE_PATH, "w") as outputf: + write_header(outputf) + write_menu_categories(outputf, defs, eng_translation) + write_menu_entries(outputf, defs, eng_translation) + logging.info("Done") + + +if __name__ == "__main__": + main() From cf70c65a952f59417c01dda6a0baabbd2a999e50 Mon Sep 17 00:00:00 2001 From: "Ben V. Brown" Date: Tue, 18 Jan 2022 23:06:38 +1100 Subject: [PATCH 10/40] Create Settings.md --- Documentation/Settings.md | 302 ++++++++++++++++++++++++++++++++++++++ 1 file changed, 302 insertions(+) create mode 100644 Documentation/Settings.md diff --git a/Documentation/Settings.md b/Documentation/Settings.md new file mode 100644 index 00000000..552787d9 --- /dev/null +++ b/Documentation/Settings.md @@ -0,0 +1,302 @@ + + +# IronOS Settings Menu + +The below breaks down the menu's and what each setting means. + +## Menu Categories + +In the menu there are a few main categories that are used to keep the list manageable. + +### Category: Power settings + +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. + +### Category: Sleep mode + +Settings to do with power saving, such as sleep mode and shutdown modes. + +### Category: User interface + +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. + +## Settings + +These are all off the settings possible in the menu. +Not all settings are visible for all devices. +For example, the TS100 does not have USB-PD settings. + +When using the device, if unsure you can pause (press nothing) on a setting and after a short delay help text will scroll across the screen. +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. + +On device help text: + +Power source. Sets cutoff voltage. (DC 10V) (S 3.3V per cell, disable power limit) + +### Setting: Sleep temp + +Temperature the device will drop down to while asleep. Typically around halfway between off and soldering temperature. + +On device help text: + +Tip temperature while in "sleep mode" + +### Setting: Sleep timeout + +How long after inactivity the device drops down to the sleep temperature. + +On device help text: + +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. + +On device help text: + +Interval before the iron shuts down (M=minutes) + +### Setting: Motion sensitivity + +Scale of how sensitive the device is to movement. Higher numbers == more sensitive. 0 == motion detection turned off. + +On device help text: + +0=off | 1=least sensitive | ... | 9=most sensitive + +### Setting: Temperature unit + +If the device shows temperatures in C or F + +On device help text: + +C=Celsius | F=Fahrenheit + +### Setting: Detailed idle screen + +Should the device show an 'advanced' view on the idle screen. Advanced view uses text to show more details than the typical icons. + +On device help text: + +Display detailed information in a smaller font on the idle screen + +### Setting: Display orientation + +If the display should rotate automatically or if it should be fixed into Left or Right handed mode. + +On device help text: + +R=right-handed | L=left-handed | A=automatic + +### Setting: Boost temp + +When the unit is in soldering mode. You can hold down the button at the front of the device to temporarily override the soldering temperature to this value. This SETS the temperature, it does not ADD to it. + +On device help text: + +Temperature used in "boost mode" + +### Setting: Heat on power up + +When the device powers up, should it enter into a special mode. These settings set it to either start into: Soldering mode, sleeping mode, Auto mode (Enters into soldering mode on first movement). + +On device help text: + +O=off | S=soldering temp | Z=standby at sleep temp until moved | R=standby without heating until moved + +### 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. + +On device help text: + +Flash the temperature reading after heating was halted while the tip is still hot + +### Setting: Calibrate temperature? + +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 5C off target. + +On device help text: + +Start tip temperature offset calibration + +### Setting: Factory reset? + +Resets all settings and calibrations to factory defaults. Does NOT erase custom user bootup logo's + +On device help text: + +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 + +On device help text: + +Start VIN calibration (long press to exit) + +### Setting: Detailed solder screen + +Should the device show an 'advanced' soldering view. This is a text based view that shows more information at the cost of no nice graphics. + +On device help text: + +Display detailed information in a smaller font on soldering screen + +### Setting: Scrolling speed + +How fast the description text scrolls when hovering on a menu. Faster speeds may induce tearing but allow reading the whole description faster. + +On device help text: + +Speed info text scrolls past at (S=slow | F=fast) + +### Setting: QC voltage + +This adjusts the maximum voltage the QC negotiation will adjust to. Does NOT affect USB-PD. Should be set safely based on the current rating of your power supply. + +On device help text: + +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. + +On device help text: + +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. + +On device help text: + +Maximum power the iron can use (W=watt) + +### Setting: Reverse + - keys + +Swaps which button increments and decrements the temperature on temperature change screens. + +On device help text: + +Reverse assignment of buttons for temperature adjustment + +### Setting: Temp change short + +How much the temperature is increased with a quick press of the buttons. + +On device help text: + +Temperature-change-increment on short button press + +### Setting: Temp change long + +How much the temperature is increased with a long hold of the buttons. + +On device help text: + +Temperature-change-increment on long button press + +### Setting: Power pulse + +Enables and sets the wattage of the power pulse. Power pulse causes the iron to briefly turn on the heater to draw power to avoid power banks going to sleep. + +On device help text: + +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. + +On device help text: + +Sensitivity of the Hall effect sensor to detect sleep (O=off | L=low | M=medium | H=high) + +### Setting: Allow locking buttons + +If the locking mode for the buttons is enabled. Allows locking the buttons from accidental presses. + +On device help text: + +While soldering, hold down both buttons to toggle locking them (D=disable | B=boost mode only | F=full locking) + +### Setting: Minimum voltage + +When powered by a battery, sets the minimum voltage per cell that is allowed. This is multiplied by the cell count. + +On device help text: + +Minimum allowed voltage per cell (3S: 3 - 3.7V | 4-6S: 2.4 - 3.7V) + +### Setting: Anim. loop + +Should the menu animations loop. + +On device help text: + +Loop icon animations in main menu + +### Setting: Anim. speed + +How fast should the menu animations loop. + +On device help text: + +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. + +On device help text: + +Delay before keep-awake-pulse is triggered (x 2.5s) + +### Setting: Power pulse duration + +How long should the power pulse go for. + +On device help text: + +Keep-awake-pulse duration (x 250ms) + +### Setting: Language: EN English + +Changes the device language on multi-lingual builds + +On device help text: + +Current firmware language + +### Setting: Screen contrast + +Display brightness. Higher values age the OLED faster but are brighter. + +On device help text: + +Adjust the brightness of the OLED screen + +### Setting: Invert screen + +Inverts the entire OLED. + +On device help text: + +Invert the colours of the OLED screen From 415f9dfcf32696dd6a8f271ae1eb6d17144c557a Mon Sep 17 00:00:00 2001 From: "Ben V. Brown" Date: Tue, 18 Jan 2022 23:09:51 +1100 Subject: [PATCH 11/40] Update gen_menu_docs.py --- Translations/gen_menu_docs.py | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/Translations/gen_menu_docs.py b/Translations/gen_menu_docs.py index c0593da2..96be1886 100755 --- a/Translations/gen_menu_docs.py +++ b/Translations/gen_menu_docs.py @@ -19,6 +19,8 @@ ENGLISH_TRANSLATION_PATH = os.path.join(HERE, "translation_EN.json") MENU_DOCS_FILE_PATH = os.path.join(HERE.parent, "Documentation/Settings.md") # Loading a single JSON file + + def load_json(filename: str, skip_first_line: bool) -> dict: with open(filename) as f: if skip_first_line: @@ -66,10 +68,11 @@ def write_menu_entries(filep, defs, translation_data): """ Writes the menu entries section out """ + menu_entries_pretense = """ ## Settings -These are all off the settings possible in the menu. +These are all off the settings possible in the menu. Not all settings are visible for all devices. For example, the TS100 does not have USB-PD settings. From 996821ff694272c50a4d85e7318a1271cf5014cc Mon Sep 17 00:00:00 2001 From: "Ben V. Brown" Date: Tue, 18 Jan 2022 23:10:45 +1100 Subject: [PATCH 12/40] Update gen_menu_docs.py --- Translations/gen_menu_docs.py | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/Translations/gen_menu_docs.py b/Translations/gen_menu_docs.py index 96be1886..bea5d437 100755 --- a/Translations/gen_menu_docs.py +++ b/Translations/gen_menu_docs.py @@ -72,8 +72,8 @@ def write_menu_entries(filep, defs, translation_data): menu_entries_pretense = """ ## Settings -These are all off the settings possible in the menu. -Not all settings are visible for all devices. +These are all of the settings possible in the menu. +**Not all settings are visible for all devices.** For example, the TS100 does not have USB-PD settings. When using the device, if unsure you can pause (press nothing) on a setting and after a short delay help text will scroll across the screen. From 8479991b6c18d1a6f6793b4d1d99274ed70cd08b Mon Sep 17 00:00:00 2001 From: "Ben V. Brown" Date: Tue, 18 Jan 2022 23:11:25 +1100 Subject: [PATCH 13/40] Fix typo --- Documentation/Settings.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/Documentation/Settings.md b/Documentation/Settings.md index 552787d9..246f75c2 100644 --- a/Documentation/Settings.md +++ b/Documentation/Settings.md @@ -30,8 +30,8 @@ Advanced settings. Misc catchall for settings that dont fit anywhere else or set ## Settings -These are all off the settings possible in the menu. -Not all settings are visible for all devices. +These are all of the settings possible in the menu. +**Not all settings are visible for all devices.** For example, the TS100 does not have USB-PD settings. When using the device, if unsure you can pause (press nothing) on a setting and after a short delay help text will scroll across the screen. From 8c29347c263ae327f1fbd13d2bd2518582733077 Mon Sep 17 00:00:00 2001 From: "Ben V. Brown" Date: Wed, 19 Jan 2022 20:49:04 +1100 Subject: [PATCH 14/40] Update definitions and regenerate output --- Documentation/Settings.md | 42 ++++++++++++++++---------------- Translations/translations_def.js | 42 ++++++++++++++++---------------- 2 files changed, 42 insertions(+), 42 deletions(-) diff --git a/Documentation/Settings.md b/Documentation/Settings.md index 246f75c2..f1a5c20a 100644 --- a/Documentation/Settings.md +++ b/Documentation/Settings.md @@ -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: diff --git a/Translations/translations_def.js b/Translations/translations_def.js index 4a49bd04..ffbbe240 100644 --- a/Translations/translations_def.js +++ b/Translations/translations_def.js @@ -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", From 649d6a330b013912f44a14e9f545a2db4e05aca8 Mon Sep 17 00:00:00 2001 From: "Ben V. Brown" Date: Wed, 19 Jan 2022 20:52:54 +1100 Subject: [PATCH 15/40] More grammer touchups --- Translations/translations_def.js | 144 +++++++++++++++---------------- 1 file changed, 72 insertions(+), 72 deletions(-) diff --git a/Translations/translations_def.js b/Translations/translations_def.js index ffbbe240..7c5d8def 100644 --- a/Translations/translations_def.js +++ b/Translations/translations_def.js @@ -3,172 +3,172 @@ var def = "messages": [ { "id": "SettingsCalibrationWarning", - "description":"Confirmation message shown before performing an offset calibration. Should warn user to make sure tip and handle are at the same temperature." + "description": "Confirmation message shown before performing an offset calibration. Should warn user to make sure tip and handle are at the same temperature." }, { "id": "SettingsResetWarning", - "description":"Confirmation message shown before confirming a settings reset." + "description": "Confirmation message shown before confirming a settings reset." }, { "id": "UVLOWarningString", "maxLen": 8, - "description":"Warning text shown when the unit turns off due to undervoltage in simple mode." + "description": "Warning text shown when the unit turns off due to undervoltage in simple mode." }, { "id": "UndervoltageString", "maxLen": 16, - "description":"Warning text shown when the unit turns off due to undervoltage in advanced mode." + "description": "Warning text shown when the unit turns off due to undervoltage in advanced mode." }, { "id": "InputVoltageString", "maxLen": 11, "note": "Preferably end with a space", - "description":"Prefix text for 'Input Voltage' shown before showing the input voltage reading" + "description": "Prefix text for 'Input Voltage' shown before showing the input voltage reading" }, { "id": "SleepingSimpleString", "maxLen": 4, - "description":"The text shown to indicate the unit is in sleep mode when advanced view is NOT on" + "description": "The text shown to indicate the unit is in sleep mode when the advanced view is NOT on." }, { "id": "SleepingAdvancedString", "maxLen": 16, - "description":"The text shown to indicate the unit is in sleep mode when advanced view is turned on" + "description": "The text shown to indicate the unit is in sleep mode when the advanced view is turned on." }, { "id": "SleepingTipAdvancedString", "maxLen": 6, - "description":"The prefix text shwon before tip temperature when the unit is sleeping with advanced view on." + "description": "The prefix text shwon before tip temperature when the unit is sleeping with advanced view on." }, { "id": "OffString", "maxLen": 3, - "description":"Shown when a setting is turned off" + "description": "Shown when a setting is turned off." } ], "messagesWarn": [ { "id": "SettingsResetMessage", - "description":"Shown when the settings are reset to factory defaults either by user or by incompatible firmware changes." + "description": "Shown when the settings are reset to factory defaults either by the user or by incompatible firmware changes." }, { "id": "NoAccelerometerMessage", - "description":"No accelerometer could be communicated with. This means that either the devices accelerometer is broken or unknown to IronOS. All motion based settings are disabled and motion based features will not work." + "description": "No accelerometer could be communicated with. This means that either the device's accelerometer is broken or unknown to IronOS. All motion-based settings are disabled and motion-based features will not work." }, { "id": "NoPowerDeliveryMessage", - "description":"The IC required for USB-PD could not be communicated with. This is an error warning that USB-PD WILL NOT FUNCTION. Generally indicative of either a hardware or software issues." + "description": "The IC required for USB-PD could not be communicated with. This is an error warning that USB-PD WILL NOT FUNCTION. Generally indicative of either a hardware or software issues." }, { "id": "LockingKeysString", - "description":"Shown when keys are locked" + "description": "Shown when keys are locked" }, { "id": "UnlockingKeysString", - "description":"Shown when keys are unlocked" + "description": "Shown when keys are unlocked" }, { "id": "WarningKeysLockedString", - "description":"Warning shown when imput is ignored due to key lock being on" + "description": "Warning that is shown when input is ignored due to the key lock being on" }, { "id": "WarningThermalRunaway", - "description":"Warning text shown when the software has disabled the heater as a safety precaution as the temperature reading didnt react as expected." + "description": "Warning text shown when the software has disabled the heater as a safety precaution as the temperature reading didn't react as expected." } ], "characters": [ { "id": "SettingRightChar", "len": 1, - "description":"Shown for fixed Right-handed display rotation." + "description": "Shown for fixed Right-handed display rotation." }, { "id": "SettingLeftChar", "len": 1, - "description":"Shown for fixed Left-handed display rotation." + "description": "Shown for fixed Left-handed display rotation." }, { "id": "SettingAutoChar", "len": 1, - "description":"Shown for automatic display rotation." + "description": "Shown for automatic display rotation." }, { "id": "SettingFastChar", "len": 1, - "description":"Shown when a setting is set to a fast value i.e. animation speed" + "description": "Shown when a setting is set to a fast value i.e. animation speed" }, { "id": "SettingSlowChar", "len": 1, - "description":"Shown when a setting is set to a slow value i.e. animation speed" + "description": "Shown when a setting is set to a slow value i.e. animation speed" }, { "id": "SettingMediumChar", "len": 1, - "description":"Shown when a setting is set to a medium value i.e. animation speed" + "description": "Shown when a setting is set to a medium value i.e. animation speed" }, { "id": "SettingOffChar", "len": 1, - "description":"Shown when a setting is turned off" + "description": "Shown when a setting is turned off" }, { "id": "SettingStartSolderingChar", "len": 1, - "description":"Shown when the auto start mode is set to go straight to soldering." + "description": "Shown when the auto start mode is set to go straight to soldering." }, { "id": "SettingStartSleepChar", "len": 1, - "description":"Shown when the auto start mode is to start in sleep mode." + "description": "Shown when the auto start mode is to start in sleep mode." }, { "id": "SettingStartSleepOffChar", "len": 1, - "description":"Shown when the auto start state is set to go to an off state but on movement wake into soldering mode." + "description": "Shown when the auto start state is set to go to an off state but on movement wake into soldering mode." }, { "id": "SettingStartNoneChar", "len": 1, - "description":"Shown when auto start state is to do nothing and go to a normal boot" + "description": "Shown when autostart state is to do nothing and go to a normal boot" }, { "id": "SettingSensitivityOff", "len": 1, - "description":"Shown when a sensitivity (hall effect) is disabled. Turning off the sensor." + "description": "Shown when a sensitivity (hall effect) is disabled. Turning off the sensor." }, { "id": "SettingSensitivityLow", "len": 1, - "description":"Shown when a sensitivity (hall effect) is not very sensitive" + "description": "Shown when a sensitivity (hall effect) is not very sensitive" }, { "id": "SettingSensitivityMedium", "len": 1, - "description":"Shown when a sensitivity (hall effect) is average sensitive" + "description": "Shown when a sensitivity (hall effect) is average sensitive" }, { "id": "SettingSensitivityHigh", "len": 1, - "description":"Shown when a sensitivity (hall effect) is highly sensitive" + "description": "Shown when a sensitivity (hall effect) is highly sensitive" }, { "id": "SettingLockDisableChar", "len": 1, "default": "D", - "description":"Shown when locking mode is turned off" + "description": "Shown when locking mode is turned off" }, { "id": "SettingLockBoostChar", "len": 1, "default": "B", - "description":"Shown when the locking mode is set to lock all buttons except for boost mode." + "description": "Shown when the locking mode is set to lock all buttons except for boost mode." }, { "id": "SettingLockFullChar", "len": 1, "default": "F", - "description":"Shown when the locking mode is set to lock all buttons." + "description": "Shown when the locking mode is set to lock all buttons." } ], "menuGroups": [ @@ -176,31 +176,31 @@ var def = "id": "PowerMenu", "maxLen": 5, "maxLen2": 11, - "description":"Menu for settings related to power. Main settings to do with the input voltage." + "description": "Menu for settings related to power. Main settings to do with the input voltage." }, { "id": "SolderingMenu", "maxLen": 5, "maxLen2": 11, - "description":"Settings for soldering mode, such as boost temps, the increment used when pressing buttons and if button locking is enabled." + "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,sleep temps, and shutdown modes." + "description": "Settings to do with power saving, such as sleep mode, sleep temps, and shutdown modes." }, { "id": "UIMenu", "maxLen": 5, "maxLen2": 11, - "description":"User interface related settings, such as Units." + "description": "User interface related settings, such as Units." }, { "id": "AdvancedMenu", "maxLen": 5, "maxLen2": 11, - "description":"Advanced settings. Misc catchall for settings that don't 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,200 +208,200 @@ var def = "id": "DCInCutoff", "maxLen": 5, "maxLen2": 11, - "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." + "description": "When the device is powered by a battery, this adjusts the low voltage threshold for when the unit should turn off the heater to protect the battery." }, { "id": "SleepTemperature", "maxLen": 4, "maxLen2": 9, - "description":"Temperature the device will drop down to while asleep. Typically around halfway between off and soldering temperature." + "description": "Temperature the device will drop down to while asleep. Typically around halfway between off and soldering temperature." }, { "id": "SleepTimeout", "maxLen": 4, "maxLen2": 9, - "description":"How long of a period of movement/button pressing inactivity is required before 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 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." + "description": "How long of a period of movement/button pressing inactivity is required before the device turns off the tip heater completely and returns to the main idle screen." }, { "id": "MotionSensitivity", "maxLen": 6, "maxLen2": 13, - "description":"Scale of how sensitive the device is to movement. Higher numbers == more sensitive. 0 == motion detection turned off." + "description": "Scale of how sensitive the device is to movement. Higher numbers == more sensitive. 0 == motion detection turned off." }, { "id": "TemperatureUnit", "maxLen": 6, "maxLen2": 13, - "description":"If the device shows temperatures in C or F" + "description": "If the device shows temperatures in C or F" }, { "id": "AdvancedIdle", "maxLen": 6, "maxLen2": 13, - "description":"Should the device show an 'advanced' view on the idle screen. Advanced view uses text to show more details than the typical icons." + "description": "Should the device show an 'advanced' view on the idle screen. The advanced view uses text to show more details than the typical icons." }, { "id": "DisplayRotation", "maxLen": 6, "maxLen2": 13, - "description":"If the display should rotate automatically or if it should be fixed into Left or Right handed mode." + "description": "If the display should rotate automatically or if it should be fixed into Left or Right handed mode." }, { "id": "BoostTemperature", "maxLen": 4, "maxLen2": 9, - "description":"When the unit is in soldering mode. You can hold down the button at the front of the device to temporarily override the soldering temperature to this value. This SETS the temperature, it does not ADD to it." + "description": "When the unit is in soldering mode. You can hold down the button at the front of the device to temporarily override the soldering temperature to this value. This SETS the temperature, it does not ADD to it." }, { "id": "AutoStart", "maxLen": 6, "maxLen2": 13, - "description":"When the device powers up, should it enter into a special mode. These settings set it to either start into: Soldering mode, sleeping mode, Auto mode (Enters into soldering mode on first movement)." + "description": "When the device powers up, should it enter into a special mode. These settings set it to either start into Soldering mode, sleeping mode, Auto mode (Enters into soldering mode on the first movement)." }, { "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 still 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", "maxLen": 8, "maxLen2": 16, - "description":"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 5C off target." + "description": "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 5C off target." }, { "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 boot up 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", "maxLen": 6, "maxLen2": 13, - "description":"Should the device show an 'advanced' soldering view. This is a text based view that shows more information at the cost of no nice graphics." + "description": "Should the device show an 'advanced' soldering view. This is a text-based view that shows more information at the cost of no nice graphics." }, { "id": "ScrollingSpeed", "maxLen": 6, "maxLen2": 11, - "description":"How fast the description text scrolls when hovering on a menu. Faster speeds may induce tearing but allow reading the whole description faster." + "description": "How fast the description text scrolls when hovering on a menu. Faster speeds may induce tearing but allow reading the whole description faster." }, { "id": "QCMaxVoltage", "maxLen": 8, "maxLen2": 16, - "description":"This adjusts the maximum voltage the QC negotiation will adjust to. Does NOT affect USB-PD. Should be set safely based on the current rating of your power supply." + "description": "This adjusts the maximum voltage the QC negotiation will adjust to. Does NOT affect USB-PD. Should be set safely based on the current rating of your power supply." }, { "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. Recommended 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 keeping to small values." }, { "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 on temperature change screens." + "description": "Swaps which button increments and decrements on temperature change screens." }, { "id": "TempChangeShortStep", "maxLen": 8, "maxLen2": 16, - "description":"How much the temperature is increased with a quick press of the buttons." + "description": "How much the temperature is increased with a quick press of the buttons." }, { "id": "TempChangeLongStep", "maxLen": 6, "maxLen2": 16, - "description":"How much the temperature is increased with a long hold of the buttons." + "description": "How much the temperature is increased with a long hold of the buttons." }, { "id": "PowerPulsePower", "maxLen": 6, "maxLen2": 16, - "description":"Enables and sets the wattage of the power pulse. Power pulse causes the iron to briefly turn on the heater to draw power to avoid power banks going to sleep." + "description": "Enables and sets the wattage of the power pulse. Power pulse causes the iron to briefly turn on the heater to draw power to avoid power banks going to sleep." }, { "id": "HallEffSensitivity", "maxLen": 6, "maxLen2": 8, - "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." + "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 locking the buttons against accidental presses is enabled." + "description": "If locking the buttons against accidental presses is enabled." }, { "id": "MinVolCell", "maxLen": 4, "maxLen2": 9, - "description":"When powered by a battery, this adjust sets the minimum voltage per cell before shutdown. (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. Only visible if the animation speed is not turned turn to \"Off\"" + "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, or if they should not loop at all." + "description": "How fast should the menu animations loop, or if they should not loop at all." }, { "id": "PowerPulseWait", "maxLen": 6, "maxLen2": 13, - "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." + "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. 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." + "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 due to burn in. (However, it is notable that most of these screens die from other causes first.)" + "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", "maxLen": 7, "maxLen2": 15, - "description":"Inverts the entire OLED." + "description": "Inverts the entire OLED." } ] } From 900957a9ffae41a7676cfaccb29462577e26dc0d Mon Sep 17 00:00:00 2001 From: "Ben V. Brown" Date: Wed, 19 Jan 2022 20:53:49 +1100 Subject: [PATCH 16/40] Update translations_def.js --- Translations/translations_def.js | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/Translations/translations_def.js b/Translations/translations_def.js index 7c5d8def..5d78acf1 100644 --- a/Translations/translations_def.js +++ b/Translations/translations_def.js @@ -3,7 +3,7 @@ var def = "messages": [ { "id": "SettingsCalibrationWarning", - "description": "Confirmation message shown before performing an offset calibration. Should warn user to make sure tip and handle are at the same temperature." + "description": "Confirmation message shown before performing an offset calibration. Should warn the user to make sure tip and handle are at the same temperature." }, { "id": "SettingsResetWarning", @@ -38,7 +38,7 @@ var def = { "id": "SleepingTipAdvancedString", "maxLen": 6, - "description": "The prefix text shwon before tip temperature when the unit is sleeping with advanced view on." + "description": "The prefix text shown before tip temperature when the unit is sleeping with advanced view on." }, { "id": "OffString", @@ -250,7 +250,7 @@ var def = "id": "DisplayRotation", "maxLen": 6, "maxLen2": 13, - "description": "If the display should rotate automatically or if it should be fixed into Left or Right handed mode." + "description": "If the display should rotate automatically or if it should be fixed into Left or Right handed orientation." }, { "id": "BoostTemperature", From a9f8d88a2faeb81805b0c5f8702ec1c3d266ecf8 Mon Sep 17 00:00:00 2001 From: "Ben V. Brown" Date: Wed, 19 Jan 2022 20:53:58 +1100 Subject: [PATCH 17/40] Update Settings.md --- Documentation/Settings.md | 20 ++++++++++---------- 1 file changed, 10 insertions(+), 10 deletions(-) diff --git a/Documentation/Settings.md b/Documentation/Settings.md index f1a5c20a..c12b919a 100644 --- a/Documentation/Settings.md +++ b/Documentation/Settings.md @@ -18,7 +18,7 @@ Settings for soldering mode, such as boost temps, the increment used when pressi ### Category: Sleep mode -Settings to do with power saving, such as sleep mode,sleep temps, and shutdown modes. +Settings to do with power saving, such as sleep mode, sleep temps, and shutdown modes. ### Category: User interface @@ -39,7 +39,7 @@ This is the "on device help text". ### Setting: Power source -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. +When the device is powered by a battery, this adjusts the low voltage threshold for when the unit should turn off the heater to protect the battery. On device help text: @@ -63,7 +63,7 @@ Interval before "sleep mode" kicks in (S=seconds | M=minutes) ### Setting: Shutdown timeout -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. +How long of a period of movement/button pressing inactivity is required before the device turns off the tip heater completely and returns to the main idle screen. On device help text: @@ -87,7 +87,7 @@ C=Celsius | F=Fahrenheit ### Setting: Detailed idle screen -Should the device show an 'advanced' view on the idle screen. Advanced view uses text to show more details than the typical icons. +Should the device show an 'advanced' view on the idle screen. The advanced view uses text to show more details than the typical icons. On device help text: @@ -95,7 +95,7 @@ Display detailed information in a smaller font on the idle screen ### Setting: Display orientation -If the display should rotate automatically or if it should be fixed into Left or Right handed mode. +If the display should rotate automatically or if it should be fixed into Left or Right handed orientation. On device help text: @@ -111,7 +111,7 @@ Temperature used in "boost mode" ### Setting: Heat on power up -When the device powers up, should it enter into a special mode. These settings set it to either start into: Soldering mode, sleeping mode, Auto mode (Enters into soldering mode on first movement). +When the device powers up, should it enter into a special mode. These settings set it to either start into Soldering mode, sleeping mode, Auto mode (Enters into soldering mode on the first movement). 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 boot up logo's. On device help text: @@ -151,7 +151,7 @@ Start VIN calibration (long press to exit) ### Setting: Detailed solder screen -Should the device show an 'advanced' soldering view. This is a text based view that shows more information at the cost of no nice graphics. +Should the device show an 'advanced' soldering view. This is a text-based view that shows more information at the cost of no nice graphics. 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. Recommended 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 keeping to small values. On device help text: @@ -287,7 +287,7 @@ Current firmware language ### Setting: Screen contrast -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.) +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: From b36f84ea0878ad0f792f9d1e1817fd944db2d8d4 Mon Sep 17 00:00:00 2001 From: "Ben V. Brown" Date: Thu, 20 Jan 2022 20:37:54 +1100 Subject: [PATCH 18/40] Update translations_def.js --- Translations/translations_def.js | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/Translations/translations_def.js b/Translations/translations_def.js index 5d78acf1..1e36d9f3 100644 --- a/Translations/translations_def.js +++ b/Translations/translations_def.js @@ -359,13 +359,13 @@ var def = "id": "MinVolCell", "maxLen": 4, "maxLen2": 9, - "description": "When powered by a battery, this adjust sets the minimum voltage per cell before shutdown. (This is multiplied by the cell count.)" + "description": "When powered by a battery, this adjusts 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. Only visible if the animation speed is not turned turn to \"Off\"" + "description": "Should the menu animations loop. Only visible if the animation speed is not set to \"Off\"" }, { "id": "AnimSpeed", From c691e4f9b355b5924d79c684dfc64c8c2992d84d Mon Sep 17 00:00:00 2001 From: "Ben V. Brown" Date: Thu, 20 Jan 2022 20:37:57 +1100 Subject: [PATCH 19/40] Update Settings.md --- Documentation/Settings.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/Documentation/Settings.md b/Documentation/Settings.md index c12b919a..75f8ed00 100644 --- a/Documentation/Settings.md +++ b/Documentation/Settings.md @@ -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, this adjust sets the minimum voltage per cell before shutdown. (This is multiplied by the cell count.) +When powered by a battery, this adjusts 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. Only visible if the animation speed is not turned turn to "Off" +Should the menu animations loop. Only visible if the animation speed is not set to "Off" On device help text: From c06b40fd516a59c3db0a2afe3a590ad6ee66e460 Mon Sep 17 00:00:00 2001 From: "Ben V. Brown" <5425387+Ralim@users.noreply.github.com> Date: Fri, 21 Jan 2022 08:41:03 +1100 Subject: [PATCH 20/40] Update Translations/translations_def.js Co-authored-by: discip <53649486+discip@users.noreply.github.com> --- Translations/translations_def.js | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/Translations/translations_def.js b/Translations/translations_def.js index 1e36d9f3..68fac89e 100644 --- a/Translations/translations_def.js +++ b/Translations/translations_def.js @@ -262,7 +262,8 @@ var def = "id": "AutoStart", "maxLen": 6, "maxLen2": 13, - "description": "When the device powers up, should it enter into a special mode. These settings set it to either start into Soldering mode, sleeping mode, Auto mode (Enters into soldering mode on the first movement)." + "description": "When the device powers up, should it enter into a special mode. These settings set it to either start into soldering mode, sleeping mode or auto mode (Enters into soldering mode on the first movement)." + }, { "id": "CooldownBlink", From 98f4ab79bd842cc48b1c76a16c6a1a1b14e275b2 Mon Sep 17 00:00:00 2001 From: "Ben V. Brown" <5425387+Ralim@users.noreply.github.com> Date: Fri, 21 Jan 2022 08:47:49 +1100 Subject: [PATCH 21/40] Update Translations/translations_def.js Co-authored-by: discip <53649486+discip@users.noreply.github.com> --- Translations/translations_def.js | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/Translations/translations_def.js b/Translations/translations_def.js index 68fac89e..4757829e 100644 --- a/Translations/translations_def.js +++ b/Translations/translations_def.js @@ -269,7 +269,8 @@ 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 still hot' warning." + "description": "If the idle screen should blink the tip temperature for attention while the tip is over 50°C. Intended as a 'tip is still hot' warning." + }, { "id": "TemperatureCalibration", From dbb2605042cd577a40b702164798bca67dcbfb80 Mon Sep 17 00:00:00 2001 From: "Ben V. Brown" <5425387+Ralim@users.noreply.github.com> Date: Fri, 21 Jan 2022 08:47:58 +1100 Subject: [PATCH 22/40] Update Translations/translations_def.js Co-authored-by: discip <53649486+discip@users.noreply.github.com> --- Translations/translations_def.js | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/Translations/translations_def.js b/Translations/translations_def.js index 4757829e..f6b8812b 100644 --- a/Translations/translations_def.js +++ b/Translations/translations_def.js @@ -276,7 +276,8 @@ var def = "id": "TemperatureCalibration", "maxLen": 8, "maxLen2": 16, - "description": "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 5C off target." + "description": "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." + }, { "id": "SettingsReset", From 59a75bb8d057ee841cb1d65f3638ee994d451cdc Mon Sep 17 00:00:00 2001 From: "Ben V. Brown" <5425387+Ralim@users.noreply.github.com> Date: Fri, 21 Jan 2022 08:55:32 +1100 Subject: [PATCH 23/40] Update Translations/translations_def.js Co-authored-by: discip <53649486+discip@users.noreply.github.com> --- Translations/translations_def.js | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/Translations/translations_def.js b/Translations/translations_def.js index f6b8812b..9a8cde20 100644 --- a/Translations/translations_def.js +++ b/Translations/translations_def.js @@ -250,7 +250,8 @@ var def = "id": "DisplayRotation", "maxLen": 6, "maxLen2": 13, - "description": "If the display should rotate automatically or if it should be fixed into Left or Right handed orientation." + "description": "If the display should rotate automatically or if it should be fixed for left- or right-handed mode." + }, { "id": "BoostTemperature", From d2723ddf61d646769115563b6c9185ae8e15a7af Mon Sep 17 00:00:00 2001 From: "Ben V. Brown" <5425387+Ralim@users.noreply.github.com> Date: Fri, 21 Jan 2022 08:55:45 +1100 Subject: [PATCH 24/40] Update Translations/translations_def.js Co-authored-by: discip <53649486+discip@users.noreply.github.com> --- Translations/translations_def.js | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/Translations/translations_def.js b/Translations/translations_def.js index 9a8cde20..8b29fad2 100644 --- a/Translations/translations_def.js +++ b/Translations/translations_def.js @@ -226,7 +226,8 @@ var def = "id": "ShutdownTimeout", "maxLen": 5, "maxLen2": 11, - "description": "How long of a period of movement/button pressing inactivity is required before the device turns off the tip heater completely and returns to the main idle screen." + "description": "How long of a period without movement / button-pressing is required before the device turns off the tip heater completely and returns to the main idle screen." + }, { "id": "MotionSensitivity", From 58bac37ed7ffa0519e36c09e501d59cfbf17737a Mon Sep 17 00:00:00 2001 From: "Ben V. Brown" <5425387+Ralim@users.noreply.github.com> Date: Fri, 21 Jan 2022 08:55:54 +1100 Subject: [PATCH 25/40] Update Translations/translations_def.js Co-authored-by: discip <53649486+discip@users.noreply.github.com> --- Translations/translations_def.js | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/Translations/translations_def.js b/Translations/translations_def.js index 8b29fad2..33e36cfc 100644 --- a/Translations/translations_def.js +++ b/Translations/translations_def.js @@ -220,7 +220,8 @@ var def = "id": "SleepTimeout", "maxLen": 4, "maxLen2": 9, - "description": "How long of a period of movement/button pressing inactivity is required before the device drops down to the sleep temperature." + "description": "How long of a period without movement / button-pressing is required before the device drops down to the sleep temperature." + }, { "id": "ShutdownTimeout", From 6da9bae3ebb557631d13a781051a6567b01c398b Mon Sep 17 00:00:00 2001 From: "Ben V. Brown" <5425387+Ralim@users.noreply.github.com> Date: Fri, 21 Jan 2022 08:56:02 +1100 Subject: [PATCH 26/40] Update Translations/translations_def.js Co-authored-by: discip <53649486+discip@users.noreply.github.com> --- Translations/translations_def.js | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/Translations/translations_def.js b/Translations/translations_def.js index 33e36cfc..dc514722 100644 --- a/Translations/translations_def.js +++ b/Translations/translations_def.js @@ -194,7 +194,8 @@ var def = "id": "UIMenu", "maxLen": 5, "maxLen2": 11, - "description": "User interface related settings, such as Units." + "description": "User interface related settings, such as units." + }, { "id": "AdvancedMenu", From 2289034e4566fdb7fac25e2c5afa85fceae59cc7 Mon Sep 17 00:00:00 2001 From: "Ben V. Brown" <5425387+Ralim@users.noreply.github.com> Date: Fri, 21 Jan 2022 08:56:11 +1100 Subject: [PATCH 27/40] Update Translations/translations_def.js Co-authored-by: discip <53649486+discip@users.noreply.github.com> --- Translations/translations_def.js | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/Translations/translations_def.js b/Translations/translations_def.js index dc514722..ebfeb38b 100644 --- a/Translations/translations_def.js +++ b/Translations/translations_def.js @@ -241,7 +241,8 @@ var def = "id": "TemperatureUnit", "maxLen": 6, "maxLen2": 13, - "description": "If the device shows temperatures in C or F" + "description": "If the device shows temperatures in °C or °F." + }, { "id": "AdvancedIdle", From c0808e8c9cb4f5621b2b83b16f4c189b41b00c4e Mon Sep 17 00:00:00 2001 From: "Ben V. Brown" <5425387+Ralim@users.noreply.github.com> Date: Fri, 21 Jan 2022 08:56:19 +1100 Subject: [PATCH 28/40] Update Translations/translations_def.js Co-authored-by: discip <53649486+discip@users.noreply.github.com> --- Translations/translations_def.js | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/Translations/translations_def.js b/Translations/translations_def.js index ebfeb38b..5d49ae7f 100644 --- a/Translations/translations_def.js +++ b/Translations/translations_def.js @@ -125,7 +125,8 @@ var def = { "id": "SettingStartSleepOffChar", "len": 1, - "description": "Shown when the auto start state is set to go to an off state but on movement wake into soldering mode." + "description": "Shown when the auto start state is set to go to an off state, but on movement wake into soldering mode." + }, { "id": "SettingStartNoneChar", From 7286ff4db8fb2490166e771878aacbb75fcdf948 Mon Sep 17 00:00:00 2001 From: "Ben V. Brown" <5425387+Ralim@users.noreply.github.com> Date: Fri, 21 Jan 2022 08:56:37 +1100 Subject: [PATCH 29/40] Update Translations/translations_def.js Co-authored-by: discip <53649486+discip@users.noreply.github.com> --- Translations/translations_def.js | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/Translations/translations_def.js b/Translations/translations_def.js index 5d49ae7f..0e65f437 100644 --- a/Translations/translations_def.js +++ b/Translations/translations_def.js @@ -136,7 +136,8 @@ var def = { "id": "SettingSensitivityOff", "len": 1, - "description": "Shown when a sensitivity (hall effect) is disabled. Turning off the sensor." + "description": "Shown when a sensitivity (hall effect sensor) is disabled. Turning off the sensor." + }, { "id": "SettingSensitivityLow", From da5d3ca42baf07234c4d89dce1ab3e02e4e47ad2 Mon Sep 17 00:00:00 2001 From: "Ben V. Brown" <5425387+Ralim@users.noreply.github.com> Date: Fri, 21 Jan 2022 08:56:49 +1100 Subject: [PATCH 30/40] Update Translations/translations_def.js Co-authored-by: discip <53649486+discip@users.noreply.github.com> --- Translations/translations_def.js | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/Translations/translations_def.js b/Translations/translations_def.js index 0e65f437..881e3617 100644 --- a/Translations/translations_def.js +++ b/Translations/translations_def.js @@ -23,7 +23,8 @@ var def = "id": "InputVoltageString", "maxLen": 11, "note": "Preferably end with a space", - "description": "Prefix text for 'Input Voltage' shown before showing the input voltage reading" + "description": "Prefix text for 'Input Voltage' shown before showing the input voltage reading." + }, { "id": "SleepingSimpleString", From 59ef869c339dcf58ac6b3f4193ca4270950546ce Mon Sep 17 00:00:00 2001 From: "Ben V. Brown" <5425387+Ralim@users.noreply.github.com> Date: Fri, 21 Jan 2022 08:57:12 +1100 Subject: [PATCH 31/40] Update Translations/translations_def.js Co-authored-by: discip <53649486+discip@users.noreply.github.com> --- Translations/translations_def.js | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/Translations/translations_def.js b/Translations/translations_def.js index 881e3617..b3f398b6 100644 --- a/Translations/translations_def.js +++ b/Translations/translations_def.js @@ -121,7 +121,8 @@ var def = { "id": "SettingStartSleepChar", "len": 1, - "description": "Shown when the auto start mode is to start in sleep mode." + "description": "Shown when the auto start mode is set to start in sleep mode." + }, { "id": "SettingStartSleepOffChar", From d375c088b1cb16f323ac513cc951c44224c5bd2c Mon Sep 17 00:00:00 2001 From: "Ben V. Brown" <5425387+Ralim@users.noreply.github.com> Date: Fri, 21 Jan 2022 08:59:59 +1100 Subject: [PATCH 32/40] Update Translations/translations_def.js Co-authored-by: discip <53649486+discip@users.noreply.github.com> --- Translations/translations_def.js | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/Translations/translations_def.js b/Translations/translations_def.js index b3f398b6..77590026 100644 --- a/Translations/translations_def.js +++ b/Translations/translations_def.js @@ -160,7 +160,8 @@ var def = "id": "SettingLockDisableChar", "len": 1, "default": "D", - "description": "Shown when locking mode is turned off" + "description": "Shown when locking mode is turned off." + }, { "id": "SettingLockBoostChar", From ca21c4859d8f9b6f0223163a23fe980d0d7d3012 Mon Sep 17 00:00:00 2001 From: "Ben V. Brown" <5425387+Ralim@users.noreply.github.com> Date: Fri, 21 Jan 2022 09:00:12 +1100 Subject: [PATCH 33/40] Update Translations/translations_def.js Co-authored-by: discip <53649486+discip@users.noreply.github.com> --- Translations/translations_def.js | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/Translations/translations_def.js b/Translations/translations_def.js index 77590026..08864e1e 100644 --- a/Translations/translations_def.js +++ b/Translations/translations_def.js @@ -311,7 +311,8 @@ var def = "id": "ScrollingSpeed", "maxLen": 6, "maxLen2": 11, - "description": "How fast the description text scrolls when hovering on a menu. Faster speeds may induce tearing but allow reading the whole description faster." + "description": "How fast the description text scrolls when hovering on a menu. Faster speeds may induce tearing, but allow reading the whole description faster." + }, { "id": "QCMaxVoltage", From 5f52141a42bdd1d89707c9215d02a78d63668002 Mon Sep 17 00:00:00 2001 From: "Ben V. Brown" <5425387+Ralim@users.noreply.github.com> Date: Fri, 21 Jan 2022 09:00:19 +1100 Subject: [PATCH 34/40] Update Translations/translations_def.js Co-authored-by: discip <53649486+discip@users.noreply.github.com> --- Translations/translations_def.js | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/Translations/translations_def.js b/Translations/translations_def.js index 08864e1e..16846a61 100644 --- a/Translations/translations_def.js +++ b/Translations/translations_def.js @@ -331,7 +331,8 @@ var def = "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 device to aim to keep the AVERAGE power below. The unit can't 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", From 021eb1a7e655b7603177cb6190d6e5bff3d271e6 Mon Sep 17 00:00:00 2001 From: "Ben V. Brown" <5425387+Ralim@users.noreply.github.com> Date: Fri, 21 Jan 2022 09:00:30 +1100 Subject: [PATCH 35/40] Update Translations/translations_def.js Co-authored-by: discip <53649486+discip@users.noreply.github.com> --- Translations/translations_def.js | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/Translations/translations_def.js b/Translations/translations_def.js index 16846a61..5d37fc67 100644 --- a/Translations/translations_def.js +++ b/Translations/translations_def.js @@ -344,7 +344,8 @@ var def = "id": "TempChangeShortStep", "maxLen": 8, "maxLen2": 16, - "description": "How much the temperature is increased with a quick press of the buttons." + "description": "Factor by which the temperature is changed with a quick press of the buttons." + }, { "id": "TempChangeLongStep", From 7ced8531c5ec312dafae1ab41354b07aff908fcc Mon Sep 17 00:00:00 2001 From: "Ben V. Brown" <5425387+Ralim@users.noreply.github.com> Date: Fri, 21 Jan 2022 09:00:52 +1100 Subject: [PATCH 36/40] Update Translations/translations_def.js Co-authored-by: discip <53649486+discip@users.noreply.github.com> --- Translations/translations_def.js | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/Translations/translations_def.js b/Translations/translations_def.js index 5d37fc67..d567720c 100644 --- a/Translations/translations_def.js +++ b/Translations/translations_def.js @@ -324,7 +324,8 @@ 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. Recommended keeping to small values." + "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 values." + }, { From 1757ad442f2849d254fd7e9cf79d665c7d925e57 Mon Sep 17 00:00:00 2001 From: "Ben V. Brown" <5425387+Ralim@users.noreply.github.com> Date: Fri, 21 Jan 2022 09:09:04 +1100 Subject: [PATCH 37/40] Update Translations/translations_def.js Co-authored-by: discip <53649486+discip@users.noreply.github.com> --- Translations/translations_def.js | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/Translations/translations_def.js b/Translations/translations_def.js index d567720c..e99bb3e2 100644 --- a/Translations/translations_def.js +++ b/Translations/translations_def.js @@ -364,7 +364,8 @@ var def = "id": "HallEffSensitivity", "maxLen": 6, "maxLen2": 8, - "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." + "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." + }, { "id": "LockingMode", From eb75a96671a4e17052d7d812319341aebe7ad3b6 Mon Sep 17 00:00:00 2001 From: "Ben V. Brown" <5425387+Ralim@users.noreply.github.com> Date: Fri, 21 Jan 2022 09:09:10 +1100 Subject: [PATCH 38/40] Update Translations/translations_def.js Co-authored-by: discip <53649486+discip@users.noreply.github.com> --- Translations/translations_def.js | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/Translations/translations_def.js b/Translations/translations_def.js index e99bb3e2..6330fd4c 100644 --- a/Translations/translations_def.js +++ b/Translations/translations_def.js @@ -358,7 +358,8 @@ var def = "id": "PowerPulsePower", "maxLen": 6, "maxLen2": 16, - "description": "Enables and sets the wattage of the power pulse. Power pulse causes the iron to briefly turn on the heater to draw power to avoid power banks going to sleep." + "description": "Enables and sets the wattage of the power pulse. Power pulse causes the device to briefly turn on the heater to draw power to avoid power banks going to sleep." + }, { "id": "HallEffSensitivity", From 4a5afc63019dc0d1af95388fc66b4e9e0fba44ab Mon Sep 17 00:00:00 2001 From: "Ben V. Brown" <5425387+Ralim@users.noreply.github.com> Date: Fri, 21 Jan 2022 09:09:18 +1100 Subject: [PATCH 39/40] Update Translations/translations_def.js Co-authored-by: discip <53649486+discip@users.noreply.github.com> --- Translations/translations_def.js | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/Translations/translations_def.js b/Translations/translations_def.js index 6330fd4c..78aaf327 100644 --- a/Translations/translations_def.js +++ b/Translations/translations_def.js @@ -352,7 +352,8 @@ var def = "id": "TempChangeLongStep", "maxLen": 6, "maxLen2": 16, - "description": "How much the temperature is increased with a long hold of the buttons." + "description": "Factor by which the temperature is changed with a hold of the buttons." + }, { "id": "PowerPulsePower", From f71ec30ed0e7b34c7ad95291e90d93e48a70e1ca Mon Sep 17 00:00:00 2001 From: "Ben V. Brown" Date: Fri, 21 Jan 2022 09:20:56 +1100 Subject: [PATCH 40/40] new settings --- Documentation/Settings.md | 30 +++++++++++++++--------------- 1 file changed, 15 insertions(+), 15 deletions(-) diff --git a/Documentation/Settings.md b/Documentation/Settings.md index 75f8ed00..ebcdaa6a 100644 --- a/Documentation/Settings.md +++ b/Documentation/Settings.md @@ -22,7 +22,7 @@ Settings to do with power saving, such as sleep mode, sleep temps, and shutdown ### Category: User interface -User interface related settings, such as Units. +User interface related settings, such as units. ### Category: Advanced settings @@ -55,7 +55,7 @@ Tip temperature while in "sleep mode" ### Setting: Sleep timeout -How long of a period of movement/button pressing inactivity is required before the device drops down to the sleep temperature. +How long of a period without movement / button-pressing 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 of a period of movement/button pressing inactivity is required before the device turns off the tip heater completely and returns to the main idle screen. +How long of a period without movement / button-pressing is required before the device turns off the tip heater completely and returns to the main idle screen. On device help text: @@ -79,7 +79,7 @@ On device help text: ### Setting: Temperature unit -If the device shows temperatures in C or F +If the device shows temperatures in °C or °F. On device help text: @@ -95,7 +95,7 @@ Display detailed information in a smaller font on the idle screen ### Setting: Display orientation -If the display should rotate automatically or if it should be fixed into Left or Right handed orientation. +If the display should rotate automatically or if it should be fixed for left- or right-handed mode. On device help text: @@ -111,7 +111,7 @@ Temperature used in "boost mode" ### Setting: Heat on power up -When the device powers up, should it enter into a special mode. These settings set it to either start into Soldering mode, sleeping mode, Auto mode (Enters into soldering mode on the first movement). +When the device powers up, should it enter into a special mode. These settings set it to either start into soldering mode, sleeping mode or auto mode (Enters into soldering mode on the first movement). 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 still hot' warning. +If the idle screen should blink the tip temperature for attention while the tip is over 50°C. Intended as a 'tip is still hot' warning. On device help text: @@ -127,7 +127,7 @@ Flash the temperature reading after heating was halted while the tip is still ho ### Setting: Calibrate temperature? -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 5C off target. +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: @@ -159,7 +159,7 @@ Display detailed information in a smaller font on soldering screen ### Setting: Scrolling speed -How fast the description text scrolls when hovering on a menu. Faster speeds may induce tearing but allow reading the whole description faster. +How fast the description text scrolls when hovering on a menu. Faster speeds may induce tearing, but allow reading the whole description faster. 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. Recommended keeping to small values. +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 values. 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 device to aim to keep the AVERAGE power below. The unit can't 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: @@ -199,7 +199,7 @@ Reverse assignment of buttons for temperature adjustment ### Setting: Temp change short -How much the temperature is increased with a quick press of the buttons. +Factor by which the temperature is changed with a quick press of the buttons. On device help text: @@ -207,7 +207,7 @@ Temperature-change-increment on short button press ### Setting: Temp change long -How much the temperature is increased with a long hold of the buttons. +Factor by which the temperature is changed with a hold of the buttons. On device help text: @@ -215,7 +215,7 @@ Temperature-change-increment on long button press ### Setting: Power pulse -Enables and sets the wattage of the power pulse. Power pulse causes the iron to briefly turn on the heater to draw power to avoid power banks going to sleep. +Enables and sets the wattage of the power pulse. Power pulse causes the device to briefly turn on the heater to draw power to avoid power banks going to sleep. On device help text: @@ -223,7 +223,7 @@ Intensity of power of keep-awake-pulse (watt) ### Setting: Hall sensor sensitivity -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. +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. On device help text: