docs : make modifications to all md files to make them compatible with mkdocs
all markdown files must have a single H1 heading at the top. Signed-off-by: Damien Martin <damlobster@gmail.com> Update CNAME
This commit is contained in:
@@ -1,7 +1,8 @@
|
||||
# Debugging
|
||||
|
||||
This document describes some of the Klipper debugging tools.
|
||||
|
||||
Translating gcode files to micro-controller commands
|
||||
====================================================
|
||||
## Translating gcode files to micro-controller commands
|
||||
|
||||
The Klippy host code can run in a batch mode to produce the low-level
|
||||
micro-controller commands associated with a gcode file. Inspecting
|
||||
@@ -43,8 +44,7 @@ actual commands and the above output. The generated data is useful for
|
||||
testing and inspection; it is not useful for sending to a real
|
||||
micro-controller.
|
||||
|
||||
Testing with simulavr
|
||||
=====================
|
||||
## Testing with simulavr
|
||||
|
||||
The [simulavr](http://www.nongnu.org/simulavr/) tool enables one to
|
||||
simulate an Atmel ATmega micro-controller. This section describes how
|
||||
@@ -94,8 +94,8 @@ python virtual environment):
|
||||
~/klippy-env/bin/python ./klippy/klippy.py config/generic-simulavr.cfg -i test.gcode -v
|
||||
```
|
||||
|
||||
Using simulavr with gtkwave
|
||||
---------------------------
|
||||
### Using simulavr with gtkwave
|
||||
|
||||
|
||||
One useful feature of simulavr is its ability to create signal wave
|
||||
generation files with the exact timing of events. To do this, follow
|
||||
@@ -114,8 +114,8 @@ using gtkwave with:
|
||||
gtkwave avrsim.vcd
|
||||
```
|
||||
|
||||
Manually sending commands to the micro-controller
|
||||
=================================================
|
||||
## Manually sending commands to the micro-controller
|
||||
|
||||
|
||||
Normally, the host klippy.py process would be used to translate gcode
|
||||
commands to Klipper micro-controller commands. However, it's also
|
||||
@@ -132,8 +132,7 @@ functionality.
|
||||
Some command-line options are available. For more information run:
|
||||
`~/klippy-env/bin/python ./klippy/console.py --help`
|
||||
|
||||
Generating load graphs
|
||||
======================
|
||||
## 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
|
||||
@@ -158,8 +157,7 @@ One can then view the resulting **loadgraph.png** file.
|
||||
Different graphs can be produced. For more information run:
|
||||
`~/klipper/scripts/graphstats.py --help`
|
||||
|
||||
Extracting information from the klippy.log 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
|
||||
@@ -178,8 +176,7 @@ shutdown information. The information dumps from an MCU shutdown (if
|
||||
present) will be reordered by timestamp to assist in diagnosing cause
|
||||
and effect scenarios.
|
||||
|
||||
Running the regression tests
|
||||
============================
|
||||
## Running the regression tests
|
||||
|
||||
The main Klipper GitHub repository uses "github actions" to run a
|
||||
series of regression tests. It can be useful to run some of these
|
||||
|
||||
Reference in New Issue
Block a user