From dff8ab67576f0f1f98a58ed063d61e98db619580 Mon Sep 17 00:00:00 2001 From: River B <97197236+River-b@users.noreply.github.com> Date: Wed, 24 Aug 2022 20:04:45 -0700 Subject: [PATCH 01/28] Delete translation_EN.json --- Translations/translation_EN.json | 207 ------------------------------- 1 file changed, 207 deletions(-) delete mode 100644 Translations/translation_EN.json diff --git a/Translations/translation_EN.json b/Translations/translation_EN.json deleted file mode 100644 index 8e570a5f3a..0000000000 --- a/Translations/translation_EN.json +++ /dev/null @@ -1,207 +0,0 @@ -{ - "languageCode": "EN", - "languageLocalName": "English", - "fonts": ["ascii_basic"], - "tempUnitFahrenheit": true, - "messages": { - "SettingsCalibrationWarning": "Please ensure the tip is at room temperature, before proceeding!", - "SettingsResetWarning": "Are you sure you want to restore default settings?", - "UVLOWarningString": "DC LOW", - "UndervoltageString": "Undervoltage", - "InputVoltageString": "Input V: ", - "SleepingSimpleString": "Zzzz", - "SleepingAdvancedString": "Sleeping...", - "SleepingTipAdvancedString": "Tip:", - "OffString": "Off" - }, - "messagesWarn": { - "ResetOKMessage": "Reset OK", - "SettingsResetMessage": ["Certain settings", "were changed!"], - "NoAccelerometerMessage": ["No accelerometer", "detected!"], - "NoPowerDeliveryMessage": ["No USB-PD IC", "detected!"], - "LockingKeysString": "LOCKED", - "UnlockingKeysString": "UNLOCKED", - "WarningKeysLockedString": "!LOCKED!", - "WarningThermalRunaway": ["Thermal", "Runaway"] - }, - "characters": { - "SettingRightChar": "R", - "SettingLeftChar": "L", - "SettingAutoChar": "A", - "SettingOffChar": "O", - "SettingSlowChar": "S", - "SettingMediumChar": "M", - "SettingFastChar": "F", - "SettingStartNoneChar": "O", - "SettingStartSolderingChar": "S", - "SettingStartSleepChar": "Z", - "SettingStartSleepOffChar": "R", - "SettingSensitivityOff": "O", - "SettingSensitivityLow": "L", - "SettingSensitivityMedium": "M", - "SettingSensitivityHigh": "H", - "SettingLockDisableChar": "D", - "SettingLockBoostChar": "B", - "SettingLockFullChar": "F" - }, - "menuGroups": { - "PowerMenu": { - "text2": ["Power", "settings"], - "desc": "Power settings" - }, - "SolderingMenu": { - "text2": ["Soldering", "settings"], - "desc": "Soldering settings" - }, - "PowerSavingMenu": { - "text2": ["Sleep", "mode"], - "desc": "Power saving settings" - }, - "UIMenu": { - "text2": ["User", "interface"], - "desc": "User interface settings" - }, - "AdvancedMenu": { - "text2": ["Advanced", "settings"], - "desc": "Advanced settings" - } - }, - "menuOptions": { - "DCInCutoff": { - "text2": ["Power", "source"], - "desc": "Power source. Sets cutoff voltage. (DC 10V) (S 3.3V per cell, disable power limit)" - }, - "SleepTemperature": { - "text2": ["Sleep", "temp"], - "desc": "Tip temperature while in \"sleep mode\"" - }, - "SleepTimeout": { - "text2": ["Sleep", "timeout"], - "desc": "Interval before \"sleep mode\" kicks in (s=seconds | m=minutes)" - }, - "ShutdownTimeout": { - "text2": ["Shutdown", "timeout"], - "desc": "Interval before the iron shuts down (m=minutes)" - }, - "MotionSensitivity": { - "text2": ["Motion", "sensitivity"], - "desc": "0=off | 1=least sensitive | ... | 9=most sensitive" - }, - "TemperatureUnit": { - "text2": ["Temperature", "unit"], - "desc": "C=Celsius | F=Fahrenheit" - }, - "AdvancedIdle": { - "text2": ["Detailed", "idle screen"], - "desc": "Display detailed information in a smaller font on the idle screen" - }, - "DisplayRotation": { - "text2": ["Display", "orientation"], - "desc": "R=right-handed | L=left-handed | A=automatic" - }, - "BoostTemperature": { - "text2": ["Boost", "temp"], - "desc": "Tip temperature used in \"boost mode\"" - }, - "AutoStart": { - "text2": ["Start-up", "behavior"], - "desc": "O=off | S=heat up to soldering temp | Z=standby at sleep temp until moved | R=standby without heating until moved" - }, - "CooldownBlink": { - "text2": ["Cooldown", "flashing"], - "desc": "Flash the temperature reading after heating was halted while the tip is still hot" - }, - "TemperatureCalibration": { - "text2": ["Calibrate", "temperature?"], - "desc": "Start tip temperature offset calibration" - }, - "SettingsReset": { - "text2": ["Restore factory", "settings?"], - "desc": "Reset all settings to default" - }, - "VoltageCalibration": { - "text2": ["Calibrate", "input voltage?"], - "desc": "Start VIN calibration (long press to exit)" - }, - "AdvancedSoldering": { - "text2": ["Detailed", "solder screen"], - "desc": "Display detailed information in a smaller font on soldering screen" - }, - "ScrollingSpeed": { - "text2": ["Scrolling", "speed"], - "desc": "Speed info text scrolls past at (S=slow | F=fast)" - }, - "QCMaxVoltage": { - "text2": ["QC", "voltage"], - "desc": "Max QC voltage the iron should negotiate for" - }, - "PDNegTimeout": { - "text2": ["PD", "timeout"], - "desc": "PD negotiation timeout in 100ms steps for compatibility with some QC chargers" - }, - "PowerLimit": { - "text2": ["Power", "limit"], - "desc": "Maximum power the iron can use (W=watt)" - }, - "ReverseButtonTempChange": { - "text2": ["Swap", "+ - keys"], - "desc": "Reverse assignment of buttons for temperature adjustment" - }, - "TempChangeShortStep": { - "text2": ["Temp change", "short"], - "desc": "Temperature-change-increment on short button press" - }, - "TempChangeLongStep": { - "text2": ["Temp change", "long"], - "desc": "Temperature-change-increment on long button press" - }, - "PowerPulsePower": { - "text2": ["Power", "pulse"], - "desc": "Intensity of power of keep-awake-pulse (watt)" - }, - "HallEffSensitivity": { - "text2": ["Hall sensor", "sensitivity"], - "desc": "Sensitivity of the Hall effect sensor to detect sleep (0=off | 1=least sensitive | ... | 9=most sensitive)" - }, - "LockingMode": { - "text2": ["Allow locking", "buttons"], - "desc": "While soldering, hold down both buttons to toggle locking them (D=disable | B=boost mode only | F=full locking)" - }, - "MinVolCell": { - "text2": ["Minimum", "voltage"], - "desc": "Minimum allowed voltage per cell (3S: 3 - 3.7V | 4-6S: 2.4 - 3.7V)" - }, - "AnimLoop": { - "text2": ["Anim.", "loop"], - "desc": "Loop icon animations in main menu" - }, - "AnimSpeed": { - "text2": ["Anim.", "speed"], - "desc": "Pace of icon animations in menu (O=off | S=slow | M=medium | F=fast)" - }, - "PowerPulseWait": { - "text2": ["Power pulse", "delay"], - "desc": "Delay before keep-awake-pulse is triggered (x 2.5s)" - }, - "PowerPulseDuration": { - "text2": ["Power pulse", "duration"], - "desc": "Keep-awake-pulse duration (x 250ms)" - }, - "LanguageSwitch": { - "text2": ["Language:", " EN English"], - "desc": "Current firmware language" - }, - "Brightness": { - "text2": ["Screen", "brightness"], - "desc": "Adjust the brightness of the OLED screen" - }, - "ColourInversion": { - "text2": ["Invert", "screen"], - "desc": "Invert the colours of the OLED screen" - }, - "LOGOTime": { - "text2": ["Boot logo", "duration"], - "desc": "Sets the duration for the boot logo (s=seconds)" - } - } -} From b1ba1665b550bc6f15d3c3ae57a04cdc94f996b9 Mon Sep 17 00:00:00 2001 From: River B <97197236+River-b@users.noreply.github.com> Date: Wed, 24 Aug 2022 20:05:24 -0700 Subject: [PATCH 02/28] Add files via upload --- Translations/translation_EN.json | 339 +++++++++++++++++++++++++++++++ 1 file changed, 339 insertions(+) create mode 100644 Translations/translation_EN.json diff --git a/Translations/translation_EN.json b/Translations/translation_EN.json new file mode 100644 index 0000000000..035c3f310b --- /dev/null +++ b/Translations/translation_EN.json @@ -0,0 +1,339 @@ +{ + "languageCode": "EN", + "languageLocalName": "English", + "fonts": [ + "ascii_basic" + ], + "tempUnitFahrenheit": true, + "messages": { + "SettingsCalibrationWarning": "Warning: tip & handle must be at room temperature before starting!", + "SettingsResetWarning": "Are you sure you want to restore default settings?", + "UVLOWarningString": "DC LOW", + "UndervoltageString": "Undervoltage", + "InputVoltageString": "Input V: ", + "SleepingSimpleString": "Zzzz", + "SleepingAdvancedString": "Sleeping...", + "SleepingTipAdvancedString": "Tip:", + "OffString": "Off", + "DeviceFailedValidationWarning": "" + }, + "messagesWarn": { + "ResetOKMessage": "Reset OK", + "SettingsResetMessage": [ + "Certain settings", + "were changed!" + ], + "NoAccelerometerMessage": [ + "No accelerometer", + "detected!" + ], + "NoPowerDeliveryMessage": [ + "No USB-PD IC", + "detected!" + ], + "LockingKeysString": "LOCKED", + "UnlockingKeysString": "UNLOCKED", + "WarningKeysLockedString": "!LOCKED!", + "WarningThermalRunaway": [ + "Thermal", + "Runaway" + ] + }, + "characters": { + "SettingRightChar": "R", + "SettingLeftChar": "L", + "SettingAutoChar": "A", + "SettingOffChar": "O", + "SettingSlowChar": "S", + "SettingMediumChar": "M", + "SettingFastChar": "F", + "SettingStartNoneChar": "O", + "SettingStartSolderingChar": "S", + "SettingStartSleepChar": "Z", + "SettingStartSleepOffChar": "R", + "SettingSensitivityOff": "O", + "SettingSensitivityLow": "L", + "SettingSensitivityMedium": "M", + "SettingSensitivityHigh": "H", + "SettingLockDisableChar": "D", + "SettingLockBoostChar": "B", + "SettingLockFullChar": "F" + }, + "menuGroups": { + "PowerMenu": { + "text2": [ + "Power", + "settings" + ], + "desc": "Power settings" + }, + "SolderingMenu": { + "text2": [ + "Soldering", + "settings" + ], + "desc": "Soldering settings" + }, + "PowerSavingMenu": { + "text2": [ + "Sleep", + "mode" + ], + "desc": "Power saving settings" + }, + "UIMenu": { + "text2": [ + "User", + "interface" + ], + "desc": "User interface settings" + }, + "AdvancedMenu": { + "text2": [ + "Advanced", + "settings" + ], + "desc": "Advanced settings" + } + }, + "menuOptions": { + "DCInCutoff": { + "text2": [ + "Power", + "source" + ], + "desc": "Power source. Sets cutoff voltage. (DC 10V) (S 3.3V per cell, disable power limit)" + }, + "SleepTemperature": { + "text2": [ + "Sleep", + "temp" + ], + "desc": "Tip temperature while in \"sleep mode\"" + }, + "SleepTimeout": { + "text2": [ + "Sleep", + "timeout" + ], + "desc": "Interval before \"sleep mode\" kicks in (s=seconds | m=minutes)" + }, + "ShutdownTimeout": { + "text2": [ + "Shutdown", + "timeout" + ], + "desc": "Interval before the iron shuts down (m=minutes)" + }, + "MotionSensitivity": { + "text2": [ + "Motion", + "sensitivity" + ], + "desc": "0=off | 1=least sensitive | ... | 9=most sensitive" + }, + "TemperatureUnit": { + "text2": [ + "Temperature", + "unit" + ], + "desc": "C=Celsius | F=Fahrenheit" + }, + "AdvancedIdle": { + "text2": [ + "Detailed", + "idle screen" + ], + "desc": "Display detailed information in a smaller font on the idle screen" + }, + "DisplayRotation": { + "text2": [ + "Display", + "orientation" + ], + "desc": "R=right-handed | L=left-handed | A=automatic" + }, + "BoostTemperature": { + "text2": [ + "Boost", + "temp" + ], + "desc": "Tip temperature used in \"boost mode\"" + }, + "AutoStart": { + "text2": [ + "Start-up", + "behavior" + ], + "desc": "O=off | S=heat up to soldering temp | Z=standby at sleep temp until moved | R=standby without heating until moved" + }, + "CooldownBlink": { + "text2": [ + "Cooldown", + "flashing" + ], + "desc": "Flash the temperature reading after heating was halted while the tip is still hot" + }, + "TemperatureCalibration": { + "text2": [ + "Calibrate", + "Tip Offset?" + ], + "desc": "Calibrate tip temperature offset; not required unless device > 5°C off target" + }, + "SettingsReset": { + "text2": [ + "Restore factory", + "settings?" + ], + "desc": "Reset all settings to default" + }, + "VoltageCalibration": { + "text2": [ + "Calibrate", + "input voltage?" + ], + "desc": "Start V-IN calibration (long press to exit)" + }, + "AdvancedSoldering": { + "text2": [ + "Detailed", + "solder screen" + ], + "desc": "Display detailed information in a smaller font on soldering screen" + }, + "ScrollingSpeed": { + "text2": [ + "Scrolling", + "speed" + ], + "desc": "Speed info text scrolls past at (S=slow | F=fast)" + }, + "QCMaxVoltage": { + "text2": [ + "QC", + "voltage" + ], + "desc": "Max QC voltage the iron should negotiate for" + }, + "PDNegTimeout": { + "text2": [ + "PD", + "timeout" + ], + "desc": "PD negotiation timeout in 100ms steps for compatibility with some QC chargers" + }, + "PowerLimit": { + "text2": [ + "Power", + "limit" + ], + "desc": "Maximum power the iron can use (W=watt)" + }, + "ReverseButtonTempChange": { + "text2": [ + "Swap", + "+ - keys" + ], + "desc": "Reverse assignment of buttons for temperature adjustment" + }, + "TempChangeShortStep": { + "text2": [ + "Temp change", + "short" + ], + "desc": "Temperature-change-increment on short button press" + }, + "TempChangeLongStep": { + "text2": [ + "Temp change", + "long" + ], + "desc": "Temperature-change-increment on long button press" + }, + "PowerPulsePower": { + "text2": [ + "Power", + "pulse" + ], + "desc": "Intensity of power of keep-awake-pulse (watt)" + }, + "HallEffSensitivity": { + "text2": [ + "Hall Effect", + "sensitivity" + ], + "desc": "Sensitivity to magnets (0=off | 1=least sensitive | ... | 9=most sensitive)" + }, + "LockingMode": { + "text2": [ + "Allow locking", + "buttons" + ], + "desc": "While soldering, hold down both buttons to toggle locking them (D=disable | B=boost mode only | F=full locking)" + }, + "MinVolCell": { + "text2": [ + "Minimum", + "voltage" + ], + "desc": "Minimum allowed voltage per cell (3S: 3 - 3.7V | 4-6S: 2.4 - 3.7V)" + }, + "AnimLoop": { + "text2": [ + "Anim.", + "loop" + ], + "desc": "Loop icon animations in main menu" + }, + "AnimSpeed": { + "text2": [ + "Anim.", + "speed" + ], + "desc": "Pace of icon animations in menu (O=off | S=slow | M=medium | F=fast)" + }, + "PowerPulseWait": { + "text2": [ + "Power pulse", + "delay" + ], + "desc": "Delay before keep-awake-pulse is triggered (x 2.5s)" + }, + "PowerPulseDuration": { + "text2": [ + "Power pulse", + "duration" + ], + "desc": "Keep-awake-pulse duration (x 250ms)" + }, + "LanguageSwitch": { + "text2": [ + "Language:", + " EN English" + ], + "desc": "Current firmware language" + }, + "Brightness": { + "text2": [ + "Screen", + "brightness" + ], + "desc": "Adjust the brightness of the OLED screen" + }, + "ColourInversion": { + "text2": [ + "Invert", + "screen" + ], + "desc": "Invert the colours of the OLED screen" + }, + "LOGOTime": { + "text2": [ + "Boot logo", + "duration" + ], + "desc": "Sets the duration for the boot logo (s=seconds)" + } + } +} \ No newline at end of file From 86ecf0f80cc215407352fba83683aafd6778602f Mon Sep 17 00:00:00 2001 From: River B <97197236+River-b@users.noreply.github.com> Date: Wed, 24 Aug 2022 20:31:00 -0700 Subject: [PATCH 03/28] Update Settings.md --- Documentation/Settings.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/Documentation/Settings.md b/Documentation/Settings.md index 9faaf67514..40afeab97f 100644 --- a/Documentation/Settings.md +++ b/Documentation/Settings.md @@ -125,13 +125,13 @@ On device help text: Flash the temperature reading after heating was halted while the tip is still hot -### Setting: Calibrate temperature? +### Setting: Calibrate Tip Offset? -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. +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 temperature*. On device help text: -Start tip temperature offset calibration +Calibrate tip temperature offset; not required unless device > 5°C off target ### Setting: Restore factory settings? From f1e314a71e920a648e8db03c41fc4078ad7f2aee Mon Sep 17 00:00:00 2001 From: River B <97197236+River-b@users.noreply.github.com> Date: Wed, 24 Aug 2022 20:32:52 -0700 Subject: [PATCH 04/28] Update translation_EN.json --- Translations/translation_EN.json | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/Translations/translation_EN.json b/Translations/translation_EN.json index 035c3f310b..e396d4c74e 100644 --- a/Translations/translation_EN.json +++ b/Translations/translation_EN.json @@ -193,7 +193,7 @@ "Calibrate", "input voltage?" ], - "desc": "Start V-IN calibration (long press to exit)" + "desc": "Start VIN calibration (long press to exit)" }, "AdvancedSoldering": { "text2": [ @@ -336,4 +336,4 @@ "desc": "Sets the duration for the boot logo (s=seconds)" } } -} \ No newline at end of file +} From 418065f47d3e52ff478785de98cf0cff9e115470 Mon Sep 17 00:00:00 2001 From: River B <97197236+River-b@users.noreply.github.com> Date: Thu, 25 Aug 2022 17:13:58 -0700 Subject: [PATCH 05/28] Update Settings.md --- Documentation/Settings.md | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/Documentation/Settings.md b/Documentation/Settings.md index 40afeab97f..468a685c5d 100644 --- a/Documentation/Settings.md +++ b/Documentation/Settings.md @@ -127,10 +127,9 @@ Flash the temperature reading after heating was halted while the tip is still ho ### Setting: Calibrate Tip Offset? -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 temperature*. +Used to calibrate the ADC + Op-amp offsets for the tip. This calibration should only be performed when the tip and handle temperature are equal and at room/ambient temperature. Generally *not required unless your device is reading more than 5°C off target temperature*. This is intended to be performed at boot-up before internal components get warm. Avoid repeating the calibration, but if you must repeat it, unplug the unit, and wait for everything to go back to room temperature. On device help text: - Calibrate tip temperature offset; not required unless device > 5°C off target ### Setting: Restore factory settings? From 2c5a7a64570c3f3aaba85e96f2be6625aa272ca7 Mon Sep 17 00:00:00 2001 From: River B <97197236+River-b@users.noreply.github.com> Date: Sun, 28 Aug 2022 14:57:57 -0700 Subject: [PATCH 06/28] 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 f6a90e3d85..109392d8c0 100644 --- a/Translations/translation_EN.json +++ b/Translations/translation_EN.json @@ -338,7 +338,7 @@ } } } -======= + { "languageCode": "EN", "languageLocalName": "English", From 42a79398e62095f7b4a863e94aaff82ef2333230 Mon Sep 17 00:00:00 2001 From: River B <97197236+River-b@users.noreply.github.com> Date: Sun, 28 Aug 2022 15:12:22 -0700 Subject: [PATCH 07/28] Update translation_EN.json --- Translations/translation_EN.json | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/Translations/translation_EN.json b/Translations/translation_EN.json index 109392d8c0..7bdbdce188 100644 --- a/Translations/translation_EN.json +++ b/Translations/translation_EN.json @@ -180,7 +180,7 @@ "Calibrate", "Tip Offset?" ], - "desc": "Calibrate tip temperature offset; not required unless device > 5 C off target" + "desc": "Calibrate tip temperature offset; only required if device is more than 5 C off target" }, "SettingsReset": { "text2": [ @@ -327,7 +327,7 @@ "Invert", "screen" ], - "desc": "Invert OLED screen colors black/white" + "desc": "Invert OLED screen colors black|white" }, "LOGOTime": { "text2": [ @@ -348,7 +348,7 @@ ], "tempUnitFahrenheit": true, "messages": { - "SettingsCalibrationWarning": "Please make absolutely sure the tip and handle are at room temperature before proceeding!", + "SettingsCalibrationWarning": "Please make absolutely sure the tip & handle are at room temperature before proceeding!", "SettingsResetWarning": "Are you sure you want to restore default settings?", "UVLOWarningString": "DC LOW", "UndervoltageString": "Undervoltage", @@ -521,7 +521,7 @@ "Calibrate", "temperature" ], - "desc": "Calibrate tip Cold Junction Compensation (not required if Delta T is < 5 C)" + "desc": "Calibrate tip Cold Junction Compensation (not required if Delta Temp is < 5 C)" }, "SettingsReset": { "text2": [ @@ -668,7 +668,7 @@ "Invert", "screen" ], - "desc": "Invert OLED screen colors black/white" + "desc": "Invert OLED screen colors black | white" }, "LOGOTime": { "text2": [ From 9b9206b48ab9e4743d6c3c13490053d5c3ffeee8 Mon Sep 17 00:00:00 2001 From: River B <97197236+River-b@users.noreply.github.com> Date: Sun, 28 Aug 2022 15:14:39 -0700 Subject: [PATCH 08/28] 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 7bdbdce188..37ffd35aeb 100644 --- a/Translations/translation_EN.json +++ b/Translations/translation_EN.json @@ -521,7 +521,7 @@ "Calibrate", "temperature" ], - "desc": "Calibrate tip Cold Junction Compensation (not required if Delta Temp is < 5 C)" + "desc": "Calibrate tip Cold Junction Compensation (not required if Delta Temp is less than 5 C)" }, "SettingsReset": { "text2": [ From c9de9e44f9a1ccc8045e756c9f6b1e1a5ccdebc3 Mon Sep 17 00:00:00 2001 From: River B <97197236+River-b@users.noreply.github.com> Date: Sun, 28 Aug 2022 15:19:44 -0700 Subject: [PATCH 09/28] Update Settings.md --- Documentation/Settings.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/Documentation/Settings.md b/Documentation/Settings.md index 468a685c5d..04d2429fde 100644 --- a/Documentation/Settings.md +++ b/Documentation/Settings.md @@ -125,12 +125,12 @@ On device help text: Flash the temperature reading after heating was halted while the tip is still hot -### Setting: Calibrate Tip Offset? +### Setting: Calibrate Tip Temperature Offset? -Used to calibrate the ADC + Op-amp offsets for the tip. This calibration should only be performed when the tip and handle temperature are equal and at room/ambient temperature. Generally *not required unless your device is reading more than 5°C off target temperature*. This is intended to be performed at boot-up before internal components get warm. Avoid repeating the calibration, but if you must repeat it, unplug the unit, and wait for everything to go back to room temperature. +Used to calibrate the ADC + Op-amp offsets for the tip. This calibration should only be performed when the tip and handle temperature are equal and at room/ambient temperature. Generally *not required unless your device is reading more than 5 °C off target temperature*. This is intended to be performed at boot-up before internal components get warm. Avoid repeating the calibration, but if you must repeat it, unplug the unit, and wait for everything to go back to room temperature. On device help text: -Calibrate tip temperature offset; not required unless device > 5°C off target +Calibrate tip temperature offset; not required unless device > 5 C off target ### Setting: Restore factory settings? From ee42d4ca9b42bbd7a7fb1775827ebd58be179cc5 Mon Sep 17 00:00:00 2001 From: River B <97197236+River-b@users.noreply.github.com> Date: Sun, 28 Aug 2022 15:29:30 -0700 Subject: [PATCH 10/28] Update translation_EN.json --- Translations/translation_EN.json | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/Translations/translation_EN.json b/Translations/translation_EN.json index 37ffd35aeb..cef923964e 100644 --- a/Translations/translation_EN.json +++ b/Translations/translation_EN.json @@ -7,7 +7,7 @@ ], "tempUnitFahrenheit": true, "messages": { - "SettingsCalibrationWarning": "Warning: tip & handle must be at room temperature before starting!", + "SettingsCalibrationWarning": "Warning: tip & device must be at room temperature before starting!", "SettingsResetWarning": "Are you sure you want to restore default settings?", "UVLOWarningString": "DC LOW", "UndervoltageString": "Undervoltage", @@ -180,7 +180,7 @@ "Calibrate", "Tip Offset?" ], - "desc": "Calibrate tip temperature offset; only required if device is more than 5 C off target" + "desc": "Calibrate tip temperature offset; not needed if device is within 5 C" }, "SettingsReset": { "text2": [ @@ -348,7 +348,7 @@ ], "tempUnitFahrenheit": true, "messages": { - "SettingsCalibrationWarning": "Please make absolutely sure the tip & handle are at room temperature before proceeding!", + "SettingsCalibrationWarning": "Confirm, tip & device are at room temperature before starting!", "SettingsResetWarning": "Are you sure you want to restore default settings?", "UVLOWarningString": "DC LOW", "UndervoltageString": "Undervoltage", @@ -521,7 +521,7 @@ "Calibrate", "temperature" ], - "desc": "Calibrate tip Cold Junction Compensation (not required if Delta Temp is less than 5 C)" + "desc": "Calibrate tip Cold Junction Compensation (not required if temp is within 5 C)" }, "SettingsReset": { "text2": [ From 421b34201bcad6f8194504d8fde3537f679c16cb Mon Sep 17 00:00:00 2001 From: River B <97197236+River-b@users.noreply.github.com> Date: Sun, 28 Aug 2022 15:48:27 -0700 Subject: [PATCH 11/28] Update translation_EN.json --- Translations/translation_EN.json | 349 +------------------------------ 1 file changed, 4 insertions(+), 345 deletions(-) diff --git a/Translations/translation_EN.json b/Translations/translation_EN.json index cef923964e..7ece63327e 100644 --- a/Translations/translation_EN.json +++ b/Translations/translation_EN.json @@ -1,344 +1,3 @@ - -{ - "languageCode": "EN", - "languageLocalName": "English", - "fonts": [ - "ascii_basic" - ], - "tempUnitFahrenheit": true, - "messages": { - "SettingsCalibrationWarning": "Warning: tip & device must be at room temperature before starting!", - "SettingsResetWarning": "Are you sure you want to restore default settings?", - "UVLOWarningString": "DC LOW", - "UndervoltageString": "Undervoltage", - "InputVoltageString": "Input V: ", - "SleepingSimpleString": "Zzzz", - "SleepingAdvancedString": "Sleeping...", - "SleepingTipAdvancedString": "Tip:", - "OffString": "Off", - "DeviceFailedValidationWarning": "" - }, - "messagesWarn": { - "ResetOKMessage": "Reset OK", - "SettingsResetMessage": [ - "Certain settings", - "were changed!" - ], - "NoAccelerometerMessage": [ - "No accelerometer", - "detected!" - ], - "NoPowerDeliveryMessage": [ - "No USB-PD IC", - "detected!" - ], - "LockingKeysString": "LOCKED", - "UnlockingKeysString": "UNLOCKED", - "WarningKeysLockedString": "!LOCKED!", - "WarningThermalRunaway": [ - "Thermal", - "Runaway" - ] - }, - "characters": { - "SettingRightChar": "R", - "SettingLeftChar": "L", - "SettingAutoChar": "A", - "SettingOffChar": "O", - "SettingSlowChar": "S", - "SettingMediumChar": "M", - "SettingFastChar": "F", - "SettingStartNoneChar": "O", - "SettingStartSolderingChar": "S", - "SettingStartSleepChar": "Z", - "SettingStartSleepOffChar": "R", - "SettingSensitivityOff": "O", - "SettingSensitivityLow": "L", - "SettingSensitivityMedium": "M", - "SettingSensitivityHigh": "H", - "SettingLockDisableChar": "D", - "SettingLockBoostChar": "B", - "SettingLockFullChar": "F" - }, - "menuGroups": { - "PowerMenu": { - "text2": [ - "Power", - "settings" - ], - "desc": "Power settings" - }, - "SolderingMenu": { - "text2": [ - "Soldering", - "settings" - ], - "desc": "Soldering settings" - }, - "PowerSavingMenu": { - "text2": [ - "Sleep", - "mode" - ], - "desc": "Power saving settings" - }, - "UIMenu": { - "text2": [ - "User", - "interface" - ], - "desc": "User interface settings" - }, - "AdvancedMenu": { - "text2": [ - "Advanced", - "settings" - ], - "desc": "Advanced settings" - } - }, - "menuOptions": { - "DCInCutoff": { - "text2": [ - "Power", - "source" - ], - "desc": "Power source. Sets cutoff voltage. (DC 10V) (S 3.3V per cell, disable power limit)" - }, - "SleepTemperature": { - "text2": [ - "Sleep", - "temp" - ], - "desc": "Tip temperature while in \"sleep mode\"" - }, - "SleepTimeout": { - "text2": [ - "Sleep", - "timeout" - ], - "desc": "Interval before \"sleep mode\" kicks in (s=seconds | m=minutes)" - }, - "ShutdownTimeout": { - "text2": [ - "Shutdown", - "timeout" - ], - "desc": "Interval before the iron shuts down (m=minutes)" - }, - "MotionSensitivity": { - "text2": [ - "Motion", - "sensitivity" - ], - "desc": "0=off | 1=least sensitive | ... | 9=most sensitive" - }, - "TemperatureUnit": { - "text2": [ - "Temperature", - "unit" - ], - "desc": "C=Celsius | F=Fahrenheit" - }, - "AdvancedIdle": { - "text2": [ - "Detailed", - "idle screen" - ], - "desc": "Display detailed information in a smaller font on the idle screen" - }, - "DisplayRotation": { - "text2": [ - "Display", - "orientation" - ], - "desc": "R=right-handed | L=left-handed | A=automatic" - }, - "BoostTemperature": { - "text2": [ - "Boost", - "temp" - ], - "desc": "Tip temperature used in \"boost mode\"" - }, - "AutoStart": { - "text2": [ - "Start-up", - "behavior" - ], - "desc": "O=off | S=heat up to soldering temp | Z=standby at sleep temp until moved | R=standby without heating until moved" - }, - "CooldownBlink": { - "text2": [ - "Cooldown", - "flashing" - ], - "desc": "Flash the temperature reading after heating was halted while the tip is still hot" - }, - "TemperatureCalibration": { - "text2": [ - "Calibrate", - "Tip Offset?" - ], - "desc": "Calibrate tip temperature offset; not needed if device is within 5 C" - }, - "SettingsReset": { - "text2": [ - "Restore factory", - "settings?" - ], - "desc": "Reset all settings to default" - }, - "VoltageCalibration": { - "text2": [ - "Calibrate", - "input voltage?" - ], - "desc": "Start VIN calibration (long press to exit)" - }, - "AdvancedSoldering": { - "text2": [ - "Detailed", - "solder screen" - ], - "desc": "Display detailed information in a smaller font on soldering screen" - }, - "ScrollingSpeed": { - "text2": [ - "Scrolling", - "speed" - ], - "desc": "Speed info text scrolls past at (S=slow | F=fast)" - }, - "QCMaxVoltage": { - "text2": [ - "QC", - "voltage" - ], - "desc": "Max QC voltage the iron should negotiate for" - }, - "PDNegTimeout": { - "text2": [ - "PD", - "timeout" - ], - "desc": "PD negotiation timeout in 100ms steps for compatibility with some QC chargers" - }, - "PowerLimit": { - "text2": [ - "Power", - "limit" - ], - "desc": "Maximum power the iron can use (W=watt)" - }, - "ReverseButtonTempChange": { - "text2": [ - "Swap", - "+ - keys" - ], - "desc": "Reverse assignment of buttons for temperature adjustment" - }, - "TempChangeShortStep": { - "text2": [ - "Temp change", - "short" - ], - "desc": "Temperature-change-increment on short button press" - }, - "TempChangeLongStep": { - "text2": [ - "Temp change", - "long" - ], - "desc": "Temperature-change-increment on long button press" - }, - "PowerPulsePower": { - "text2": [ - "Power", - "pulse" - ], - "desc": "Intensity of power of keep-awake-pulse (watt)" - }, - "HallEffSensitivity": { - "text2": [ - "Hall Effect", - "sensitivity" - ], - "desc": "Sensitivity to magnets (0=off | 1=least sensitive | ... | 9=most sensitive)" - }, - "LockingMode": { - "text2": [ - "Allow locking", - "buttons" - ], - "desc": "While soldering, hold down both buttons to toggle locking them (D=disable | B=boost mode only | F=full locking)" - }, - "MinVolCell": { - "text2": [ - "Minimum", - "voltage" - ], - "desc": "Minimum allowed voltage per cell (3S: 3 - 3.7V | 4-6S: 2.4 - 3.7V)" - }, - "AnimLoop": { - "text2": [ - "Anim.", - "loop" - ], - "desc": "Loop icon animations in main menu" - }, - "AnimSpeed": { - "text2": [ - "Anim.", - "speed" - ], - "desc": "Pace of icon animations in menu (O=off | S=slow | M=medium | F=fast)" - }, - "PowerPulseWait": { - "text2": [ - "Power pulse", - "delay" - ], - "desc": "Delay before keep-awake-pulse is triggered (x 2.5s)" - }, - "PowerPulseDuration": { - "text2": [ - "Power pulse", - "duration" - ], - "desc": "Keep-awake-pulse duration (x 250ms)" - }, - "LanguageSwitch": { - "text2": [ - "Language:", - " EN English" - ], - "desc": "Current firmware language" - }, - "Brightness": { - "text2": [ - "Screen", - "brightness" - ], - "desc": "Adjust OLED screen brightness" - }, - "ColourInversion": { - "text2": [ - "Invert", - "screen" - ], - "desc": "Invert OLED screen colors black|white" - }, - "LOGOTime": { - "text2": [ - "Boot logo", - "duration" - ], - "desc": "Sets the duration for the boot logo (s=seconds)" - } - } -} - { "languageCode": "EN", "languageLocalName": "English", @@ -348,7 +7,7 @@ ], "tempUnitFahrenheit": true, "messages": { - "SettingsCalibrationWarning": "Confirm, tip & device are at room temperature before starting!", + "SettingsCalibrationWarning": "Please be absolutely sure the tip and device are at room temperature before proceeding!", "SettingsResetWarning": "Are you sure you want to restore default settings?", "UVLOWarningString": "DC LOW", "UndervoltageString": "Undervoltage", @@ -521,7 +180,7 @@ "Calibrate", "temperature" ], - "desc": "Calibrate tip Cold Junction Compensation (not required if temp is within 5 C)" + "desc": "Adjust tip Cold Junction Compensation (not required if temp is within 5 C)" }, "SettingsReset": { "text2": [ @@ -605,7 +264,7 @@ "Hall sensor", "sensitivity" ], - "desc": "Sensitivity of the Hall effect sensor to trigger sleep mode (0=off | 1=least sensitive | ... | 9=most sensitive)" + "desc": "Hall effect sensitivity to trigger sleep mode (0=off | 1=least sensitive | ... | 9=most sensitive)" }, "LockingMode": { "text2": [ @@ -668,7 +327,7 @@ "Invert", "screen" ], - "desc": "Invert OLED screen colors black | white" + "desc": "Invert OLED screen colors Black | White" }, "LOGOTime": { "text2": [ From 6d4aaca39953ca9fa6c87ccb97effe4e2b24505e Mon Sep 17 00:00:00 2001 From: River B <97197236+River-b@users.noreply.github.com> Date: Sun, 28 Aug 2022 16:34:30 -0700 Subject: [PATCH 12/28] 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 b20f9f7967..529ae50f9e 100644 --- a/Translations/translations_def.js +++ b/Translations/translations_def.js @@ -364,8 +364,8 @@ var def = /// }, { "id": "HallEffSensitivity", - "maxLen": 6, - "maxLen2": 8, + "maxLen": 12, + "maxLen2": 15, "description": "If the unit has a hall effect sensor (Pinecil), this adjusts how sensitive it is at detecting a magnet to put the device into sleep mode." }, @@ -430,4 +430,4 @@ var def = /// "description": "Sets the duration for the boot logo (S=seconds)." } ] - } \ No newline at end of file + } From cb30d72b472d3a7f4638c29ddeca5ec8fc3b99f0 Mon Sep 17 00:00:00 2001 From: River B <97197236+River-b@users.noreply.github.com> Date: Sun, 28 Aug 2022 16:54:53 -0700 Subject: [PATCH 13/28] 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 529ae50f9e..5618566d7c 100644 --- a/Translations/translations_def.js +++ b/Translations/translations_def.js @@ -364,7 +364,7 @@ var def = /// }, { "id": "HallEffSensitivity", - "maxLen": 12, + "maxLen": 6, "maxLen2": 15, "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." From d4b4ee6d5bc5f09bcef60522404124b98ce3dbce Mon Sep 17 00:00:00 2001 From: River B <97197236+River-b@users.noreply.github.com> Date: Sun, 28 Aug 2022 17:32:09 -0700 Subject: [PATCH 14/28] Add files via upload --- Translations/translation_EN.json | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/Translations/translation_EN.json b/Translations/translation_EN.json index 7ece63327e..f04147fa3e 100644 --- a/Translations/translation_EN.json +++ b/Translations/translation_EN.json @@ -7,7 +7,7 @@ ], "tempUnitFahrenheit": true, "messages": { - "SettingsCalibrationWarning": "Please be absolutely sure the tip and device are at room temperature before proceeding!", + "SettingsCalibrationWarning": "Confirm the tip & device are at room temperature before starting!", "SettingsResetWarning": "Are you sure you want to restore default settings?", "UVLOWarningString": "DC LOW", "UndervoltageString": "Undervoltage", @@ -94,7 +94,7 @@ "Advanced", "settings" ], - "desc": "Advanced settings" + "desc": "Advanced options that require more thought before use." } }, "menuOptions": { @@ -103,7 +103,7 @@ "Power", "source" ], - "desc": "Power source. Sets cutoff voltage. (DC 10V) (S 3.3V per cell, disable power limit)" + "desc": "set Cutoff voltage to protect battery over-drain. (DC 10V) (S 3.3V per cell, disable power limit)" }, "SleepTemperature": { "text2": [ @@ -180,7 +180,7 @@ "Calibrate", "temperature" ], - "desc": "Adjust tip Cold Junction Compensation (not required if temp is within 5 C)" + "desc": "Tip Cold Junction Compensation (not required if temp is within 5 C)" }, "SettingsReset": { "text2": [ @@ -264,7 +264,7 @@ "Hall sensor", "sensitivity" ], - "desc": "Hall effect sensitivity to trigger sleep mode (0=off | 1=least sensitive | ... | 9=most sensitive)" + "desc": "Hall sensitivity to magnets (0=off | 1=least sensitive | ... | 9=most sensitive)" }, "LockingMode": { "text2": [ @@ -337,4 +337,4 @@ "desc": "Sets the duration for the boot logo (s=seconds)" } } -} +} \ No newline at end of file From ccb1118df6279f7d26486ccb849a964a873bccb5 Mon Sep 17 00:00:00 2001 From: River B <97197236+River-b@users.noreply.github.com> Date: Sun, 28 Aug 2022 17:40:31 -0700 Subject: [PATCH 15/28] Update Settings.md --- Documentation/Settings.md | 11 ++++++----- 1 file changed, 6 insertions(+), 5 deletions(-) diff --git a/Documentation/Settings.md b/Documentation/Settings.md index 04d2429fde..995930fa1f 100644 --- a/Documentation/Settings.md +++ b/Documentation/Settings.md @@ -39,11 +39,11 @@ This is the "on device help text". ### Setting: Power source -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. +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 from over-draining. On device help text: -Power source. Sets cutoff voltage. (DC 10V) (S 3.3V per cell, disable power limit) +Set cutoff voltage to protect battery over-drain. (DC 10V) (S 3.3V per cell, disable power limit) ### Setting: Sleep temp @@ -125,12 +125,13 @@ On device help text: Flash the temperature reading after heating was halted while the tip is still hot -### Setting: Calibrate Tip Temperature Offset? +### Setting: Calibrate temperature? -Used to calibrate the ADC + Op-amp offsets for the tip. This calibration should only be performed when the tip and handle temperature are equal and at room/ambient temperature. Generally *not required unless your device is reading more than 5 °C off target temperature*. This is intended to be performed at boot-up before internal components get warm. Avoid repeating the calibration, but if you must repeat it, unplug the unit, and wait for everything to go back to room temperature. +Used to calibrate the ADC + Op-amp offsets for the tip. This calibration should only be performed when the tip and handle temperature are equal and at room/ambient temperature. Generally *not required unless your device is reading more than 5 °C off target temperature*. This is intended to be performed at boot-up before internal components get warm. Avoid repeating the calibration, but if you must repeat it, unplug the unit, and wait for everything to go back to room temperature. Temperatures start to drift even after plugging in the device, which is why cold junction calibration is best done at a fresh boot-up. On device help text: -Calibrate tip temperature offset; not required unless device > 5 C off target +Tip Cold Junction Compensation (not required if temp is within 5 C) +Confirm the tip & device are at room temperature before starting! ### Setting: Restore factory settings? From d80cf45296f241a0024319d35941031197489272 Mon Sep 17 00:00:00 2001 From: River B <97197236+River-b@users.noreply.github.com> Date: Sun, 28 Aug 2022 17:43:37 -0700 Subject: [PATCH 16/28] Update Settings.md --- Documentation/Settings.md | 8 +++++--- 1 file changed, 5 insertions(+), 3 deletions(-) diff --git a/Documentation/Settings.md b/Documentation/Settings.md index 995930fa1f..35c3ef26c4 100644 --- a/Documentation/Settings.md +++ b/Documentation/Settings.md @@ -127,11 +127,13 @@ 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 should only be performed when the tip and handle temperature are equal and at room/ambient temperature. Generally *not required unless your device is reading more than 5 °C off target temperature*. This is intended to be performed at boot-up before internal components get warm. Avoid repeating the calibration, but if you must repeat it, unplug the unit, and wait for everything to go back to room temperature. Temperatures start to drift even after plugging in the device, which is why cold junction calibration is best done at a fresh boot-up. +Used to calibrate the ADC + Op-amp offsets for the tip. This calibration should only be performed when the tip and handle temperature are equal and at room/ambient temperature. + +Generally *not required unless your device is reading more than 5 °C off target temperature*. This is intended to be performed at boot-up before internal components get warm. Avoid repeating the calibration, but if you must repeat it, unplug the unit, and wait for everything to go back to room temperature. Temperatures start to drift even after plugging in the device, which is why cold junction calibration is best done at a fresh boot-up. On device help text: -Tip Cold Junction Compensation (not required if temp is within 5 C) -Confirm the tip & device are at room temperature before starting! +- Tip Cold Junction Compensation (not required if temp is within 5 C) +- Confirm the tip & device are at room temperature before starting! ### Setting: Restore factory settings? From f3d747228755cb1e984452c202f3708124810971 Mon Sep 17 00:00:00 2001 From: River B <97197236+River-b@users.noreply.github.com> Date: Sun, 28 Aug 2022 18:13:26 -0700 Subject: [PATCH 17/28] Update translation_EN.json increase readabiltiy on scrolling details. reduce words --- Translations/translation_EN.json | 28 ++++++++++++++-------------- 1 file changed, 14 insertions(+), 14 deletions(-) diff --git a/Translations/translation_EN.json b/Translations/translation_EN.json index f04147fa3e..aab63aa7b1 100644 --- a/Translations/translation_EN.json +++ b/Translations/translation_EN.json @@ -7,7 +7,7 @@ ], "tempUnitFahrenheit": true, "messages": { - "SettingsCalibrationWarning": "Confirm the tip & device are at room temperature before starting!", + "SettingsCalibrationWarning": "Affirm the tip & device are at room temperature before starting!", "SettingsResetWarning": "Are you sure you want to restore default settings?", "UVLOWarningString": "DC LOW", "UndervoltageString": "Undervoltage", @@ -16,7 +16,7 @@ "SleepingAdvancedString": "Sleeping...", "SleepingTipAdvancedString": "Tip:", "OffString": "Off", - "DeviceFailedValidationWarning": "Your device is most likely a counterfeit!" + "DeviceFailedValidationWarning": "Your device is most likely a Counterfeit!" }, "messagesWarn": { "ResetOKMessage": "Reset OK", @@ -103,7 +103,7 @@ "Power", "source" ], - "desc": "set Cutoff voltage to protect battery over-drain. (DC 10V) (S 3.3V per cell, disable power limit)" + "desc": "Set cutoff voltage to protect battery drain. (DC 10V) (S 3.3V per cell, disable PWR limit)" }, "SleepTemperature": { "text2": [ @@ -145,7 +145,7 @@ "Detailed", "idle screen" ], - "desc": "Display detailed information in a smaller font on the idle screen" + "desc": "Display detailed info in a smaller font on the idle screen" }, "DisplayRotation": { "text2": [ @@ -159,7 +159,7 @@ "Boost", "temp" ], - "desc": "Tip temperature used in \"boost mode\"" + "desc": "Tip temperature in \"boost mode\"" }, "AutoStart": { "text2": [ @@ -173,18 +173,18 @@ "Cooldown", "flashing" ], - "desc": "Flash the temperature reading after heating was halted while the tip is still hot" + "desc": "If the tip is still hot after heat is halted, Flash temperature" }, "TemperatureCalibration": { "text2": [ "Calibrate", "temperature" ], - "desc": "Tip Cold Junction Compensation (not required if temp is within 5 C)" + "desc": "Tip Cold Junction Compensation; not needed if temp is +/- 5 C" }, "SettingsReset": { "text2": [ - "Restore factory", + "Restore default", "settings" ], "desc": "Reset all settings to default" @@ -201,7 +201,7 @@ "Detailed", "solder screen" ], - "desc": "Display detailed information in a smaller font on soldering screen" + "desc": "Display detailed info in a smaller font on soldering screen" }, "ScrollingSpeed": { "text2": [ @@ -257,14 +257,14 @@ "Power", "pulse" ], - "desc": "Intensity of power of keep-awake-pulse (watt)" + "desc": "Power Intensity of keep-awake-pulse (watt)" }, "HallEffSensitivity": { "text2": [ "Hall sensor", "sensitivity" ], - "desc": "Hall sensitivity to magnets (0=off | 1=least sensitive | ... | 9=most sensitive)" + "desc": "Sensitivity to magnets (0=off | 1=least sensitive | ... | 9=most sensitive)" }, "LockingMode": { "text2": [ @@ -278,7 +278,7 @@ "Minimum", "voltage" ], - "desc": "Minimum allowed voltage per cell (3S: 3 - 3.7V | 4-6S: 2.4 - 3.7V)" + "desc": "Minimum allowed volts per cell (3S: 3 - 3.7V | 4-6S: 2.4 - 3.7V)" }, "AnimLoop": { "text2": [ @@ -334,7 +334,7 @@ "Boot logo", "duration" ], - "desc": "Sets the duration for the boot logo (s=seconds)" + "desc": "Sets duration for the boot logo (s=seconds)" } } -} \ No newline at end of file +} From f857553ab233bb8ea008c36ee07766fb99eba8f5 Mon Sep 17 00:00:00 2001 From: River B <97197236+River-b@users.noreply.github.com> Date: Sun, 28 Aug 2022 18:14:56 -0700 Subject: [PATCH 18/28] Update Development.md --- Documentation/Development.md | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/Documentation/Development.md b/Documentation/Development.md index f59779cf36..fe2a5dd5f2 100644 --- a/Documentation/Development.md +++ b/Documentation/Development.md @@ -96,9 +96,12 @@ To build a release instead, run the `build.sh` script. This will update translat To update the language translation files and their associated font maps, execute the `make_translation.py` code from the `Translations` directory. If you edit the translation definitions or the English translation, please also run `gen_menu_docs.py` to update the settings menu documentation automatically. -## Building Pinecil +## Building Pinecil V1 I highly recommend using the command line tools and using Docker to run the compiler. It's a bit fussier on setup than the STM tooling, and this is by far the easiest way. If you _need_ an IDE I have used [Nuclei's IDE](https://nucleisys.com/download.php). Follow the same idea as the STM Cube IDE notes above. + +## Building Pinecil V2 + From b023f993240ec295277f3f7cf9add4b303ca6183 Mon Sep 17 00:00:00 2001 From: River B <97197236+River-b@users.noreply.github.com> Date: Sun, 28 Aug 2022 18:16:37 -0700 Subject: [PATCH 19/28] Update Flashing.md --- Documentation/Flashing.md | 1 + 1 file changed, 1 insertion(+) diff --git a/Documentation/Flashing.md b/Documentation/Flashing.md index b5b50ba7f5..bbce568cad 100644 --- a/Documentation/Flashing.md +++ b/Documentation/Flashing.md @@ -90,6 +90,7 @@ Check the extension of your firmware, it should be `.RDY` now. - The MCU in V2 is Bouffalo BL706 and does *not* use usb-dfu for flashing as the previous MCU did. - The current firmware (2.18) is very fresh and no upgrade is available/needed. - When an update is released for V2, then IronOS will also include an update method to follow. +- Some background on the [BL706 chipset](https://lupyuen.github.io/articles/bl706) # Pinecil V1 (Pine64) From cf910ad991b5bf388b8ebbed757862d80fbfebb5 Mon Sep 17 00:00:00 2001 From: River B <97197236+River-b@users.noreply.github.com> Date: Sun, 28 Aug 2022 18:17:37 -0700 Subject: [PATCH 20/28] Update GettingStarted.md --- Documentation/GettingStarted.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/Documentation/GettingStarted.md b/Documentation/GettingStarted.md index 7e5ce05735..e9a9c6ab08 100644 --- a/Documentation/GettingStarted.md +++ b/Documentation/GettingStarted.md @@ -59,7 +59,7 @@ In Sleep mode, the temperature of the iron automatically lowers to 150 °C (defa Simply picking up or moving the iron will wake it back up into soldering mode. You can also press any button and this will also wake the iron up. Optional Hall Effect Feature (Pinecil only): -Pinecil has an unpopulated footprint (U14) for a hall effect sensor (Si7210). Adding the sensor and placing a strong magnet on the holder stand will trigger Pinecil to sleep after it enters the stand, and Zzzz will appear on the screen. The magnet is positioned on the stand in proximity to the sensor which then activates one of 10 user defined settings (0=off, 1=lowest sensitivity, 9=highest sensitivity). Read the Hall Sensor document for details on [installation](/Documentation/HallSensor.md). +Pinecil has an unpopulated footprint (U14) for a hall effect sensor (Si7210). Adding the sensor and placing a strong magnet on the holder stand will trigger Pinecil to sleep after it enters the stand, and Zzzz will appear on the screen. The magnet is positioned on the stand in proximity to the sensor which then activates one of 10 user defined settings (0=off, 1=lowest sensitivity, 9=highest sensitivity). Read the Hall Sensor document for [details on installation](/Documentation/HallSensor.md). ### Idle Shutdown From cd3cc855f9f2cda7a2a0cbbcffba82946f867e59 Mon Sep 17 00:00:00 2001 From: River B <97197236+River-b@users.noreply.github.com> Date: Sun, 28 Aug 2022 18:18:31 -0700 Subject: [PATCH 21/28] Update HallSensor.md --- Documentation/HallSensor.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/Documentation/HallSensor.md b/Documentation/HallSensor.md index 52e6391d36..4ef022cf83 100644 --- a/Documentation/HallSensor.md +++ b/Documentation/HallSensor.md @@ -17,6 +17,6 @@ After installing the hall sensor, a magnet is positioned on the stand close enou - Neodymium magnets are recommended. If using small magnets, 2-3 may be required, but too many can also be detrimental. - Actively watch the hall number change ([see debug menu](/Documentation/DebugMenu.md)) while you slowly move the magnet around to seek the best locations & whether you have too many or too few magnets. Positioning the magnet(s) where you have the highest hall number will ensure consistent sleep mode when you place the iron in the stand. This requires some experimenting. - Note that the sensor is physically located near the copper contacts for the tip at the front of the handle. [Reference Schematics U14](https://files.pine64.org/doc/Pinecil/Pinecil_schematic_v1.0a_20201120.pdf). - - Positioning/type/quantity of magnets is important for best results. Sometimes too many magnets breaks the effect by distorting the magnetic field [as seen in this demo video](https://www.youtube.com/shorts/afkqKwCX00I). The video shows magnets at the top of the stand, and the pinecil goes correctly into Zzzz with *only* those magnets. When more magnets are added at the side, the Pinecil did not go to sleep, which is contrary to the goal. See the PDF below for details on magnetic fields with SI7210. + - Positioning/type/quantity of magnets is important for best results. Sometimes too many magnets breaks the effect by distorting the magnetic field **[as seen in this demo video](https://www.youtube.com/shorts/afkqKwCX00I)**. The video shows magnets at the top of the stand, and the pinecil goes correctly into Zzzz with *only* those magnets. When more magnets are added at the side, the Pinecil did not go to sleep, which is contrary to the goal. See the PDF below for details on magnetic fields with SI7210. - Orientation of North and South faces of magnets is important to increase reaction of the hall sensor [see data sheet SI7210-B-00-IV](https://www.silabs.com/documents/public/application-notes/an1018-si72xx-sensors.pdf). - \ No newline at end of file + From 6a82fc3d0be762b7099db00c9dcd42a798c0412c Mon Sep 17 00:00:00 2001 From: River B <97197236+River-b@users.noreply.github.com> Date: Sun, 28 Aug 2022 18:28:50 -0700 Subject: [PATCH 22/28] Update Menu.md --- Documentation/Menu.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/Documentation/Menu.md b/Documentation/Menu.md index d1d6ba6709..888b634a76 100644 --- a/Documentation/Menu.md +++ b/Documentation/Menu.md @@ -38,13 +38,13 @@ To calibrate your iron: 7. Press both buttons at the same time to Save and Exit to the menu ### Calibrating tip offset (Set tip model) -This is normally not needed unless you have an issue with your temperature or your tips are wearing out prematurely. Changing tip lengths does not necessarily mean a calibration is needed. If the method below is not followed, the iron could be worse than before calibration, repeat the method. -Some tips have an offset on their readings which causes issues, i.e., the actual temperature of the tip is much higher than displayed. To calibrate this out, perform the following steps: +This is normally not needed unless you have an issue with your temperature or your tips are wearing out prematurely (tip is much higher temperature than displayed). Changing tip lengths does not necessarily mean a calibration is needed. If the method below is not followed closely, the iron could be worse than before calibration, repeat the method. +Some tips have an offset on their readings which causes issues and needs a [cold junction calibration](https://www.youtube.com/watch?v=AYblSfpKRUk&t=406s). To calibrate this out, perform the following steps: 1. Connect power to your iron 2. **Critical: make sure the tip & handle is at room temperature** (wait a good while after using the iron before calibration) 3. Using (`-/B`) scroll down to Advanced settings > press (`+/A`) to select > then (`-/B`) to scroll to Calibrate temperature? > press (`+/A`) -4. Important warning message is shown: *Please ensure the tip is at room temperature before proceeding!* +4. Important warning message is shown: *Affirm the tip & device are at room temperature before starting!* 5. Press the (`+/A`) button to confirm (tip/handle are at ambient temperature). 6. Display shows **`....`** for a short time as the unit measures and compares the tip and handle temperatures. 7. The display then goes back to *TMP CAL* and displays your *Offset number*. You generally don't need this offset unless debugging issues. From f8df544171a73957a6ac68dfe4fc7ec1a874fd54 Mon Sep 17 00:00:00 2001 From: River B <97197236+River-b@users.noreply.github.com> Date: Sun, 28 Aug 2022 18:31:57 -0700 Subject: [PATCH 23/28] Update Settings.md --- Documentation/Settings.md | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/Documentation/Settings.md b/Documentation/Settings.md index 35c3ef26c4..0f68b7f60f 100644 --- a/Documentation/Settings.md +++ b/Documentation/Settings.md @@ -91,7 +91,7 @@ Should the device show an 'advanced' view on the idle screen. The advanced view On device help text: -Display detailed information in a smaller font on the idle screen +Display detailed info in a smaller font on the idle screen ### Setting: Display orientation @@ -132,16 +132,16 @@ Used to calibrate the ADC + Op-amp offsets for the tip. This calibration should Generally *not required unless your device is reading more than 5 °C off target temperature*. This is intended to be performed at boot-up before internal components get warm. Avoid repeating the calibration, but if you must repeat it, unplug the unit, and wait for everything to go back to room temperature. Temperatures start to drift even after plugging in the device, which is why cold junction calibration is best done at a fresh boot-up. On device help text: -- Tip Cold Junction Compensation (not required if temp is within 5 C) +- Tip Cold Junction Compensation; not needed if temp is +/- 5 C - Confirm the tip & device are at room temperature before starting! -### Setting: Restore factory settings? +### Setting: Restore default settings? -Resets all settings and calibrations to factory defaults. Does NOT erase custom user boot up logo's. +Resets all settings and calibrations to defaults included with the installed firmware version. Does NOT erase custom user boot up logo's. On device help text: -Reset all settings to default +Reset all settings to default? ### Setting: Calibrate input voltage? @@ -157,7 +157,7 @@ Should the device show an 'advanced' soldering view. This is a text-based view t On device help text: -Display detailed information in a smaller font on soldering screen +Display detailed info in a smaller font on soldering screen ### Setting: Scrolling speed From 8e3cfe17bf44914df44ba7591458001796b65043 Mon Sep 17 00:00:00 2001 From: River B <97197236+River-b@users.noreply.github.com> Date: Sun, 28 Aug 2022 18:41:41 -0700 Subject: [PATCH 24/28] 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 aab63aa7b1..a24541f2cb 100644 --- a/Translations/translation_EN.json +++ b/Translations/translation_EN.json @@ -185,7 +185,7 @@ "SettingsReset": { "text2": [ "Restore default", - "settings" + "settings?" ], "desc": "Reset all settings to default" }, From c3c26bf0fad1d584be1ca5a3527551eff3bcdb30 Mon Sep 17 00:00:00 2001 From: River B <97197236+River-b@users.noreply.github.com> Date: Sun, 28 Aug 2022 18:47:00 -0700 Subject: [PATCH 25/28] 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 0f68b7f60f..df861bfa41 100644 --- a/Documentation/Settings.md +++ b/Documentation/Settings.md @@ -127,13 +127,13 @@ 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 should only be performed when the tip and handle temperature are equal and at room/ambient temperature. +Used to calibrate the ADC + Op-amp offsets for the tip. This calibration should only be performed when the tip and device temperature are **equal** and at **room/ambient temperature**. Generally *not required unless your device is reading more than 5 °C off target temperature*. This is intended to be performed at boot-up before internal components get warm. Avoid repeating the calibration, but if you must repeat it, unplug the unit, and wait for everything to go back to room temperature. Temperatures start to drift even after plugging in the device, which is why cold junction calibration is best done at a fresh boot-up. On device help text: - Tip Cold Junction Compensation; not needed if temp is +/- 5 C -- Confirm the tip & device are at room temperature before starting! +- Affirm the tip & device are at room temperature before starting! ### Setting: Restore default settings? From dbd01aea0742dbe8449eb63a3aabe0adf6c79fc2 Mon Sep 17 00:00:00 2001 From: River B <97197236+River-b@users.noreply.github.com> Date: Sun, 28 Aug 2022 18:50:15 -0700 Subject: [PATCH 26/28] 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 a24541f2cb..3856134fd2 100644 --- a/Translations/translation_EN.json +++ b/Translations/translation_EN.json @@ -173,7 +173,7 @@ "Cooldown", "flashing" ], - "desc": "If the tip is still hot after heat is halted, Flash temperature" + "desc": "If the tip is still hot after heat is halted, Flash temperature reading" }, "TemperatureCalibration": { "text2": [ From e8610fc8a0b6916e94b514c71945650ce8b49bd8 Mon Sep 17 00:00:00 2001 From: River B <97197236+River-b@users.noreply.github.com> Date: Sun, 28 Aug 2022 19:21:32 -0700 Subject: [PATCH 27/28] Update translation_EN.json --- Translations/translation_EN.json | 2 ++ 1 file changed, 2 insertions(+) diff --git a/Translations/translation_EN.json b/Translations/translation_EN.json index 3856134fd2..2ccb442a02 100644 --- a/Translations/translation_EN.json +++ b/Translations/translation_EN.json @@ -1,3 +1,4 @@ + { "languageCode": "EN", "languageLocalName": "English", @@ -338,3 +339,4 @@ } } } + From 8a9c6d0910678067324c8240e3afac24ba8a5e54 Mon Sep 17 00:00:00 2001 From: River B <97197236+River-b@users.noreply.github.com> Date: Sun, 28 Aug 2022 19:23:57 -0700 Subject: [PATCH 28/28] Update translation_EN.json --- Translations/translation_EN.json | 1 - 1 file changed, 1 deletion(-) diff --git a/Translations/translation_EN.json b/Translations/translation_EN.json index 2ccb442a02..31cace7560 100644 --- a/Translations/translation_EN.json +++ b/Translations/translation_EN.json @@ -1,4 +1,3 @@ - { "languageCode": "EN", "languageLocalName": "English",