aboutsummaryrefslogtreecommitdiffhomepage
path: root/Documentation
diff options
context:
space:
mode:
authordiscip <[email protected]>2022-08-25 01:17:15 +0200
committerGitHub <[email protected]>2022-08-25 09:17:15 +1000
commitb5323d9c77a020e343ef81a9818b551ab83d4242 (patch)
treef373eaad4f02f96a5b678689ecd97d6709e8367a /Documentation
parent3895218b2d7b10b4a475bcff1ffdd8779b300495 (diff)
downloadIronOS-b5323d9c77a020e343ef81a9818b551ab83d4242.tar.gz
IronOS-b5323d9c77a020e343ef81a9818b551ab83d4242.zip
reorder debug menu . . . (#1380)
* Update DebugMenu.md * Update make_translation.py * Update GUIThread.cpp * Update DebugMenu.md
Diffstat (limited to 'Documentation')
-rw-r--r--Documentation/DebugMenu.md48
1 files changed, 26 insertions, 22 deletions
diff --git a/Documentation/DebugMenu.md b/Documentation/DebugMenu.md
index 7b573faa..49245a0b 100644
--- a/Documentation/DebugMenu.md
+++ b/Documentation/DebugMenu.md
@@ -11,7 +11,11 @@ This menu is meant to be simple, so it has no fancy GUI animations.
Items are shown in the menu on a single line, so they use short codes and appear in this order:
-### Time
+### ID
+- This is used by Irons that have an ID and serial number to help check if the iron is authentic. All Pinecil V1 show the same ID number as this is the number programmed into the MCU.
+- The new Pinecil V2 released Aug. 2, 2022 now uses BL706, which enables generating a unique ID/Serial number to every iron. This can be used to verify your Pinecil authenticity [here](https://pinecil.pine64.org/).
+
+### UpTime
This just shows how many deciseconds the unit has been powered for.
@@ -20,6 +24,22 @@ This just shows how many deciseconds the unit has been powered for.
This is the last timestamp of movement. When the iron is moved, this should update to match the time field (one before in the menu).
This can be used for checking performance of the movement detection code.
+### ACC
+
+This indicates the accelerometer that is fitted inside the unit.
+
+- MMA8652
+- LIS2DH12
+- BMA223
+- MSA301
+- SC7A20
+- None detected -> running in fallback without movement detection
+- Scanning -> Still searching I2C for one
+
+### Tip Res
+
+This indicates the tip resistance that the device is currently using. For devices with multiple possible values to choose from (Pinecil V2), the appropriate value is set automatically.
+
### RTip
This is the raw tip reading in μV. This can be used when assessing the calibration routines for example.
@@ -34,21 +54,14 @@ This can be used with RTip for assessing temperature processing performance.
This is the handle temperature in °C. This is used for cold junction compensation of the tip temperature.
This is shown in degrees Celsius x10, so 200 == 20.0 °C
-### Vin
-
-The input voltage as read by the internal ADC. Can be used to sanity check its being read correctly.
+### CMax
-### ACC
+This indicates the max temperature in degrees Celsius that the system estimates it can measure the tip reliably to.
+This is dependent on a few factors including the handle temperature so it can move around during use.
-This indicates the accelerometer that is fitted inside the unit.
+### Vin
-- MMA8652
-- LIS2DH12
-- BMA223
-- MSA301
-- SC7A20
-- None detected -> running in fallback without movement detection
-- Scanning -> Still searching I2C for one
+The input voltage as read by the internal ADC. Can be used to sanity check its being read correctly.
### PWR
@@ -60,15 +73,6 @@ This may change during power up as the sources are negotiated in turn.
- **PD W. VBus** input (PD subsystem is used to negotiate for current supply); and VBus is connected to your input power source
- **PD No VBus** input (PD subsystem is used to negotiate for current supply); and VBus is **NOT** connected to your input power source. If it is Not required or possible to do a special mod of your PCB (i.e. late model V1, some early Green PCB models) then 'PD No VBus' displays on screen, see details and PD Debug [below](/Documentation/DebugMenu.md#pd-debug-menu). Or if you had 'PD Vbus' displayed before and then successfully modified the Pinecil to support 24V by cutting the trace line to Vbus, then you will see 'PD No Vbus' now as a confirmation that the cut worked.
-### ID
-- This is used by Irons that have an ID and serial number to help check if the iron is authentic. All Pinecil V1 show the same ID number as this is the number programmed into the MCU.
-- The new Pinecil V2 released Aug. 2, 2022 now uses BL706, which enables generating a unique ID/Serial number to every iron. This can be used to [verify your V2 authenticity here](https://pinecil.pine64.org/).
-
-### Max
-
-This indicates the max temperature in degrees Celsius that the system estimates it can measure the tip reliably to.
-This is dependent on a few factors including the handle temperature so it can move around during use.
-
### HW G
This indicates the high water mark for the stack for the GUI thread. The smaller this number is, the less headroom we have in the stack.