aboutsummaryrefslogtreecommitdiffstats
path: root/docs
diff options
context:
space:
mode:
authorKevin O'Connor <kevin@koconnor.net>2017-04-11 13:41:11 -0400
committerKevin O'Connor <kevin@koconnor.net>2017-04-11 13:41:11 -0400
commita7b4d70cc638fca24d23bef43e92d0b28895039e (patch)
tree471b3ae29ce4713c6ade374019585ccd8ba226bc /docs
parentfa193e9618cd60e31d0c0a71a5b6db320e4bb9ed (diff)
downloadkutter-a7b4d70cc638fca24d23bef43e92d0b28895039e.tar.gz
kutter-a7b4d70cc638fca24d23bef43e92d0b28895039e.tar.xz
kutter-a7b4d70cc638fca24d23bef43e92d0b28895039e.zip
docs: Add documentation on how to run the graphstats.py script
Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
Diffstat (limited to 'docs')
-rw-r--r--docs/Debugging.md23
1 files changed, 23 insertions, 0 deletions
diff --git a/docs/Debugging.md b/docs/Debugging.md
index 5b730e03..eaac6748 100644
--- a/docs/Debugging.md
+++ b/docs/Debugging.md
@@ -123,3 +123,26 @@ Klipper source code). To do so, run:
```
~/klippy-env/bin/python ./klippy/console.py /tmp/pseudoserial 250000
```
+
+Generating load graphs
+======================
+
+The Klippy log file (/tmp/klippy.log) stores statistics on bandwidth,
+micro-controller load, and host buffer load. It can be useful to graph
+these statistics after a print.
+
+To generate a graph, a one time step is necessary to install the
+"matplotlib" package:
+
+```
+sudo apt-get update
+sudo apt-get install python-matplotlib
+```
+
+Then graphs can be produced with:
+
+```
+~/klipper/scripts/graphstats.py /tmp/klippy.log loadgraph.png
+```
+
+One can then view the resulting **loadgraph.png** file.