Deploying to gh-pages from @ Klipper3d/klipper@f511e201f9 🚀
This commit is contained in:
@@ -1481,14 +1481,14 @@
|
||||
|
||||
|
||||
<h1 id="installation">Installation<a class="headerlink" href="#installation" title="Permanent link">¶</a></h1>
|
||||
<p>These instructions assume the software will run on a linux based host
|
||||
running a Klipper compatible front end. It is recommended that a
|
||||
SBC(Small Board Computer) such as a Raspberry Pi or Debian based Linux
|
||||
<p>These instructions assume the software will run on a Linux-based host
|
||||
running a Klipper-compatible front end. It is recommended that a
|
||||
SBC(Small Board Computer) such as a Raspberry Pi or Debian-based Linux
|
||||
device be used as the host machine (see the
|
||||
<a href="FAQ.html#can-i-run-klipper-on-something-other-than-a-raspberry-pi-3">FAQ</a>
|
||||
for other options).</p>
|
||||
<p>For the purposes of these instructions host relates to the Linux device and
|
||||
mcu relates to the printboard. SBC relates to the term Small Board Computer
|
||||
<p>For the purposes of these instructions, host relates to the Linux device and
|
||||
mcu relates to the printer board. SBC relates to the term Small Board Computer
|
||||
such as the Raspberry Pi.</p>
|
||||
<h2 id="obtain-a-klipper-configuration-file">Obtain a Klipper Configuration File<a class="headerlink" href="#obtain-a-klipper-configuration-file" title="Permanent link">¶</a></h2>
|
||||
<p>Most Klipper settings are determined by a "printer configuration file"
|
||||
@@ -1525,23 +1525,23 @@ same in all cases. We encourage users to research the options available and
|
||||
make an informed decision.</p>
|
||||
<h2 id="obtaining-an-os-image-for-sbcs">Obtaining an OS image for SBC's<a class="headerlink" href="#obtaining-an-os-image-for-sbcs" title="Permanent link">¶</a></h2>
|
||||
<p>There are many ways to obtain an OS image for Klipper for SBC use, most depend on
|
||||
what front end you wish to use. Some manafactures of these SBC boards also provide
|
||||
what front end you wish to use. Some manufacturers of these SBC boards also provide
|
||||
their own Klipper-centric images.</p>
|
||||
<p>The two main Moonraker based front ends are <a href="https://docs.fluidd.xyz/">Fluidd</a>
|
||||
<p>The two main Moonraker-based front ends are <a href="https://docs.fluidd.xyz/">Fluidd</a>
|
||||
and <a href="https://docs.mainsail.xyz/">Mainsail</a>, the latter of which has a premade install
|
||||
image <a href="https://docs-os.mainsail.xyz/">"MainsailOS"</a>, this has the option for Raspberry Pi
|
||||
and some OrangePi varianta.</p>
|
||||
and some OrangePi variants.</p>
|
||||
<p>Fluidd can be installed via KIAUH(Klipper Install And Update Helper), which
|
||||
is explained below and is a 3rd party installer for all things Klipper.</p>
|
||||
<p>OctoPrint can be installed via the popular OctoPi image or via KIAUH, this
|
||||
process is explained in <a href="OctoPrint.html">OctoPrint.md</a></p>
|
||||
<h2 id="installing-via-kiauh">Installing via KIAUH<a class="headerlink" href="#installing-via-kiauh" title="Permanent link">¶</a></h2>
|
||||
<p>Normally you would start with a base image for your SBC, RPiOS Lite for example,
|
||||
or in the case of a x86 Linux device, Ubuntu Server. Please note that Desktop
|
||||
or in the case of an x86 Linux device, Ubuntu Server. Please note that Desktop
|
||||
variants are not recommended due to certain helper programs that can stop some
|
||||
Klipper functions working and even mask access to some print boards.</p>
|
||||
Klipper functions from working and even mask access to some printer boards.</p>
|
||||
<p>KIAUH can be used to install Klipper and its associated programs on a variety
|
||||
of Linux based systems that run a form of Debian. More information can be found
|
||||
of Linux-based systems that run a form of Debian. More information can be found
|
||||
at <a href="https://github.com/dw-0/kiauh">https://github.com/dw-0/kiauh</a></p>
|
||||
<h2 id="building-and-flashing-the-micro-controller">Building and flashing the micro-controller<a class="headerlink" href="#building-and-flashing-the-micro-controller" title="Permanent link">¶</a></h2>
|
||||
<p>To compile the micro-controller code, start by running these commands
|
||||
@@ -1563,7 +1563,7 @@ then "Y" to save. Then run:</p>
|
||||
<p>If the comments at the top of the
|
||||
<a href="#obtain-a-klipper-configuration-file">printer configuration file</a>
|
||||
describe custom steps for "flashing" the final image to the printer
|
||||
control board then follow those steps and then proceed to
|
||||
control board, then follow those steps and then proceed to
|
||||
<a href="#configuring-octoprint-to-use-klipper">configuring OctoPrint</a>.</p>
|
||||
<p>Otherwise, the following steps are often used to "flash" the printer
|
||||
control board. First, it is necessary to determine the serial port
|
||||
@@ -1583,11 +1583,11 @@ items are listed and the choice is ambiguous, unplug the board and
|
||||
run the command again, the missing item will be your print board(see the
|
||||
<a href="FAQ.html#wheres-my-serial-port">FAQ</a> for more information).</p>
|
||||
<p>For common micro-controllers with STM32 or clone chips, LPC chips and
|
||||
others it is usual that these need an initial Klipper flash via SD card.</p>
|
||||
others, it is usual that these need an initial Klipper flash via SD card.</p>
|
||||
<p>When flashing with this method, it is important to make sure that the
|
||||
print board is not connected with USB to the host, due to some boards
|
||||
being able to feed power back to the board and stopping a flash from
|
||||
occuring.</p>
|
||||
occurring.</p>
|
||||
<p>For common micro-controllers using Atmega chips, for example the 2560,
|
||||
the code can be flashed with something
|
||||
similar to:</p>
|
||||
@@ -1612,7 +1612,7 @@ before this operation.</p>
|
||||
<a href="#obtain-a-klipper-configuration-file">printer configuration file</a> to
|
||||
the host.</p>
|
||||
<p>Arguably the easiest way to set the Klipper configuration file is using the
|
||||
built in editors in Mainsail or Fluidd. These will allow the user to open
|
||||
built-in editors in Mainsail or Fluidd. These will allow the user to open
|
||||
the configuration examples and save them to be printer.cfg.</p>
|
||||
<p>Another option is to use a desktop editor that supports editing files
|
||||
over the "scp" and/or "sftp" protocols. There are freely available tools
|
||||
@@ -1621,7 +1621,7 @@ Load the printer config file in the editor and then save it as a file
|
||||
named "printer.cfg" in the home directory of the pi user
|
||||
(ie, /home/pi/printer.cfg).</p>
|
||||
<p>Alternatively, one can also copy and edit the file directly on the
|
||||
host via ssh. That may look something like the following (be
|
||||
host via SSH. That may look something like the following (be
|
||||
sure to update the command to use the appropriate printer config
|
||||
filename):</p>
|
||||
<div class="highlight"><pre><span></span><code>cp ~/klipper/config/example-cartesian.cfg ~/printer.cfg
|
||||
@@ -1644,19 +1644,19 @@ the <code>[mcu]</code> section to look something similar to:</p>
|
||||
serial: /dev/serial/by-id/usb-1a86_USB2.0-Serial-if00-port0
|
||||
</code></pre></div>
|
||||
|
||||
<p>After creating and editing the file it will be necessary to issue a
|
||||
<p>After creating and editing the file, it will be necessary to issue a
|
||||
"restart" command in the command console to load the config. A
|
||||
"status" command will report the printer is ready if the Klipper
|
||||
"status" command will report that the printer is ready if the Klipper
|
||||
config file is successfully read and the micro-controller is
|
||||
successfully found and configured.</p>
|
||||
<p>When customizing the printer config file, it is not uncommon for
|
||||
Klipper to report a configuration error. If an error occurs, make any
|
||||
necessary corrections to the printer config file and issue "restart"
|
||||
until "status" reports the printer is ready.</p>
|
||||
<p>Klipper reports error messages via the command console and via pop up in
|
||||
<p>Klipper reports error messages via the command console and pop-ups in
|
||||
Fluidd and Mainsail. The "status" command can be used to re-report error
|
||||
messages. A log is available and usually located in ~/printer_data/logs
|
||||
this is named klippy.log</p>
|
||||
messages. A log is available and usually located at
|
||||
<code>~/printer_data/logs/klippy.log</code>.</p>
|
||||
<p>After Klipper reports that the printer is ready, proceed to the
|
||||
<a href="Config_checks.html">config check document</a> to perform some basic checks
|
||||
on the definitions in the config file. See the main
|
||||
|
||||
Reference in New Issue
Block a user