Klippain-ShakeTune 项目使用教程

Klippain-ShakeTune 项目使用教程

klippain-shaketuneKlipper streamlined input shaper workflow and calibration tools项目地址:https://gitcode.com/gh_mirrors/kl/klippain-shaketune

1. 项目的目录结构及介绍

Klippain-ShakeTune 项目的目录结构如下：

klippain-shaketune/
├── ci/
│   └── smoke-test
├── docs/
├── shaketune/
├── .gitignore
├── .git-blame-ignore-revs
├── LICENSE
├── README.md
├── install.sh
├── moonraker.conf
├── pyproject.toml
├── requirements.txt
└── system-dependencies.json

目录结构介绍

• ci/: 包含持续集成相关的配置文件。
• docs/: 包含项目文档。
• shaketune/: 包含 ShakeTune 模块的核心代码。
• .gitignore: Git 忽略文件配置。
• .git-blame-ignore-revs: Git 历史忽略配置。
• LICENSE: 项目许可证文件。
• README.md: 项目介绍和使用说明。
• install.sh: 安装脚本。
• moonraker.conf: Moonraker 配置文件示例。
• pyproject.toml: Python 项目配置文件。
• requirements.txt: 项目依赖列表。
• system-dependencies.json: 系统依赖配置文件。

2. 项目的启动文件介绍

项目的启动文件主要是 install.sh，这是一个安装脚本，用于在 Klipper 机器上安装 ShakeTune 模块。

install.sh 介绍

install.sh 脚本的主要功能是下载并安装 ShakeTune 模块。使用方法如下：

wget -O - https://raw.githubusercontent.com/Frix-x/klippain-shaketune/main/install.sh | bash

该脚本会自动下载并安装 ShakeTune 模块，并配置 Klipper 以使用该模块。

3. 项目的配置文件介绍

项目的配置文件主要包括 moonraker.conf 和 printer.cfg。

moonraker.conf 介绍

moonraker.conf 是一个示例配置文件，用于配置 Moonraker 以支持 ShakeTune 模块。通常不需要手动修改此文件，安装脚本会自动处理。

printer.cfg 介绍

printer.cfg 是 Klipper 的主配置文件，需要在其中添加 ShakeTune 模块的配置。

在 printer.cfg 文件中添加以下内容：

[shaketune]
# result_folder: ~/printer_data/config/ShakeTune_results
# The folder where the results will be stored. It will be created if it doesn't exist.

此配置项指定了 ShakeTune 结果存储的文件夹路径。可以根据需要修改 result_folder 的值。

以上是 Klippain-ShakeTune 项目的使用教程，包括项目的目录结构、启动文件和配置文件的介绍。希望对您有所帮助。

klippain-shaketuneKlipper streamlined input shaper workflow and calibration tools项目地址:https://gitcode.com/gh_mirrors/kl/klippain-shaketune