docs: Installation updates
Recommend using 'make flash' and clean up the octoprint instructions. Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
This commit is contained in:
Kevin O'Connor
parent
1878da228d
commit
70599667cb
|
|
@ -1,12 +1,15 @@
|
|||
Klipper is currently in an experimental state. These instructions
|
||||
assume the software will run on a Raspberry Pi computer in conjunction
|
||||
with OctoPrint. Klipper supports Atmel ATmega based micro-controllers
|
||||
and Arduino Due (Atmel SAM3x8e ARM micro-controllers) printers.
|
||||
These instructions assume the software will run on a Raspberry Pi
|
||||
computer in conjunction with OctoPrint. It is recommended that a
|
||||
Raspberry Pi 2 or Raspberry Pi 3 computer be used as the host
|
||||
machine.
|
||||
|
||||
It is recommended that a Raspberry Pi 2 or Raspberry Pi 3 computer be
|
||||
used as the host. The software will run on a first generation
|
||||
Raspberry Pi, but the combined load of OctoPrint, Klipper, and a web
|
||||
cam (if applicable) can overwhelm its CPU leading to print stalls.
|
||||
It should be possible to run the Klipper host software on any 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 and
|
||||
Arduino Due (Atmel SAM3x8e ARM micro-controller) printers.
|
||||
|
||||
Prepping an OS image
|
||||
====================
|
||||
|
|
@ -32,8 +35,8 @@ setup Klipper to run at system startup, and start the Klipper host
|
|||
software. It will require an internet connection and it may take a few
|
||||
minutes to complete.
|
||||
|
||||
Building the micro-controller code
|
||||
==================================
|
||||
Building and flashing the micro-controller
|
||||
==========================================
|
||||
|
||||
To compile the micro-controller code, start by configuring it:
|
||||
|
||||
|
|
@ -49,51 +52,37 @@ configured, run:
|
|||
make
|
||||
```
|
||||
|
||||
Installing Klipper on an AVR micro-controller
|
||||
---------------------------------------------
|
||||
|
||||
The avrdude package can be used to install the micro-controller code
|
||||
on an AVR ATmega chip. The exact syntax of the avrdude command is
|
||||
different for each micro-controller. The following is an example
|
||||
command for atmega2560 chips:
|
||||
Finally, for common micro-controllers, the code can be flashed with:
|
||||
|
||||
```
|
||||
example-only$ avrdude -C/etc/avrdude.conf -v -patmega2560 -cwiring -P/dev/ttyACM0 -b115200 -D -Uflash:w:/home/pi/klipper/out/klipper.elf.hex:i
|
||||
```
|
||||
|
||||
Installing Klipper on an Arduino Due
|
||||
------------------------------------
|
||||
|
||||
Klipper currently uses the Arduino Due USB programming port (it will
|
||||
not work when connected to the application USB port). The programming
|
||||
port is the USB port closest to the power supply. To flash Klipper to
|
||||
the Due connect it to the host machine and run:
|
||||
|
||||
```
|
||||
stty -F /dev/ttyACM0 1200
|
||||
bossac -i -p ttyACM0 -R -e -w -v -b ~/klipper/out/klipper.bin
|
||||
make flash FLASH_DEVICE=/dev/ttyACM0
|
||||
```
|
||||
|
||||
Setting up the printer configuration
|
||||
====================================
|
||||
|
||||
It is necessary to configure the printer. This is done by modifying a
|
||||
configuration file that resides on the host. Start by copying an
|
||||
example configuration and editing it. For example:
|
||||
The Klipper configuration is stored in a text file on the Raspberry
|
||||
Pi. Take a look at the example config files in the
|
||||
[config directory](../config/). The
|
||||
[example.cfg](../config/example.cfg) file contains documentation on
|
||||
command parameters and it can also be used as an initial config file
|
||||
template. However, for most printers, one of the other config files
|
||||
may be a more concise starting point. The next step is to copy and
|
||||
edit one of these config files - for example:
|
||||
|
||||
```
|
||||
cp ~/klipper/config/example.cfg ~/printer.cfg
|
||||
nano printer.cfg
|
||||
nano ~/printer.cfg
|
||||
```
|
||||
|
||||
Make sure to look at and update each setting that is appropriate for
|
||||
Make sure to review and update each setting that is appropriate for
|
||||
the hardware.
|
||||
|
||||
Configuring OctoPrint to use Klippy
|
||||
===================================
|
||||
Configuring OctoPrint to use Klipper
|
||||
====================================
|
||||
|
||||
The OctoPrint web server needs to be configured to communicate with
|
||||
the Klippy host software. Using a web-browser, login to the OctoPrint
|
||||
the Klipper host software. Using a web browser, login to the OctoPrint
|
||||
web page, and navigate to the Settings tab. Then configure the
|
||||
following items:
|
||||
|
||||
|
|
@ -101,28 +90,29 @@ Under "Serial Connection" in "Additional serial ports" add
|
|||
"/tmp/printer". Then click "Save".
|
||||
|
||||
Enter the Settings tab again and under "Serial Connection" change the
|
||||
"Serial Port" setting to "/tmp/printer". Change the Baudrate field to
|
||||
250000 (this buad rate field is not related to the firmware baudrate
|
||||
and may be safely left at 250000). Unselect the "Not only cancel
|
||||
"Serial Port" setting to "/tmp/printer". Unselect the "Not only cancel
|
||||
ongoing prints but also disconnect..." checkbox. Click "Save".
|
||||
|
||||
From the main page, under the "Connection" window (at the top left of
|
||||
From the main page, under the "Connection" section (at the top left of
|
||||
the page) make sure the "Serial Port" is set to "/tmp/printer" and
|
||||
click "Connect". (If "/tmp/printer" is not an available selection then
|
||||
try reloading the page.)
|
||||
|
||||
Once connected, navigate to the "Terminal" tab and type "status"
|
||||
(without the quotes) into the command entry box and click "Send". If
|
||||
the Klippy config file was successfully read, and the micro-controller
|
||||
was successfully found and configured, then this command will report
|
||||
that the printer is ready. Klippy reports error messages via this
|
||||
terminal tab. The "status" command can be used to re-report error
|
||||
messages. The default Klipper startup script also places a log in
|
||||
**/tmp/klippy.log** which may provide more detailed information should
|
||||
an error occur.
|
||||
the Klipper config file was successfully read, and the
|
||||
micro-controller was successfully found and configured, then this
|
||||
command will report that the printer is ready. It is not unusual to
|
||||
have a configuration error during the initial setup - one may modify
|
||||
the printer config file and then issue a "restart" command in the
|
||||
OctoPrint terminal to reload the config. Continue modifying the config
|
||||
and restarting until "status" reports the printer is ready.
|
||||
|
||||
In addition to common g-code commands, Klippy supports a few extended
|
||||
commands - "status" is an example of one of these commands. Use the
|
||||
"help" command to get a list of other extended commands. In
|
||||
particular, note the "restart" command - use this command to reload
|
||||
the Klippy config file after any changes.
|
||||
Klipper reports error messages via the OctoPrint terminal tab. The
|
||||
"status" command can be used to re-report error messages. The default
|
||||
Klipper startup script also places a log in **/tmp/klippy.log** which
|
||||
provides more detailed information.
|
||||
|
||||
In addition to common g-code commands, Klipper supports a few extended
|
||||
commands - "status" and "restart" are examples of these commands. Use
|
||||
the "help" command to get a list of other extended commands.
|
||||
|
|
|
|||
Loading…
Reference in New Issue