3diy
/
klipper
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

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>
This commit is contained in:
Kevin O'Connor 2018-01-04 13:19:11 -05:00
parent db927bd822
commit 29c83cec22
2 changed files with 73 additions and 27 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

72
docs/FAQ.md
View File

@ -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 pitch, motor step angle, and driver microstepping. If unsure, do a web
search for "calculate steps per mm" to find an online calculator. 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 The general way to find a USB serial port is to run `ls -l
ssh into the host computer and run: ```ls -l /dev/serial/by-id/``` /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 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 use it in the config file and while flashing the micro-controller
like: 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] [mcu]
serial: /dev/serial/by-id/usb-UltiMachine__ultimachine.com__RAMBo_12345678912345678912-if00 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 Be sure to copy-and-paste the name from the "ls" command that you ran
name will be different on each printer. above as the name will be different for each printer.
### The "make flash" command doesn't work. ### 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 If you're having an intermittent failure or you do have a standard
setup, then double check that Klipper isn't running when flashing 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 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), 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 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 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 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 [avrdude](http://www.nongnu.org/avrdude/) with custom command-line
parameters - see the avrdude documentation for further information. 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?
Klipper only requires Python running on a Linux (or similar) 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 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 computer. However, if you wish to run it on a different machine you
will need Linux admin knowledge to install the system prerequisites 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 [install-octopi.sh](../scripts/install-octopi.sh) script for further
information on the necessary Linux admin steps. 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 command) then the motors will need to be homed again prior to
movement. movement.
If you want to move the head after canceling a print via Octoprint, If you want to move the head after canceling a print via OctoPrint,
consider changing the Octoprint cancel sequence to do that for consider changing the OctoPrint cancel sequence to do that for
you. It's configured in Octoprint via a web browser under: you. It's configured in OctoPrint via a web browser under:
Settings->GCODE Scripts Settings->GCODE Scripts
If you want to move the head after a print finishes, consider adding If you want to move the head after a print finishes, consider adding

28
docs/Installation.md
View File

@ -1,13 +1,9 @@
These instructions assume the software will run on a Raspberry Pi These instructions assume the software will run on a Raspberry Pi
computer in conjunction with OctoPrint. (See the computer in conjunction with OctoPrint. It is recommended that a
[Beaglebone specific instructions](beaglebone.md) if using a Raspberry Pi 2 or Raspberry Pi 3 computer be used as the host machine
Beaglebone.) It is recommended that a Raspberry Pi 2 or Raspberry Pi 3 (see the
computer be used as the host machine. [FAQ](FAQ.md#can-i-run-klipper-on-something-other-than-a-raspberry-pi-3)
for other machines).
It should be possible to run the Klipper host software on any computer
running a recent Linux distribution, but doing so will require Linux
admin knowledge to translate these installation instructions to the
particulars of that machine.
Klipper currently supports Atmel ATmega based micro-controllers, Klipper currently supports Atmel ATmega based micro-controllers,
Arduino Due (Atmel SAM3x8e ARM micro-controller), and Arduino Due (Atmel SAM3x8e ARM micro-controller), and
@ -53,8 +49,10 @@ cd ~/klipper/
make menuconfig make menuconfig
``` ```
Select the appropriate micro-controller and serial baud rate. Once Select the appropriate micro-controller and review any other options
configured, run: 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:
``` ```
make make
@ -68,6 +66,12 @@ make flash FLASH_DEVICE=/dev/ttyACM0
sudo service klipper start sudo service klipper start
``` ```
When flashing for the first time, make sure that OctoPrint is not
connected directly to the printer (from the OctoPrint web page, under
the "Connection" section, click "Disconnect"). The most common
communication device is **/dev/ttyACM0** - see the
[FAQ](FAQ.md#wheres-my-serial-port) for other possibilities.
Configuring OctoPrint to use Klipper Configuring OctoPrint to use Klipper
==================================== ====================================
@ -91,7 +95,7 @@ try reloading the page.)
Once connected, navigate to the "Terminal" tab and type "status" Once connected, navigate to the "Terminal" tab and type "status"
(without the quotes) into the command entry box and click "Send". The (without the quotes) into the command entry box and click "Send". The
terminal window will likely report there is an error opening the terminal window will likely report there is an error opening the
config file - that means Octoprint is successfully communicating with config file - that means OctoPrint is successfully communicating with
Klipper. Proceed to the next section. Klipper. Proceed to the next section.
Configuring Klipper Configuring Klipper