序言

本教程适合已安装Debian系发行版(至少Debian 10或Ubuntu 20.04或至少基于以上发行版的Armbian)的设备,如PC(瘦客户机、工控机等)、ARM架构的开发板(香橙派、NanoPi等)。

准备

安全起见,KIAUH不会在Root用户中执行,所以请确保安装Klipper前,系统中拥有一个普通用户

如果不确定或者没有普通用户,可输入以下命令创建用户:

sudo adduser 用户名

创建完毕后,使用 su - 用户名 切换到新创建的用户。

使用apt安装软件之前,请确保使用了国内的软件源,以保证下载速度。

这里贴出清华源中科大源的换源教程:

Armbian需要额外替换/etc/apt/sources.list.d/armbian.list中的软件源,将官方源网址改为国内镜像源。

更改软件源后需要运行sudo apt update,如检测到更新请使用sudo apt upgrade安装。

更新软件源和所有软件后,需要检查系统是否安装Python3.7及以上版本、gitpipvirtualenv命令。如果没有安装,请运行sudo apt install python3-pip python3-virtualenv git来安装。

更换Python源

为防止安装Python依赖时安装缓慢,需要提前更换好pip的源。安装好pip后,输入pip3 config set global.index-url 链接即可更换源。

以下列出了一些常用的pip源链接:

# 清华源
https://pypi.tuna.tsinghua.edu.cn/simple
# 豆瓣源
https://pypi.doubanio.com/simple
# 腾讯源
https://mirrors.cloud.tencent.com/pypi/simple
# 阿里源
https://mirrors.aliyun.com/pypi/simple

如果你是树莓派用户并使用官方的Raspberry Pi OS镜像,则需要删除或注释掉 /etc/pip.conf 文件中的所有内容,防止pip从位于英国的piwheels.org下载文件,极度拖慢下载速度。

开始安装

下载KIAUH安装器

首先,安装好git,使用以下命令下载KIAUH:

git clone https://github.com/dw-0/kiauh

如果所在地的GitHub速度缓慢,可使用以下命令,使用托管到国内的源(强烈推荐):

git clone https://gitee.com/miroky/kiauh

安装

Klipper

运行kiauh.sh,出现如下界面(可以看到所有软件都显示为Not Installed):

选择1) [Install]后,出现如下界面:

选择1) [Klipper]来安装Klipper。

首先是选择Python版本的界面,因Python 2早已停止维护,不建议使用Python 2环境安装,直接选择Python 3环境安装即可。

/=======================================================\
| Please select your preferred Python version.          |
| The recommended version is Python 3.x.                |
|-------------------------------------------------------|
|  1) [Python 3.x]  (recommended)                       |
|  2) [Python 2.7]  (legacy)                            |
|-------------------------------------------------------|
|                       B) « Back                       |
\=======================================================/
###### Select Python version:

下一步会询问安装Klipper的实例数量,如果只连接一台打印机,只需安装一个实例。
这里以一台打印机为例,按两下回车继续。

###### Initializing Klipper installation ...
/=======================================================\
| Please select the number of Klipper instances to set  |
| up. The number of Klipper instances will determine    |
| the amount of printers you can run from this host.    |
|                                                       |
| WARNING:                                              |
| Setting up too many instances may crash your system.  |
\=======================================================/
###### Number of Klipper instances to set up: 1
 [➔] 1
###### Install 1 instance(s)? (Y/n): 

此时KIAUH便会开始Klipper的安装,只需稍作等待即可。

安装过程中需要安装并更新软件,可能需要系统的管理员密码。

安装好Klipper后,可能会询问是否将当前用户加入ttydialout等用户组,用于解决无串口使用权限的问题,回车确认即可。

/=======================================================\
| WARNING: Your current user is not in group:           |
| ● tty                                                 |
| ● dialout                                             |
|                                                       |
| It is possible that you won't be able to successfully |
| connect and/or flash the controller board without     |
| your user being a member of that group.               |
| If you want to add the current user to the group(s)   |
| listed above, answer with 'Y'. Else skip with 'n'.    |
|                                                       |
| INFO:                                                 |
| Relog required for group assignments to take effect!  |
\=======================================================/
###### Add user '用户名' to group(s) now? (Y/n): 

