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:
Damien
2021-07-22 00:40:40 +02:00
committed by KevinOConnor
parent 7e88f9220c
commit cff61605fb
44 changed files with 565 additions and 536 deletions

View File

@@ -15,10 +15,9 @@ pulling SDO to GND), and, if it is going to be connected to a 5V printer MCU,
that it has a voltage regulator and a level shifter.
Installation instructions
===========================
## Installation instructions
## Wiring
### Wiring
You need to connect ADXL345 to your Raspberry Pi via SPI. Note that the I2C
connection, which is suggested by ADXL345 documentation, has too low throughput
@@ -41,7 +40,7 @@ Fritzing wiring diagrams for some of the ADXL345 boards:
Double-check your wiring before powering up the Raspberry Pi to prevent
damaging it or the accelerometer.
## Mounting the accelerometer
### Mounting the accelerometer
The accelerometer must be attached to the toolhead. One needs to design a proper
mount that fits their own 3D printer. It is better to align the axes of the
@@ -63,7 +62,7 @@ be designed such as to ensure the electrical isolation of the accelerometer
from the printer frame. Failing to ensure that can create a ground loop in
the system that may damage the electronics.
## Software installation
### Software installation
Note that resonance measurements and shaper auto-calibration require additional
software dependencies not installed by default. First, you will have to run on
@@ -107,10 +106,9 @@ slightly above it.
Restart Klipper via the `RESTART` command.
Measuring the resonances
===========================
## Measuring the resonances
## Checking the setup
### Checking the setup
Now you can test a connection.
@@ -138,7 +136,7 @@ somewhere in the range of ~1-100). Too high axes noise (e.g. 1000 and more)
can be indicative of the sensor issues, problems with its power, or too
noisy imbalanced fans on a 3D printer.
## Measuring the resonances
### Measuring the resonances
Now you can run some real-life tests. Run the following command:
```
@@ -212,7 +210,7 @@ from Klipper [directly](#input-shaper-auto-calibration), which can be
convenient, for example, for the input shaper
[re-calibration](#input-shaper-re-calibration).
## Bed-slinger printers
### Bed-slinger printers
If your printer is a bed slinger printer, you will need to change the location
of the accelerometer between the measurements for X and Y axes: measure the
@@ -242,7 +240,7 @@ probe_points: ...
Then the commands `TEST_RESONANCES AXIS=X` and `TEST_RESONANCES AXIS=Y`
will use the correct accelerometer for each axis.
## Max smoothing
### Max smoothing
Keep in mind that the input shaper can create some smoothing in parts.
Automatic tuning of the input shaper performed by `calibrate_shaper.py`
@@ -327,7 +325,7 @@ Then, if you [rerun](#input-shaper-re-calibration) the input shaper auto-tuning
using `SHAPER_CALIBRATE` Klipper command in the future, it will use the stored
`max_smoothing` value as a reference.
## Selecting max_accel
### Selecting max_accel
Since the input shaper can create some smoothing in parts, especially at high
accelerations, you will still need to choose the `max_accel` value that
@@ -357,7 +355,7 @@ If you are doing a shaper re-calibration and the reported smoothing for the
suggested shaper configuration is almost the same as what you got during the
previous calibration, this step can be skipped.
## Testing custom axes
### Testing custom axes
`TEST_RESONANCES` command supports custom axes. While this is not really
useful for input shaper calibration, it can be used to study printer
@@ -387,7 +385,7 @@ and then use the same command
```
to generate `/tmp/resonances.png` comparing the resonances.
# Input Shaper auto-calibration
## Input Shaper auto-calibration
Besides manually choosing the appropriate parameters for the input shaper
feature, it is also possible to run the auto-tuning for the input shaper
@@ -436,7 +434,7 @@ However, if you connected two accelerometers simultaneously, you simply run
`SHAPER_CALIBRATE` without specifying an axis to calibrate the input shaper
for both axes in one go.
## Input Shaper re-calibration
### Input Shaper re-calibration
`SHAPER_CALIBRATE` command can be also used to re-calibrate the input shaper in
the future, especially if some changes to the printer that can affect its
@@ -463,7 +461,7 @@ is not expected that the noise will affect the print quality too much.
However, it is still advised to double-check the suggested parameters, and
print some test prints before using them to confirm they are good.
# Offline processing of the accelerometer data
## Offline processing of the accelerometer data
It is possible to generate the raw accelerometer data and process it offline
(e.g. on a host machine), for example to find resonances. In order to do so,