aboutsummaryrefslogtreecommitdiffstats
path: root/docs/FAQ.md
diff options
context:
space:
mode:
authorKevin O'Connor <kevin@koconnor.net>2018-01-04 13:19:11 -0500
committerKevin O'Connor <kevin@koconnor.net>2018-01-04 13:29:17 -0500
commit29c83cec22190f1a00d118d5743594c8d5eda826 (patch)
tree19cb27957d8b7c23936209bd6a3a10451afdf040 /docs/FAQ.md
parentdb927bd82291464b023cf5cd3b5274e288db9ba8 (diff)
downloadkutter-29c83cec22190f1a00d118d5743594c8d5eda826.tar.gz
kutter-29c83cec22190f1a00d118d5743594c8d5eda826.tar.xz
kutter-29c83cec22190f1a00d118d5743594c8d5eda826.zip
docs: Update installation document with pointers to FAQ
Add some pointers to the FAQ for common pitfalls during installation. Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
Diffstat (limited to 'docs/FAQ.md')
-rw-r--r--docs/FAQ.md72
1 files changed, 57 insertions, 15 deletions
diff --git a/docs/FAQ.md b/docs/FAQ.md
index 58487e62..0c3402e7 100644
--- a/docs/FAQ.md
+++ b/docs/FAQ.md
@@ -13,21 +13,31 @@ each motor driver pulse. It can also be calculated from the axis
pitch, motor step angle, and driver microstepping. If unsure, do a web
search for "calculate steps per mm" to find an online calculator.
-### When I restart my micro-controller the device changes to /dev/ttyACM1
+### Where's my serial port?
-If the device sometimes changes from /dev/ttyACM0 to /dev/ttyACM1 then
-ssh into the host computer and run: ```ls -l /dev/serial/by-id/```
+The general way to find a USB serial port is to run `ls -l
+/dev/serial/by-id/` from an ssh terminal on the host machine. It will
+likely produce output similar to the following:
+```
+lrwxrwxrwx 1 root root 13 Jan 3 22:15 usb-UltiMachine__ultimachine.com__RAMBo_12345678912345678912-if00 -> ../../ttyACM0
+```
The name found in the above command is stable and it is possible to
-use it in the config file. For example, an updated config might look
-like:
+use it in the config file and while flashing the micro-controller
+code. For example, a flash command might look similar to:
+```
+sudo service klipper stop
+make flash FLASH_DEVICE=/dev/serial/by-id/usb-UltiMachine__ultimachine.com__RAMBo_12345678912345678912-if00
+sudo service klipper start
+```
+and the updated config might look like:
```
[mcu]
serial: /dev/serial/by-id/usb-UltiMachine__ultimachine.com__RAMBo_12345678912345678912-if00
```
-Be sure to copy-and-paste the name from the "ls" command above as the
-name will be different on each printer.
+Be sure to copy-and-paste the name from the "ls" command that you ran
+above as the name will be different for each printer.
### The "make flash" command doesn't work.
@@ -37,11 +47,11 @@ methods, so the "make flash" command may not work on all boards.
If you're having an intermittent failure or you do have a standard
setup, then double check that Klipper isn't running when flashing
-(sudo service klipper stop), make sure Octoprint isn't trying to
+(sudo service klipper stop), make sure OctoPrint isn't trying to
connect directly to the device (open the Connection tab in the web
page and click Disconnect if the Serial Port is set to the device),
and make sure FLASH_DEVICE is set correctly for your board (see the
-[question above](#when-i-restart-my-micro-controller-the-device-changes-to-devttyacm1)).
+[question above](#wheres-my-serial-port)).
However, if "make flash" just doesn't work for your board, then you
will need to manually flash. See if there is a config file in the
@@ -52,12 +62,44 @@ may be possible to manually flash the device using
[avrdude](http://www.nongnu.org/avrdude/) with custom command-line
parameters - see the avrdude documentation for further information.
-### Can I run Klipper on something other than a Raspberry Pi?
+### 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.)
+
+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:
+```
+[mcu]
+baud: 250000
+```
+
+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.
+
+### Can I run Klipper on something other than a Raspberry Pi 3?
+
+The recommended hardware is a Raspberry Pi 2 or a Raspberry
+Pi 3. Klipper will run on a Raspberry Pi 1 and on the Raspberry Pi
+Zero, but these boards don't have enough processing power to run
+OctoPrint well. It's not uncommon for print stalls to occur on these
+slower machines (the printer may move faster than OctoPrint can send
+movement commands).
+
+For running on the Beaglebone, see the
+[Beaglebone specific installation instructions](beaglebone.md).
-Klipper only requires Python running on a Linux (or similar)
+Klipper has been run on other machines. The Klipper host software
+only requires Python running on a Linux (or similar)
computer. However, if you wish to run it on a different machine you
will need Linux admin knowledge to install the system prerequisites
-for the Linux distribution running on that particular machine. See the
+for that particular machine. See the
[install-octopi.sh](../scripts/install-octopi.sh) script for further
information on the necessary Linux admin steps.
@@ -70,9 +112,9 @@ the config file. If the motors are disabled (via an M84 or M18
command) then the motors will need to be homed again prior to
movement.
-If you want to move the head after canceling a print via Octoprint,
-consider changing the Octoprint cancel sequence to do that for
-you. It's configured in Octoprint via a web browser under:
+If you want to move the head after canceling a print via OctoPrint,
+consider changing the OctoPrint cancel sequence to do that for
+you. It's configured in OctoPrint via a web browser under:
Settings->GCODE Scripts
If you want to move the head after a print finishes, consider adding