diff options
| author | Ben V. Brown <[email protected]> | 2020-12-31 12:32:00 +1100 |
|---|---|---|
| committer | Ben V. Brown <[email protected]> | 2020-12-31 12:32:00 +1100 |
| commit | bfcfc294c8b38eff7833ae23c94d0c3b7c8ef62b (patch) | |
| tree | f2c803c515ddf4faf516522013b6675b4d7a4c82 /Documentation/DebugMenu.md | |
| parent | dc2b507045f777f1bd70a1e30d765ed5d2623a70 (diff) | |
| download | IronOS-bfcfc294c8b38eff7833ae23c94d0c3b7c8ef62b.tar.gz IronOS-bfcfc294c8b38eff7833ae23c94d0c3b7c8ef62b.zip | |
Preparing for rename
Diffstat (limited to 'Documentation/DebugMenu.md')
| -rw-r--r-- | Documentation/DebugMenu.md | 76 |
1 files changed, 76 insertions, 0 deletions
diff --git a/Documentation/DebugMenu.md b/Documentation/DebugMenu.md new file mode 100644 index 00000000..f06ed6b2 --- /dev/null +++ b/Documentation/DebugMenu.md @@ -0,0 +1,76 @@ +# Debugging Menu
+
+In this firmware there is extra debugging information hidden under and extra menu.
+This is accessed by holding the rear (B) button on the iron while its on the home screen.
+
+This menu is meant to be simple, so it has no fancy GUI animations.
+
+To move through the menu use the front (A) button.
+To exit, use the rear (B) button again.
+
+## Menu items
+
+Items are shown in the menu on a single line, so they use short codes
+
+### 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.
+As this is a Highwater mater, you should only trust this once you have walked through all GUI options to "hit" the worst one.
+
+### HW M
+
+This indicates the High Water mark for the stack for the movement detection thread. The smaller this number is, the less headroom we have in the stack.
+
+### HW P
+
+This indicates the High Water mark for the stack for the PID thread. The smaller this number is, the less headroom we have in the stack.
+
+### Time
+
+This just shows how many seconds the unit has been powered for.
+
+### Move
+
+This is the last timestamp of movement. When the iron is moved this should update to match the Time field (one before in the menu).
+This can be used for checking performance of the movement dection code.
+
+### RTip
+
+This is the raw tip reading in uV. This can be used when assessing the calibration routines for example.
+
+### CTip
+
+This is the tip temperature in deg C. This can be used with RTip for assessing temperature processing performance.
+
+### CHan
+
+This is the handle temperature in C. This is used for cold junction compensation of the tip temp.
+
+### Vin
+
+The input voltage reading.
+
+### PCB
+
+This is slightly miss-named, but preserving the name for now.
+This indicates the PCB "version" number, which comes from the TS100 changing the model of accelerometer without warning.
+This indicates the accelerometer that is fitted inside the unit.
+
+- 0 = MMA8652
+- 1 = LIS2DH12
+- 2 = BMA223
+- 99 = None detected (running in fallback without movement detection)
+
+### PWR
+
+This indicates the current power source for the iron.
+This may change during power up as the sources are negotiated in turn.
+
+- 0 = DC input (dumb)
+- 1 = QC input (We used QC2/3 negotiation for current supply)
+- 2 = PD input (We used the PD subsystem to negotiate for the current supply)
+
+### Max
+
+This indicates the max temp in C that the system estimates it can measure the tip reliably to.
+This is dependant on a few factors including the handle temperature so it can move around during use.
\ No newline at end of file |