安装完成后,会自动返回Installation Menu界面。

Moonraker

Installation Menu界面选择2) [Moonraker]即可开始安装。
安装前会自动检测是否安装有Klipper,如果没有安装,请参照上一步。看到这里的应该都安装了吧

按回车即可进行Moonraker的安装。

###### Initializing Moonraker installation ...
[✓ OK] Klipper installation found!

###### Install Moonraker? (Y/n): 

安装完成后会显示Moonraker的IP地址:

#########################################################
 Moonraker has been set up! 
#########################################################

        Instance 1: 192.168.2.235:7125

使用浏览器访问此地址后,显示类似如下内容即表示安装成功:

Web界面

KIAUH支持安装Mainsail和Fluidd这两种Web界面。

以安装Fluidd为例,Mainsail安装过程与Fluidd大同小异,故不再赘述。

Installation Menu界面中选择4) [Fluidd]即可开始安装。
这一步完成后会下载并部署Fluidd或Mainsail,完成后会询问是否添加常用的gcode脚本,直接回车安装即可:

/=======================================================\
| It is recommended to have some important macros in    |
| your printer configuration to have Fluidd fully       |
| functional and working.                               |
|                                                       |
| The recommended macros for Fluidd can be found here:  |
| https://docs.fluidd.xyz/configuration/initial_setup   |
|                                                       |
| If you already have these macros in your config file, |
| skip this step and answer with 'no'.                  |
| Otherwise you should consider to answer with 'yes' to |
| add the recommended example macros to your config.    |
\=======================================================/
###### Add the recommended macros? (Y/n): 

等待片刻,Fluidd或Mainsail即可安装完成。
如果在已经登陆图形界面且带有浏览器的系统安装,可进入浏览器访问127.0.0.1localhost,网页加载成功即为完成安装。

如果在远程连接的系统上安装,可以在同一局域网下使用浏览器访问系统的IP地址,查看网页是否加载成功。

图中的错误是因为没有连接打印机,此时Klipper等软件已经可以正常工作。

为下位机(主板)编译固件

启动KIAUH,选择4) [Advanced]后,会进入如下界面:

/=======================================================\
|     ~~~~~~~~~~~~~~~~~ [ KIAUH ] ~~~~~~~~~~~~~~~~~     |
|        Klipper Installation And Update Helper         |
|     ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~     |
\=======================================================/
/=======================================================\
|     ~~~~~~~~~~~~~ [ Advanced Menu ] ~~~~~~~~~~~~~     |
|-------------------------------------------------------|
| Klipper & API:          | Mainsail:                   |
|  1) [Rollback]          |  6) [Theme installer]       |
|                         |                             |
| Firmware:               | System:                     |
|  2) [Build only]        |  7) [Change hostname]       |
|  3) [Flash only]        |                             |
|  4) [Build + Flash]     | Extras:                     |
|  5) [Get MCU ID]        |  8) [G-Code Shell Command]  |
|-------------------------------------------------------|
|                       B) « Back                       |
\=======================================================/
####### Perform action: 

选择2) [Build only]即可编译固件。

编译固件前,会显示如图的配置界面:

如图,默认配置适用于ATmega2560(适用于RAMPS、MKS Gen_L等主板)。

LPC1768(MKS SGENL、必趣SKR)和RP2040主控的主板一般不需要修改配置,可以直接使用默认配置编译固件和线刷。

基于STM32的主板(MKS Monster8/Robin Nano v3、八爪鱼、蜘蛛)等,需要参考厂家说明书修改配置,以编译出正确的固件。

修改完成后,按Q键退出并保存配置,即开始编译固件。

编译好后,可以在klipper\out目录中找到编译好的固件klipper.elf.hexklipper.binklipper.u2f,刷入主板即可。

配置摄像头

请参考 安装与配置 Crowsnest 摄像头服务