diff options
| author | Kevin O'Connor <kevin@koconnor.net> | 2018-11-13 14:06:27 -0500 |
|---|---|---|
| committer | Kevin O'Connor <kevin@koconnor.net> | 2018-11-13 14:06:27 -0500 |
| commit | 5f9ce32fae034288e13a698b94b4fe69efd35ecf (patch) | |
| tree | e498c1c6d4a5d87f44d4dc6169243731dc850694 | |
| parent | ccb660a0ea373e85b5d2ae70d7cf4324a4bf5575 (diff) | |
| download | kutter-5f9ce32fae034288e13a698b94b4fe69efd35ecf.tar.gz kutter-5f9ce32fae034288e13a698b94b4fe69efd35ecf.tar.xz kutter-5f9ce32fae034288e13a698b94b4fe69efd35ecf.zip | |
docs: Be more clear that a baud of 250000 is recommended
Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
| -rw-r--r-- | docs/FAQ.md | 24 | ||||
| -rw-r--r-- | docs/Installation.md | 6 |
2 files changed, 18 insertions, 12 deletions
diff --git a/docs/FAQ.md b/docs/FAQ.md index f54d3f41..f0dd7534 100644 --- a/docs/FAQ.md +++ b/docs/FAQ.md @@ -95,16 +95,17 @@ parameters - see the avrdude documentation for further information. ### How do I change the serial baud rate? -The default baud rate is 250000 in both the Klipper micro-controller -configuration and in the Klipper host software. This works on almost -all micro-controllers and it is the recommended setting. (Most online -guides that refer to a baud rate of 115200 are outdated.) +The recommended baud rate for Klipper is 250000. This baud rate works +well on all micro-controller boards that Klipper supports. If you've +found an online guide recommending a different baud rate, then ignore +that part of the guide and continue with the default value of 250000. -If you need to change the baud rate, then the new rate will need to be -configured in the micro-controller (during **make menuconfig**) and -that updated code will need to be flashed to the micro-controller. The -Klipper printer.cfg file will also need to be updated to match that -baud rate (see the example.cfg file for details). For example: +If you want to change the baud rate anyway, then the new rate will +need to be configured in the micro-controller (during **make +menuconfig**) and that updated code will need to be compiled and +flashed to the micro-controller. The Klipper printer.cfg file will +also need to be updated to match that baud rate (see the example.cfg +file for details). For example: ``` [mcu] baud: 250000 @@ -114,6 +115,11 @@ The baud rate shown on the OctoPrint web page has no impact on the internal Klipper micro-controller baud rate. Always set the OctoPrint baud rate to 250000 when using Klipper. +The Klipper micro-controller baud rate is not related to the baud rate +of the micro-controller's bootloader. See the +[bootloader document](docs/Bootloaders.md) for additional information +on bootloaders. + ### Can I run Klipper on something other than a Raspberry Pi 3? The recommended hardware is a Raspberry Pi 2 or a Raspberry diff --git a/docs/Installation.md b/docs/Installation.md index 1ab0a005..23c14727 100644 --- a/docs/Installation.md +++ b/docs/Installation.md @@ -50,9 +50,9 @@ make menuconfig ``` Select the appropriate micro-controller and review any other options -provided. For boards with serial ports, the default baud rate is -250000 (see the [FAQ](FAQ.md#how-do-i-change-the-serial-baud-rate) if -changing). Once configured, run: +provided. For boards with serial ports, the recommended baud rate is +250000 (see the [FAQ](FAQ.md#how-do-i-change-the-serial-baud-rate) +before changing). Once configured, run: ``` make |