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

docs: Offer alternatives to ssh/scp/sftp 

Try to make the Installation document more friendly to users not
familiar with the Linux command-line.  Offer some hints on how to
obtain ssh and how to edit the config file remotely.

Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
This commit is contained in:
Kevin O'Connor 2017-12-21 17:34:35 -05:00
parent d303e556ad
commit 522093ef00
2 changed files with 63 additions and 46 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

27
docs/Contact.md
View File

@ -4,23 +4,20 @@ developers.
Bug reporting Bug reporting
============= =============
Bug reports are submitted through github issues. All bug reports must Bug reports are submitted through github issues. **All bug reports
include the full /tmp/klippy.log log file from the session that must include the full /tmp/klippy.log log file from the session that
produced the error. To acquire this log file, ssh into the computer produced the error.** An "scp" and/or "sftp" utility is needed to
running the klipper host software, and run: acquire this log file. The "scp" utility comes standard with Linux and
MacOS desktops. There are freely available scp utilities for other
desktops (eg, WinSCP).
``` Use the scp utility to copy the `/tmp/klippy.log` file from the host
gzip -k /tmp/klippy.log machine to your desktop. Open a new issue at
```
Then scp the resulting `/tmp/klippy.log.gz` file from the host machine
to your desktop. (If your desktop does not have scp installed, there
are a number of free scp programs available - just do a web search for
`windows scp` to find one.) Open a new issue at
https://github.com/KevinOConnor/klipper/issues , provide a description https://github.com/KevinOConnor/klipper/issues , provide a description
of the problem, and attach the `klippy.log.gz` file to the issue (use of the problem, and attach the `klippy.log` file to the issue (use the
the blue "selecting them" link beneath the problem description on the blue "selecting them" link beneath the problem description on the
github issue page to attach files). github issue page to attach files). It is a good idea to compress the
klippy.log file before posting it (eg, using zip or gzip).
If the Klipper software does something unexpected but does not produce If the Klipper software does something unexpected but does not produce
an error, then immediately issue an M112 command in the Octoprint an error, then immediately issue an M112 command in the Octoprint

82
docs/Installation.md
View File

@ -23,9 +23,14 @@ release information. One should verify that OctoPi boots and that the
OctoPrint web server works. After connecting to the OctoPrint web OctoPrint web server works. After connecting to the OctoPrint web
page, follow the prompt to upgrade OctoPrint to v1.3.5 or later. page, follow the prompt to upgrade OctoPrint to v1.3.5 or later.
After installing OctoPi and upgrading OctoPrint, ssh into the target After installing OctoPi and upgrading OctoPrint, it will be necessary
machine (ssh pi@octopi -- password is "raspberry") and run the to ssh into the target machine to run a handful of system commands. If
following commands: using a Linux or MacOS desktop, then the "ssh" software should already
be installed on the desktop. There are free ssh clients available for
other desktops (eg,
[PuTTY](https://www.chiark.greenend.org.uk/~sgtatham/putty/)). Use the
ssh utility to connect to the Raspberry Pi (ssh pi@octopi -- password
is "raspberry") and run the following commands:
``` ```
git clone https://github.com/KevinOConnor/klipper git clone https://github.com/KevinOConnor/klipper
@ -40,7 +45,8 @@ minutes to complete.
Building and flashing the micro-controller Building and flashing the micro-controller
========================================== ==========================================
To compile the micro-controller code, start by configuring it: To compile the micro-controller code, start by running these commands
on the Raspberry Pi:
``` ```
cd ~/klipper/ cd ~/klipper/
@ -62,26 +68,6 @@ make flash FLASH_DEVICE=/dev/ttyACM0
sudo service klipper start sudo service klipper start
``` ```
Configuring Klipper
===================
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
```
Make sure to review and update each setting that is appropriate for
the hardware.
Configuring OctoPrint to use Klipper Configuring OctoPrint to use Klipper
==================================== ====================================
@ -105,13 +91,47 @@ 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 - issue a "restart" command in the OctoPrint terminal to config file - that means Octoprint is successfully communicating with
load the config. A "status" command will report the printer is ready Klipper. Proceed to the next section.
if the Klipper config file is successfully read and the
micro-controller is successfully found and configured. It is not Configuring Klipper
unusual to have configuration errors during the initial setup - update ===================
the printer config file and issue "restart" until "status" reports the
printer is ready. 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.
Arguably the easiest way to update the Klipper configuration file is
to use a desktop editor that supports editing files over the "scp"
and/or "sftp" protocols. There are freely available tools that support
this (eg, Notepad++, WinSCP, and Cyberduck). Use one of the example
config files as a starting point and save it as a file named
"printer.cfg" in the home directory of the pi user (ie,
/home/pi/printer.cfg).
Alternatively, one can also copy and edit the file directly on the
Raspberry Pi via ssh - for example:
```
cp ~/klipper/config/example.cfg ~/printer.cfg
nano ~/printer.cfg
```
Make sure to review and update each setting that is appropriate for
the hardware.
After creating and editing the file it will be necessary to issue a
"restart" command in the OctoPrint web terminal to load the config. A
"status" command will report the printer is ready if the Klipper
config file is successfully read and the micro-controller is
successfully found and configured. It is not unusual to have
configuration errors during the initial setup - update the printer
config file and issue "restart" until "status" reports the printer is
ready.
Klipper reports error messages via the OctoPrint terminal tab. The Klipper reports error messages via the OctoPrint terminal tab. The
"status" command can be used to re-report error messages. The default "status" command can be used to re-report error messages. The default