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

docs: Update installation document 

Various installation updates.  Recommend upgrade to OctoPrint v1.3.0.
Recommend configuring OctoPrint to not disconnect on error.  Note
quirk with needing to reload page if "/tmp/printer" not in list of
serial connections.  Add brief documentation on use of extended
commands and checking for errors.

Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
This commit is contained in:
Kevin O'Connor 2016-12-21 11:55:55 -05:00
parent 219796ef4e
commit 29aa6ef6c7
1 changed files with 26 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

33
docs/Installation.md
View File

@ -12,13 +12,14 @@ Prepping an OS image
==================== ====================
Start by installing [OctoPi](https://github.com/guysoft/OctoPi) on the Start by installing [OctoPi](https://github.com/guysoft/OctoPi) on the
Raspberry Pi computer. Use version 0.13.0 or later - see the Raspberry Pi computer. Use OctoPi v0.13.0 or later - see the
[octopi releases](https://github.com/guysoft/OctoPi/releases) for [octopi releases](https://github.com/guysoft/OctoPi/releases) for
release information. One should verify that OctoPi boots, that the release information. One should verify that OctoPi boots and that the
OctoPrint web server works, and that one can ssh to the octopi server OctoPrint web server works. After connecting to the OctoPrint web
(ssh pi@octopi -- password is "raspberry") before continuing. page, follow the prompt to upgrade OctoPrint to v1.3.0 or later.
After installing OctoPi, ssh into the target machine and run the After installing OctoPi and upgrading OctoPrint, ssh into the target
machine (ssh pi@octopi -- password is "raspberry") and run the
following commands: following commands:
``` ```
@ -116,7 +117,8 @@ Under "Serial Connection" in "Additional serial ports" add
Enter the Settings tab again and under "Serial Connection" change the Enter the Settings tab again and under "Serial Connection" change the
"Serial Port" setting to "/tmp/printer". Change the Baudrate field to "Serial Port" setting to "/tmp/printer". Change the Baudrate field to
250000 (this buad rate field is not related to the firmware baudrate 250000 (this buad rate field is not related to the firmware baudrate
and may be safely left at 250000). and may be safely left at 250000). Unselect the "Not only cancel
ongoing prints but also disconnect..." checkbox.
Under the "Features" tab, unselect "Enable SD support". Then click Under the "Features" tab, unselect "Enable SD support". Then click
"Save". "Save".
@ -132,4 +134,21 @@ The host software is executed by running the following as the regular
``` ```
Once Klippy is running, use a web-browser and navigate to the Once Klippy is running, use a web-browser and navigate to the
OctoPrint web site. Click on "Connect" under the "Connection" tab. OctoPrint web site. Under the "Connection" tab (on the left of the
main 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.
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.