aboutsummaryrefslogtreecommitdiffstats
path: root/docs/Debugging.md
diff options
context:
space:
mode:
authorKevin O'Connor <kevin@koconnor.net>2018-01-11 13:46:20 -0500
committerKevin O'Connor <kevin@koconnor.net>2018-01-11 13:48:40 -0500
commitf1222565b892c456656ad1395cde2acdf07db633 (patch)
tree95c6b97ae962935fd988f3063aeb7575600e0cb8 /docs/Debugging.md
parent5caff594c5d78edd6da114d0d9e8d5f78ad31cdf (diff)
downloadkutter-f1222565b892c456656ad1395cde2acdf07db633.tar.gz
kutter-f1222565b892c456656ad1395cde2acdf07db633.tar.xz
kutter-f1222565b892c456656ad1395cde2acdf07db633.zip
docs: Update Debugging.md with information on logextract
Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
Diffstat (limited to 'docs/Debugging.md')
-rw-r--r--docs/Debugging.md33
1 files changed, 28 insertions, 5 deletions
diff --git a/docs/Debugging.md b/docs/Debugging.md
index da0fba16..ce9d0c08 100644
--- a/docs/Debugging.md
+++ b/docs/Debugging.md
@@ -115,17 +115,20 @@ gtkwave avrsim.vcd
```
Manually sending commands to the micro-controller
--------------------------------------------------
+=================================================
-Normally, Klippy would be used to translate gcode commands to Klipper
-commands. However, it's also possible to manually send Klipper
-commands (functions marked with the DECL_COMMAND() macro in the
-Klipper source code). To do so, run:
+Normally, the host klippy.py process would be used to translate gcode
+commands to Klipper micro-controller commands. However, it's also
+possible to manually send these MCU commands (functions marked with
+the DECL_COMMAND() macro in the Klipper source code). To do so, run:
```
~/klippy-env/bin/python ./klippy/console.py /tmp/pseudoserial 250000
```
+See the "HELP" command within the tool for more information on its
+functionality.
+
Generating load graphs
======================
@@ -148,3 +151,23 @@ Then graphs can be produced with:
```
One can then view the resulting **loadgraph.png** file.
+
+Extracting information from the klippy.log file
+===============================================
+
+The Klippy log file (/tmp/klippy.log) also contains debugging
+information. There is a logextract.py script that may be useful when
+analyzing a micro-controller shutdown or similar problem. It is
+typically run with something like:
+
+```
+mkdir work_directory
+cd work_directory
+cp /tmp/klippy.log .
+~/klipper/scripts/logextract.py ./klippy.log
+```
+
+The script will extract the printer config file and will extract MCU
+shutdown information. The information dumps from an MCU shutdown (if
+present) will be reordered by timestamp to assist in diagnosing cause
+and effect scenarios.