Deploying to gh-pages from @ Klipper3d/klipper@383b83d788 🚀
This commit is contained in:
@@ -480,22 +480,22 @@
|
||||
</li>
|
||||
|
||||
<li class="md-nav__item">
|
||||
<a href="#interacting-with-klipper" class="md-nav__link">
|
||||
Interacting with Klipper
|
||||
<a href="#klipper_1" class="md-nav__link">
|
||||
与 Klipper 交互
|
||||
</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class="md-nav__item">
|
||||
<a href="#obtaining-an-os-image-for-sbcs" class="md-nav__link">
|
||||
Obtaining an OS image for SBC's
|
||||
<a href="#sbc" class="md-nav__link">
|
||||
获取 SBC 的操作系统映像
|
||||
</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class="md-nav__item">
|
||||
<a href="#installing-via-kiauh" class="md-nav__link">
|
||||
Installing via KIAUH
|
||||
<a href="#kiauh" class="md-nav__link">
|
||||
通过 KIAUH 安装
|
||||
</a>
|
||||
|
||||
</li>
|
||||
@@ -508,7 +508,7 @@
|
||||
</li>
|
||||
|
||||
<li class="md-nav__item">
|
||||
<a href="#klipper_1" class="md-nav__link">
|
||||
<a href="#klipper_2" class="md-nav__link">
|
||||
配置 Klipper
|
||||
</a>
|
||||
|
||||
@@ -1415,22 +1415,22 @@
|
||||
</li>
|
||||
|
||||
<li class="md-nav__item">
|
||||
<a href="#interacting-with-klipper" class="md-nav__link">
|
||||
Interacting with Klipper
|
||||
<a href="#klipper_1" class="md-nav__link">
|
||||
与 Klipper 交互
|
||||
</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class="md-nav__item">
|
||||
<a href="#obtaining-an-os-image-for-sbcs" class="md-nav__link">
|
||||
Obtaining an OS image for SBC's
|
||||
<a href="#sbc" class="md-nav__link">
|
||||
获取 SBC 的操作系统映像
|
||||
</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class="md-nav__item">
|
||||
<a href="#installing-via-kiauh" class="md-nav__link">
|
||||
Installing via KIAUH
|
||||
<a href="#kiauh" class="md-nav__link">
|
||||
通过 KIAUH 安装
|
||||
</a>
|
||||
|
||||
</li>
|
||||
@@ -1443,7 +1443,7 @@
|
||||
</li>
|
||||
|
||||
<li class="md-nav__item">
|
||||
<a href="#klipper_1" class="md-nav__link">
|
||||
<a href="#klipper_2" class="md-nav__link">
|
||||
配置 Klipper
|
||||
</a>
|
||||
|
||||
@@ -1467,27 +1467,27 @@
|
||||
|
||||
|
||||
<h1 id="_1">安装<a class="headerlink" href="#_1" 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 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 such as the Raspberry Pi.</p>
|
||||
<p>这些说明假设软件将在运行 Klipper 兼容前端的 Linux 主机上运行。建议使用 SBC(小型板计算机),例如 Raspberry Pi 或基于 Debian 的 Linux 设备作为主机(有关其他选项,请参阅 <a href="FAQ.html#can-i-run-klipper-on-something-other-than-a-raspberry-pi-3">FAQ</a>)。</p>
|
||||
<p>就本说明而言,主机与 Linux 设备相关,而 mcu 与印刷电路板相关。SBC 与术语“小型板计算机”相关,例如 Raspberry Pi。</p>
|
||||
<h2 id="klipper">获取 Klipper 配置文件<a class="headerlink" href="#klipper" title="Permanent link">¶</a></h2>
|
||||
<p>Most Klipper settings are determined by a "printer configuration file" printer.cfg, that will be stored on the host. An appropriate configuration file can often be found by looking in the Klipper <a href="https://github.com/Klipper3d/klipper/blob/master/config/">config directory</a> for a file starting with a "printer-" prefix that corresponds to the target printer. The Klipper configuration file contains technical information about the printer that will be needed during the installation.</p>
|
||||
<p>大多数 Klipper 设置由“打印机配置文件”printer.cfg 决定,该文件将存储在主机上。通常可以通过在 Klipper <a href="https://github.com/Klipper3d/klipper/blob/master/config/">config 目录</a> 中查找以“printer-”前缀开头且与目标打印机相对应的文件来找到适当的配置文件。Klipper 配置文件包含安装过程中需要的有关打印机的技术信息。</p>
|
||||
<p>如果 Klipper 配置目录中没有合适的打印机配置文件,请尝试搜索打印机制造商的网站,看看他们是否有合适的 Klipper 配置文件。</p>
|
||||
<p>如果找不到打印机的配置文件,但可以找到打印机控制板的类型,则可以查找以“generic-”前缀开头的适当 <a href="https://github.com/Klipper3d/klipper/blob/master/config/">配置文件</a>。这些示例打印机模板文件应该足以成功完成初始安装,但需要进行一些自定义才能获得完整的打印机功能。</p>
|
||||
<p>也可以从头开始定义一个新的打印机配置。然而,这需要关于打印机及其电子系统的大量技术知识。建议大多数用户从一个适当的配置文件开始。如果需要创建一个新的自定义打印机配置文件,那么可以先从最接近的<a href="https://github.com/Klipper3d/klipper/blob/master/config/">配置文件</a>的例子开始,并从 Klipper <a href="Config_Reference.html">配置参考文档</a>了解进一步信息。</p>
|
||||
<h2 id="interacting-with-klipper">Interacting with Klipper<a class="headerlink" href="#interacting-with-klipper" title="Permanent link">¶</a></h2>
|
||||
<p>Klipper is a 3d printer firmware, so it needs some way for the user to interact with it.</p>
|
||||
<p>Currently the best choices are front ends that retrieve information through the <a href="https://moonraker.readthedocs.io/">Moonraker web API</a> and there is also the option to use <a href="https://octoprint.org/">Octoprint</a> to control Klipper.</p>
|
||||
<p>The choice is up to the user on what to use, but the underlying Klipper is the 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 their own Klipper-centric images.</p>
|
||||
<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="http://docs.mainsailOS.xyz">"MainsailOS"</a>, this has the option for Raspberry Pi and some OrangePi varianta.</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 <OctoPrint.md></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 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>
|
||||
<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 at <a href="https://github.com/dw-0/kiauh">https://github.com/dw-0/kiauh</a></p>
|
||||
<h2 id="klipper_1">与 Klipper 交互<a class="headerlink" href="#klipper_1" title="Permanent link">¶</a></h2>
|
||||
<p>Klipper 是一个 3D 打印机固件,因此需要某种方式让用户与其进行交互。</p>
|
||||
<p>目前最好的选择是通过 <a href="https://moonraker.readthedocs.io/">Moonraker web API</a> 检索信息的前端,也可以选择使用 <a href="https://octoprint.org/">Octoprint</a> 来控制 Klipper。</p>
|
||||
<p>用户可自行选择使用哪种工具,但底层的 Klipper 在所有情况下都是相同的。我们鼓励用户研究可用的选项并做出明智的决定。</p>
|
||||
<h2 id="sbc">获取 SBC 的操作系统映像<a class="headerlink" href="#sbc" title="Permanent link">¶</a></h2>
|
||||
<p>有多种方法可以获取用于 SBC 的 Klipper 操作系统映像,大多数方法取决于您希望使用哪种前端。这些 SBC 板的一些制造商还提供自己的以 Klipper 为中心的映像。</p>
|
||||
<p>两个主要的基于 Moonraker 的前端是 <a href="https://docs.fluidd.xyz/">Fluidd</a> 和 <a href="https://docs.mainsail.xyz/">Mainsail</a>,后者具有预制的安装映像 <a href="http://docs.mainsailOS.xyz">"MainsailOS"</a>,它有适用于 Raspberry Pi 和一些 OrangePi 变体的选项。</p>
|
||||
<p>Fluidd 可以通过 KIAUH(Klipper 安装和更新助手)进行安装,如下所述,它是所有 Klipper 的第三方安装程序。</p>
|
||||
<p>OctoPrint 可以通过流行的 OctoPi 镜像或通过 KIAUH 安装,此过程在 <OctoPrint.md> 中有说明</p>
|
||||
<h2 id="kiauh">通过 KIAUH 安装<a class="headerlink" href="#kiauh" title="Permanent link">¶</a></h2>
|
||||
<p>通常,您会从 SBC 的基本映像(例如 RPiOS Lite)开始,或者在 x86 Linux 设备的情况下,从 Ubuntu Server 开始。请注意,不建议使用桌面版本,因为某些辅助程序可能会阻止某些 Klipper 功能运行,甚至屏蔽对某些打印板的访问。</p>
|
||||
<p>KIAUH 可用于在运行 Debian 的各种 Linux 系统上安装 Klipper 及其相关程序。更多信息请访问 <a href="https://github.com/dw-0/kiauh">https://github.com/dw-0/kiauh</a></p>
|
||||
<h2 id="_2">构建和刷写微控制器<a class="headerlink" href="#_2" title="Permanent link">¶</a></h2>
|
||||
<p>To compile the micro-controller code, start by running these commands on your host device:</p>
|
||||
<p>要编译微控制器代码,首先在主机设备上运行以下命令:</p>
|
||||
<div class="highlight"><pre><span></span><code>cd ~/klipper/
|
||||
make menuconfig
|
||||
</code></pre></div>
|
||||
@@ -1505,9 +1505,9 @@ make menuconfig
|
||||
<div class="highlight"><pre><span></span><code>/dev/serial/by-id/usb-1a86_USB2.0-Serial-if00-port0
|
||||
</code></pre></div>
|
||||
|
||||
<p>It's common for each printer to have its own unique serial port name. This unique name will be used when flashing the micro-controller. It's possible there may be multiple lines in the above output - if so, choose the line corresponding to the micro-controller. If many 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>
|
||||
<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>
|
||||
<p>通常,每台打印机都有自己独特的串行端口名称。此唯一名称将在刷新微控制器时使用。上面的输出中可能有多行 - 如果是这样,请选择与微控制器相对应的行。如果列出了许多项目并且选择不明确,请拔下电路板并再次运行命令,缺少的项目将是您的打印板(有关更多信息,请参阅 <a href="FAQ.html#wheres-my-serial-port">FAQ</a>)。</p>
|
||||
<p>对于带有 STM32 或克隆芯片、LPC 芯片和其他芯片的常见微控制器,通常需要通过 SD 卡进行初始 Klipper 闪存。</p>
|
||||
<p>使用此方法进行闪烁时,务必确保打印板未通过 USB 连接到主机,因为某些电路板能够将电源反馈给电路板并阻止发生闪烁。</p>
|
||||
<p>For common micro-controllers using Atmega chips, for example the 2560, the code can be flashed with something similar to:</p>
|
||||
<div class="highlight"><pre><span></span><code>sudo service klipper stop
|
||||
make flash FLASH_DEVICE=/dev/serial/by-id/usb-1a86_USB2.0-Serial-if00-port0
|
||||
@@ -1522,7 +1522,7 @@ sudo service klipper start
|
||||
</code></pre></div>
|
||||
|
||||
<p>It is important to note that RP2040 chips may need to be put into Boot mode before this operation.</p>
|
||||
<h2 id="klipper_1">配置 Klipper<a class="headerlink" href="#klipper_1" title="Permanent link">¶</a></h2>
|
||||
<h2 id="klipper_2">配置 Klipper<a class="headerlink" href="#klipper_2" title="Permanent link">¶</a></h2>
|
||||
<p>The next step is to copy the <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 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 that support this (eg, Notepad++, WinSCP, and Cyberduck). 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>
|
||||
|
||||
Reference in New Issue
Block a user